LuaRemote

Registry of interfaces between scripts. An interface is simply a dictionary mapping names to functions. A script or mod can then register an interface with LuaRemote, after that any script can call the registered functions, provided it knows the interface name and the desired function name. An instance of LuaRemote is available through the global object named remote.

Attributes

object_name

• Read: string
• Write: unknown
• Optional: false

The class name of this object. Available even when valid is false. For LuaStruct objects it may also be suffixed with a dotted path to a member of the struct.

interfaces

• Read: Dict<string, Dict<string, true>>
• Write: unknown
• Optional: false

List of all registered interfaces. For each interface name, remote.interfaces[name] is a dictionary mapping the interface's registered functions to true.

Methods

add_interface

LuaRemote.add_interface(name: string, functions: Dict<string, function()>)

Call As

remote.add_interface(name, functions)

Call Convention

• takes_table: false
• table_optional: false

Add a remote interface.

Parameters

• name: string — Name of the interface. If the name matches any existing interface, an error is thrown.
• functions: Dict<string, function()> — List of functions that are members of the new interface.

remove_interface

LuaRemote.remove_interface(name: string) -> boolean

Call As

remote.remove_interface(name)

Call Convention

• takes_table: false
• table_optional: false

Removes an interface with the given name.

Parameters

• name: string — Name of the interface.

Returns

• boolean — Whether the interface was removed. false if the interface didn't exist.

call

LuaRemote.call(interface: string, function: string) -> Any?

Call As

remote.call(interface, function)

Call Convention

• takes_table: false
• table_optional: false

Call a function of an interface.

Providing an unknown interface or function name will result in a script error.

Parameters

• interface: string — Interface to look up function in.
• function: string — Function name that belongs to the interface.

Returns

• Any?