gamecircle.Whispersync.SyncableStringList

Overview

A lua table returned by the functions like GetLatestStringList.

Properties

• value - String
  The string value of the
• maxSize - Number
  The maximum length of the list. Default value is 5.
• isSet - Boolean
  Tells whether or not the list has been set and thus stored with Whispersync.
• [] Square Bracket Accessor - SyncableStringElement
  The returned string-keys are stored as numerically-indexed entires on the table, ranging in value from 1 to “num”. They can also be access using an ipairs interation.

Example

local latestListKey = "myFirstLatestStringList"  
local gamecircle = require("plugin.gamecircle")  
gamecircle.Init(false, false, true)  
gamecircle.Whispersync.SetLatestStringListLength(latestListKey, 4)  
gamecircle.Whispersync.AddToLatestStringList(latestListKey, "A")
gamecircle.Whispersync.AddToLatestStringList(latestListKey, "B")
gamecircle.Whispersync.AddToLatestStringList(latestListKey, "C")
gamecircle.Whispersync.AddToLatestStringList(latestListKey, "D") 
gamecircle.Whispersync.AddToLatestStringList(latestListKey, "E") 
print("Here is the list of strings as they are stored in the latest string list. They should be in the order from latest to oldest.")  
local latestList = gamecircle.Whispersync.GetLatestStringList(latestListKey)  
for i,entry in ipairs(latestList) do  
    print("-" entry.value)  
end  
local keys = gamecircle.Whispersync.GetLatestStringListKeys()  
for i,key in ipairs(keys) do  
    print("-" .. key)  
end