Class: TouchdownCalloutUserSettings

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/TouchdownCalloutSettings.ts:58

A manager of touchdown callout user settings.

Extends

• DefaultUserSettingManager<TouchdownCalloutUserSettingTypes>

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<TouchdownCalloutUserSettingTypes>

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

Inherited from

DefaultUserSettingManager.publisher

---

settings

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

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

Inherited from

DefaultUserSettingManager.settings

---

subscriber

protected readonly subscriber: EventSubscriber<TouchdownCalloutUserSettingTypes>

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

Methods

getAllSettings()

getAllSettings(): UserSetting<UserSettingValue>[]

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

Returns

UserSetting<UserSettingValue>[]

Inherit Doc

Inherited from

DefaultUserSettingManager.getAllSettings

---

getEnabledSetting()

getEnabledSetting(altitude): UserSetting<boolean>

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/TouchdownCalloutSettings.ts:152

Gets the setting for whether the callout for a given altitude is enabled.

Parameters

Parameter	Type	Description
altitude	GarminTawsVoiceCalloutAltitude	The altitude for which to get the setting.

Returns

UserSetting<boolean>

The setting for whether the callout for the specified altitude is enabled.

---

getSetting()

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

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

Type Parameters

Type Parameter

K extends "touchdownCalloutMasterEnabled" | "touchdownCallout500Enabled" | "touchdownCallout450Enabled" | "touchdownCallout400Enabled" | "touchdownCallout350Enabled" | "touchdownCallout300Enabled" | "touchdownCallout250Enabled" | "touchdownCallout200Enabled" | "touchdownCallout150Enabled" | "touchdownCallout100Enabled" | "touchdownCallout50Enabled" | "touchdownCallout40Enabled" | "touchdownCallout30Enabled" | "touchdownCallout20Enabled" | "touchdownCallout10Enabled"

Parameters

Parameter	Type
name	K

Returns

UserSetting<NonNullable<TouchdownCalloutUserSettingTypes[K]>>

Inherit Doc

Inherited from

DefaultUserSettingManager.getSetting

---

mapTo()

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

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, TouchdownCalloutUserSettingTypes>

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 keyof TouchdownCalloutUserSettingTypes

Parameters

Parameter	Type	Description
entry	UserSettingManagerEntry<TouchdownCalloutUserSettingTypes[K]>	The entry for the setting that was changed.
value	TouchdownCalloutUserSettingTypes[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 keyof TouchdownCalloutUserSettingTypes

Parameters

Parameter	Type	Description
entry	UserSettingManagerEntry<TouchdownCalloutUserSettingTypes[K]>	The entry for the setting that was changed.
data	UserSettingManagerSyncData<TouchdownCalloutUserSettingTypes[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 keyof TouchdownCalloutUserSettingTypes

Parameters

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

Returns

void

Inherited from

DefaultUserSettingManager.syncSettingFromEvent

---

tryGetSetting()

tryGetSetting<K>(name): undefined | UserSetting<NonNullable<TouchdownCalloutUserSettingTypes[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<TouchdownCalloutUserSettingTypes[K]>>

Inherit Doc

Inherited from

DefaultUserSettingManager.tryGetSetting

---

whenSettingChanged()

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

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

Type Parameters

Type Parameter

K extends "touchdownCalloutMasterEnabled" | "touchdownCallout500Enabled" | "touchdownCallout450Enabled" | "touchdownCallout400Enabled" | "touchdownCallout350Enabled" | "touchdownCallout300Enabled" | "touchdownCallout250Enabled" | "touchdownCallout200Enabled" | "touchdownCallout150Enabled" | "touchdownCallout100Enabled" | "touchdownCallout50Enabled" | "touchdownCallout40Enabled" | "touchdownCallout30Enabled" | "touchdownCallout20Enabled" | "touchdownCallout10Enabled"

Parameters

Parameter	Type
name	K

Returns

Consumer<NonNullable<TouchdownCalloutUserSettingTypes[K]>>

Inherit Doc

Inherited from

DefaultUserSettingManager.whenSettingChanged

---

getManager()

static getManager(bus): TouchdownCalloutUserSettings

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/TouchdownCalloutSettings.ts:161

Gets an instance of the touchdown callout user settings manager.

Parameters

Parameter	Type	Description
bus	EventBus	The event bus.

Returns

TouchdownCalloutUserSettings

An instance of the touchdown callout user settings manager.