Settings.getFlags

Gets the value that is stored in @settings for @key and converts it to the flags value that it represents.

In order to use this function the type of the value must be an array of strings and it must be marked in the schema file as an flags type.

It is a programmer error to give a @key that isn't contained in the schema for @settings or is not marked as a flags type.

If the value stored in the configuration database is not a valid value for the flags type then this function will return the default value.

class Settings
uint
getFlags
(
string key
)

Parameters

key string

the key to get the value for

Return Value

Type: uint

the flags value

Meta

Since

2.26