Skip to main content

Class: Annunciation

The main logic for a cabin annunciation.

Constructors

constructor

new Annunciation(type, text, condition, suffix, uuid): Annunciation

Creates an instance of Annunciation.

Parameters

NameTypeDescription
typeAnnunciationTypeThe type of annuniciaton this is.
textstringThe text label to show.
conditionCompositeLogicXMLElementThe logic condition for setting it.
suffixundefined | stringAny suffix text to past to the end.
uuidundefined | stringA preset UUID, or one will be generated.

Returns

Annunciation

Defined in

src/sdk/components/Annunciatons/Annunciaton.ts:35

Properties

condition

Readonly condition: CompositeLogicXMLElement

An XML logic element that will show when we are active.

Defined in

src/sdk/components/Annunciatons/Annunciaton.ts:22


suffix

Readonly suffix: undefined | string

An optional text suffix to put on the alert text.

Defined in

src/sdk/components/Annunciatons/Annunciaton.ts:24


text

Readonly text: string

The text to show when we are displayed.

Defined in

src/sdk/components/Annunciatons/Annunciaton.ts:20


type

Readonly type: AnnunciationType

The priority type of the annunciation.

Defined in

src/sdk/components/Annunciatons/Annunciaton.ts:16


uuid

Readonly uuid: string

An identifier tying every suffix for a given annunciation together.

Defined in

src/sdk/components/Annunciatons/Annunciaton.ts:18