Miliastra Wonderland Lua API

ServerSignal

The type that represents an instance of a Server Signal which can be sent and received by Node Graphs. Contains functions for adding parameters and sending the signal.

Methods20 

function ServerSignal:AddBool(value: boolean)

Appends a Boolean to the Server Signal instance.

Parameters
valueboolean

The Boolean to append.

function ServerSignal:AddBoolList(values: boolean[])

Appends a Boolean List to the Server Signal instance.

Parameters
valuesboolean[]

The sequence of Booleans to append.

function ServerSignal:AddConfigId(value: number)

Appends a Config ID to the Server Signal instance.

Floating Point Numbers are evaluated as 0, and negative numbers underflow to their 32-bit unsigned integer equivalent.

Parameters
valuenumber

The Config ID to append.

function ServerSignal:AddConfigIdList(values: number[])

Appends a Config ID List to the Server Signal instance.

  • Floating Point Numbers in the sequence are evaluated as 0.
  • Negative numbers underflow to their 32-bit unsigned integer equivalent.
  • Throws an error if the table contains fields not in sequence, or values that are not numbers.
Parameters
valuesnumber[]

The sequence of Config IDs to append.

function ServerSignal:AddEntity(value: number)

Appends an Entity to the Server Signal instance.

  • Floating Point Numbers are evaluated as 0.
  • Negative numbers underflow to their 32-bit unsigned integer equivalent.
Parameters
valuenumber

The ID of the Entity to append.

function ServerSignal:AddEntityList(values: number[])

Appends an Entity List to the Server Signal instance.

  • Floating Point Numbers in the sequence are evaluated as 0.
  • Negative numbers underflow to their 32-bit unsigned integer equivalent.
  • Throws an error if the table contains fields not in sequence, or values that are not numbers.
Parameters
valuesnumber[]

The sequence of Entity IDs to append.

function ServerSignal:AddFloat(value: number)

Appends a Floating Point Number to the Server Signal instance.

Parameters
valuenumber

The Floating Point Number to append.

function ServerSignal:AddFloatList(values: number[])

Appends a Floating Point Number List parameter to the Server Signal instance.

Parameters
valuesnumber[]

The sequence of Floating Point Numbers to append.

function ServerSignal:AddGuid(value: number)

Appends a GUID to the Server Signal instance.

  • Floating Point Numbers are evaluated as 0.
  • Negative numbers underflow to their 32-bit unsigned integer equivalent.
Parameters
valuenumber

The GUID to append.

function ServerSignal:AddGuidList(values: number[])

Appends a GUID List to the Server Signal instance.

  • Floating Point Numbers in the sequence are evaluated as 0.
  • Negative numbers underflow to their 32-bit unsigned integer equivalent.
  • Throws an error if the table contains fields not in sequence, or values that are not numbers.
Parameters
valuesnumber[]

The sequence of GUIDs to append.

function ServerSignal:AddInt(value: number)

Appends an Integer parameter to the Server Signal instance. Floating Point Numbers are evaluated as 0.

Parameters
valuenumber

The Integer to append.

function ServerSignal:AddIntList(values: number[])

Appends an Integer List parameter to the Server Signal instance.

  • Throws an error if the table contains fields not in sequence, or values that are not numbers.
Parameters
valuesnumber[]

The sequence of Integers to append. Floating Point Numbers in the sequence are evaluated as 0.

function ServerSignal:AddParam(type: EnumItem.ParamType, value: ServerDataType)

Appends a parameter to the Server Signal instance.

  • Behavior for unexpected type values are documented in the add function for the corresponding type.

See:

Parameters
typeEnumItem.ParamType

The type that the parameter should be interpreted as.

valueServerDataType

The value that should be sent for the added parameter.

function ServerSignal:AddPrefabId(value: number)

Appends a Prefab ID to the Server Signal instance.

  • Floating Point Numbers are evaluated as 0.
  • Negative numbers underflow to their 32-bit unsigned integer equivalent.
Parameters
valuenumber

The Prefab ID to append.

function ServerSignal:AddPrefabIdList(values: number[])

Appends a Prefab ID List to the Server Signal instance.

  • Floating Point Numbers in the sequence are evaluated as 0.
  • Negative numbers underflow to their 32-bit unsigned integer equivalent.
  • Throws an error if the table contains fields not in sequence, or values that are not numbers.
Parameters
valuesnumber[]

The sequence of Prefab IDs to append.

function ServerSignal:AddString(value: string)

Appends a String to the Server Signal instance.

Parameters
valuestring

The String to append.

function ServerSignal:AddStringList(values: string[])

Appends a String List to the Server Signal instance.

Parameters
valuesstring[]

The sequence of Strings to append.

function ServerSignal:AddVector3(value: Vector3)

Appends a 3D Vector to the Server Signal instance.

Parameters
valueVector3

The 3D Vector to append.

function ServerSignal:AddVector3List(values: Vector3[])

Appends a 3D Vector List to the Server Signal instance.

Parameters
valuesVector3[]

The sequence of 3D Vectors to append.

function ServerSignal:SendSignal()

Sends the signal.

  • The Signal Source Entity will always be the Stage Entity.
  • Client Controls will not receive the signal, only Node Graphs.