Abstract Class: Epic2UpperMfdAvionicsPlugin

Defined in: workingtitle-instruments-epic2/instruments/html_ui/Pages/VCockpit/Instruments/NavSystems/Epic2v2/MFD/UpperMFD/Epic2UpperMfdAvionicsPlugin.ts:13

A Epic2 Upper MFD plugin.

Extends

• Epic2AvionicsPlugin<Epic2UpperMfdPluginBinder>

Constructors

Constructor

new Epic2UpperMfdAvionicsPlugin(binder): Epic2UpperMfdAvionicsPlugin

Defined in: sdk/components/FSComponent.ts:2070

Creates an instance of a Plugin.

Parameters

Parameter	Type	Description
binder	Epic2PluginBinder	The avionics specific plugin binder to accept from the system.

Returns

Epic2UpperMfdAvionicsPlugin

Inherited from

Epic2AvionicsPlugin.constructor

Properties

binder

protected readonly binder: Epic2PluginBinder

Defined in: sdk/components/FSComponent.ts:2070

The avionics specific plugin binder to accept from the system.

Inherited from

Epic2AvionicsPlugin.binder

---

onComponentCreated()?

optional onComponentCreated: (component) => void

Defined in: sdk/components/FSComponent.ts:2090

An optional hook called when a component is created. If this hook is present, it will be called for EVERY component instantiation, so be sure to ensure that this code is well optimized.

Parameters

Parameter	Type
component	DisplayComponent<any>

Returns

void

Inherited from

Epic2AvionicsPlugin.onComponentCreated

---

onComponentCreating()?

optional onComponentCreating: (constructor, props) => DisplayComponent<any, []> | undefined

Defined in: sdk/components/FSComponent.ts:2083

An optional hook called when a component is about to be created. Returning a component causes that component to be used instead of the one that was to be created, and returning undefined will cause the original component to be created. If this hook is present, it will be called for EVERY component instantiation, so be sure to ensure that this code is well optimized.

Parameters

Parameter	Type
constructor	DisplayComponentFactory<any>
props	any

Returns

DisplayComponent<any, []> | undefined

Inherited from

Epic2AvionicsPlugin.onComponentCreating

---

onComponentRendered()?

optional onComponentRendered: (node) => void

Defined in: sdk/components/FSComponent.ts:2097

An optional hook called when a component has completed rendering. If this hook is present, it will be called for EVERY component render completion, so be sure to ensure that this code is well optimized.

Parameters

Parameter	Type
node	VNode

Returns

void

Inherited from

Epic2AvionicsPlugin.onComponentRendered

Methods

getAutothrottleOptions()?

optional getAutothrottleOptions(): AutothrottleOptions

Defined in: workingtitle-instruments-epic2/instruments/html_ui/Pages/VCockpit/Instruments/NavSystems/Epic2v2/MFD/UpperMFD/Epic2UpperMfdAvionicsPlugin.ts:30

Allows the plugin to overwrite the autothrottle options for an aircraft.

Returns

AutothrottleOptions

an instance of the autothrottle options.

---

getChartProviders()?

optional getChartProviders(): Record<string, Epic2ChartsProvider>

Defined in: workingtitle-instruments-epic2/instruments/html_ui/Pages/VCockpit/Instruments/NavSystems/Epic2v2/MFD/UpperMFD/Epic2UpperMfdAvionicsPlugin.ts:35

Gets any available additional chart providers

Returns

Record<string, Epic2ChartsProvider>

---

getChartViewers()?

optional getChartViewers(bus, chart, selectedProvider, modalService, settings): VNode[]

Defined in: workingtitle-instruments-epic2/instruments/html_ui/Pages/VCockpit/Instruments/NavSystems/Epic2v2/MFD/UpperMFD/Epic2UpperMfdAvionicsPlugin.ts:41

Calls a chart viewer to be rendered Note: When implementing, this will need to be hidden by the plugin based on the selected provider key

Parameters

Parameter	Type
bus	EventBus
chart	Subscribable<ChartMetadata<string> | null>
selectedProvider	Subscribable<string>
modalService	ModalService
settings	UserSettingManager<MfdAliasedUserSettingTypes>

Returns

VNode[]

---

getClimbRate()?

optional getClimbRate(pressureAlt, weight): number

Defined in: workingtitle-instruments-epic2/instruments/html_ui/Pages/VCockpit/Instruments/NavSystems/Epic2v2/MFD/UpperMFD/Epic2UpperMfdAvionicsPlugin.ts:24

Gets a predicted climb rate based on pressure altitude and weight

Parameters

Parameter	Type
pressureAlt	number
weight	number

Returns

number

The climb rate for the given parameters

---

getFadec()?

optional getFadec(): Epic2Fadec

Defined in: workingtitle-instruments-epic2/instruments/html_ui/Pages/VCockpit/Instruments/NavSystems/Epic2v2/MFD/UpperMFD/Epic2UpperMfdAvionicsPlugin.ts:18

Allows the plugin to provide a FADEC implementation that will override the default one.

Returns

Epic2Fadec

An instance of a FADEC.

---

loadCss()

protected loadCss(uri): Promise<void>

Defined in: sdk/components/FSComponent.ts:2103

Loads a CSS file into the instrument.

Parameters

Parameter	Type	Description
uri	string	The URI to the CSS file.

Returns

Promise<void>

Inherited from

Epic2AvionicsPlugin.loadCss

---

onInstalled()

abstract onInstalled(): void

Defined in: sdk/components/FSComponent.ts:2075

A callback run when the plugin has been installed.

Returns

void

Inherited from

Epic2AvionicsPlugin.onInstalled