# Navigation Services XML Properties<no value>
The `<service_name>.xml` file is used to define the *states*, *behaviours* and *tasks* that will make up the service being defined. In general, you will have one file per service. For example if you have an aircraft that has a skydiving activity then you may have two different navigation service files:

-   one file for the skydivers
-   another file for the pilot and copilot

 

This file is formatted using [XML](../../devmode/editors/project-editor/file-formats/xml-files/) and can be 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="MissionFile" version="1.0" id="ID_NAME">

    <CabinService.ServiceStateList>
    
        <ServiceState Name="CS_INIT">
        
            <Task TaskName="TN_FIRST" ParamBehaviourName="behaviour_1"/>
        </ServiceState>
        <ServiceState Name="CS_START">
            <Task TaskName="TN_SECOND" ParamBehaviourName="behaviour_2"/>
        </ServiceState>
        
    </CabinService.ServiceStateList>

    <CabinService.BehaviourList>
    
        <Behaviour Name="NAME">
            <BehaviourStateList>
            
                <BehaviourState Name="BS_INIT">
                
                    <AvailableTaskList>
                        <AvailableTask TaskName="TN_FIRST">
                            <Sequence StateChange="BS_BEHAVIOUR"/>
                        </AvailableTask>                    
                    </AvailableTaskList>
                </BehaviourState>
                
            </BehaviourStateList>
        </Behaviour>
        
    </CabinService.BehaviourList>
</SimBase.Document>
```

When creating these files we recommend that you follow an established naming convention that is used by the files included in the default packages for Microsoft Flight Simulator 2024. This convention requires that the different named elements in the file are prefixed as follows:

-   `CS_` → Navigation State (Cabin State)
-   `BS_` → Behaviour State
-   `TN_` → Task Name

For example:

``` xml
<CabinService.ServiceStateList>
    <ServiceState Name="CS_START">
        <Task TaskName="TN_GOTO_SIT" ParamBehaviourName="Skydiver"/>
        <Task TaskName="TN_GOTO_DOOR" ParamBehaviourName="JumpMaster"/>
    </ServiceState>
</CabinService.ServiceStateList>
<CabinService.BehaviourList>
    <Behaviour Name="JumpMaster">
        <BehaviourStateList>
            <BehaviourState Name="BS_INIT">
                <AvailableTaskList>
                    <AvailableTask TaskName="TN_GOTO_DOOR">
                    <Sequence StateChange="BS_GOTO_DOOR"/>
                </AvailableTask>                    
            </AvailableTaskList>
        </BehaviourState>
    </Behaviour>
</CabinService.BehaviourList>
```

As a continuation to this naming convention, we strongly suggest that each file also has a `CS_INIT` state for the navigation service and a `BS_INIT` state for the behaviours. These would be the state and behaviour that are first in the {{< glossterm >}}fsm{{< /glossterm >}} when the navigation service file is first initialised.

 

 

### &lt;SimBase.Document&gt;

This is the main parent element that is used to contain the navigation service data. This element should have the following sub-elements:

1.  `<CabinService.ServiceStateList>`
2.  `<CabinService.BehaviourList>`

 

This element has the following attributes:

 

{{< table-wrapper >}}

| Attribute | Description                                                                                                                                                                                                                                                                                                                                  | Type   | Required |
|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|:--------:|
| `type`    | The type of SimBase file. Should always be "MissionFile".                                                                                                                                                                                                                                                                                    | String |    Yes   |
| `version` | The file version.                                                                                                                                                                                                                                                                                                                            | Float  |    No    |
| `id`      | The unique ID for the navigation service. This can be a [GUID](../mission-xml-files/mission-xml-properties/#) enclosed in `{}`, or a name string (alpha-numeric characters and under-scores "\_", only). You can find more information on GUID's here: [GUIDs](../../introduction/using-the-sdk/#GUIDs) | String |    Yes   |

{{< /table-wrapper >}}


 

 

### &lt;CabinService.ServiceStateList&gt;

This is is a container element that is used to list the different states within the navigation service {{< glossterm >}}fsm{{< /glossterm >}}. It has no attributes and requires one or more of the following sub-element:

1.  `<ServiceState>`

 

The following shows a complete example of a navigation service state list definition in an XML file:

``` xml
<CabinService.ServiceStateList>
    <ServiceState Name="CS_INIT">
        <Task TaskName="TN_GO_TO_PARKING" ParamBehaviourName="BoardingRamp"/>
    </ServiceState>
    <ServiceState Name="CS_GO_TO_PLANE">
        <Task TaskName="TN_GO_TO_PLANE" ParamBehaviourName="BoardingRamp" Count="0"/>
        <Task TaskName="TN_ATTACH_TO_PLANE" ParamBehaviourName="BoardingRamp"/>
    </ServiceState>
    <ServiceState Name="CS_ATTACHED">
        <Task TaskName="TN_WAIT_BOARDING_END" ParamBehaviourName="BoardingRamp"/>
    </ServiceState>
    <ServiceState Name="CS_DETACH">
        <Task TaskName="TN_DETACH_FROM_AIRCRAFT" ParamBehaviourName="BoardingRamp"/>
    </ServiceState>
</CabinService.ServiceStateList>
```

 

 

### &lt;ServiceState&gt;

This element is a sub-element of `<CabinService.ServiceStateList>` and is used to define a single state within the navigation service {{< glossterm >}}fsm{{< /glossterm >}}. It must contain *at least* one of the following sub-element (but may contain more):

1.  `<Task/>`

 

Note that by default the first `<ServiceState>` defined will be the "start" state of the navigation service {{< glossterm >}}fsm{{< /glossterm >}}, used when the object is first initialised. See the `<CabinService.ServiceStateList>` section for an example of use.

 

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>name</code></td><td>The name of the state. If this is the first state in the FSM, then it should be named <code>CS_INIT</code>, otherwise use <code>CS_&lt;name&gt;</code>.</td><td>String</td><td>Yes</td></tr><tr class="even"><td><code>StateChange</code></td><td>This is the name of a <code>&lt;ServiceState&gt;</code> to move to at the end of the service state being defined currently. Note that this will <em>only</em> change the state for the navigation Service FSM, which <em>may</em> conflict with the <code>&lt;AvailableTask&gt;</code> of the associated behaviour, which is something to be aware of.</td><td>String</td><td>No</td></tr><tr class="odd"><td><code>RecomputeInteractiveObjectsLinks</code></td><td><p>This should be set to "True" if you want to recompute all of the interactive objects links on the first frame of the state.</p><p>Default value is "False".</p></td><td>Boolean</td><td>No</td></tr><tr class="even"><td><code>EFBEnabled</code></td><td><p>If this is set to "True" then the EFB is allowed to change the behaviours in this state.</p><p>Default value is "False".</p></td><td>Boolean</td><td>No</td></tr><tr class="odd"><td><code>EFBDefaultStateBoarding</code></td><td><p>If this is set to "True", the EFB will call this state if boarding is forced while being in a state that currently is not boarding.</p><p>Default value is "False".</p></td><td>Boolean</td><td>No</td></tr><tr class="even"><td><code>EFBPostBoarding</code></td><td><p>If this is set to "True", the EFB is allowed to move the behaviours in this state, as they are already boarded.</p><p>Default value is "False".</p></td><td>Boolean</td><td>No</td></tr></tbody></table>

 

 

#### &lt;Task/&gt;

This is a self-closing sub-element of `<ServiceState>` which is used to define a task to be performed when the navigation service {{< glossterm >}}fsm{{< /glossterm >}} reaches the state that holds the task(s). You may have multiple `<Task/>` elements per state. See the `<CabinService.ServiceStateList>` section for an example of use.

 

The element has the following attributes:

 

{{< table-wrapper >}}

| Attribute            | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | Type    | Required |
|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|:--------:|
| `TaskName`           | The name of the task. You should use the use `TN_<name>` naming convention for this attribute.                                                                                                                                                                                                                                                                                                                                                                                        | String  |    Yes   |
| `ParamBehaviourName` | This is the `name` attribute of the `<Behaviour>` that is to be used to perform the task.                                                                                                                                                                                                                                                                                                                                                                                             | String  |    Yes   |
| `Count`              | This corresponds to the number of behaviours that have to do the task before it can be validated. Note that, by default, a navigation state requires *all* behaviours to do a given task before it is considered "validated" (completed). When a task is not validated, it can block the change to a new service state. This may be avoided by either using 0 for the count, or by "forcing" the state change using the `<ForceCabinServiceState>` element in the mission definition. | Integer |    No    |

{{< /table-wrapper >}}


 

 

### &lt;CabinService.BehaviourList&gt;

This is is a container element that is used to list the different behaviours that can be used within the tasks defined in the various navigation service {{< glossterm >}}fsm{{< /glossterm >}} states. It has no attributes and requires one or more of the following sub-element:

1.  `<Behaviour>`

 

The following shows a simple example of a behaviour state definition in an XML file:

``` xml
<CabinService.BehaviourList>
    <Behaviour Name="Passenger">
        <BehaviourStateList>
            <BehaviourState Name="BS_INIT">                    
                <AvailableTaskList>
                    <AvailableTask TaskName="TN_GO_TO_SIT">
                        <Sequence StateChange="BS_GOTO_SIT"/>
                    </AvailableTask>                        
                </AvailableTaskList>
            </BehaviourState>
            <BehaviourState Name="BS_GOTO_SIT">
                <LinkedCabinStateList>
                    <LinkedCabinState>CS_SIT</LinkedCabinState>
                </LinkedCabinStateList>
                <OnSkipFrame>
                    <Sequence>
                    </Sequence>
                </OnSkipFrame>
                <OnFirstFrame>
                    <Sequence>
                        <AttachToAircraft/>
                        <TeleportToGraphNode NodeTag="SIT"/>
                        <PlayAnimation Name="Idle_Sit_01" Layer="Base" Force="TRUE"/>
                        <NotifyTaskComplete TaskName="TN_GO_TO_SIT"/>
                    </Sequence>
                </OnFirstFrame>
            </BehaviourState>
        </BehaviourStateList>
    </Behaviour>
</CabinService.BehaviourList>
```

 

 

### &lt;Behaviour&gt;

This element is a sub-element of `<CabinService.BehaviourList>` and is used to define a group of behaviours that will be used by actors. It must contain one of the following sub-element:

1.  `<BehaviourStateList>`

 

See the `<CabinService.BehaviourList>` section for an example of use. This element has the following attributes:

 

{{< table-wrapper >}}

| Attribute | Description                | Type   | Required |
|-----------|----------------------------|--------|:--------:|
| `name`    | The name of the behaviour. | String |    Yes   |

{{< /table-wrapper >}}


 

 

### &lt;BehaviourStateList&gt;

This is is a child of the `<Behaviour>` element and acts as a container element for one or more of the following element:

1.  `<BehaviourState>`

 

Within this element you can define all the different states for the actor behaviour {{< glossterm >}}fsm{{< /glossterm >}}. See the `<CabinService.BehaviourList>` section for an example of use.

 

 

### &lt;BehaviourState&gt;

This is a sub-element of the `<BehaviourStateList>` and is used to define a single actor behaviour. This element has the following sub-elements:

1.  `<LinkedCabinStateList>`
2.  `<OnFirstFrame>`
3.  `<OnLastFrame>`
4.  `<OnSkipFrame>`
5.  `<AvailableTaskList>`

 

This element has the following attribute:

 

{{< table-wrapper >}}

| Attribute           | Description                                                                                                                                                                                                         | Type   | Required |
|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|:--------:|
| `name`              | The name of the behaviour state. You should use the use `BS_<name>` naming convention for this attribute.                                                                                                           | String |    Yes   |
| `UseMassInstancing` | When set to "true", the object with this behaviour will be added to the "Mass Instancing" group, which means that it will stop being updated when it is far from the camera. If omitted, it will default to "true". | String |    No    |

{{< /table-wrapper >}}


 

Below is a simple example of this element being used:

``` xml
<BehaviourState Name="BS_RESET">    
    <LinkedCabinStateList>
        <LinkedCabinState>CS_RESET</LinkedCabinState>
    </LinkedCabinStateList>                
    <OnFirstFrame>
        <Sequence StateChange="BS_GOTO_DOOR">
            <PlayAnimation Name="Idle_Stand_01" Layer="Base" Force="True"/>
            <AttachToAircraft/>
            <NotifyTaskComplete TaskName="TN_RESET"/>
        </Sequence>
    </OnFirstFrame>
</BehaviourState>
```

 

 

#### &lt;LinkedCabinStateList&gt;

This is a sub-element of `<BehaviourState>` and has no attributes. It is a container element for one or more of the following element:

1.  `<LinkedCabinState>`

 

##### &lt;LinkedCabinState&gt;

This is a sub-element of `<LinkedCabinStateList>` and has no attributes. For this element you are expected to supply a navigation Service state name (as defined in `<ServiceState>`). This state will be used when a navigation State change has been forced.

``` xml
<LinkedCabinStateList>
    <LinkedCabinState>CS_RESET</LinkedCabinState>
</LinkedCabinStateList>
```

  
The normal behaviour when a state change happens is that a new group of tasks will become available, as defined in the `<CabinService.ServiceStateList>`. When a behaviour has finished the current tasks, it will then look into this list of possible next tasks, and if one of these tasks is available, it will be performed and (usually) launch a state change to get to a new behaviour state for the task. However, when you force the navigation state change, you will want to bypass these available tasks, as they will not be relevant for the forced state, which is when the `<LinkedCabinStateList>` element is comes in. When a state change is forced, all behaviours will switch to the behaviour flagged as the first one for the new navigation state after a skip using this element.

 

 

#### &lt;OnFirstFrame&gt;

This child element of `<BehaviourState>` is a container element for a `<Sequence>`, where the sequence defines what should happen on the very first frame of the behaviour *after* the behaviour state has been changed to the one containing the `<OnFirstFrame>` element. The element has no attributes, and below you can see an example of how it would look in the XML:

``` xml
<OnFirstFrame>
    <Sequence>
        <AttachToAircraft/>
        <TeleportToGraphNode NodeTag="SIT"/>
        <PlayAnimation Name="Idle_Sit_01" Layer="Base" Force="TRUE"/>
        <NotifyTaskComplete TaskName="TN_GO_TO_SIT"/>
    </Sequence>
</OnFirstFrame>
```

 

 

#### &lt;OnLastFrame&gt;

This child element of `<BehaviourState>` is a container element for a `<Sequence>`, where the sequence defines what should happen on the very *last* frame of the behaviour *before* the behaviour state changes to the next one. The element has no attributes, and below you can see an example of how it would look in the XML:

``` xml
<OnLastFrame>
    <Sequence>
        <DetachFromAircraft />
        <NotifyTaskComplete TaskName="TN_GO_TO_PARKING"/>
    </Sequence>
</OnLastFrame>
```

 

 

#### &lt;OnSkipFrame&gt;

This child element of `<BehaviourState>` is a container element for a `<Sequence>`, where the sequence defines what should happen *before* the very first frame of the behaviour state (so before the `<OnFirstFrame>` element is triggered) just *after* a behaviour state has been skipped to the one containing the `<OnSkipFrame>` element.

{{< callout context="note" title="NOTE" icon="outline/bulb" >}}

the `<OnFirstFrame>` element will still be triggered, just that it will be triggered after the `<OnSkipFrame>` element.

{{< /callout >}}

The element has no attributes, and below you can see an example of how it would look in the XML:

``` xml
<OnSkipFrame>
    <Sequence>
        <AttachToAircraft/>
        <TeleportToGraphNode NodeTag="PUMP"/>
    </Sequence>
</OnSkipFrame>
```

 

 

#### &lt;AvailableTaskList&gt;

This is a sub-element of `<BehaviourState>` and has no attributes. It is a container element for one or more of the following element:

1.  `<AvailableTask>`

 

 

##### &lt;AvailableTask&gt;

This element is a sub-element of `<AvailableTaskList>` and is used to define a task that is available as part of the behaviour state. The task being defined is named using the attribute listed below, and the sequence of events that will comprise the task itself are defined using the following sub-element:

1.  `<Sequence>`

 

This element has the following attributes:

 

{{< table-wrapper >}}

| Attribute  | Description                                                                                                                  | Type   | Required |
|------------|------------------------------------------------------------------------------------------------------------------------------|--------|:--------:|
| `TaskName` | The task name for the navigation service behaviour. You should use the use `TN_<name>` naming convention for this attribute. | String |    Yes   |

{{< /table-wrapper >}}


 

Example of how it would look in the XML:

``` xml
<AvailableTaskList>
    <AvailableTask TaskName="TN_JUMP">
        <Sequence StateChange="BS_JUMP">
        </Sequence>                            
    </AvailableTask>
    <AvailableTask TaskName="TN_RESET">
        <Sequence StateChange="BS_RESET">
        </Sequence>
    </AvailableTask>
</AvailableTaskList>
```

 

 

### &lt;Sequence&gt;

This is a container sub-element which defines a sequence of events that should be followed when the sequence is called. The timing of the sequence will depend on the parent element where the sequence has been placed, which can be one of the following:

1.  `<OnFirstFrame>`
2.  `<OnLastFrame>`
3.  `<OnSkipFrame>`
4.  `<AvailableTask>`

 

The element itself can contain any of the following sub-elements:

1.  `<RegisterForInteractionVolume>`
2.  `<UnRegisterForInteractionVolume>`
3.  `<AttachToAircraft />`
4.  `<DetachFromAircraft>`
5.  `<TaxiAIMoveToDestination />`
6.  `<InteractWithNode>`
7.  `<MoveToGraphNode>`
8.  `<TeleportToGraphNode>`
9.  `<NotifyTaskComplete>` (Required)
10. `<PlayAnimation>`
11. `<SetAlpha>`
12. `<SetHighQualityForRTCRenderFlag />`
13. `<RequireLOD0 />`

 

The `<Sequence>` element may also 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>StateChange</code></td><td>This attribute can be used to force a behaviour state state change. The supplied string should be the name of a <code>&lt;BehaviourState&gt;</code> element.</td><td>String</td><td>No</td></tr><tr class="even"><td><code>Probability</code></td><td>This attribute can be used to provide a probability that the sequence will be chosen. Value should be a <a href="#" class="glossterm">Percent Over 100</a>, and the sum of all supplied sequence probabilities for the task should be 1.0.</td><td>Float</td><td>No</td></tr><tr class="odd"><td><code>DisplayModelEntry</code></td><td>This attribute can be used to change the model that is being displayed. Fore example, this can be used to switch models if you have a service worker with a headset when inside the aircraft but want to have them without the headset when outside the aircraft. If this attribute is omitted then the default model will be used.</td><td><p>String:</p><ol><li>"Interior"</li><li>"Exterior"</li></ol></td><td>No</td></tr><tr class="even"><td><code>RequireLOD0</code></td><td><p>When set to "True", the SimObject will have it's LOD0 pre-loaded before being displayed.</p><p>Default value is "False".</p></td><td>Boolean</td><td>No</td></tr><tr class="odd"><td><code>SetHighQualityForRTCRenderFlag</code></td><td><p>When set to "True", the SimObject will be flagged for high-quality rendering. Only used for objects used in RTCs.</p><p>Default value is "False".</p></td><td>Boolean</td><td>No</td></tr><tr class="even"><td><code>RecomputeInteractiveObjectsLinksAction</code></td><td><p>Recomputes the links between this object and the navigation service in which it's an interactor.</p><p>Default value is "False".</p></td><td>Boolean</td><td>No</td></tr></tbody></table>

 

 

#### &lt;RegisterForInteractionVolume /&gt;

This is a self-closing element used in a `<Sequence>` to register the navigation service as one which can interact with any *interactive volumes*. Objects registered in this way are the *only* ones that can interact with a node (assuming the node has the [interactiveVolumeConstraint](../cfg-files/navigation_graph.cfg/#interactiveVolumeConstraint) defined as "RegisterOnly").

 

This element has the following parameters:

 

<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>NodeTag</code></td><td>This is the <a href="../cfg-files/navigation_graph/#tag">tag</a> of the node to search for with the interaction volume. Note that if multiple nodes have this tag, then the first node with this tag will be used.</td><td>String</td><td>Yes</td></tr><tr class="even"><td><code>RegisterId</code></td><td><p>This is an ID string for the registration, which can be used with <code>&lt;UnregisterFromInteractionVolume&gt;</code> so it can deregister specific interactions when necessary.</p><p>Default is "".</p></td><td>String</td><td>No</td></tr></tbody></table>

 

 

#### &lt;UnregisterFromInteractionVolume /&gt;

This is a self-closing element used in a `<Sequence>` to deregister the navigation service from being able to interact with any *interactive volumes*.

 

This element has the following parameter:

 

<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>RegisterId</code></td><td><p>This is the string that identifies the interaction that is to be deregistered from the interaction manager as capable of using an interaction volume.</p><p>Default is "".</p></td><td>String</td><td>No</td></tr></tbody></table>

 

 

#### &lt;AttachToAircraft /&gt;

This is a self-closing element used in a `<Sequence>`. It has no attributes and simply tells the simulation that the object behaviour has been attached to the aircraft. Attached objects will have two effects:

1.  Should the aircraft move, the attached object will move along with it.
2.  The weight of the object will be added to the weight of the aircraft and affect its physics, such that if a heavy object (for example cargo) is placed in the left side of the aircraft, the aircraft will "sag" to the left.

Weight is based on the values set in the `sim.cfg` file for the [Simple Object](../modular-simobjects/simobjects/simple-objects/) or the [Procedural Character](../modular-simobjects/simobjects/procedural-characters/) associated with the behaviour.

 

 

#### &lt;DetachFromAircraft&gt;

This element is used in a `<Sequence>`. It tells the simulation that the object behaviour has been detached from the aircraft. Detaching an object will mean that the weight of the object will no longer be considered by the aircraft physics, and it's weight will be removed from the total aircraft weight. Weight is based on the values set in the `sim.cfg` file for the [Simple Object](../modular-simobjects/simobjects/simple-objects/) or the [Procedural Character](../modular-simobjects/simobjects/procedural-characters/) associated with the behaviour.

 

This element has the following parameter:

 

<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>StayInCabinService</code></td><td><p>This is used to define whether to keep object in the navigation service ("True") or not ("False"). If not kept in the navigation service, it will not listen to new tasks.</p><p>Default is "False".</p></td><td>Boolean</td><td>No</td></tr></tbody></table>

 

 

#### &lt;TaxiAIMoveToDestination /&gt;

This is a self-closing element used in a `<Sequence>`. It has no attributes and simply tells the simulation that the behaviour object should move along the taxiway to the stored destination using the **Taxiway AI ** as part of the sequence. Note that this will require that the [Apron Services XML](../environment/airports-and-facilities/apron-services/apron-services-overview/) has been correctly set up and the object has been linked to **Apron Control**.

 

 

#### &lt;InteractWithNode&gt;

This element used in a `<Sequence>` and allows the behaviour object to interact with the current graph node. Using this element will generate a check to see if an interaction with the name `InteractionName` is available, and if it exists it will call the associated XML. For more information, please see here:

-   [Service Interaction XML Properties](interaction-xml-properties/)

 

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>InteractionName </code></td><td>The interaction to perform on the current graph node, as defined in the <a href="Interaction_XML_Properties.htm">Interaction XML</a>.</td><td>String</td><td>Yes</td></tr><tr class="even"><td><code>Remotely</code></td><td><p>By default the behaviour object should be on the graph node to perform the interaction, but you can perform the interaction remotely by setting this attribute to "TRUE".</p><p>Default is "FALSE".</p></td><td>Boolean</td><td>No</td></tr></tbody></table>

 

 

#### &lt;MoveToGraphNode&gt;

This element used in a `<Sequence>` and is used to tell the behaviour object to move to a selected graph node. The exact node that the behaviour object moves to will depend on the combination of `InteractionName`, `NodeTag` and `NodeOrder` attributes.

 

This element can have one or more `<NodeStep>` sub-elements to define the nodes through which the object should move to get to the final node in the node step list. If this sub-element is used, then the following attributes do not need to be included:

1.  `NodeTag`
2.  `NodeOrder`
3.  `InteractionName`
4.  `CheckNodeReserved`

 

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>InteractionName</code></td><td><p>The interaction used to select the graph node to move to, as defined in the <a href="Interaction_XML_Properties.htm">Interaction XML</a>. The interaction XML may contain multiple nodes, so the node that is chosen will depend on the <code>NodeOrder</code> attribute.</p><p>Default is "".</p><p><strong>NOTE</strong>: This is not used when the element has one or more <code>&lt;NodeStep&gt;</code> sub-element.</p></td><td>String</td><td>No</td></tr><tr class="even"><td><code>NodeTag</code></td><td><p>The interactive node tag to move to, as defined in the <a href="Interaction_XML_Properties.htm">Interaction XML</a>. Multiple nodes may share a tag, so the node that is chosen will depend on the <code>NodeOrder</code> attribute.</p><p>Default is "".</p><p><strong>NOTE</strong>: This is not used when the element has one or more <code>&lt;NodeStep&gt;</code> sub-element.</p></td><td>String</td><td>No</td></tr><tr class="odd"><td><code>NodeTagsToExclude</code></td><td><p>One or more interactive node tags to exclude from movement (as defined in the <a href="Interaction_XML_Properties.htm">Interaction XML)</a>, given as a comma seperated list.</p><p>Default is "".</p></td><td>String</td><td>No</td></tr><tr class="even"><td><code>MaxSpeed</code></td><td><p>The maximum speed of movement, given in <a href="#" class="glossterm">ft</a> per second (note that this can't be negative). If this is omited then the value set in the sim.cfg file <code>max_speed_mph</code> / <code>max_speed_knots</code> parameters will be used, and if one of those doesn't exist then it will be the default value.</p><p>Default is 3.28084 (approx: 1m per second).</p></td><td>Float</td><td>No</td></tr><tr class="odd"><td><code>MaxSpeedAlways</code></td><td><p>When set to "True", the object will always move at the given maximum speed, otherwise it will move at a variable speed, which will never exceed the maximum speed.</p><p>Default is "False".</p></td><td>Boolean</td><td>No</td></tr><tr class="even"><td><code>MoveStraight</code></td><td><p>Sets whether to move straight to the given node ("TRUE") or whether to follow the defined path ("FALSE").</p><p>Default is "FALSE".</p></td><td>Boolean</td><td>No</td></tr><tr class="odd"><td><code>NodeOrder</code></td><td><p>This attribute defines the way that nodes will be parsed to find the node that the behaviour object should move to. The nodes that will be used are defined using the <code>InteractionName</code> and/or the <code>NodeTag</code> attributes.</p><p>Default is "Random".</p><p><strong>NOTE</strong>: This is not used when the element has one or more <code>&lt;NodeStep&gt;</code> sub-element.</p></td><td><p>Enum:</p><ol><li><strong>"Random"</strong> - Choose a random node to move to</li><li><strong>"Ascending"</strong> - Choose the next node in ascending order by ID</li><li><strong>"Descending"</strong> - Choose the next node in descending order by ID</li><li><strong>"Distance"</strong> - Choose the nearest node based on distance to the behaviour object.</li><li>"<strong>Distance_Reverse</strong>" - Choose the furthest node based on distance from the behaviour object.</li><li>"<strong>Placement_Config</strong>" - Look at the placement config priority.</li></ol></td><td>No</td></tr><tr class="even"><td><code>Ratio</code></td><td><p>This value is used to modify the maximum speed (as defined in the <a href="../modular-simobjects/simobjects/SimObjects.htm">sim.CFG</a> file) at which the behaviour object will move. For example, if the speed is set to 2m per second, and you set the ratio tio 0.5, the maximum speed of the object will be 1m per second.</p><p>Default is 1.0.</p></td><td>Float</td><td>No</td></tr><tr class="odd"><td><code>TeleportOnSkip</code></td><td><p>When this is set to "TRUE" the behaviour object will "teleport" to the selected node if the sequence is cancelled by a skip. If set to "FALSE", then it will continuing to move along the path, regardless of the skip.</p><p>Default is "FALSE".</p></td><td>Boolean</td><td>No</td></tr><tr class="even"><td><code>WaitAvailableToMove</code></td><td><p>When this is set to "TRUE" the behaviour object will wait to move to a node if no free node is available. If set to "FALSE", and no node is available, it will check <code>HideOnNodeNotFound</code>.</p><p>Default value is "FALSE".</p></td><td>Boolean</td><td>No</td></tr><tr class="odd"><td><code>HideOnNodeNotFound</code></td><td><p>When this is set to "TRUE" the behaviour object will be hidden if no node with the expected name is available, and then teleport to the node the instant one becomes available. If set to "FALSE", the behaviour object will simply do nothing and be static and visible until a node is available.</p><p><strong>NOTE</strong>: While DevMode is enabled, this attribute does nothing and models will always be visible.</p><p>Default is "TRUE".</p></td><td>Boolean</td><td>No</td></tr><tr class="even"><td><code>CheckNodeReserved</code></td><td><p>When this is set to "True" the simulation will check to see if a node matching the supplied tags is reserved or not. A reserved node is one where an object is already moving to it, but has not arrived yet.</p><p>Default value is "False".</p><p><strong>NOTE</strong>: This is not used when the element has one or more <code>&lt;NodeStep&gt;</code> sub-element.</p></td><td>Boolean</td><td>No</td></tr></tbody></table>

 

 

##### &lt;NodeStep&gt;

This element used in a `<MoveToGraphNode>` to define one of the "steps" (nodes) for the object to move to. You can have multiple of these elements within the parent, and the object will move between them.

 

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>InteractionName</code></td><td><p>The interaction used to select the graph node to move to, as defined in the <a href="Interaction_XML_Properties.htm">Interaction XML</a>. The interaction XML may contain multiple nodes, so the node that is chosen will depend on the <code>NodeOrder</code> attribute.</p><p>Default is "".</p></td><td>String</td><td>No</td></tr><tr class="even"><td><code>NodeTag</code></td><td><p>The interactive node tag to move to, as defined in the <a href="Interaction_XML_Properties.htm">Interaction XML</a>. Multiple nodes may share a tag, so the node that is chosen will depend on the <code>NodeOrder</code> attribute.</p><p>Default is "".</p></td><td>String</td><td>No</td></tr><tr class="odd"><td><code>NodeOrder</code></td><td><p>This attribute defines the way that nodes will be parsed to find the node that the behaviour object should move to. The nodes that will be used are defined using the <code>InteractionName</code> and/or the <code>NodeTag</code> attributes.</p><p>Default is "Random".</p></td><td><p>Enum:</p><ol><li><strong>"Random"</strong> - Choose a random node to move to</li><li><strong>"Ascending"</strong> - Choose the next node in ascending order by ID</li><li><strong>"Descending"</strong> - Choose the next node in descending order by ID</li><li><strong>"Distance"</strong> - Choose the nearest node based on distance to the behaviour object.</li><li>"<strong>Distance_Reverse</strong>" - Choose the furthest node based on distance from the behaviour object.</li><li>"<strong>Placement_Config</strong>" - Look at the placement config priority.</li></ol></td><td>No</td></tr><tr class="even"><td><code>CheckNodeReserved</code></td><td><p>When this is set to "True" the simulation will check to see if a node matching the supplied tags is reserved or not. A reserved node is one where an object is already moving to it, but has not arrived yet.</p><p>Default value is "False".</p></td><td>Boolean</td><td>No</td></tr></tbody></table>

 

 

#### &lt;TeleportToGraphNode&gt;

This element used in a `<Sequence>` and is used to tell the behaviour object to teleport directly to a selected graph node. The exact node that the behaviour object teleports to will depend on the combination of `InteractionName`, `NodeTag` and `NodeOrder` attributes.

 

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>InteractionName</code></td><td><p>The interaction used to select the graph node to move to, as defined in the <a href="Interaction_XML_Properties.htm">Interaction XML</a>. The interaction XML may contain multiple nodes, so the node that is chosen will depend on the <code>NodeOrder</code> attribute.</p><p>Default is "".</p></td><td>String</td><td>No</td></tr><tr class="even"><td><code>NodeTag</code></td><td><p>The interactive node tag to move to, as defined in the <a href="Interaction_XML_Properties.htm">Interaction XML</a>. Multiple nodes may share a tag, so the node that is chosen will depend on the <code>NodeOrder</code> attribute.</p><p>Default is "".</p></td><td>String</td><td>Yes</td></tr><tr class="odd"><td><code>NodeOrder</code></td><td><p>This attribute defines the way that nodes will be parsed to find the node that the behaviour object should move to. The nodes that will be used are defined using the <code>InteractionName</code> and/or the <code>NodeTag</code> attributes.</p><p>Default is "Random".</p></td><td><p>Enum:</p><ol><li><strong>"Random"</strong> - Choose a random node to move to</li><li><strong>"Ascending"</strong> - Choose the next node in ascending order by ID</li><li><strong>"Descending"</strong> - Choose the next node in descending order by ID</li><li><strong>"Distance"</strong> - Choose the nearest node based on distance to the behaviour object.</li><li>"<strong>Distance_Reverse</strong>" - Choose the furthest node based on distance from the behaviour object.</li><li>"<strong>Placement_Config</strong>" - Look at the placement config priority.</li></ol></td><td>No</td></tr><tr class="even"><td><code>HideOnNodeNotFound</code></td><td><p>When this is set to "TRUE" the behaviour object will be hidden if no node with the expected name is available, and then teleport to the node the instant one becomes available. If set to "FALSE", the behaviour object will simply do nothing and be static and visible until a node is available.</p><p><strong>NOTE</strong>: While DevMode is enabled, this attribute does nothing and models will always be visible.</p><p>Default is "TRUE".</p></td><td>Boolean</td><td>No</td></tr><tr class="odd"><td><code>TeleportWhenNodeAvailable</code></td><td><p>When set to "True", and if no nodes matching the required tags are available, the object will wait until a node is available to teleport to it. When this is set to "False", it will check <code>HideOnNodeNotFound</code>.</p><p>Default value is "True".</p></td><td>Boolean</td><td>No</td></tr><tr class="even"><td><code>CheckNodeReserved</code></td><td><p>When this is set to "True" the simulation will check to see if a node matching the supplied tags is reserved or not. A reserved node is one where an object is already moving to it, but has not arrived yet.</p><p>Default value is "True".</p></td><td>Boolean</td><td>No</td></tr></tbody></table>

 

 

#### &lt;NotifyTaskComplete&gt;

This element required by a `<Sequence>` and is used to tell the `<ServiceState>` {{< glossterm >}}fsm{{< /glossterm >}} that the given task has been completed.

This element has the following attribute:

 

{{< table-wrapper >}}

| Attribute  | Description                                     | Type   | Required |
|------------|-------------------------------------------------|--------|:--------:|
| `TaskName` | The name of the task to set as being completed. | String |    Yes   |

{{< /table-wrapper >}}


 

 

#### &lt;PlayAnimation&gt;

This element used in a `<Sequence>` and is used to tell the behaviour object to play its animation. The sequence will then wait until the animation has been completed before continuing on to the next action in the sequence. 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>Name</code></td><td><p>The name of the animation to use.</p></td><td>String</td><td>Yes</td></tr><tr class="even"><td><code>Layer</code></td><td><p>The name of the layer that the animation is on. If this could be any layer, then you should use "Base".</p><p>Default is "Base".</p></td><td>String</td><td>No</td></tr><tr class="odd"><td><code>Force</code></td><td><p>If set to "TRUE", the animation will play even if a transition exists to another state. If "FALSE" then it will not.</p><p>Default is "FALSE".</p></td><td>Boolean</td><td>No</td></tr></tbody></table>

 

 

#### &lt;SetAlpha&gt;

This element used in a `<Sequence>` and is used to set the transparency of the behaviour object. This element has the following attribute:

 

{{< table-wrapper >}}

| Attribute | Description                                                                                                         | Type   | Required |
|-----------|---------------------------------------------------------------------------------------------------------------------|--------|:--------:|
| `Ratio`   | The alpha value to use for the behaviour object, expressed as a {{< glossterm >}}percent_over_100{{< /glossterm >}}. | String |    Yes   |

{{< /table-wrapper >}}


 

 

#### &lt;SetHighQualityForRTCRenderFlag /&gt;

This element used in a `<Sequence>` and is used to set whether RTC's should use a high quality render or not. It is a self-closing element and has the folloing 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>AddHightQualityForRTCRenderFlag</code></td><td><p>When this is set to "True", a render flag is set to use high quality settings on the container for the RTC.</p><p>The default value is "False".</p></td><td>Boolean</td><td>No</td></tr></tbody></table>

 

 

#### &lt;RequireLOD0 /&gt;

This element used in a `<Sequence>` and is used to tell the simulation to pre-load LOD0 for the container. This element has no attributes and only needs to be included in the sequence definition for it to be active.

 

 

<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>AddHightQualityForRTCRenderFlag</code></td><td><p>When this is set to "True", a render flag is set to use high quality settings on the container for the RTC.</p><p>The default value is "False".</p></td><td>Boolean</td><td>No</td></tr></tbody></table>

 

 

### &lt;CabinService.RegisterInteractorsToCabinServiceAction&gt;

This is a sub-element of `<WorldBase.Flight>` and is not usually included as part of the navigation service XML, but instead as part of the [mission XML](../mission-xml-files/mission-xml-properties/) file. It is used to register an interactive object with the navigation service controller and flag it as interactive for a specific navigation service. This element requires the following sub-elements:

1.  `<Descr>`
2.  `<ObjectReference />`
3.  `<CabinName>`
4.  `<Interactor>`

 

This element has the following parameters:

 

{{< table-wrapper >}}

| Attribute    | Description                                                                                                                                                                                                                                                  | Type   | Required |
|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|:--------:|
| `id`         | The unique identifier of the object element reference.                                                                                                                                                                                                       | String |    Yes   |
| `InstanceId` | The unique ID for the reference state action, as a [GUID](../mission-xml-files/mission-xml-properties/#) enclosed in {}. You can find more information on GUID's here: [GUIDs](../../introduction/using-the-sdk/#GUIDs) | String |    Yes   |

{{< /table-wrapper >}}


 

Example of how it would look in the XML:

``` xml
<CabinService.RegisterInteractorsToCabinServiceAction id="RegisterGenerator" InstanceId="{C6A43E09-29B4-49EB-B163-E419D5DB545D}">
    <Descr>Register Generator as interactive to loadworker service</Descr>
    <ObjectReference id="ApronContextReference:ApronControl" InstanceId="{0B6CFBA9-4A13-44E5-BB2A-A4175277E4E0}"/>
    <CabinName>LoadWorkerService</CabinName>
    <Interactor>
        <ObjectReference id="ApronContextReference:PowerGenerator" InstanceId="{C53FE0CC-BD97-4235-9C37-136BEF7BAA90}"/>
        <NodeTag>POWER_GENERATOR_ACCESS</NodeTag>
    </Interactor>
</CabinService.RegisterInteractorsToCabinServiceAction>
```

 

 

#### &lt;CabinName&gt;

This sub-element of `<CabinService.RegisterInteractorsToCabinServiceAction>` has no attributes and is used to define the navigation service to link the interaction with.

 

 

#### &lt;Interactor&gt;

This sub-element of `<CabinService.RegisterInteractorsToCabinServiceAction>` has no attributes and is used to define the interactive object to assign as the interactor in the navigation service. It requires the following sub-elements:

1.  `<ObjectReference />`
2.  `<NodeTag>`

 

 

### &lt;NodeTag&gt;

This element is used to supply the tag associated with one or more nodes that should be considered by the calling navigation service or calculator. It is used in the following elements:

1.  `<Interactor>`
2.  `<CabinServiceBehaviourParameter>`
3.  `<CabinServiceGraphParameter>`
4.  `<ParentCabinServiceBehaviourParameter>`