Bindings: Difference between revisions

Jump to navigation Jump to search
56 bytes removed ,  27 October 2015
→‎property-adjust: Finish docing
(Doc property-adjust params)
(→‎property-adjust: Finish docing)
Line 68: Line 68:
   <command>property-adjust</command>
   <command>property-adjust</command>
   <property>/autopilot/settings/heading-bug-deg</property>
   <property>/autopilot/settings/heading-bug-deg</property>
   <step>1</step>    <!-- will add 1 to /autopilot/settings/heading-bug-deg whenever this binding is called -->
   <step>1</step>
   <min>000</min>    <!-- the property will never be allowed to go below 0 -->
   <min>0</min>
   <max>360</max>    <!-- ...or above 360 -->
   <max>360</max>
   <wrap>true</wrap> <!-- when we hit 361, wrap back to 0 and vice-versa -->
   <wrap>true</wrap>
</binding>
</binding>
</syntaxhighlight>
</syntaxhighlight>
Line 81: Line 81:
; min      : The minimum allowed value. Defaults to "no minimum."
; min      : The minimum allowed value. Defaults to "no minimum."
; max      : The maximum allowed value. Defaults to "no maximum."
; max      : The maximum allowed value. Defaults to "no maximum."
<!-- To be researched (Red Leader, 27/10/15)
; mask    : This argument has three accepted value: "integer," "decimal" and "all" (default). "Integer" applies only to the left of the decimal point, "decimal" applies to the right of the decimal point, and "all" applies to the whole number.
-->
; 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.
; 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.
; 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 prt to the right of the decimal point. "all" simply applies it to the whole number. This parameter does not seem to affect the resulting new value of the property, and so is not needed.


=== property-assign ===
=== property-assign ===

Navigation menu