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:192

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:177

Inherited from

DefaultUserSettingManager.publisher

---

settings

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

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

Inherited from

DefaultUserSettingManager.settings

---

subscriber

protected readonly subscriber: EventSubscriber<AuralAlertUserSettingTypes>

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

Inherited from

DefaultUserSettingManager.subscriber

---

syncPublisher

protected readonly syncPublisher: Publisher<UserSettingManagerSyncEvents>

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

Inherited from

DefaultUserSettingManager.syncPublisher

---

syncSubscriber

protected readonly syncSubscriber: EventSubscriber<UserSettingManagerSyncEvents>

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

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:270

Returns

UserSetting<UserSettingValue>[]

Inherit Doc

Inherited from

DefaultUserSettingManager.getAllSettings

---

getSetting()

getSetting<K>(name): UserSetting<NonNullable<AuralAlertUserSettingTypes[K]>>

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

Type Parameters

Type Parameter
K extends "auralAlertVoice"

Parameters

Parameter	Type
name	K

Returns

UserSetting<NonNullable<AuralAlertUserSettingTypes[K]>>

Inherit Doc

Inherited from

DefaultUserSettingManager.getSetting

---

mapTo()

mapTo<M>(map): MappedUserSettingManager<M, AuralAlertUserSettingTypes>

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

Type Parameters

Type Parameter
M extends UserSettingRecord

Parameters

Parameter	Type
map	UserSettingMap<M, T>

Returns

MappedUserSettingManager<M, AuralAlertUserSettingTypes>

Inherit Doc

Inherited from

DefaultUserSettingManager.mapTo

---

onSettingValueChanged()

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

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

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:304

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:323

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): undefined | UserSetting<NonNullable<AuralAlertUserSettingTypes[K]>>

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

Type Parameters

Type Parameter
K extends string

Parameters

Parameter	Type
name	K

Returns

undefined | UserSetting<NonNullable<AuralAlertUserSettingTypes[K]>>

Inherit Doc

Inherited from

DefaultUserSettingManager.tryGetSetting

---

whenSettingChanged()

whenSettingChanged<K>(name): Consumer<NonNullable<AuralAlertUserSettingTypes[K]>>

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

Type Parameters

Type Parameter
K extends "auralAlertVoice"

Parameters

Parameter	Type
name	K

Returns

Consumer<NonNullable<AuralAlertUserSettingTypes[K]>>

Inherit Doc

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.