wiki.sine.space | sinespace

Difference between revisions of "Scripting/SPersistence"

From wiki.sine.space
Jump to: navigation, search
Line 2: Line 2:
  
 
=Members=
 
=Members=
==Get/Set Values==
+
{{ScriptFunction|void|SetValue|(string key, string value);|Assign the string value to the key.|5=Space.Persistence.SetValue("MyValue", "Hello World");}}
  
{{ScriptFunction|void|SetValue|(string key, string value);|Set a value as 'key'='value'.|5=Space.Persistence.SetValue("MyValue", "Hello World");}}
+
{{ScriptFunction|string|RetrieveValue|(string key);|Returns the saved value with the key.|5=Space.Persistence.RetrieveValue("TestValue");}}
{{ScriptFunction|string|GetValue|(string key);|Retrieve the value assigned to 'key'.|5=Space.Log(Space.Persistence.GetValue("MyValue"));}}
+
  
==Miscellaneous==
+
{{ScriptFunction|string|SetRegionValue|(string key);|Save the string value to the key.|5=Space.Persistence.SetRegionValue("TestRegionValue","456");}}
{{ScriptFunction|void|UpdateValue|(Action onComplete);|Call the onComplete function upon the server saving a value.}}
+
 
 +
{{ScriptFunction|string|RetrieveRegionValue|(string key);|Returns the saved value.|5=Space.Persistence.RetrieveRegionValue("TestRegionValue");}}
 +
 
 +
{{ScriptFunction|void|UpdateInfo|(Closure onComplete);|Call the onComplete function upon the server saving a value.|5=
 +
Space.Persistence.SetValue("TestValue","123");<br><br>
 +
Space.Persistence.UpdateInfo(function ()<br>
 +
&nbsp;&nbsp;&nbsp;&nbsp;local value = Space.Persistence.RetrieveValue("TestValue")<br>
 +
&nbsp;&nbsp;&nbsp;&nbsp;Space.Log(value)<br>
 +
end)<br>
 +
''--print "123" to console.''
 +
}}
 +
 
 +
{{ScriptFunction|void|UpdateRegionInfo|(Closure onComplete);|Call the onComplete function upon the server saving a value.|5=
 +
Space.Persistence.SetRegionValue("TestRegionValue","456")<br><br>
 +
Space.Persistence.UpdateRegionInfo(function ()<br>
 +
&nbsp;&nbsp;&nbsp;&nbsp;local value = Space.Persistence.RetrieveRegionValue("TestRegionValue")<br>
 +
&nbsp;&nbsp;&nbsp;&nbsp;Space.Log(value)<br>
 +
end)<br>
 +
''--print "456" to console.''
 +
}}

Revision as of 08:49, 16 December 2020

The SPersistence class allows you to store persistent data to the avatar.

Members

SetValue

void SetValue (string key, string value);

Assign the string value to the key.

Space.Persistence.SetValue("MyValue", "Hello World");


RetrieveValue

string RetrieveValue (string key);

Returns the saved value with the key.

Space.Persistence.RetrieveValue("TestValue");


SetRegionValue

string SetRegionValue (string key);

Save the string value to the key.

Space.Persistence.SetRegionValue("TestRegionValue","456");


RetrieveRegionValue

string RetrieveRegionValue (string key);

Returns the saved value.

Space.Persistence.RetrieveRegionValue("TestRegionValue");


UpdateInfo

void UpdateInfo (Closure onComplete);

Call the onComplete function upon the server saving a value.

Space.Persistence.SetValue("TestValue","123");

Space.Persistence.UpdateInfo(function ()
    local value = Space.Persistence.RetrieveValue("TestValue")
    Space.Log(value)
end)

--print "123" to console.


UpdateRegionInfo

void UpdateRegionInfo (Closure onComplete);

Call the onComplete function upon the server saving a value.

Space.Persistence.SetRegionValue("TestRegionValue","456")

Space.Persistence.UpdateRegionInfo(function ()
    local value = Space.Persistence.RetrieveRegionValue("TestRegionValue")
    Space.Log(value)
end)

--print "456" to console.