Bindings

From FlightGear wiki
(Redirected from Fgcommands)
Jump to navigation Jump to search

Bindings define what happens when a user:

In other words, bindings are simply the term for actions that are associated with certain events in FlightGear.

There are different types of events supported by various subsystems, but the resulting action that can be triggered will typically involve either a hard-coded command (a so called fgcommand), or a block of scripted code (using Nasal). Bindings can be parameterized / customized using properties as arguments that are passed to each binding as a props.Node object. And Nasal code can also be registered to become available as a dedicated fgcommand.

An object, button or key can have multiple bindings assigned to them. The bindings will be executed in the order in which they appear in the XML file. Bindings may contain conditions to make them conditionally executed. Each binding must specify a command node with its particular type, see below.


Note  Aircraft are free to override key bindings to fullfill their needs. The Space Shuttle for instance has no mixture control, so the m-key switches from translational to rotational hand controller.

The key only performs as mixture control if the plane has mixture settings and if the plane didn't re-assign the key - so dependent on what plane you try, it may or may not. Usually the aircraft-specific help spells it out.[1]

This article gives a small overview of frequently used bindings. Please refer to $FG_ROOT/Docs/README.commands for additional information and refer to $FG_SRC/Main/commands.cxx for a complete list of available bindings.

All given codes are examples, found on various places in the FlightGear package.

Commands

Below are some useful commands, some also with their equivalent Nasal call. A more complete listing can be found in the readme file, $FG_ROOT/Docs/README.commands.

To learn more about adding your own custom fgcommands to the source code, see Howto:Add new fgcommands to FlightGear.

replay

Toggles replay. 

<binding>
  <command>replay</command>
</binding>

fgcommand("replay");

dialog-close

Closes the active dialog. 

<binding>
  <command>dialog-close</command>
</binding>

fgcommand("dialog-close");

To close a specific dialog use for example: 

fgcommand("dialog-close", props.Node.new({"dialog-name": "chat-full"}));

dialog-show

Shows a dialog, which should be present in $FG_ROOT/gui/dialogs. In addition, from FlightGear 2.8, dialog files located in <aircraft directory>/gui/dialogs are also loaded. This should be used for dialogs specific to a certain aircraft. 

<binding>
  <command>dialog-show</command>
  <dialog-name>location-in-air</dialog-name>
</binding>

fgcommand("dialog-show", props.Node.new({"dialog-name": "location-in-air"}));
dialog-name
The name of the dialog, as designated in its XML file.

nasal

Nasal is frequently used for complicated systems, because it can execute virtually any function and allows running previously-defined Nasal functions. 

<binding>
  <command>nasal</command>
  <script>b777.afds.input(0,1);</script>
</binding>
script
The Nasal script to execute.
Note Make sure that the script does not conflict with the predefined XML entities This is a link to a Wikipedia article. If it does, you can either put it in a CDATA section This is a link to a Wikipedia article or use a non-interpreted version (e.g., &gt; in place of >).

The cmdarg() function is often useful in these situations to extract offset values passed to the binding. It returns the specific <binding> node, which contains a <setting> node at runtime if used in a joystick axis that represents the value of that axis.

In joysticks and keyboard keys, the script is run in a specific namespace; please see Howto:Understand Namespaces and Methods for more information on namespaces.

property-adjust

Increases or decreases a property's value with a given step. Maximum and minimum values are optional. 

<binding>
  <command>property-adjust</command>
  <property>/autopilot/settings/heading-bug-deg</property>
  <step>1</step>
  <min>0</min>
  <max>360</max>
  <wrap>true</wrap>
</binding>
property
Property that will be changed.
step
Amount to increase or decrease the property's value. Defaults to 0.
offset
Offset from the property's current value. If step is not given, this is multiplied by factor.
factor
When step is not given, offset is multiplied by this. Defaults to 1.
min
The minimum allowed value. Defaults to "no minimum."
max
The maximum allowed value. Defaults to "no maximum."
wrap
If true, the value will be wrapped when it passes min or max; both min and max must be present for this to work. Defaults to false.:
Note  When wrap is set to true, the max parameter must be set to the desired maximum value + step or factor in order to work correctly !
mask
This argument accepts three value: integer, decimal and all (default). integer means that step or offset * factor is applied to the part of the property's current value left of the decimal point first. decimal does the same, but applies it to the part to the right of the decimal point. all simply applies it to the whole number. This is especially useful for COM / NAV radio frequency knobs - use integer for the outer (big) knob and decimal for the inner (small) knob.

property-assign

One of the most important commands. It sets a property to a predefined value or to the value of another property.[2] 

<binding>
  <command>property-assign</command>
  <property>/autopilot/settings/target-speed-kt</property>
  <value>0</value>
</binding>

or

<binding>
  <command>property-assign</command>
  <property>autopilot/input/hdg</property>
  <property>instrumentation/heading-indicator/hdg-autopilot</property>
</binding>

property-cycle

Cycles between a list of values and assigns one to a property. The value-list can vary in length. If the current value is value1, it will change to value2; if it is value2, it will change to value3, and so on. If the current value is not in the list, it will jump to the first one. 

<binding>
  <command>property-cycle</command>
  <property>/autopilot/autobrake/setting</property>
  <value type="string">ARM</value>
  <value type="string">DISARM</value>
  <value type="string">OFF</value>
</binding>

As of May 2013, the command supports additional behaviours to simplify use with the new knob and slider animations. The wrapping behaviour can be disabled by setting <wrap>0</wrap>, and the command uses the offset argument to select a direction of movement. This means a property-cycle bound to a multi-position knob will function as expected for movement in both directions.

property-interpolate

Interpolates to a value with a given rate of change (per second). 

<binding>
  <command>property-interpolate</command>
  <property>/controls/flight/aileron-trim</property>
  <value type="double">0</value>
  <rate>0.5</rate><!-- 2 seconds to 0 from 1 or -1 -->
</binding>

Instead of using <rate>, one could use <time>

<binding>
  <command>property-interpolate</command>
  <property>/controls/flight/aileron-trim</property>
  <value type="double">0</value>
  <time>2</time><!-- 2 seconds to 0 from 1, 0.5, -1 etc. -->
</binding>

You can also interpolate to a value given by a property. 

<binding>
  <command>property-interpolate</command>
  <property>/controls/flight/aileron-trim</property>
  <property>/controls/flight/default-aileron-trim</property><!-- the value to interpolate to, is 0 -->
  <rate>0.5</rate><!-- 2 seconds to 0 from 1 or -1 -->
</binding>

property-multiply

Multiply the value of a property by a given factor. 

<binding>
  <command>property-multiply</command>
  <property>/controls/flight/aileron</property>
  <factor>0.5</factor>
  <min>-1</min>
  <max>1</max>
  <mask>all</mask>
  <wrap>true</wrap>
</binding>
  • factor: the amount to multiply by.
  • min: minimum value.
  • max: maximum value.
  • mask:
    • integer: mutiply only left of the decimal point.
    • decimal: multiply only the right of the decimal point.
    • all: multiply the entire value.
  • wrap: true if the value should be wrapped if it passes min/max. It is required to set both min and max in that case.

property-randomize

Assigns a random value (between min and max) to a property. 

<binding>
  <command>property-randomize</command>
  <property>/orientation/pitch-deg</property>
  <min>0</min>
  <max>360</max>
</binding>

property-scale

Set the value of a property based on an axis, often used in joystick configuration files. 

<binding>
  <command>property-scale</command>
  <property>/controls/flight/aileron</property>
  <offset>0.001</offset>
  <factor>-1</factor>
  <power>3</power>
</binding>
  • setting: the current input setting (usually a joystick axis from -1 or 0 to 1)
  • offset: the offset to shift by, before applying the factor.
  • factor: the factor to multiply by (use negative to reverse).
  • squared: if true will square the resulting value (same as power=2).
  • power: the resulting value will be taken to the power of this integer value (overrides squared).

Remember: (property ^ power + offset) * factor = result

property-swap

Swaps the values of two properties, useful for radio panels. 

<binding>
  <command>property-swap</command>
  <property>/instrumentation/comm/frequencies/selected-mhz</property>
  <property>/instrumentation/comm/frequencies/standby-mhz</property>
</binding>

property-toggle

Toggles the value of a property on each click, between true (1) and false (0): 

<binding>
  <command>property-toggle</command>
  <property>/controls/gear/gear-down</property>
</binding>

Or - if defined - it toggles between two custom values: 

<binding>
  <command>property-toggle</command>
  <property>/controls/gear/gear-down</property>
  <value>2</value>
  <value>3</value>
</binding>

request-metar

Cquote1.png 
fgcommand("request-metar", props.Node.new({"path": "/foo/mymetar", "station": "LOWI"}));

If you pass an existing path, the station ID will be updated, and if you pass the same station ID as before, no additional request is made. As usual for metar-properties, there's a time-to-live and valid flags you can check, and the metar refreshes automatically every 900 seconds. You can also write to the station ID directly to change station, update the time-to-live, and wait for the valid signal.

There's also an unregister command ('clear-metar') to cancel the binding into the property tree.[3]
— James Turner
 Cquote2.png
  1. ↑ Thorsten  (Nov 9th, 2016).  Re: trouble with m-key .
  2. ↑ flightgear/flightgear/next/src/Main/fg_commands.cxx#l446
  3. ↑ James Turner (Sun, 23 Sep 2012 08:56:48 -0700). [Flightgear-devel] Requesting arbitrary metar.

Related content

Wiki

Forum topics

Readme file

Source

Note that many commands are defined elsewhere. The readme file has a more complete listing.

Retrieved from "https://wiki.flightgear.org/w/index.php?title=Bindings&oldid=140140"