Interface: UserSettingManager<T>
Defined in: src/sdk/settings/UserSetting.ts:99
A manager for user settings. Provides settings using their names as keys, publishes value change events on the event bus, and keeps setting values up to date when receiving change events across the bus.
Extended by
Type Parameters
| Type Parameter | Description |
|---|---|
T extends UserSettingRecord | The record describing the settings provided by the manager. |
Methods
getAllSettings()
getAllSettings():
UserSetting<UserSettingValue>[]
Defined in: src/sdk/settings/UserSetting.ts:128
Gets an array of all settings of this manager.
Returns
UserSetting<UserSettingValue>[]
an array of all settings of this manager.
getSetting()
getSetting<
K>(name):UserSetting<ToNonNullable<PropertyTypeOf<T,K>>>
Defined in: src/sdk/settings/UserSetting.ts:113
Gets a setting from this manager.
Type Parameters
| Type Parameter |
|---|
K extends string |
Parameters
| Parameter | Type | Description |
|---|---|---|
name | K | The name of the setting to get. |
Returns
UserSetting<ToNonNullable<PropertyTypeOf<T, K>>>
The requested setting.
Throws
Error if no setting with the specified name exists.
mapTo()
mapTo<
M>(map):UserSettingManager<M&T>
Defined in: src/sdk/settings/UserSetting.ts:137
Maps a subset of this manager's settings to ones with aliased names, and creates a new setting manager which supports accessing the settings using their aliases.
Type Parameters
| Type Parameter |
|---|
M extends UserSettingRecord |
Parameters
| Parameter | Type | Description |
|---|---|---|
map | UserSettingMap<M, T> | A map defining the aliases of a subset of this manager's settings, with aliased setting names as keys and original setting names as values. |
Returns
UserSettingManager<M & T>
A new setting manager which supports accessing a subset of this manager's settings using aliased names.
tryGetSetting()
tryGetSetting<
K>(name):OptionalUserSettingFromManager<T,K>
Defined in: src/sdk/settings/UserSetting.ts:105
Attempts to get a setting from this manager.
Type Parameters
| Type Parameter |
|---|
K extends string |
Parameters
| Parameter | Type | Description |
|---|---|---|
name | K | The name of the setting to get. |
Returns
OptionalUserSettingFromManager<T, K>
The requested setting, or undefined if no such setting exists.
whenSettingChanged()
whenSettingChanged<
K>(name):UserSettingConsumerFromManager<T,K>
Defined in: src/sdk/settings/UserSetting.ts:122
Gets a consumer which notifies handlers when the value of a setting changes.
Type Parameters
| Type Parameter |
|---|
K extends string |
Parameters
| Parameter | Type | Description |
|---|---|---|
name | K | The name of a setting. |
Returns
UserSettingConsumerFromManager<T, K>
a consumer which notifies handlers when the value of the setting changes.
Throws
Error if no setting with the specified name exists.
Deprecated
Please use getSetting(name).sub() instead.