Bindings: Difference between revisions

=== dialog-close ===

Closes the active dialog.

=== dialog-show ===

Shows a dialog, which should be present in <tt>[[$FG ROOT]]/gui/dialogs</tt>. Starting with FlightGear 2.7 dialog files located in <tt><Current aircraft directory>/gui/dialogs</tt> are also loaded. This should be used for dialogs specific to a certain aircraft.

* '''dialog-name:''' the name of the dialog, as designated in its .xml file.

=== nasal ===

[[Nasal]] is frequently used for complicated systems.

The cmadarg() function is often useful in these situations to extract offset values passed to the binding.

=== property-adjust ===

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

=== property-assign ===

One of the most important commands. It sets a property to a predefined value.

=== 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, wrapping around the end.  If the current value is not in the list, it will jump to the first one.

As of May 2013, the command supports additional behaviours to simplify use with the new [[Knob_/_slider_animation|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-multiply ===

Multiply the value of a property by a given factor.

*'''factor:''' the amount to multiply by.

*'''min:''' minimum value.

=== property-randomize ===

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

=== property-scale ===

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

* '''offset:''' the offset to shift by, before applying the factor.

=== property-swap ===

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

=== property-toggle ===

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

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

===request-metar ===