Settings.setEnum

Looks up the enumerated type nick for value and writes it to key, within settings.

It is a programmer error to give a key that isn't contained in the schema for settings or is not marked as an enumerated type, or for value not to be a valid value for the named type.

After performing the write, accessing key directly with Settings.getString will return the 'nick' associated with value.

class Settings
bool
setEnum
(
string key
,
int value
)

Parameters

key string

a key, within settings

value int

an enumerated value

Return Value

Type: bool

TRUE, if the set succeeds