summaryrefslogtreecommitdiffstatshomepage
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/source/luascript/ref-input.rst45
1 files changed, 41 insertions, 4 deletions
diff --git a/docs/source/luascript/ref-input.rst b/docs/source/luascript/ref-input.rst
index 840e0a3ff5f..96d31fca6c1 100644
--- a/docs/source/luascript/ref-input.rst
+++ b/docs/source/luascript/ref-input.rst
@@ -269,6 +269,20 @@ field:set_value(value)
field:clear_value()
Clear programmatically overridden value and restore the field’s regular
behaviour.
+field:set_sensitivity(sensitivity)
+ Set the sensitivity or gain for analog fields. Raises an error for digital
+ fields.
+field:set_keydelta(sensitivity)
+ Set the sensitivity to corresponding digital increment/decrement inputs for
+ analog fields. Raises an error for digital fields.
+field:set_centerdelta(sensitivity)
+ Set the speed at which non-wrapping analog fields return to their default
+ values after associated digital increment/decrement inputs are released.
+ Raises an error for digital fields and wrapping analog fields.
+field:set_analog_reverse(reverse)
+ Set whether an analog field’s value increases in the opposite direction to
+ the convention (e.g. larger values when a pedal is released or a joystick is
+ moved to the left). Raises an error for digital fields.
field:set_input_seq(seqtype, seq)
Set the :ref:`input sequence <luascript-ref-inputseq>` for the specified
sequence type. This is used to configure per-machine input settings. The
@@ -319,6 +333,33 @@ field.maxvalue (read-only)
The maximum allowed value for analog fields, or ``nil`` for digital fields.
field.sensitivity (read-only)
The sensitivity or gain for analog fields, or ``nil`` for digital fields.
+field.default_sensitivity (read-only)
+ The default sensitivity or gain for analog fields, or ``nil`` for digital
+ fields.
+field.keydelta (read-only)
+ The sensitivity to corresponding digital increment/decrement inputs for
+ analog fields, or ``nil`` for digital fields.
+field.default_keydelta (read-only)
+ The default sensitivity to corresponding digital increment/decrement inputs
+ for analog fields, or ``nil`` for digital fields.
+field.centerdelta (read-only)
+ The speed at which non-wrapping analog fields return to their default values
+ after associated digital increment/decrement inputs are released, or ``nil``
+ for digital fields and wrapping analog fields.
+field.default_centerdelta (read-only)
+ The default speed at which non-wrapping analog fields return to their
+ default values after associated digital increment/decrement inputs are
+ released, or ``nil`` for digital fields and wrapping analog fields.
+field.analog_reverse (read-only)
+ A Boolean indicating whether the field corresponds to an analog control that
+ increases in the opposite direction to the convention (e.g. larger values
+ when a pedal is released or a joystick is moved to the left), or ``nil`` for
+ digital fields.
+field.default_analog_reverse (read-only)
+ A Boolean indicating whether the field corresponds to an analog control that
+ increases in the opposite direction to the convention by default (e.g.
+ larger values when a pedal is released or a joystick is moved to the left),
+ or ``nil`` for digital fields.
field.way (read-only)
The number of directions allowed by the restrictor plate/gate for a digital
joystick, or zero (0) for other inputs.
@@ -339,10 +380,6 @@ field.cocktail (read-only)
field.toggle (read-only)
A Boolean indicating whether the field corresponds to a hardware toggle
switch or push-on, push-off button.
-field.analog_reverse (read-only)
- A Boolean indicating whether the field corresponds to an analog control that
- increases in the opposite direction to the convention (e.g. larger values
- when a pedal is released or a joystick is moved to the left).
field.analog_reset (read-only)
A Boolean indicating whether the field corresponds to an incremental
position input (e.g. a dial or trackball axis) that should be reset to zero