Type function
Library gamecircle.*
Return value None
Revision Release 2024.3703
Keywords Highest, List, Whispersync


Add a value to a HighNumberList. If the number is higher than the lowest number stored in the list, then it will be added. And then, if the list exceeds it's maximum length, the number that is currently lowest in the whole list will be trimmed off.


gamecircle.Whispersync.AddToHighNumberList(key, value, NT_constant)
gamecircle.Whispersync.AddToHighNumberList(key, value, NT_constant, metadata)
key (required)

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

value (require)

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

NT_constant (required)

String. The NT_constant, which is either "INT" or "DOUBLE", determins how the highest number will be stored. "INT" cutt off the decimal value. "DOUBLE" maintain the decimal value intact. If the string given is invalid, "INT" will be used by default.

metadata (optional)

Metadata. A table of metadata to be stored with the number. It must be a lua table comprised only of string fields with string values in those fields. For examples and more information, check the documentation page for metadata.


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)