gamecircle.Whispersync.SyncableNumberList

Overview

A lua table returned by the functions like GetHighNumberList.

Properties

• size - Number
  The number values in the array.
• 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 - SyncableNumberElement
  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 highListKey = "myFirstHighNumberList" 
local gamecircle = require("plugin.gamecircle")  
gamecircle.Init(false, false, true)  
gamecircle.Whispersync.SetHighNumberListLength(highListKey, 4)  
gamecircle.Whispersync.AddToHighNumberList(highListKey, 10, "INT")  
gamecircle.Whispersync.AddToHighNumberList(highListKey, 1000, "INT")  
gamecircle.Whispersync.AddToHighNumberList(highListKey, 1, "INT")  
gamecircle.Whispersync.AddToHighNumberList(highListKey, 10000, "INT")   
gamecircle.Whispersync.AddToHighNumberList(highListKey, 100, "INT")  
print("Here is the list of numbers as they are stored in the high number list. They should be in the order from highest to lowest.")  
local highList = gamecircle.Whispersync.GetHighNumberList(highListKey)  
for i,entry in ipairs(highList) do  
    print("-" entry.value)  
end  
local keys = gamecircle.Whispersync.GetHighNumberListKeys()  
for i,key in ipairs(keys) do  
    print("-" .. key)  
end