Skip to main content

Abstract Class: Epic2UpperMfdAvionicsPlugin

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

A Epic2 Upper MFD plugin.

Extends​

Constructors​

Constructor​

new Epic2UpperMfdAvionicsPlugin(binder): Epic2UpperMfdAvionicsPlugin

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

Creates an instance of a Plugin.

Parameters​

ParameterTypeDescription
binderEpic2PluginBinderThe avionics specific plugin binder to accept from the system.

Returns​

Epic2UpperMfdAvionicsPlugin

Inherited from​

Epic2AvionicsPlugin<Epic2UpperMfdPluginBinder>.constructor

Properties​

binder​

protected readonly binder: Epic2PluginBinder

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

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

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​

ParameterType
componentDisplayComponent<any>

Returns​

void

Inherited from​

Epic2AvionicsPlugin.onComponentCreated


onComponentCreating()?​

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

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

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​

ParameterType
constructorDisplayComponentFactory<any>
propsany

Returns​

undefined | DisplayComponent<any, []>

Inherited from​

Epic2AvionicsPlugin.onComponentCreating


onComponentRendered()?​

optional onComponentRendered: (node) => void

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

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​

ParameterType
nodeVNode

Returns​

void

Inherited from​

Epic2AvionicsPlugin.onComponentRendered

Methods​

getAutothrottleOptions()?​

optional getAutothrottleOptions(): AutothrottleOptions

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

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

Returns​

AutothrottleOptions

an instance of the autothrottle options.


getClimbRate()?​

optional getClimbRate(pressureAlt, weight): number

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

Gets a predicted climb rate based on pressure altitude and weight

Parameters​

ParameterType
pressureAltnumber
weightnumber

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/Epic2/MFD/UpperMFD/Epic2UpperMfdAvionicsPlugin.ts:15

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

Loads a CSS file into the instrument.

Parameters​

ParameterTypeDescription
uristringThe URI to the CSS file.

Returns​

Promise<void>

Inherited from​

Epic2AvionicsPlugin.loadCss


onInstalled()​

abstract onInstalled(): void

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

A callback run when the plugin has been installed.

Returns​

void

Inherited from​

Epic2AvionicsPlugin.onInstalled