wiki.sine.space | sinespace
Open Nav

Difference between revisions of "Scripting/Server/SShared"

From wiki.sine.space
Jump to: navigation, search
Line 13: Line 13:
  
 
'''Space.Shared.RegisterFunction'''("com.someNameHere.world", "func", someFunction);
 
'''Space.Shared.RegisterFunction'''("com.someNameHere.world", "func", someFunction);
−
|6=<pre>--Script placed on object A will allow other objects to call one of it's registered functions when clicked
+
|6=}}
−
 
+
−
--Script in Object A
+
−
thisObject = Space.Host.ExecutingObject
+
−
namespace = "com.example.shared"
+
−
 
+
−
LogFunction = function(Parameter)
+
−
Space.Log("I've been called with parameter: " .. Parameter) 
+
−
end
+
−
 
+
−
Space.Shared.RegisterFunction(namespace, "Log", LogFunction)
+
−
 
+
−
 
+
−
 
+
−
-- Script in Other Objects
+
−
thisObject = Space.Host.ExecutingObject
+
−
namespace = "com.example.shared"
+
−
 
+
−
OnClick = function()
+
−
Space.Shared.CallFunction(namespace, "Log", {"Example"})
+
−
end
+
−
 
+
−
thisObject.AddClickable()
+
−
thisObject.Clickable.OnClick(OnClick)</pre>}}
+
  
 
{{ScriptFunction|void|CallFunction|(string ns, string func, IEnumerable< DynValue > args);|Calls the registered function with the specified arguments.|5=
 
{{ScriptFunction|void|CallFunction|(string ns, string func, IEnumerable< DynValue > args);|Calls the registered function with the specified arguments.|5=
Line 49: Line 26:
  
  
−
{{ScriptFunction|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.|5=
+
{{ScriptFunction|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.|5=}}
−
''-- Script A: Receiver''<br>
+
−
function someFunction(status)<br>
+
−
&nbsp;&nbsp;if status == "start"<br>
+
−
&nbsp;&nbsp;then Space.Log("Do receiver 1 procedures.")<br>
+
−
&nbsp;&nbsp;end<br>
+
−
end<br><br>
+
  
−
Space.Shared.RegisterBroadcastFunction("com.someNameHere.world", "func", someFunction);<br><br>
+
{{ScriptFunction|int|UnregisterBroadcastFunction|(string ns, string func, Closure reference);|Unregister Broadcast Function.|5=}}
  
−
 
+
{{ScriptFunction|int|UnregisterBroadcastFunction|(string ns, string func);|Unregister Broadcast Function.|5=}}
−
''-- Script B: Another Receiver''<br>
+
−
function someFunction(status)<br>
+
−
&nbsp;&nbsp;if status == "start"<br>
+
−
&nbsp;&nbsp;then Space.Log("Do receiver 2 procedures.")<br>
+
−
&nbsp;&nbsp;end<br>
+
−
end<br><br>
+
−
 
+
−
Space.Shared.RegisterBroadcastFunction("com.someNameHere.world", "func", someFunction);<br><br>
+
−
 
+
−
 
+
−
''--Script C: Sender''<br>
+
−
local ball = Space.Host.ExecutingObject;<br>
+
−
ball.SubscribeToEvents();<br><br>
+
−
 
+
−
function onDown()<br>
+
−
&nbsp;&nbsp;local queue = '''Space.Shared.CallBroadcastFunction'''("com.someNameHere.world", "func", {"start"});<br>
+
−
&nbsp;&nbsp;Space.Log("number in queue: " .. queue);<br>
+
−
end<br><br>
+
−
 
+
−
 
+
−
ball.OnMouseDown(onDown);}}
+
−
 
+
−
{{ScriptFunction|int|UnregisterBroadcastFunction|(string ns, string func, Closure reference);|Unregister Broadcast Function.|5=
+
−
''-- Script A: Receiver''<br>
+
−
function someFunction(status)<br>
+
−
&nbsp;&nbsp;if status == "start"<br>
+
−
&nbsp;&nbsp;then Space.Log("Do receiver 1 procedures.")<br>
+
−
&nbsp;&nbsp;end<br>
+
−
end<br><br>
+
−
 
+
−
Space.Shared.RegisterBroadcastFunction("com.someNameHere.world", "func", someFunction);<br><br>
+
−
 
+
−
 
+
−
''-- Script B: Another Receiver''<br>
+
−
function someFunction(status)<br>
+
−
&nbsp;&nbsp;if status == "start"<br>
+
−
&nbsp;&nbsp;then Space.Log("Do receiver 2 procedures.")<br>
+
−
&nbsp;&nbsp;end<br>
+
−
end<br><br>
+
−
 
+
−
Space.Shared.RegisterBroadcastFunction("com.someNameHere.world", "func", someFunction);<br><br>
+
−
 
+
−
 
+
−
''--Script C: Sender''<br>
+
−
local ball = Space.Host.ExecutingObject;<br>
+
−
ball.SubscribeToEvents();<br><br>
+
−
 
+
−
function onDown()<br>
+
−
&nbsp;&nbsp;local queue = '''Space.Shared.CallBroadcastFunction'''("com.someNameHere.world", "func", {"start"});<br>
+
−
&nbsp;&nbsp;Space.Log("number in queue: " .. queue);<br>
+
−
&nbsp;&nbsp;Space.Shared.UnregisterBroadcastFunction("com.someNameHere.world", "func", someFunction);<br>
+
−
&nbsp;&nbsp;Space.Log("UnregisterBroadcastFunction");<br>
+
−
end<br><br>
+
−
 
+
−
 
+
−
ball.OnMouseDown(onDown);}}
+
−
 
+
−
{{ScriptFunction|int|UnregisterBroadcastFunction|(string ns, string func);|Unregister Broadcast Function.|5=
+
−
''-- Script A: Receiver''<br>
+
−
function someFunction(status)<br>
+
−
&nbsp;&nbsp;if status == "start"<br>
+
−
&nbsp;&nbsp;then Space.Log("Do receiver 1 procedures.")<br>
+
−
&nbsp;&nbsp;end<br>
+
−
end<br><br>
+
−
 
+
−
Space.Shared.RegisterBroadcastFunction("com.someNameHere.world", "func", someFunction);<br><br>
+
−
 
+
−
 
+
−
''-- Script B: Another Receiver''<br>
+
−
function someFunction(status)<br>
+
−
&nbsp;&nbsp;if status == "start"<br>
+
−
&nbsp;&nbsp;then Space.Log("Do receiver 2 procedures.")<br>
+
−
&nbsp;&nbsp;end<br>
+
−
end<br><br>
+
−
 
+
−
Space.Shared.RegisterBroadcastFunction("com.someNameHere.world", "func", someFunction);<br><br>
+
−
 
+
−
 
+
−
''--Script C: Sender''<br>
+
−
local ball = Space.Host.ExecutingObject;<br>
+
−
ball.SubscribeToEvents();<br><br>
+
−
 
+
−
function onDown()<br>
+
−
&nbsp;&nbsp;local queue = '''Space.Shared.CallBroadcastFunction'''("com.someNameHere.world", "func", {"start"});<br>
+
−
&nbsp;&nbsp;Space.Log("number in queue: " .. queue);<br>
+
−
&nbsp;&nbsp;Space.Shared.UnregisterBroadcastFunction("com.someNameHere.world", "func");<br>
+
−
&nbsp;&nbsp;Space.Log("UnregisterBroadcastFunction");<br>
+
−
end<br><br>
+
−
 
+
−
 
+
−
ball.OnMouseDown(onDown);}}
+
  
 
{{ScriptFunction|void|SetSuperGlobal|(string ns, string key, DynValue value);|Sets a Super global key to a value. The value can be any object type.|5=
 
{{ScriptFunction|void|SetSuperGlobal|(string ns, string key, DynValue value);|Sets a Super global key to a value. The value can be any object type.|5=
−
Space.Shared.SetSuperGlobal("com.someNameHere.world", "version", "1.02"); |6=<pre>--these two scripts are in two different regions but script B will know that you came from A
+
Space.Shared.SetSuperGlobal("com.someNameHere.world", "version", "1.02"); |6=
−
 
+
−
--REGION A script
+
−
username = Space.Scene.PlayerAvatar.Username
+
−
region = Space.Scene.Name
+
−
Space.Shared.SetSuperGlobal (username, "Last Location", region)
+
−
 
+
−
 
+
−
 
+
−
--REGION B script
+
−
username = Space.Scene.PlayerAvatar.Username
+
−
region = Space.Shared.GetSuperGlobal (username, "Last Location")
+
−
Space.Dialogues.SendLocalChat ("You have arrived from ".. region, "Last Location")</pre>}}
+
−
 
+
−
{{ScriptFunction|DynValue|GetSuperGlobal|(string ns, string key);|Retrieves a previously set super global variable, or returns nil.|5=
+
−
local versionValue = Space.Shared.GetSuperGlobal("com.someNameHere.world",  "version");|6=<pre>--these two scripts are in two different regions but script B will know that you came from A
+
−
 
+
−
--REGION A script
+
−
username = Space.Scene.PlayerAvatar.Username
+
−
region = Space.Scene.Name
+
−
Space.Shared.SetSuperGlobal (username, "Last Location", region)
+
−
 
+
−
 
+
−
 
+
−
--REGION B script
+
−
username = Space.Scene.PlayerAvatar.Username
+
−
region = Space.Shared.GetSuperGlobal (username, "Last Location")
+
−
Space.Dialogues.SendLocalChat ("You have arrived from ".. region, "Last Location")</pre>
+
 
}}
 
}}
  
  
 
{{Scripting Navbox}}
 
{{Scripting Navbox}}

Revision as of 14:25, 24 February 2022

Members

SetGlobal

void SetGlobal (string namespace, string key, DynValue value);

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

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


GetGlobal

DynValue GetGlobal (string namespace, string key);

Retrieves a previously set global variable, or returns nil.

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.

function someFunction(name)

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

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


CallFunction

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

Calls the registered function with the specified arguments.

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


RegisterBroadcastFunction

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

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

function someFunction(name)

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

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



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.


UnregisterBroadcastFunction

int UnregisterBroadcastFunction (string ns, string func, Closure reference);

Unregister Broadcast Function.


UnregisterBroadcastFunction

int UnregisterBroadcastFunction (string ns, string func);

Unregister Broadcast Function.


SetSuperGlobal

void SetSuperGlobal (string ns, string key, DynValue value);

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

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


v · d · e
Scripting Portal
Common
Key Classes
Helper Classes
Scripting samples and tutorials
Retrieved from "https://wiki.sine.space/index.php?title=Scripting/Server/SShared&oldid=200161"