Class: AuralAlertUserSettings
A manager of aural alert user settings.
Hierarchy
DefaultUserSettingManager<AuralAlertUserSettingTypes>↳
AuralAlertUserSettings
Properties
bus
• Protected Readonly bus: EventBus
The bus used by this manager to publish setting change events.
Inherited from
DefaultUserSettingManager.bus
Defined in
src/sdk/settings/UserSetting.ts:192
publisher
• Protected Readonly publisher: Publisher<AuralAlertUserSettingTypes>
Inherited from
DefaultUserSettingManager.publisher
Defined in
src/sdk/settings/UserSetting.ts:177
settings
• Protected Readonly settings: Map<string, UserSettingManagerEntry<AuralAlertVoiceSetting>>
Inherited from
DefaultUserSettingManager.settings
Defined in
src/sdk/settings/UserSetting.ts:175
subscriber
• Protected Readonly subscriber: EventSubscriber<AuralAlertUserSettingTypes>
Inherited from
DefaultUserSettingManager.subscriber
Defined in
src/sdk/settings/UserSetting.ts:178
syncPublisher
• Protected Readonly syncPublisher: Publisher<UserSettingManagerSyncEvents>
Inherited from
DefaultUserSettingManager.syncPublisher
Defined in
src/sdk/settings/UserSetting.ts:180
syncSubscriber
• Protected Readonly syncSubscriber: EventSubscriber<UserSettingManagerSyncEvents>
Inherited from
DefaultUserSettingManager.syncSubscriber
Defined in
src/sdk/settings/UserSetting.ts:181
voice
• Readonly voice: Subscribable<AuralAlertVoiceSetting>
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.
Defined in
src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Settings/AuralAlertSettings.ts:29
Methods
getAllSettings
▸ getAllSettings(): UserSetting<UserSettingValue>[]
Returns
UserSetting<UserSettingValue>[]
Inherit Doc
Inherited from
DefaultUserSettingManager.getAllSettings
Defined in
src/sdk/settings/UserSetting.ts:270
getSetting
▸ getSetting<K>(name): UserSetting<NonNullable<AuralAlertUserSettingTypes[K]>>
Type parameters
| Name | Type |
|---|---|
K | extends "auralAlertVoice" |
Parameters
| Name | Type |
|---|---|
name | K |
Returns
UserSetting<NonNullable<AuralAlertUserSettingTypes[K]>>
Inherit Doc
Inherited from
DefaultUserSettingManager.getSetting
Defined in
src/sdk/settings/UserSetting.ts:260
mapTo
▸ mapTo<M>(map): MappedUserSettingManager<M, AuralAlertUserSettingTypes>
Type parameters
| Name | Type |
|---|---|
M | extends UserSettingRecord |
Parameters
| Name | Type |
|---|---|
map | UserSettingMap<M, AuralAlertUserSettingTypes> |
Returns
MappedUserSettingManager<M, AuralAlertUserSettingTypes>
Inherit Doc
Inherited from
DefaultUserSettingManager.mapTo
Defined in
src/sdk/settings/UserSetting.ts:285
onSettingValueChanged
▸ onSettingValueChanged<K>(entry, value): void
A callback which is called when one of this manager's settings has its value changed locally.
Type parameters
| Name | Type |
|---|---|
K | extends "auralAlertVoice" |
Parameters
| Name | 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
Defined in
src/sdk/settings/UserSetting.ts:294
onSettingValueSynced
▸ onSettingValueSynced<K>(entry, data): void
A callback which is called when a setting changed event is received over the event bus.
Type parameters
| Name | Type |
|---|---|
K | extends "auralAlertVoice" |
Parameters
| Name | 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
Defined in
src/sdk/settings/UserSetting.ts:304
syncSettingFromEvent
▸ syncSettingFromEvent<K>(entry, data): void
Syncs a setting using data received from a sync event.
Type parameters
| Name | Type |
|---|---|
K | extends "auralAlertVoice" |
Parameters
| Name | 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
Defined in
src/sdk/settings/UserSetting.ts:323
tryGetSetting
▸ tryGetSetting<K>(name): undefined | UserSetting<NonNullable<AuralAlertUserSettingTypes[K]>>
Type parameters
| Name | Type |
|---|---|
K | extends string |
Parameters
| Name | Type |
|---|---|
name | K |
Returns
undefined | UserSetting<NonNullable<AuralAlertUserSettingTypes[K]>>
Inherit Doc
Inherited from
DefaultUserSettingManager.tryGetSetting
Defined in
src/sdk/settings/UserSetting.ts:255
whenSettingChanged
▸ whenSettingChanged<K>(name): Consumer<NonNullable<AuralAlertUserSettingTypes[K]>>
Type parameters
| Name | Type |
|---|---|
K | extends "auralAlertVoice" |
Parameters
| Name | Type |
|---|---|
name | K |
Returns
Consumer<NonNullable<AuralAlertUserSettingTypes[K]>>
Inherit Doc
Inherited from
DefaultUserSettingManager.whenSettingChanged
Defined in
src/sdk/settings/UserSetting.ts:275
getManager
▸ getManager(bus): AuralAlertUserSettings
Gets an instance of the aural alert user settings manager.
Parameters
| Name | Type | Description |
|---|---|---|
bus | EventBus | The event bus. |
Returns
An instance of the aural alert user settings manager.
Defined in
src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Settings/AuralAlertSettings.ts:50