path: root/DOCS
diff options
authorwm4 <wm4@nowhere>2012-10-12 09:21:26 +0200
committerwm4 <wm4@nowhere>2012-10-12 10:13:43 +0200
commite1b15dee4c250bf6509594e241eb2856c8d21e0f (patch)
tree180e8796a5e79b9f18fb08193db2e3ca0e8a16f3 /DOCS
parent32fe890cc1f9c90699fb9cd9eb5f42e597d9665a (diff)
commands: use "up" and "down" as 2nd argument for cycle command
Allow the values "up" and "down" as step argument for the cycle input command. Previously, this argument was a float, which specified an arbitrary step value and direction (similar to the add command). Instead of "1" and "-1", "up" and "down" is to be used. Float values are still accepted. That capability might be removed in the future, as there's probably hardly any actual use for arbitrary step values.
Diffstat (limited to 'DOCS')
1 files changed, 3 insertions, 3 deletions
diff --git a/DOCS/man/en/input.rst b/DOCS/man/en/input.rst
index db16697bd7..58565f0267 100644
--- a/DOCS/man/en/input.rst
+++ b/DOCS/man/en/input.rst
@@ -79,10 +79,10 @@ add <property> [<value>]
Add the given value to the property. On overflow or underflow, clamp the
property to the maximum. If <value> is omitted, assume ``1``.
-cycle <property> [<value>]
- Cycle the given property. Negative values cycle the property backwards. On
+cycle <property> [up|down]
+ Cycle the given property. ``up`` and ``down`` set the cycle direction. On
overflow, set the property back to the minimum, on underflow set it to the
- maximum. If <value> is omitted, assume ``1``.
+ maximum. If ``up`` or ``down`` is omitted, assume ``up``.
speed_mult <value>
Multiply the ``speed`` property by the given value.