Class: Annunciation
Defined in: src/sdk/components/Annunciatons/Annunciaton.ts:14
The main logic for a cabin annunciation.
Constructors
Constructor
new Annunciation(
type
,text
,condition
,suffix
,uuid
):Annunciation
Defined in: src/sdk/components/Annunciatons/Annunciaton.ts:35
Creates an instance of Annunciation.
Parameters
Parameter | Type | Description |
---|---|---|
type | AnnunciationType | The type of annuniciaton this is. |
text | string | The text label to show. |
condition | CompositeLogicXMLElement | The logic condition for setting it. |
suffix | undefined | string | Any suffix text to past to the end. |
uuid | undefined | string | A preset UUID, or one will be generated. |
Returns
Annunciation
Properties
condition
readonly
condition:CompositeLogicXMLElement
Defined in: src/sdk/components/Annunciatons/Annunciaton.ts:22
An XML logic element that will show when we are active.
suffix
readonly
suffix:undefined
|string
Defined in: src/sdk/components/Annunciatons/Annunciaton.ts:24
An optional text suffix to put on the alert text.
text
readonly
text:string
Defined in: src/sdk/components/Annunciatons/Annunciaton.ts:20
The text to show when we are displayed.
type
readonly
type:AnnunciationType
Defined in: src/sdk/components/Annunciatons/Annunciaton.ts:16
The priority type of the annunciation.
uuid
readonly
uuid:string
Defined in: src/sdk/components/Annunciatons/Annunciaton.ts:18
An identifier tying every suffix for a given annunciation together.