Settings.getBoolean

Gets the value that is stored at key in settings.

A convenience variant of Settings.get 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
getBoolean
(
string key
)

Parameters

key string

the key to get the value for

Return Value

Type: bool

a boolean

Meta

Since

2.26