Class Settings

hash

• get hash(): number

  Returns a hash value that may be used for checking if any internal settings were modified.

  Returns number

deleteAllKeys

• deleteAllKeys(): void

  Deletes all key/value pairs.

  Returns void

deleteKey

• deleteKey(name: string): void

  Deletes a key with the specified name.

  Parameters

  • name: string

  Returns void

getBool

• getBool(name: string, defaultValue?: boolean): boolean

  Returns the boolean point value of the specified key, or the default value if such key cannot be found.

  Parameters

  • name: string
  • OptionaldefaultValue: boolean

  Returns boolean

getFloat

• getFloat(name: string, defaultValue?: number): number

  Returns the floating point value of the specified key, or the default value if such key cannot be found.

  Parameters

  • name: string
  • OptionaldefaultValue: number

  Returns number

getInt

• getInt(name: string, defaultValue?: number): number

  Returns the integer point value of the specified key, or the default value if such key cannot be found.

  Parameters

  • name: string
  • OptionaldefaultValue: number

  Returns number

getString

• getString(name: string, defaultValue?: string): string

  Returns the string point value of the specified key, or the default value if such key cannot be found.

  Parameters

  • name: string
  • OptionaldefaultValue: string

  Returns string

hasKey

• hasKey(name: string): boolean

  Returns true if the key with the specified name exists.

  Parameters

  • name: string

  Returns boolean

markAsDirty

• markAsDirty(dirtyFlags: EnumValue<ManagedSettingsDirtyFlag>): void

  Marks the object as dirty.

  Parameters

  • dirtyFlags: EnumValue<ManagedSettingsDirtyFlag>

    Flags specifying what kind of member was changed.

  Returns void

modify

• modify(action: () => void): void

  Allows modifying this object multiple times in a row in a scope, without marking the object dirty immediately. Dirty flags are accumulated and the object is marked dirty at the end.

  Parameters

  • action: () => void

    The scope where the object is modified.

  Returns void

setBool

• setBool(name: string, value: boolean): void

  Adds or updates a property key/value pair with a boolean value.

  Parameters

  • name: string
  • value: boolean

  Returns void

setFloat

• setFloat(name: string, value: number): void

  Adds or updates a property key/value pair with a floating point value.

  Parameters

  • name: string
  • value: number

  Returns void

setInt

• setInt(name: string, value: number): void

  Adds or updates a property key/value pair with a signed integer value.

  Parameters

  • name: string
  • value: number

  Returns void

setString

• setString(name: string, value: string): void

  Adds or updates a property key/value pair with a string value.

  Parameters

  • name: string
  • value: string

  Returns void

ReadonlyonDirty