From e1b15dee4c250bf6509594e241eb2856c8d21e0f Mon Sep 17 00:00:00 2001 From: wm4 Date: Fri, 12 Oct 2012 09:21:26 +0200 Subject: 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. --- DOCS/man/en/input.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'DOCS/man') 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 [] Add the given value to the property. On overflow or underflow, clamp the property to the maximum. If is omitted, assume ``1``. -cycle [] - Cycle the given property. Negative values cycle the property backwards. On +cycle [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 is omitted, assume ``1``. + maximum. If ``up`` or ``down`` is omitted, assume ``up``. speed_mult Multiply the ``speed`` property by the given value. -- cgit v1.2.3