Type function
Library gamecircle.*
Return value None
Revision Release 2024.3703
Keywords Latest, SyncableNumber, Whispersync


Set a value to the latest number associated with the key. Only the latest value assigned will be stored.


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

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

value (require)

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

NT_constant (required)

String. The NT_constant, which is either "INT" or "DOUBLE", determins how the latest 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 latestNumKey = "myFirstLatestNumber" 
local gamecircle = require("plugin.gamecircle")  
gamecircle.Init(false, false, true)  
gamecircle.Whispersync.SetLatestNumber(latestNumKey, 10, "INT")  
gamecircle.Whispersync.SetLatestNumber(latestNumKey, 1000, "INT")  
gamecircle.Whispersync.SetLatestNumber(latestNumKey, 1, "INT")  
gamecircle.Whispersync.SetLatestNumber(latestNumKey, 10000, "INT")  
gamecircle.Whispersync.SetLatestNumber(latestNumKey, 100, "INT")  
print("The Latest Number is: " .. gamecircle.Whispersync.GetLatestNumber(latestNumKey, "INT").value)  
print("These are all the Latest Number values stored under the current GameData set of Whispersync.")  
local keys = gamecircle.Whispersync.GetLatestNumberKeys()  
for i,key in ipairs(keys) do   
    print("-" .. key)