SPersistence

Index

Functions Index

Function Name
void UpdateInfo (Closure onComplete)
string RetrieveValue (string key)
void SetValue (string key, string value)
void UpdateRegionInfo (Action onComplete) void UpdateRegionInfo (Closure onComplete)
string RetrieveRegionValue (string key)
void SetRegionValue (string key, string value)

Functions

UpdateInfo

void UpdateInfo (Closure onComplete)

Call the onComplete function upon the server saving a value.

Parameter	Type	Description

Lua

function OnCompleteFunction()
--
end

Space.Persistence.UpdateInfo(OnCompleteFunction)

Lua

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

Space.Persistence.UpdateInfo(function ()
    local value = Space.Persistence.RetrieveValue("TestValue")
    Space.Log(value)
end)
--print "123" to console.

RetrieveValue

string RetrieveValue (string key)

Returns the saved value with the key.

Parameter	Type	Description

Lua

Space.Persistence.RetrieveValue("TestValue")

SetValue

void SetValue (string key, string value)

Save a value to the storage record that is accessed with key.

Parameter	Type	Description
key	string	Max length 48
value	string	Max length 255

Lua

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

UpdateRegionInfo

void UpdateRegionInfo (Action onComplete) void UpdateRegionInfo (Closure onComplete)

Updates your local cache with the most up-to-date values from the server. This function should be called before using the RetrieveRegionValue function.

Parameter	Type	Description

Lua

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

Space.Persistence.UpdateRegionInfo(function ()
    local value = Space.Persistence.RetrieveRegionValue("TestRegionValue")
    Space.Log(value)
end)
--print "456" to console.

RetrieveRegionValue

string RetrieveRegionValue (string key)

Retrieves the saved value from "key" from your local cache. The UpdateRegionInfo function should be called first to update your local cache with the most up-to-date values from the server.

Parameter	Type	Description

Lua

Space.Persistence.RetrieveRegionValue("TestRegionValue");

SetRegionValue

void SetRegionValue (string key, string value)

Save the "value" to "key" on both your local cache and on the server.

Parameter	Type	Description
key	string	Max length 48
value	string	Max length 255

Lua

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