g:Property

Note that g:condition also uses g:property. But in g:condition, g:property refers to the property condition. Here, by g:property we refer to the FS property declaration.

Background

When Flight Simulator (FS) is running, it is possible to register to it and it starts send you information about the plane and simulation state. It has a set of predefined variables, calles SimVars. Once you register to a specific SimVar, FS will provide you information every second (or different time interval) or once the value of the SimVar change.

Look here to learn more about SimVars.

As SimVar readout is quite complex and have many initial parameters, g:properties is a concept allowing easy check of the SimVar value in the App.

Overview

g:Property is used in XML to define a mapping between a property name and the SimVar value of the airplane. For example, the following line defines a property named alt which will contain current airplane altitude in feet.

<g:property name="alt" description="Altitude" simVar="PLANE ALTITUDE" unit="foot" />

Here:

• name - defines the name of the property,

• description - describes the property

• simVar - defines the entry point in the Flight Simulator via so called SimVars, from where the value is read,

• unit - defines the unit of the variable (for example, the altitude can be in meters or feet).

Every property in the App must have unique name. However (although not suggested), properties with different name can be bound to the same simVar name.

Properties are declared:

• by default - the App have some predefined set of properties (see below)

• custom in XML file - checklists, copilot and other modules can define their own custom properties if necessary.

Predefined properties

In the App, there are several predefined properties. You can use any of them in g:property conditions directly without any additional work.

Plane Props

Name	Description	SimVar	Unit
alt	Altitude	PLANE ALTITUDE	foot
height		PLANE ALT ABOVE GROUND	foot
ias		AIRSPEED INDICATED	knot
gs		GROUND VELOCITY	knot
vs	Vertical speed	VERTICAL SPEED	feet/minute
bankAngle		PLANE BANK DEGREES	degree

Plane Lights

Name	SimVar
beaconLight	LIGHT BEACON
strobeLight	LIGHT STROBE
landingLights	LIGHT LANDING

Plane Systems

Name	SimVar
engine1Running	ENG COMBUSTION:1
engine2Running	ENG COMBUSTION:2
engine3Running	ENG COMBUSTION:3
engine4Running	ENG COMBUSTION:4

Plane Attitude

Name	SimVar	Unit
parkingBrakeSet	BRAKE PARKING POSITION	0 = not set; 1 = set
pushbackTugConnected	PUSHBACK ATTACHED	0 = no; 1 = yes

Plane Orientation

Name	SimVar	Unit
acceleration	ACCELERATION BODY Z	knot

Note that this is not final list and other properties may be added in the future.

Note that you can adjust the global predefined properties in SimProperties.xml file.

Custom Properties

In several files (like checklists, failures or copilot speeches) you can define your own property declaration in the appropriate section. The XML syntax is:

<g:property 
  name="vs" 
  description="Vertical speed" 
  simVar="VERTICAL SPEED" 
  unit="feet/minute"/>

The xml attributes are:

• name - global unique name of the property. If the property name is duplicit (together among predefined or all custom properties), the App will crash. Mandatory.

• description - simple property explanation or description. Used when property name is too short or confusing. Optional.

• simVar - a name of FS SimVar to which the property is bound to. The SimVar property must be known and exist in FS. Mandatory.

• unit - an unit in which the property value is presented. The predefined values must match those defined as valid units in FS SimVars. Optional, if not used, FS SimVar default unit is used.

Examples:

<g:property name="gs" simVar="GROUND VELOCITY" unit="knot" />
<g:property name="vs" description="Vertical speed" simVar="VERTICAL SPEED" unit="feet/minute"/>
<g:property name="bankAngle" simVar="PLANE BANK DEGREES" unit="degree" />