Settings.setBoolean

Sets key in settings to value.

A convenience variant of Settings.set for booleans.

It is a programmer error to give a key that isn't specified as having a boolean type in the schema for settings.

class Settings
bool
setBoolean
(
string key
,
bool value
)

Parameters

key string

the name of the key to set

value bool

the value to set it to

Return Value

Type: bool

TRUE if setting the key succeeded, FALSE if the key was not writable

Meta

Since

2.26