Type function
Library gamecircle.*
Return value None
Revision Release 2023.3686
Keywords High, List, SyncableNumberList, Length, Whispersync


Set the max length of the HighNumber list. This number is capped at 1,000 by the Amazon GameCircle SDK. The default length is 5.


gamecircle.Whispersync.SetHighNumberListLength(key, value)
gamecircle.Whispersync.SetHighNumberListLength(key, value)
key (required)

String. The key used to access a specific highest number.

value (require)

Number. The value to be assigned to the highest number.


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)  
local keys = gamecircle.Whispersync.GetHighNumberListKeys()  
for i,key in ipairs(keys) do  
    print("-" .. key)