SShared

Index

Functions Index

Function
void SetGlobal (string ns, string key, DynValue value)
DynValue GetGlobal (string ns, string key)
void RegisterFunction (string ns, string func, Closure reference)
void RegisterBroadcastFunction (string ns, string func, Closure reference)
void UnregisterBroadcastFunction (string ns, string func, Closure reference) void UnregisterBroadcastFunction (string ns, string func)
void CallFunction (string ns, string func, IEnumerable< DynValue > args)
int CallBroadcastFunction (string ns, string func, IEnumerable< DynValue > args)

Functions

SetGlobal

void SetGlobal (string ns, string key, DynValue value)

Sets a global key to a value. The value can be any object type.

Parameter	Type	Description

Lua

Space.Shared.SetGlobal("com.someNameHere.world", "version", "1.02");

GetGlobal

DynValue GetGlobal (string ns, string key)

Retrieves a previously set global variable, or returns nil.

Parameter	Type	Description

Lua

local versionValue = Space.Shared.GetGlobal("com.someNameHere.world", "version")

RegisterFunction

void RegisterFunction (string ns, string func, Closure reference)

Makes func into a global function that can be accessed anywhere.

Parameter	Type	Description

Lua

function someFunction(name)
  Space.Log("Hello " .. name);
end

Space.Shared.RegisterFunction("com.someNameHere.world", "func", someFunction);

RegisterBroadcastFunction

void RegisterBroadcastFunction (string ns, string func, Closure reference)

Makes func into a global function that can be accessed anywhere.

Parameter	Type	Description

Lua

function someFunction(name)
  Space.Log("Hello " .. name);
end

Space.Shared.RegisterBroadcastFunction("com.someNameHere.world", "func", someFunction);

UnregisterBroadcastFunction

void UnregisterBroadcastFunction (string ns, string func, Closure reference) void UnregisterBroadcastFunction (string ns, string func)

Unregister Broadcast Function.

Parameter	Type	Description

Lua

example 1

CallFunction

void CallFunction (string ns, string func, IEnumerable< DynValue > args)

Calls the registered function with the specified arguments.

Parameter	Type	Description

Lua

Space.Shared.CallFunction("com.someNameHere.world", "func",{"Smith"});

CallBroadcastFunction

int CallBroadcastFunction (string ns, string func, IEnumerable< DynValue > args)

Calls every registered broadcast function with the specified arguments, and returns the number of calls queued.

Parameter	Type	Description

Lua

example 1