9e2ee8b969
This change automatically changes the view direction to look at a <marker> if any is defined for a checklist item or tutorial step. Both the tutorial and checklist features support a <marker> element which can be used by an aircraft developer to display a magenta circle around an item of interest (typically a control in the cockpit). Previously aircraft developers had to add a <view> element to move the viewpoint to look at the marker, while users of checklists had to look for the marker manually. Now: - For checklists, pressing the "?" button on a checklist will pan the viewpoint to the marker. - For tutorials, if there is not a <view> element defined for a tutorial step, the view will automatically pan to the marker.
54 lines
2.2 KiB
Text
54 lines
2.2 KiB
Text
CHECKLISTS
|
|
|
|
You can create one or more checklist for an aircraft under /sim/checklists. These
|
|
are intended to mimic the checklists of aircraft themselves, and can be found under
|
|
the Help->Checklists menu within the simulator.
|
|
|
|
Tutorials are automatically generated from checklists on startup.
|
|
|
|
Each checklist is defined as a property tree under /sim/checklists/checklist[n]
|
|
or /sim/checklists/group[n]/checklist[m]
|
|
|
|
with the following tags
|
|
|
|
<title> - Name of the checklist
|
|
<auto-tutorial> - Whether a tutorial should be automatically generated (true, default)
|
|
or not (false).
|
|
<page> - Zero or more pages for the checklist containing:
|
|
<item> - One or more checklist items containing:
|
|
<name> - name of the checklist item (e.g. Carb Heat), to appear on the left
|
|
<value> - One or more values for the checklist item, to appear on the right
|
|
hand side
|
|
<marker> - A tutorial marker (displayed when the user presses the ? button)
|
|
This can be easily placed using the Help->Display Tutorial Marker.
|
|
Contains x-m, y-m, z-m and scale tag. The view will automatically
|
|
change so the marker is in the center of the screen.
|
|
<condition> - Optional standard FlightGear condition node that evaluates when the
|
|
checklist item has been completed.
|
|
<binding> - Zero or more bindings to execute the checklist item. Allows the user
|
|
to have their virtual co-pilot perform the action if they select the
|
|
">" button next to the checklist item.
|
|
|
|
The <page> tag may be omitted for single-page checklists, with the <item> tags
|
|
immediately under the <checklist[n]> node.
|
|
|
|
Tutorial auto-generation of all checklists can be disabled by setting
|
|
/sim/checklists/auto-tutorials=false.
|
|
|
|
Checklists may be grouped under <group> nodes with a <name> tag decribing the
|
|
group. For example
|
|
|
|
<group>
|
|
<name>Emergency</name>
|
|
<auto-tutorial>false</auto-tutorial>
|
|
<checklist>...
|
|
<checklist>...
|
|
</group>
|
|
<group>
|
|
<name>Normal</name>
|
|
<auto-tutorial>true</auto-tutorial>
|
|
<checklist>...
|
|
<checklist>...
|
|
</group>
|
|
|
|
See the c172p for an example of this in action (Aircraft/c172p/c172-checklists.xml).
|