gamecircle.Whispersync.StringSetContains

Type function
Library gamecircle.*
Return value Boolean
Revision Release 2025.3714
Keywords Whispersync, DeveloperString, MarkAsResolved

Overview

Returns true if the string given to it exists in the string set specified by key, otherwise it returns false.

Syntax

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

String. The key used to access a specific string set. ##### value (required) String. The value being checked to see if it exists in the set.

Examples

local stringSetKey = "myFirstStringSet"
local gamecircle = require("plugin.gamecircle") 
gamecircle.Init(false, false, true) 
gamecircle.Whispersync.AddToStringSet("A")
gamecircle.Whispersync.AddToStringSet("B")
gamecircle.Whispersync.AddToStringSet("C")
gamecircle.Whispersync.AddToStringSet("D")
gamecircle.Whispersync.AddToStringSet("E")
print("Does the set contain F?: " .. gamecircle.Whispersync.StringSetContains(stringSetKey, "F"))
print("Here is what the string set does contain:")
local stringSet = gamecircle.Whispersync.GetStringSet(stringSetKey) 
for i,entry in ipairs(stringSet) do 
    print("-" entry.value) 
end 
print("The extra for element A is:")
local entryA = gamecircle.Whispersync.GetStringSetValue("A")
print("-value: " .. entryA.value)
print("-isSet: " .. entryA.isSet)
print("-metadataPresent: " .. entryA.metadataPresent)
print("-timestamp: " .. entryA.timestamp)
local keys = gamecircle.Whispersync.GetHighNumberListKeys() 
for i,key in ipairs(keys) do 
    print("-" .. key) 
end