<SimMission.FocusInstrumentAction>
This element is a container for setting up an action to focus on a particular instrument in the cockpit. This element is used as part of the XML file used to generate a mission. Full information on this file can be found here:
The element has the following parameters:
Attribute | Description | Type | Required |
---|---|---|---|
InstanceId |
The unique ID for the focus action, as a GUID enclosed in {} . |
String | Yes |
id |
A unique ID string for the focus action. | String | No |
VRDependency |
When set to TRUE, this sets the action as being VR dependent. Default is FALSE. | Bool | No |
This element can also contain any of the following sub-elements, sometimes multiple times: <Descr>
, <Immediate>
, <SetHighlight>
, <FocusDuration>
, <SetCamera>
, <InstrumentPartId>
, <InstrumentHtmlId>
.
<SetHighlight>
This element is a sub-element of <SimMission.FocusInstrumentAction>
and is used to set whether the instrument the action is focusing on should be highlighted (TRUE) or not (FALSE). The element has no attributes and is TRUE by default.
<FocusDuration>
This element is a sub-element of <SimMission.FocusInstrumentAction>
and is used to set the duration that the instrument should be focused on when the action is triggered. The value is in seconds and setting the value to -1 will mean that the instrument is focused for an "infinite" time, ie: until some other action cancels it. The element has no attributes and is -1 by default.
<SetCamera>
This element is a sub-element of <SimMission.FocusInstrumentAction>
and is used to say whether the action sets the camera (TRUE) or not (FALSE). The element has no attributes and is FALSE by default.
<InstrumentPartId>
This element is a sub-element of <SimMission.FocusInstrumentAction>
and is used tell the action the Part ID of the instrument that you want the action to focus on. The element has no attributes.
<InstrumentHtmlId>
This element is a sub-element of <SimMission.FocusInstrumentAction>
and is used tell the action the ID of the cockpit HTML instrument that you want the action to focus on. The element has no attributes.