Class: AuralAlertUserSettings

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/AuralAlertSettings.ts:22

A manager of aural alert user settings.

Extends

• DefaultUserSettingManager<AuralAlertUserSettingTypes>

Properties

bus

protected readonly bus: EventBus

Defined in: src/sdk/settings/UserSetting.ts:239

The bus used by this manager to publish setting change events.

Inherited from

DefaultUserSettingManager.bus

---

publisher

protected readonly publisher: Publisher<AuralAlertUserSettingTypes>

Defined in: src/sdk/settings/UserSetting.ts:222

Inherited from

DefaultUserSettingManager.publisher

---

settings

protected readonly settings: Map<string, UserSettingManagerEntry<AuralAlertVoiceSetting>>

Defined in: src/sdk/settings/UserSetting.ts:220

Inherited from

DefaultUserSettingManager.settings

---

subscriber

protected readonly subscriber: EventSubscriber<AuralAlertUserSettingTypes>

Defined in: src/sdk/settings/UserSetting.ts:223

Inherited from

DefaultUserSettingManager.subscriber

---

syncPublisher

protected readonly syncPublisher: Publisher<UserSettingManagerSyncEvents>

Defined in: src/sdk/settings/UserSetting.ts:225

Inherited from

DefaultUserSettingManager.syncPublisher

---

syncSubscriber

protected readonly syncSubscriber: EventSubscriber<UserSettingManagerSyncEvents>

Defined in: src/sdk/settings/UserSetting.ts:226

Inherited from

DefaultUserSettingManager.syncSubscriber

---

voice

readonly voice: Subscribable<AuralAlertVoiceSetting>

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/AuralAlertSettings.ts:29

The voice type to use for aural alerts, derived from the user setting. Defaults to the female type if the setting has an invalid value.

Methods

getAllSettings()

getAllSettings(): UserSetting<UserSettingValue>[]

Defined in: src/sdk/settings/UserSetting.ts:330

Gets an array of all settings of this manager.

Returns

UserSetting<UserSettingValue>[]

an array of all settings of this manager.

Inherited from

DefaultUserSettingManager.getAllSettings

---

getSetting()

getSetting<K>(name): UserSetting<ToNonNullable<PropertyTypeOf<AuralAlertUserSettingTypes, K>>>

Defined in: src/sdk/settings/UserSetting.ts:320

Gets a setting from this manager.

Type Parameters

Type Parameter
K extends "auralAlertVoice"

Parameters

Parameter	Type	Description
name	K	The name of the setting to get.

Returns

UserSetting<ToNonNullable<PropertyTypeOf<AuralAlertUserSettingTypes, K>>>

The requested setting.

Throws

Error if no setting with the specified name exists.

Inherited from

DefaultUserSettingManager.getSetting

---

mapTo()

mapTo<M>(map): UserSettingManager<M & AuralAlertUserSettingTypes>

Defined in: src/sdk/settings/UserSetting.ts:345

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 & AuralAlertUserSettingTypes>

A new setting manager which supports accessing a subset of this manager's settings using aliased names.

Inherited from

DefaultUserSettingManager.mapTo

---

onSettingValueChanged()

protected onSettingValueChanged<K>(entry, value): void

Defined in: src/sdk/settings/UserSetting.ts:354

A callback which is called when one of this manager's settings has its value changed locally.

Type Parameters

Type Parameter
K extends "auralAlertVoice"

Parameters

Parameter	Type	Description
entry	UserSettingManagerEntry<AuralAlertUserSettingTypes[K]>	The entry for the setting that was changed.
value	AuralAlertUserSettingTypes[K]	The new value of the setting.

Returns

void

Inherited from

DefaultUserSettingManager.onSettingValueChanged

---

onSettingValueSynced()

protected onSettingValueSynced<K>(entry, data): void

Defined in: src/sdk/settings/UserSetting.ts:367

A callback which is called when a setting changed event is received over the event bus.

Type Parameters

Type Parameter
K extends "auralAlertVoice"

Parameters

Parameter	Type	Description
entry	UserSettingManagerEntry<AuralAlertUserSettingTypes[K]>	The entry for the setting that was changed.
data	UserSettingManagerSyncData<AuralAlertUserSettingTypes[K]>	The sync data.

Returns

void

Inherited from

DefaultUserSettingManager.onSettingValueSynced

---

syncSettingFromEvent()

protected syncSettingFromEvent<K>(entry, data): void

Defined in: src/sdk/settings/UserSetting.ts:386

Syncs a setting using data received from a sync event.

Type Parameters

Type Parameter
K extends "auralAlertVoice"

Parameters

Parameter	Type	Description
entry	UserSettingManagerEntry<AuralAlertUserSettingTypes[K]>	The entry for the setting to sync.
data	UserSettingManagerSyncData<AuralAlertUserSettingTypes[K]>	The sync event data.

Returns

void

Inherited from

DefaultUserSettingManager.syncSettingFromEvent

---

tryGetSetting()

tryGetSetting<K>(name): OptionalUserSettingFromManager<AuralAlertUserSettingTypes, K>

Defined in: src/sdk/settings/UserSetting.ts:315

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<AuralAlertUserSettingTypes, K>

The requested setting, or undefined if no such setting exists.

Inherited from

DefaultUserSettingManager.tryGetSetting

---

whenSettingChanged()

whenSettingChanged<K>(name): UserSettingConsumerFromManager<AuralAlertUserSettingTypes, K>

Defined in: src/sdk/settings/UserSetting.ts:335

Gets a consumer which notifies handlers when the value of a setting changes.

Type Parameters

Type Parameter
K extends "auralAlertVoice"

Parameters

Parameter	Type	Description
name	K	The name of a setting.

Returns

UserSettingConsumerFromManager<AuralAlertUserSettingTypes, 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.

Inherited from

DefaultUserSettingManager.whenSettingChanged

---

getManager()

static getManager(bus): AuralAlertUserSettings

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/AuralAlertSettings.ts:50

Gets an instance of the aural alert user settings manager.

Parameters

Parameter	Type	Description
bus	EventBus	The event bus.

Returns

AuralAlertUserSettings

An instance of the aural alert user settings manager.