# General Template XML Properties<no value>
On this page you can find a list of the general model behavior XML that is used within the `<CompileBehaviors>` or `<Behaviors>` element of the principle `[model].xml` file associated with a SimObject (or within the `<ModelBehaviors>` of an additional model file). For an overview of the contents of this page please see the following section:

-   [Model Behaviors](model-behaviors/)

 

 

### &lt;Macro&gt;

This element creates a global-scope macro that can be used to name values, strings and code which will then be substituted in at runtime wherever the macro is called. The macro has a "name" attribute, which is the name that should be called in the rest of the model behavior XML to use the macro, and the contents of the element are what will be substituted in instead. Note that when calling a macro name it should be preceded by an `@`.

 

Macros are usually defined at the top of the XML, directly under one of the following parent elements (see [File Structure](usingbehaviours/using-model-behaviours/#file_structure) for information on which top-level element to use where):

1.  `<Behaviors>`
2.  `<ModelBehaviors>`
3.  `<CompileBehaviors>`

 

Macro definitions look something like this:

``` xml
<Macro Name="IsUsingRelativePos">(M:InputType) 1 ==</Macro>
<Macro Name="DragLockResetTimer">0.05 0.10 @IsUsingRelativePos ?</Macro>
<Macro Name="MyCompany">'TT_COMPANY_NAME_LOCALISED'</Macro>
```

 

<table><thead><tr class="header"><th>Attribute</th><th>Description</th><th>Type</th><th>Required</th></tr></thead><tbody><tr class="odd"><td><code>Name</code></td><td><p>The name of the macro, which will be used to call the macro in the rest of the XML. Use the <code>@</code> symbol before the macro to use it, eg: <code>@on_off_condition</code></p><p>This string must be alpha-numeric, and can only contain the _ or - symbols.</p></td><td>String</td><td>Yes</td></tr></tbody></table>

 

 

### &lt;Include /&gt;

This element is used to read and register the `<InputEvent>`, `<Macro>`, `<Template>` and `<ParametersFn>` elements included within the file given in the chosen attribute (but **not** components). This is a self-closing element that is used within the following elements (see [File Structure](usingbehaviours/using-model-behaviours/#file_structure) for information on which top-level element to use where):

1.  `<Behaviors>`
2.  `<ModelBehaviors>`
3.  `<CompileBehaviors>`

 

This element *must* have *one* of the following attributes, and should always be listed at the top of the XML file, or directly after the parent element:

 

<table><thead><tr class="header"><th>Attribute</th><th>Description</th><th>Type</th><th>Required</th></tr></thead><tbody><tr class="odd"><td><code>ModelBehaviorFile</code></td><td><p>This tells the <code>models.xml</code> to include one of the Microsoft Flight Simulator 2024 core model behavior definition files. The path will be relative to the <strong>ModelBehaviorDefs</strong> folder. For example, to include the "<code>Engine.xml</code>" file, then the path supplied to this attribute would be: "<code>Asobo_EX1\Common\Exterior\Templates\Engine.xml</code>". Please see <a href="Model_Behaviors/#include">Including Template Files</a> for more information on using this attribute and compiled behaviors.</p><p> </p></td><td>String</td><td>No</td></tr><tr class="even"><td><code>Path</code></td><td>This is an alias for the <code>ModelBehaviorFile</code> attribute.</td><td>String</td><td>No</td></tr><tr class="odd"><td><code>RelativeFile</code></td><td>This is for including a file from a path relative to the <code>[model].xml</code> file location.</td><td>String</td><td>No</td></tr><tr class="even"><td><code>File</code></td><td>This is an alias for the <code>RelativeFile</code> attribute.</td><td>String</td><td>No</td></tr></tbody></table>

 

 

### &lt;IncludeBase /&gt;

This element is used to include the **components** from another `[model].xml` file, and optionally override them on an individual basis. For example, this is often used when creating *presets* for aircraft variations as it lets you take a "base" file from a different location (for example the *common* folder), use all the same components but *override* the components that are not applicable to the current *preset* with a different component definition.

 

A simple example is an aircraft that has unique landing gear in a preset, but the rest of the aircraft is the exact same. In this case you would include the base XML and then override the component in the preset model XML, eg: in the base model XML file you would have:

``` xml
<Component ID="LANDING_GEAR">
    <Component ID="LandingGear_LEFT">
    ...
    </Component>
</Component>
```

In the preset model XML file you can then overwrite specific components something like this:

``` xml
<Component OverrideID="LANDING_GEAR:LandingGear_LEFT">
    ...
</Component>
```

 

This is a self-closing element and should be defined at the top level of the XML file, directly after the any of the following parent elements (see [File Structure](usingbehaviours/using-model-behaviours/#file_structure) for information on which top-level element to use where):

1.  `<Behaviors>`
2.  `<ModelBehaviors>`
3.  `<CompileBehaviors>`

 

It has the following attribute:

 

{{< table-wrapper >}}

| Attribute      | Description                                                                           | Type   | Required |
|----------------|---------------------------------------------------------------------------------------|--------|:--------:|
| `RelativeFile` | This is for including a file from a path relative to the `[model].xml` file location. | String |    Yes   |

{{< /table-wrapper >}}


 

Optionally you may use these attributes instead of the `RelativeFile` attribute, although these are not generally required:

 

<table><thead><tr class="header"><th>Attribute</th><th>Description</th><th>Type</th><th>Required</th></tr></thead><tbody><tr class="odd"><td><code>ModelBehaviorFile</code></td><td><p>This tells the <code>models.xml</code> to include one of the Microsoft Flight Simulator 2024 core model behavior definition files. The path will be relative to the <strong>ModelBehaviorDefs</strong> folder. For example, to include the "<code>Engine.xml</code>" file, then the path supplied to this attribute would be: "<code>Asobo_EX1\Common\Exterior\Templates\Engine.xml</code>". Please see <a href="Model_Behaviors/#include">Including Template Files</a> for more information on using this attribute and compiled behaviors.</p><p> </p></td><td>String</td><td>No</td></tr><tr class="even"><td><code>Path</code></td><td>This is an alias for the <code>ModelBehaviorFile</code> attribute.</td><td>String</td><td>No</td></tr><tr class="odd"><td><code>File</code></td><td>This is an alias for the <code>RelativeFile</code> attribute.</td><td>String</td><td>No</td></tr></tbody></table>

 

For example:

``` xml

<IncludeBase RelativeFile="SubFolder/A.xml"/>

<IncludeBase RelativeFile="B.xml"/> 
```

 

 

### &lt;Component&gt;

With this element you can define a component behavior. The contents of this element will depend on the component being defined and the purpose that it is being created for. The main component elements that can be defined are as follows:

1.  `<PartID>`
2.  `<CameraTitle>`
3.  `<FX>`
4.  `<AnimationTriggers>`
5.  `<Visibility>`
6.  `<EmissiveFactor>`
7.  `<Update>`
8.  `<Animation>`
9.  `<MouseRect>`
10. `<UseInputEvent>`

 

 

Additionally you can use the `<Parameters>`, `<UseTemplate>`, `<Condition>` and other elements (like the ones that are custom to the template, as explained in the [Templates](usingbehaviours/model-behaviors-component-overview/#Templates) section of the [Model Behaviors](model-behaviors/) page). Note that you can create hierarchies of components since you can nest one or more `<Component>` elements within other `<Component>`s.

 

This element has the following attributes:

 

{{< table-wrapper >}}

| Attribute               | Description                                                                                                                                                                                    | Type   | Required |
|-------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|:--------:|
| `ID`                    | The unique ID for the component. This string must be alpha-numeric, and can only contain the \_ or - symbols.                                                                                  | String |    Yes   |
| `Node`                  | This is the name of the model node (part) that the component should affect.                                                                                                                    | String |    No    |
| `CameraTitle`           | This is the name of a camera to use to highlight an instrument when evaluating a checklist.                                                                                                    | String |    No    |
| `OverrideID`            | When using an `<IncludeBase />` as part of the XML, this lets you create a component that overrides a previously defined component with a a given ID, redefining everything it used to define. | String |    No    |
| `UpdateFrequencyPreset` | Change which update frequency preset a component should be using. See the [Note For UpdateFrequencyPreset](general-template-xml-properties/#update-note), below, for more information.      | String |    No    |

{{< /table-wrapper >}}


 

Note that you may see in some of the XML templates the element `<RootComponent>`. This is a deprecated element that is now considered an alias for the `<component>` element as such should not be used for new model behaviors.

 

 

##### Note For UpdateFrequencyPreset

This attribute of the `<Component>` element permits you to change which update frequency preset the component should be using. These presets define how often an animation, VFX, etc... should be updated based on the [size on screen](../../../models-and-textures/modeling/lods/lod-selection-system/) of the model (calculated as a {{< glossterm >}}percent_over_100{{< /glossterm >}}). The frequency itself will be 1 update per game frame for the maximum and 1 update every 30 game frames for the minimum, and the update frequency for models between the min and max size will have an interpolated frequency between 1:1 and 1:30.

  
The default preset for the update frequency is "`Asobo_Default`", which will be used if this sub-element is omitted. The presets available by default to you are:

 

<table><thead><tr class="header"><th>Name</th><th>Size On Screen For  

Max Update Frequency</th><th>Size On Screen For  

Min Update Frequency</th><th>Size On Screen  

To Stop Update</th></tr></thead><tbody><tr class="odd"><td><code>Asobo_Default</code></td><td>1.0</td><td>0.01</td><td>0.01</td></tr><tr class="even"><td><code>Asobo_FrequentWhenSmall</code></td><td>0.01</td><td>0.001</td><td>0.001</td></tr><tr class="odd"><td><code>Asobo_RareWhenSmall</code></td><td>1.0</td><td>0.1</td><td>0.1</td></tr><tr class="even"><td><code>Asobo_Default_NeverStop</code></td><td>0.1</td><td>0.01</td><td>0.0</td></tr></tbody></table>

 

You can find information on how to create your own presets from the following section:

-   [Update Frequency Preset Definitions](update-frequency-preset-xml-properties/)

 

 

#### &lt;PartID&gt;

This node defines an ID used in a [checklist](../../modular-simobjects/aircraft/checklists/checklists/) for highlighting instruments, and has no attributes. Essentially this creates a link between a name (the `PartID`) and a node (the component node `ID`), but note that you can *only* have a `<PartId>` element when the component it belongs to has an assigned `Node` as well. You may have multiple part IDs for a single component ID, and you may also use the same part ID name in multiple components, in which case when an element is highlighted from the part ID (for a checklist, for example), all the components associated with this ID - therefore their node and their children in the gltf hierarchy - will be highlighted too.

 

 

#### &lt;Update&gt;

This element describes how an animation should be updated based on the given attributes and the RPN that the element contains. This node is used extensively as part of the [Model Behaviors](model-behaviors/) templates, in particular the `ASOBO_GT_Update` template where it is called using the `<UPDATE_CODE>` custom element. It is usually part of a `<Component>` definition and can have the following attributes:

 

<table><thead><tr class="header"><th>Attribute</th><th>Description</th><th>Type</th><th>Required</th></tr></thead><tbody><tr class="odd"><td><code>InteractionModel</code></td><td><p>This specifies whether the update should run during a specific interaction model or not.</p></td><td><p>Enum:</p><p>"Default"</p><p>"Drag"</p><p>"All"</p></td><td>Yes</td></tr><tr class="even"><td><code>Once</code></td><td>This can be used to set whether the update happens only once (set to "true"), or happens repeatedly (set to "false").</td><td>Bool</td><td>No</td></tr><tr class="odd"><td><code>Frequency</code></td><td>This attribute specifies the update frequency in updates per second (Hz).</td><td><p>Float</p></td><td>No</td></tr></tbody></table>

 

 

#### &lt;CameraTitle&gt;

This element simply takes a the name of a camera (as a string) to use to highlight an instrument when evaluating a checklist. The element should be included as part of a `<Component>` and has no attributes.

 

 

#### &lt;FX&gt;

This element is used as part of a `<Component>` definition to create a VFX. It can have the following sub-elements:

1.  `<Offset>`
2.  `<ContactPoint>`
3.  `<Code>`
4.  `<EnableEntries>`
5.  `<DisableEntries>`
6.  `<OverrideEntries>`
7.  `<GraphParameters>`

 

This element has the following attribute:

 

{{< table-wrapper >}}

| Attribute | Description                                                 | Type   | Required |
|-----------|-------------------------------------------------------------|--------|:--------:|
| `GUID`    | The GUID of the effect that is being used by the component. | String |    Yes   |

{{< /table-wrapper >}}


 

 

##### &lt;Offset&gt;

This sub-element of the `<FX>` element defines the offset in the coordinate system defined by the VFX (in meters). As such it requires the following sub-elements:

Element

Description

Type

Required

`<X>`

Offset on the X axis (meters)

Float

Yes

`<Y>`

Offset on the Y axis (meters)

`<Z>`

Offset on the Z axis (meters)

`<P>`

Rotation offset of the pitch (degrees)

`<B>`

Rotation offset of the bank (degrees)

`<H>`

Rotation offset of the heading (degrees)

 

 

##### &lt;ContactPoint&gt;

This sub-element of the `<FX>` element defines the contact point to attach the effect to, and you can use -1 for none.

 

 

##### &lt;Code&gt;

This sub-element of the `<FX>` element defines the RPN code to use to spawn the effect. The result of the code will be interpreted as boolean, where if the result is "True" the visual effect is spawned and if it is "False" then it is destroyed.

 

 

##### &lt;EnableEntries&gt;

This sub-element of the `<FX>` element is used to enumerate surface types over which this effect may spawn. This element requires one or more `<SurfaceTypeEntry />` sub-elements, and may contain [Program Template Definitions](program-template-xml-properties/) to generate dynamic changes.

 

 

##### &lt;DisableEntries&gt;

This sub-element of the `<FX>` element is used to enumerate surface types over which this effect may **not** spawn. This element requires one or more `<SurfaceTypeEntry />` sub-elements, and may contain [Program Template Definitions](program-template-xml-properties/) to generate dynamic changes.

 

 

##### &lt;OverrideEntries&gt;

This sub-element of the `<FX>` element is used to define which VFX will replace the one defined by the GUID for the given surface type. This element requires one or more `<SurfaceTypeFXEntry />` sub-elements, and may contain [Program Template Definitions](program-template-xml-properties/) to generate dynamic changes.

 

 

##### &lt;GraphParameters&gt;

This sub-element of the `<FX>` element is used to define custom parameters with some RPN code and [Program Template Definitions](program-template-xml-properties/) which can then be used in the VFX graph (with the VFX editor [GraphParameter](../../../devmode/editors/vfx-editor/nodes/graphparameter/) element).

 

 

##### &lt;SurfaceTypeEntry /&gt;

This self-closing element is a sub element of `<EnableEntries>` and `<DisableEntries>`, and `<OverrideEntries>`. It defines a surface type, which is set using the following attribute:

 

<table><thead><tr class="header"><th>Attribute</th><th>Description</th><th>Type</th><th>Required</th></tr></thead><tbody><tr class="odd"><td><code>SurfaceType</code></td><td><p>A surface type string.</p></td><td><p>String:</p><ol><li>CONCRETE</li><li>GRASS</li><li>WATER_FSX</li><li>GRASS_BUMPY</li><li>ASPHALT</li><li>SHORT_GRASS</li><li>LONG_GRASS</li><li>HARD_TURF</li><li>SNOW</li><li>ICE</li><li>URBAN</li><li>FOREST</li><li>DIRT</li><li>CORAL</li><li>GRAVEL</li><li>OIL_TREATED</li><li>STEEL_MATS</li><li>BITUMINUS</li><li>BRICK</li><li>MACADAM</li><li>PLANKS</li><li>SAND</li><li>SHALE</li><li>TARMAC</li><li>WRIGHT_FLYER_TRACK</li><li>OCEAN</li><li>WATER</li><li>POND</li><li>LAKE</li><li>RIVER</li><li>WASTE_WATER</li><li>PAINT</li></ol></td><td>Yes</td></tr></tbody></table>

 

 

##### &lt;SurfaceTypeFXEntry /&gt;

This self-closing element is a sub element of `<OverrideEntries>`. It defines a surface type, which is set using the following attribute:

 

<table><thead><tr class="header"><th>Attribute</th><th>Description</th><th>Type</th><th>Required</th></tr></thead><tbody><tr class="odd"><td><code>SurfaceType</code></td><td><p>A surface type string.</p></td><td><p>String:</p><ol><li>CONCRETE</li><li>GRASS</li><li>WATER_FSX</li><li>GRASS_BUMPY</li><li>ASPHALT</li><li>SHORT_GRASS</li><li>LONG_GRASS</li><li>HARD_TURF</li><li>SNOW</li><li>ICE</li><li>URBAN</li><li>FOREST</li><li>DIRT</li><li>CORAL</li><li>GRAVEL</li><li>OIL_TREATED</li><li>STEEL_MATS</li><li>BITUMINUS</li><li>BRICK</li><li>MACADAM</li><li>PLANKS</li><li>SAND</li><li>SHALE</li><li>TARMAC</li><li>WRIGHT_FLYER_TRACK</li><li>OCEAN</li><li>WATER</li><li>POND</li><li>LAKE</li><li>RIVER</li><li>WASTE_WATER</li><li>PAINT</li></ol></td><td>Yes</td></tr><tr class="even"><td><code>FXGuid</code></td><td>A visual effect <a href="#" class="glossterm">GUID</a> to use for this surface type</td><td>String</td><td>Yes</td></tr></tbody></table>

 

 

#### &lt;Visibility&gt;

This element is usually found as part of a `<Component>` definition and is used to control the visibility of a Node (and its children) programmatically. As such it requires a `<Parameter>` sub-element to control the visibility toggle. The Parameter tag can have the following sub-elements:

-   `<Code>` - If the resulting value of any [RPN](../../../programming-apis/reverse-polish-notation/) code supplied is 0, then the target node will be hidden. It should be noted that when using the `<visibility>` tag on a **skinned mesh** the Node ID that you use should be the *root node* of the part.
-   `<Sim>` - If the value of the SimVar is 0, then the target node will be hidden

 

 

#### &lt;EmissiveFactor&gt;

This element is used as part of a `<Component>` element and sets the component as the target of a material component. A material component is used to control the intensity of an emissive programmatically. As such it requires a `<Parameter>` sub-element to control the emissive toggle. To turn off an emissive, the resulting value of the parameter code should be 0. The Parameter tag can have the following sub-elements:

-   `<Code>` - The resulting value of any [RPN](../../../programming-apis/reverse-polish-notation/) code supplied will be multiplied with the emissive texture
-   `<Sim>` - The SimVar value will be multiplied with the emissive texture

 

Additionally, if the behavior version is 1, you may supply the following sub-element:

1.  `<OverrideBaseEmissive> `

 

 

##### &lt;OverrideBaseEmissive&gt; 

This is a sub-element of `<EmissiveFactor>` and when set to "TRUE", it tells the simulation to override the emissive factor from the 3D model export. If set to "TRUE" this will be unaltered. Note that if the behavior version is set to a value greater than 1, this element is ignored and the base emissive from the model will be unaltered. See here for more information:

-   [Behavior Version Improvements](model-behaviors/#versions)

 

 

#### &lt;UseInputEvent&gt;

This element will call an input event that has been defined already from a template or from the `[model].xml` using the `<InputEvent>` element, and is used as part of a `<Component>`. It has the following attributes:

 

{{< table-wrapper >}}

| Attribute | Description                                                                                              | Type   | Required |
|-----------|----------------------------------------------------------------------------------------------------------|--------|:--------:|
| `ID`      | The ID (name) of the Input Event to use, as defined by the `ID` attribute of the `<InputEvent>` element. | String |    Yes   |

{{< /table-wrapper >}}


 

For more information on input events, please see the following page:

-   [Input Event Definitions](input-event-xml-properties/)

 

 

### &lt;Template&gt;

With this element we initialise a template definition and give it a name. This can then be called using the `<UseTemplate>` element elsewhere in the XML. The element is used as a container for the template data, which can include:

1.  `<Component>`
2.  `<Parameters>`
3.  `<UseParametersFn>`
4.  `<UseTemplate>`
5.  `<Condition>`

 

Other elements (like the ones that are custom to the template, as explained in the [Templates](usingbehaviours/model-behaviors-component-overview/#Templates) section of the [Model Behaviors](model-behaviors/) page) may also be included. This element has the following attributes:

 

{{< table-wrapper >}}

| Attribute | Description                                                                                                                                                                       | Type   | Required |
|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|:--------:|
| `Name`    | This is the name of the template, and is what will be used when calling the `<UseTemplate>` element. This string must be alpha-numeric, and can only contain the \_ or - symbols. | String |    Yes   |

{{< /table-wrapper >}}


 

#### &lt;TemplateAlias&gt;

You can use this element as a sub-element of `<Template>` and is used to define an alias for the template that is using it. This element has no attributes, and requires a string to be used correctly, for example:

``` xml
<Template Name="DEPRECATED_Propeller_Anim_Rotation_Template">
    <TemplateAlias>Propeller_Anim_Rotation_Template</TemplateAlias>
</Template>
```

 

 

### &lt;UseTemplate&gt;

This element is used to reference another template. This element has no fixed sub-elements and will generally require the use of the parameters that are created in the template being referenced, some of which may be optional. It has the following attributes:

 

{{< table-wrapper >}}

| Attribute | Description                                                                           | Type   | Required |
|-----------|---------------------------------------------------------------------------------------|--------|:--------:|
| `Name`    | This is for including a file from a path relative to the `[model].xml` file location. | String |    Yes   |

{{< /table-wrapper >}}


 

 

### &lt;InputEvent&gt;

This element is used to retrieve input from the user. The element is used as a container element for `<Presets>` that will be used to create the the different inputs. It has the following attributes:

 

{{< table-wrapper >}}

| Attribute | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | Type   | Required |
|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|:--------:|
| `ID`      | The ID (name) of the Input Event being defined. This `ID` is then used in the `<UseInputEvent>` element to call the event. This string must be alpha-numeric, and can only contain the \_ or - symbols. Also note that this string - appended with INC, DEC, SET - will be used to populate the [actiondb XML](../../input/actiondb-xml-properties/) by the [Input Profile Editor](../../../devmode/editors/input-editors/the-input-profile-editor/) when creating [Aircraft Specific Input Profiles](../../input/aircraft-specific-input-profiles/). | String |    Yes   |

{{< /table-wrapper >}}


 

This contents of this element are explained in full on the following page:

-   [Input Event Definitions](input-event-xml-properties/)

 

 

### &lt;Parameters&gt;

This sub-element is essentially a container for any number of parameters required by other elements - like `<Template>`, `<Component>`, or within `<Presets>` - and it can also be used when working with the [XML Programs](usingbehaviours/model-behaviors-component-overview/#XMLPrograms) elements. The element does not require any additional attributes, although it does have the following *optional* attributes:

 

<table><thead><tr class="header"><th>Attribute</th><th>Description</th><th>Type</th><th>Required</th></tr></thead><tbody><tr class="odd"><td><code>Type</code></td><td><p>When this attribute is included, you are saying that the parameter sub-elements contained in this element will either be used as default parameters or will override existing parameters.</p><p>If not included, the default type is "Default".</p></td><td><p>String:</p><ol><li>"Default"</li><li>"Override"</li></ol></td><td>No</td></tr><tr class="even"><td><code>Lifetime</code></td><td>This attribute establishes the lifetime of the parameters, and is <em>only</em> relevant when the element is used within a <code>&lt;Loop&gt;</code>. When the attribute is set to "Iteration", the parameters will be created and discarded on <em>each</em> iteration of the loop, while setting it to "Loop" the parameter will be created at the start of the loop, and discarded at the end of <em>all</em> iterations.</td><td><p>String:</p><ol><li>"Loop"</li><li>"Iteration"</li></ol></td><td>No</td></tr></tbody></table>

 

It should be noted that in older iterations of the model behavior files and templates the elements `<DefaultTemplateParameters>` and `<OverrideTemplateParameters>` were used to contain default and override parameters. However **these two elements are now deprecated** and you should use the `<Parameters>` element with the appropriate `Type` attribute.

 

Any user created parameters called within this element can also have a special `Process` attribute added to them. This attribute is explained here:

-   

 

 

#### &lt;SaveParameters&gt;

This element can be defined anywhere a `<Parameters>` element can be defined and is used to save the parameters and values it contains to a file. It has the following attributes:

 

<table><thead><tr class="header"><th>Attribute</th><th>Description</th><th>Type</th><th>Required</th></tr></thead><tbody><tr class="odd"><td><code>ID</code></td><td>Unique identifier given to the saved parameters. This string must be alpha-numeric, and can only contain the _ or - symbols.</td><td>String</td><td>Yes</td></tr><tr class="even"><td><code>Append</code></td><td><p>When this attribute is used, saved parameters will be appened onto the save file. When this attribute is not included, the save file will be wiped before saving. The attribute has two ways to save, identified using the following values:</p><ul><li><strong>"Default"</strong> - When you supply this value, if any parameters have been saved previously, the values will NOT be overwritten by the new value in the save.</li><li><strong>"Override"</strong> - When you supply this value, if any parameter has been saved previously, then it's value will be overwritten by the new value.</li></ul><p>In either case, if any parameter is not included in the save file already, it will be appended onto the save.</p></td><td><p>String</p></td><td>No</td></tr></tbody></table>

 

For example:

``` xml
<SaveParameters ID="MySave">
    <A>A_VALUE</A>
</SaveParameters>
<SaveParameters ID="MySave" Append="Override">
    <A>AN_OTHER_VALUE</A>
</SaveParameters>


```

 

 

#### &lt;LoadParameters /&gt;

This sub element of `<Parameters>` can be used to load in previously saved parameters and their values (parameters are saved using the `<SaveParameters>` element). This element is self closing and has the following attribute:

 

{{< table-wrapper >}}

| Attribute | Description                                                                        | Type   | Required |
|-----------|------------------------------------------------------------------------------------|--------|:--------:|
| `ID`      | The unique identifier that was given to the saved parameters when they were saved. | String |    Yes   |

{{< /table-wrapper >}}


 

 

#### &lt;RemoveSavedParameters /&gt;

This element can be defined anywhere a `<Parameters>` element can be defined and is used to wipe previously saved parameters and their associated values (parameters are saved using the `<SaveParameters>` element). This element is self closing and has the following attribute:

 

{{< table-wrapper >}}

| Attribute | Description                                                                        | Type   | Required |
|-----------|------------------------------------------------------------------------------------|--------|:--------:|
| `ID`      | The unique identifier that was given to the saved parameters when they were saved. | String |    Yes   |

{{< /table-wrapper >}}


 

 

### &lt;ParametersFn&gt;

This element is similar to the `<Template>` element, in that it permits you to create a reusable XML for use in your model behaviors. The element can takes a list of parameters as the input, perform operations on these inputs using [XML Programs](usingbehaviours/model-behaviors-component-overview/#XMLPrograms), and then return one or more parameters as the ouput. This is a container element for `<Parameters>`, `<ReturnParameters>`, and [XML Programing elements](program-template-xml-properties/), and requires a unique name, and you can have multiple parameter functions defined. This name is what would be used to reference the function in other parts of the model behavior XML.

 

{{< table-wrapper >}}

| Attribute | Description                                                                                                                                                                                     | Type   | Required |
|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|:--------:|
| `Name`    | This is the name of the parameter function, and is what will be used when calling the `<UseParametersFn>` element. This string must be alpha-numeric, and can only contain the \_ or - symbols. | String |    Yes   |

{{< /table-wrapper >}}


 

For more information on how to use this element please see the following section:

-   [Parameter Functions](usingbehaviours/model-behaviors-component-overview/#Parameter_Functions)

And for examples of use, please see here:

-   [Parameter Function Examples](../model-xml-examples/#ParameterFunctions)

 

 

#### &lt;ReturnParameters&gt;

This element is used to define one or more return parameters from a `<ParametersFn>` element. This element can also contain further parameter function calls using the `<UseParametersFn>` as well as [XML Programing elements](program-template-xml-properties/).

 

 

### &lt;UseParametersFn&gt;

This element is used to call a previously defined parameter function, and can itself serve as a container for parameters. The function named by this element should have been created already using the `<ParametersFn>` element.

 

{{< table-wrapper >}}

| Attribute | Description                                                                       | Type   | Required |
|-----------|-----------------------------------------------------------------------------------|--------|:--------:|
| `Name`    | This is the name of the previously defined parameter function that is being used. | String |    Yes   |

{{< /table-wrapper >}}


 

 

### &lt;DynamicParameters&gt;

This container element is used to define one or more fallback *dynamic* parameters for substitution within the XML and will be used as part of the **merge process** for a modular aircraft. The element has no attributes, and is used to define dynamic parameter elements as follows:

``` xml
<DynamicParameters>
    <PARAM_NAME>'string'_n</PARAM_NAME>
    <PARAM_NAME><value></PARAM_NAME>
</DynamicParameters>
```

Each element in the `<DynamicParameter>` container is a new parameter that can then be used as a reference to the "alias" contained within. Note that the alias must *always* be supplied in single quotes `''` followed by `_n`. For example:

``` xml
<DynamicParameters>
    <CIRCUIT_NAME>'Screen'_n</CIRCUIT_NAME>
    <VOLTAGE>200</VOLTAGE>
</DynamicParameters>
```

You can then use this dynamic parameter elsewhere in the XML by referencing it between `[]`, eg:

``` xml
(A:CIRCUIT ON:[CIRCUIT_NAME]) // Get the state of the circuit called Screen
```

For more information, please see the following section:

-   [Merging XML Dynamic Parameters](../../modular-simobjects/modular-simobject-merging/#dynamic_params_xml)

 

 

### &lt;AnimationTriggers&gt;

This element is used within the model behaviors to react to an animation change either by sending a *simple* event or a *sound* event, as explained in the [Animation Sounds Example](../../sounds/sound-xml-examples/#h7). It will contain one or more `<EventTrigger>` elements and requires one attribute:

 

{{< table-wrapper >}}

| Attribute | Description                              | Type   | Required |
|-----------|------------------------------------------|--------|:--------:|
| Animation | The target animation name for the event. | String |    Yes   |

{{< /table-wrapper >}}


 

 

#### &lt;EventTrigger&gt;

This is a sub-element of `<AnimationTriggers>` and is a container for the `<SoundEvent />` element (which plays a sound) or the `<EffectEvent />` element (which is a *simple* event, like changing the camera). This element has the following attributes:

 

<table><thead><tr class="header"><th>Attribute</th><th>Description</th><th>Type</th><th>Required</th></tr></thead><tbody><tr class="odd"><td><code>NormalizedTime</code></td><td>This is the normalized time of the animation from which the sound will play. It's going from 0 to 1. This attribute must be used alone, without a <code>Count</code> or <code>Frame</code> attribute.</td><td>Float</td><td>No</td></tr><tr class="even"><td><code>Count</code></td><td><p>This attribute divides the animation timeline in equal segments by the value given. Sounds will play at the middle of each segment. e.g:</p><ul><li>If the value is 2 the sound will play when the animation timeline reaches 25% and 75%.</li><li>If the value is 5 the sound will play when the animation timeline reaches 10%, 30%, 50%, 70% and 90%.</li></ul><p>This attribute must be used alone, without a <code>NormalizedTime</code> or <code>Frame</code> attribute.</p></td><td>Integer</td><td>No</td></tr><tr class="odd"><td><code>Frame</code></td><td>This is the frame of the animation where the sound will be played. This attribute must be used alone, without a <code>Count</code> or <code>NormalizedTime</code> attribute.</td><td>Integer</td><td>No</td></tr><tr class="even"><td><code>Direction</code></td><td>This attribute determines the direction of the animation timeline in which the sound will be played.</td><td><p>String:</p><ol><li>"Forward"</li><li>"Backward"</li><li>"Both"</li></ol></td><td>Yes</td></tr></tbody></table>

 

 

#### &lt;SoundEvent /&gt;

This is a self-closing sub-element of `<EventTrigger>` and is what sets the sound to be triggered. This element has the following attributes:

 

<table><thead><tr class="header"><th>Attribute</th><th>Description</th><th>Type</th><th>Required</th></tr></thead><tbody><tr class="odd"><td><code>WwiseEvent</code></td><td>This is the event that the sound is triggered on and should be the same as that defined for the sound in the <code>sound.xml</code>.</td><td>String</td><td>Yes</td></tr><tr class="even"><td><code>Action</code></td><td>Whether to play or stop the sound. The stop value is useful when dealing with looping sounds.</td><td><p>String:</p><ol><li>"Play"</li><li>"Stop"</li></ol></td><td>Yes</td></tr></tbody></table>

 

 

#### &lt;EffectEvent /&gt;

This is a self-closing sub-element of `<EventTrigger>` and is used to trigger a camera event. This element has the following attribute:

 

{{< table-wrapper >}}

| Attribute | Description                              | Type   | Required |
|-----------|------------------------------------------|--------|:--------:|
| `Name`    | The name of the simple event to trigger. | String |    Yes   |

{{< /table-wrapper >}}