Class Settings

Contains a serializable set of generic key-value pairs.

Hierarchy

FrameworkObject
- Settings

Index

Constructors

Properties

Accessors

Methods

deleteAllKeys deleteKey getBool getFloat getInt getObject getObjectOrDefault getString hasKey markAsDirty modify setBool setFloat setInt setObject setString

Events

Constructors

constructor

new Settings(isInternalConstructor?): Settings
Parameters
- OptionalisInternalConstructor: boolean
Returns Settings
Inherited from SettingsGenerated.constructor

Accessors

hash

get hash(): number
Returns a hash value that may be used for checking if any internal settings were modified.

Returns number
Inherited from SettingsGenerated.hash

Methods

deleteAllKeys

deleteAllKeys(): void
Deletes all key/value pairs.

Returns void
Inherited from SettingsGenerated.deleteAllKeys

deleteKey

deleteKey(name): void
Deletes a key with the specified name.
Parameters
- name: string
Returns void
Inherited from SettingsGenerated.deleteKey

getBool

getBool(name, defaultValue?): 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
Inherited from SettingsGenerated.getBool

getFloat

getFloat(name, defaultValue?): 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
Inherited from SettingsGenerated.getFloat

getInt

getInt(name, defaultValue?): 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
Inherited from SettingsGenerated.getInt

getObject

getObject<T>(type, name): T
Retrieves a generic object property.
Type Parameters
- T
Parameters
- type: ClassOf<T>
- name: string
  Name of the property to retrieve.
Returns T
Value of the property if it exists, otherwise an empty instance of the object. Returns null if the type of the stored object doesn't match the requested type.

getObjectOrDefault

getObjectOrDefault<T>(type, name, defaultValue): T
Retrieves a generic object property.
Type Parameters
- T
Parameters
- type: ClassOf<T>
- name: string
  Name of the property to retrieve.
- defaultValue: T
  The default value to return in case the object is not defined.
Returns T
Value of the property if it exists, otherwise returns the given default value. Returns null if the type of the stored object doesn't match the requested type.

getString

getString(name, defaultValue?): 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
Inherited from SettingsGenerated.getString

hasKey

hasKey(name): boolean
Returns true if the key with the specified name exists.
Parameters
- name: string
Returns boolean
Inherited from SettingsGenerated.hasKey

markAsDirty

markAsDirty(dirtyFlags): void
Marks the object as dirty.
Parameters
- dirtyFlags: EnumValue<ManagedSettingsDirtyFlag, number>
  Flags specifying what kind of member was changed.
Returns void
Inherited from SettingsGenerated.markAsDirty

modify

modify(action): 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.
  - - (): void
    - Returns void
Returns void
Inherited from SettingsGenerated.modify

setBool

setBool(name, value): void
Adds or updates a property key/value pair with a boolean value.
Parameters
- name: string
- value: boolean
Returns void
Inherited from SettingsGenerated.setBool

setFloat

setFloat(name, value): void
Adds or updates a property key/value pair with a floating point value.
Parameters
- name: string
- value: number
Returns void
Inherited from SettingsGenerated.setFloat

setInt

setInt(name, value): void
Adds or updates a property key/value pair with a signed integer value.
Parameters
- name: string
- value: number
Returns void
Inherited from SettingsGenerated.setInt

setObject

setObject(name, value): boolean
Sets a generic object property. Any object marked with the serializedObject attribute can be provided, excluding components and resources.
Parameters
- name: string
  Name to record the property under.
- value: any
  Value of the property.
Returns boolean

setString

setString(name, value): void
Adds or updates a property key/value pair with a string value.
Parameters
- name: string
- value: string
Returns void
Inherited from SettingsGenerated.setString

Events

`Readonly`onDirty

onDirty: Event<[dirtyFlags: EnumValue<ManagedSettingsDirtyFlag, number>], void>

Event that is triggered when a member changes.