Skip to main content

Class: TouchdownCalloutUserSettings

A manager of touchdown callout user settings.

Hierarchy

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

Inherited from

DefaultUserSettingManager.publisher

Defined in

src/sdk/settings/UserSetting.ts:177


settings

Protected Readonly settings: Map<string, UserSettingManagerEntry<boolean>>

Inherited from

DefaultUserSettingManager.settings

Defined in

src/sdk/settings/UserSetting.ts:175


subscriber

Protected Readonly subscriber: EventSubscriber<TouchdownCalloutUserSettingTypes>

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

Methods

getAllSettings

getAllSettings(): UserSetting<UserSettingValue>[]

Returns

UserSetting<UserSettingValue>[]

Inherit Doc

Inherited from

DefaultUserSettingManager.getAllSettings

Defined in

src/sdk/settings/UserSetting.ts:270


getEnabledSetting

getEnabledSetting(altitude): UserSetting<boolean>

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

Parameters

NameTypeDescription
altitudeGarminTawsVoiceCalloutAltitudeThe altitude for which to get the setting.

Returns

UserSetting<boolean>

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

Defined in

src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Settings/TouchdownCalloutSettings.ts:152


getSetting

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

Type parameters

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

Parameters

NameType
nameK

Returns

UserSetting<NonNullable<TouchdownCalloutUserSettingTypes[K]>>

Inherit Doc

Inherited from

DefaultUserSettingManager.getSetting

Defined in

src/sdk/settings/UserSetting.ts:260


mapTo

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

Type parameters

NameType
Mextends UserSettingRecord

Parameters

NameType
mapUserSettingMap<M, TouchdownCalloutUserSettingTypes>

Returns

MappedUserSettingManager<M, TouchdownCalloutUserSettingTypes>

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

NameType
Kextends keyof TouchdownCalloutUserSettingTypes

Parameters

NameTypeDescription
entryUserSettingManagerEntry<TouchdownCalloutUserSettingTypes[K]>The entry for the setting that was changed.
valueTouchdownCalloutUserSettingTypes[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

NameType
Kextends keyof TouchdownCalloutUserSettingTypes

Parameters

NameTypeDescription
entryUserSettingManagerEntry<TouchdownCalloutUserSettingTypes[K]>The entry for the setting that was changed.
dataUserSettingManagerSyncData<TouchdownCalloutUserSettingTypes[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

NameType
Kextends keyof TouchdownCalloutUserSettingTypes

Parameters

NameTypeDescription
entryUserSettingManagerEntry<TouchdownCalloutUserSettingTypes[K]>The entry for the setting to sync.
dataUserSettingManagerSyncData<TouchdownCalloutUserSettingTypes[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<TouchdownCalloutUserSettingTypes[K]>>

Type parameters

NameType
Kextends string

Parameters

NameType
nameK

Returns

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

Inherit Doc

Inherited from

DefaultUserSettingManager.tryGetSetting

Defined in

src/sdk/settings/UserSetting.ts:255


whenSettingChanged

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

Type parameters

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

Parameters

NameType
nameK

Returns

Consumer<NonNullable<TouchdownCalloutUserSettingTypes[K]>>

Inherit Doc

Inherited from

DefaultUserSettingManager.whenSettingChanged

Defined in

src/sdk/settings/UserSetting.ts:275


getManager

getManager(bus): TouchdownCalloutUserSettings

Gets an instance of the touchdown callout user settings manager.

Parameters

NameTypeDescription
busEventBusThe event bus.

Returns

TouchdownCalloutUserSettings

An instance of the touchdown callout user settings manager.

Defined in

src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Settings/TouchdownCalloutSettings.ts:161