SimMission Navigation Services

The following Mission XML Properties are used when you want to manipulate Navigation Services in a mission.

 

 

<SimMission.CreateCabinServiceObject>

This sub-element of <WorldBase.Flight> is used to request that the navigation service creates all the specified behaviour objects using the parameters set in the FLT for the mission. This element has the following sub-elements:

1. <ObjectReference />: The object container that contains the navigation service
2. <ParamBehaviourName>: Name of the behaviour object

 

This element has the following attributes:

 

Attribute	Description	Type	Required
InstanceId	The unique ID for the element, as a GUID enclosed in {}. You can find more information on GUID's here: GUIDs	String	Yes

 

 

<SimMission.RemoveCabinServiceObject>

This sub-element of <WorldBase.Flight> is used to remove a specific type of behaviour object from the Navigation Service controller. This element has the following sub-elements:

1. <ObjectReference />: The object container that contains the navigation service
2. <ParamBehaviourName>: Name of the behaviour object
3. <ParamIsInCabin>: Filter used to decide which objects to remove based on location

 

This element has the following attributes:

 

Attribute	Description	Type	Required
InstanceId	The unique ID for the element, as a GUID enclosed in {}. You can find more information on GUID's here: GUIDs	String	Yes

 

<SimMission.SetCabinStateAction>

This sub-element of <WorldBase.Flight> is used to set the state of the given navigation state FSM. This element has the following sub-elements:

1. <ObjectReference />: The object container that contains the navigation service
2. <StateName>: The name of the new navigation service state (this name must exist in the navigation service XML)
3. <CabinServiceName>: The name of the navigation service to set the sate on
4. <ForceCabinServiceState>: Whether to force the navigation service state or not

 

This element has the following attributes:

 

Attribute	Description	Type	Required
InstanceId	The unique ID for the element, as a GUID enclosed in {}. You can find more information on GUID's here: GUIDs	String	Yes

 

 

<StateName>

The state name to set the navigation service FSM to. This name has to have been defined in the Navigation Services XML file.

 

<CabinServiceName>

The name of the navigation service to set the FSM state on.

 

<ForceCabinServiceState>

This can be used to force the cabin state by setting it to TRUE. If this element is not included then it will default to FALSE.

 

 

<SimMission.AddCabinServiceLink>

This sub-element of <WorldBase.Flight> is used to add one or more container objects to a navigation service, such that they become behaviour objects (linked to the behaviour states of the service FSM).

 

This element has the following sub-elements:

1. <ObjectReference />: The object container of the navigation service to link to
2. <TargetContainers>: The list of target object containers to be added as behaviour objects
3. <ParamBehaviourName>: The behaviour tag of the new behaviour objects

 

This element has the following attributes:

 

Attribute	Description	Type	Required
InstanceId	The unique ID for the element, as a GUID enclosed in {}. You can find more information on GUID's here: GUIDs	String	Yes

 

 

<TargetContainers>

This is a container element used in <SimMission.AddCabinServiceLink> to list one or more <ObjectReference />.

 

 

<ParamBehaviourName>

This element has no attributes and is a sub-element of:

1. <SimMission.CreateCabinServiceObject>
2. <SimMission.RemoveCabinServiceObject>
3. <SimMission.AddCabinServiceLink>
4. <CabinServiceBehaviourParameter>
5. <ParentCabinServiceBehaviourParameter>

 

It is used to define the name of a behaviour object.

 

 

<ParamBehaviourState>

This element has no attributes and is a sub-element of:

1. <CabinServiceBehaviourParameter>
2. <ParentCabinServiceBehaviourParameter>

 

It is used to define the name of a behaviour state.

 

 

<ParamBehaviourTask>

This element has no attributes and is a sub-element of:

1. <CabinServiceBehaviourParameter>
2. <ParentCabinServiceBehaviourParameter>

 

It is used to define the name of a behaviour task.

 

 

<ParamIsInCabin>

This is a sub-element of the following:

1. <SimMission.RemoveCabinServiceObject>
2. <CabinServiceBehaviourParameter>
3. <ParentCabinServiceBehaviourParameter>

 

The element is used to define from where the behaviour objects should be selected. It can only be one of the following strings:

• All: All objects are chosen
• OnlyInCabin: Only objects found in the cabin are chosen
• OnlyOutCabin: Only objects found outside the cabin are chosen