# Event Trigger XML Properties<no value>
The `EventTrigger.xml` file goes in the main mission folder beside the other files and folders required for the mission type, and is used to define different notification triggers that can be shown as a mission progresses. This file is formatted using [XML](../../devmode/editors/project-editor/file-formats/xml-files/) and can be created or edited by using any text editor. The general format for the file is as follows:

``` xml
<?xml version= "1.0" encoding= "utf-8" ?> 
<SimBase.Document Type="EventTriggers" version="1,0">
    <Descr>AceXML Document</Descr>
    
    <EventTriggers.EventTrigger Name="TRIGGER_NAME">
        
        <Condition>
            
        </Condition>
        <Notification>
                      
        </Notification>
    </EventTriggers.EventTrigger>
    
</SimBase.Document>
```

 

Here you *must* include the `<SimBase.Document>` element along with the `<Descr>AceXML Document</Descr>` at the top of the document, and then you would have a list of different `<EventTriggers.EventTrigger>` elements to define the notification event triggers when the mission is being run.

 

You can find an example of this kind of file on the following page:

-   [Complete Event Trigger Example](flight-weather-event-examples/#Event)

 

 

### &lt;EventTriggers.EventTrigger&gt;

This is the main container element for a single event trigger, and you would normally have multiple of these within a single document. This element requires the following attribute:

 

{{< table-wrapper >}}

| Attribute | Description                                             | Type   | Required |
|-----------|---------------------------------------------------------|--------|:--------:|
| `Name`    | This is the name of the trigger and it should be unique | String |    Yes   |

{{< /table-wrapper >}}


 

This element can contain the following sub-elements:

1.  `<Source>` (Required)
2.  `<Context>` (Required)
3.  `<Type>` (Required)
4.  `<MaxCount>` (Required)
5.  `<Notification>` (Required)
6.  `<VoiceOver>`
7.  `<Cooldown>`
8.  `<StartElapsedTimeInContext>`
9.  `<AIControls>`
10. `<DisableIfIAHasControl>`
11. `<StartsEnabled>`
12. `<EventTriggersToActivate_OnNotif>`
13. `<EventTriggersToDeActivate_OnNotif>`
14. `<EventTriggersToActivate_OnStopNotif>`
15. `<EventTriggersToDeActivate_OnStopNotif>`
16. `<Condition>`
17. `<ConditionStartFlowEvents>`
18. `<ConditionEndFlowEvents>`

 

 

### &lt;Source&gt;

This required sub-element of `<EventTriggers.EventTrigger>` defines the source of the trigger event, as a string. The default value is "Copilot".

 

 

### &lt;Context&gt;

This required sub-element of `<EventTriggers.EventTrigger>` sets the context of the trigger. The value here will affect whether or not a triggered event will show in the menu, or in the simulation. Note that you may have multiple `<Context>` elements for a single event trigger.

 

The allowed values are as follows:

1.  All
2.  Intro
3.  Preflight Gate
4.  Preflight Pushback
5.  Preflight Taxi
6.  Preflight Hold Short
7.  Flight Runway
8.  Flight Initial Climb
9.  Flight Climb
10. Flight Cruise
11. Flight Descent
12. Landing Approach
13. Landing Final
14. Landing Touchdown
15. Landing Groundroll
16. Landing Taxi
17. Landing Gate
18. Landing Rest
19. Waiting
20. Teleport To State
21. Freeflight
22. Landing Challenge
23. Bush trip
24. Outro

 

 

### &lt;Type&gt;

This required sub-element of `<EventTriggers.EventTrigger>` sets the type of notification to be shown. Can be any one of the following values:

1.  Piloting
2.  Aircraft\_Systems
3.  Flying\_Tips
4.  Scoring
5.  Software\_Tips

 

 

### &lt;MaxCount&gt;

This sub-element of `<EventTriggers.EventTrigger>` represents the maximum number of notifications for this trigger.

 

 

### &lt;Cooldown&gt;

This sub-element of `<EventTriggers.EventTrigger>` defines the minimum permitted time (in seconds) between two calls of this event trigger.

 

 

### &lt;StartElapsedTimeInContext&gt;

This sub-element of `<EventTriggers.EventTrigger>` defines the minimum time to start the event trigger in the context.

 

 

### &lt;AIControls&gt;

This sub-element of `<EventTriggers.EventTrigger>` sets whether the AI should take the controls (True) or not (False).

 

 

### &lt;DisableIfIAHasControl&gt;

This sub-element of `<EventTriggers.EventTrigger>` sets whether the notification for when the AI has control should be shown (True) or not (False).

 

 

### &lt;StartsEnabled&gt;

This sub-element of `<EventTriggers.EventTrigger>` sets whether the trigger starts disabled (True) or not (False). If false, the Trigger is disabled at the start and will need to be enabled before the event can be triggered in the future.

 

 

### &lt;EventTriggersToActivate_OnNotif&gt;

This sub-element of `<EventTriggers.EventTrigger>` sets another event trigger to be activated when the current notification is shown. Requires the `<EventTriggers.ObjectReference />` as a sub-element.

 

 

### &lt;EventTriggersToDeActivate_OnNotif&gt;

This sub-element of `<EventTriggers.EventTrigger>` deactivates another event trigger when the current notification is shown. Requires the `<EventTriggers.ObjectReference />` as a sub-element.

 

 

### &lt;EventTriggersToActivate_OnStopNotif&gt;

This sub-element of `<EventTriggers.EventTrigger>` sets another event trigger to be activated when the current notification is finished. Requires the `<EventTriggers.ObjectReference />` as a sub-element.

 

 

### &lt;EventTriggersToDeActivate_OnStopNotif&gt;

This sub-element of `<EventTriggers.EventTrigger>` deactivates another event trigger when the current notification is finished. Requires the `<EventTriggers.ObjectReference />` as a sub-element.

 

 

### &lt;Condition&gt;

This sub-element of `<EventTriggers.EventTrigger>` defines the condition that causes the event trigger to execute using [RPN](../../programming-apis/reverse-polish-notation/).

 

 

### &lt;ConditionStartFlowEvents&gt;

This sub-element of `<EventTriggers.EventTrigger>` sets the FlowEvents that are triggered the first time the condition is met (and a notification should appear). Requires `<FlowEvent />` as a sub-element.

 

 

### &lt;ConditionEndFlowEvents&gt;

This sub-element of `<EventTriggers.EventTrigger>` sets the FlowEvents that are triggered once the condition is not met, but was valid just before. Requires `<FlowEvent />` as a sub-element.

 

 

### &lt;VoiceOver&gt;

This is a sub-element of the main `<EventTriggers.EventTrigger>` and is used to add voice-over sound effects to a trigger. The element can have the following attribute:

 

{{< table-wrapper >}}

| Attribute | Description                                                                                | Type   |                  Required                  |
|-----------|--------------------------------------------------------------------------------------------|--------|:------------------------------------------:|
| `TT`      | This is a localized string that should be shown to represent what the voice-over is saying | String | No |

{{< /table-wrapper >}}


 

This element should contain the following sub-element:

1.  `<SoundFileName>`

 

#### &lt;SoundFileName&gt;

This is the name of the sound file that should be used for the voice-over.

 

 

### &lt;Notification&gt;

This required sub-element of the main `<EventTriggers.EventTrigger>` element is a container for various sub-elements that are used to define the notification properties. The sub-elements that you can use are:

1.  `<Priority>`
2.  `<Delay>`
3.  `<Param />`

 

#### &lt;Priority&gt;

This is a sub-element of `<Notification>`, and sets the notification priority. If not included, this will default to "normal". Available values are as follows:

1.  Urgent
2.  UrgentSpeed
3.  UrgentAltitude
4.  UrgentHeading
5.  Normal
6.  NormalSpeed
7.  NormalAltitude
8.  NormalHeading
9.  Low
10. LowSpeed
11. LowAltitude
12. LowHeading

 

#### &lt;Delay&gt;

This is a sub-element of `<Notification>`, and sets the notification delay time in seconds.

 

#### &lt;Param /&gt;

This is a self-closing sub-element is used to set parameters for the `<Notification>` element, and each notification can have one or more of these sub-elements. The available attributes are:

 

{{< table-wrapper >}}

| Attribute      | Description                                                                                                                       | Type   |                  Required                  |
|----------------|-----------------------------------------------------------------------------------------------------------------------------------|--------|:------------------------------------------:|
| `TextVariable` | This is a text Variable that will be replaced by the parameter for the notification.                                              | String | No |
| `Value`        | This is a simple value parameter to the notification.                                                                             | Float  |                     No                     |
| `Key`          | Key text for the notification (needs to be formatted starting with "KEY\_...").                                                   | String |                     No                     |
| `Simvar`       | One of the available [Simulation Variables](../../programming-apis/simvars/simulation-variables/) to be used as a parameter. | Float  |                     No                     |
| `SimvarScale`  | The value that the simvar parameter is multiplied by.                                                                             | Float  |                     No                     |
| `SimvarUnit`   | The [Simulation Variable Units](../../programming-apis/simvars/simulation-variable-units/) for the parameter.                | String |                     No                     |

{{< /table-wrapper >}}


 

 

### &lt;EventTriggers.ObjectReference /&gt;

This is a self-closing reference that is used by the following elements to define another event trigger:

1.  `<EventTriggersToActivate_OnNotif>`
2.  `<EventTriggersToDeActivate_OnNotif>`
3.  `<EventTriggersToActivate_OnStopNotif>`
4.  `<EventTriggersToDeActivate_OnStopNotif>`

 

This element has a single attribute:

 

{{< table-wrapper >}}

| Attribute | Description                                                                                                          | Type   |                   Required                  |
|-----------|----------------------------------------------------------------------------------------------------------------------|--------|:-------------------------------------------:|
| `id`      | The unique ID of the event trigger being referenced. This ID is the `<EventTriggers.EventTrigger>` "Name" attribute. | String | Yes |

{{< /table-wrapper >}}


 

 

### &lt;FlowEvent /&gt;

This is a self-closing reference that is used by the following elements to define a flow event trigger:

1.  `<ConditionStartFlowEvents>`
2.  `<ConditionEndFlowEvents>`

 

This element has a single attribute:

 

{{< table-wrapper >}}

| Attribute | Description                                      | Type   |                   Required                  |
|-----------|--------------------------------------------------|--------|:-------------------------------------------:|
| `id`      | The unique ID of the Flow Event to be triggered. | String | Yes |

{{< /table-wrapper >}}