From d4217fda2ff3991eb1ee9a9bec6acff751798507 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isma=C3=ABl=20Bouya?= Date: Fri, 12 Aug 2016 18:21:22 +0200 Subject: wait actions are now pausable and resettable This fixes https://git.immae.eu/mantisbt/view.php?id=6 --- documentation_en.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) (limited to 'documentation_en.md') diff --git a/documentation_en.md b/documentation_en.md index 899ef1a..e92b85c 100644 --- a/documentation_en.md +++ b/documentation_en.md @@ -386,9 +386,22 @@ actions. action. When false, it is thus useless to add actions after that one. - `interrupt_wait`: stop a wait event (normal `wait` or fade out wait). The keys that were waiting will move to the next actions. Parameters: - * `wait_id: name` (optional) gives the id of the `wait` to interrupt (defined with - `set_wait_id`, see actions `wait` and `stop`). If not given, interrupts - all wait events. + * `wait_id: name` (optional) gives the id of the `wait` to interrupt + (defined with `set_wait_id`, see actions `wait` and `stop`). If not given, + interrupts all wait events. +- `pause_wait`: pauses a wait event (only for a wait with duration). The key + that were waiting will keep waiting until the `wait` is unpaused. Parameters: + * `wait_id: name` (optional) gives the id of the `wait` to pause. If not + given, pauses all compatible wait events. +- `unpause_wait`: unpauses a paused wait event (only a wait with duration). The + countdown will resume for the corresponding keys. Parameters: + * `wait_id: name` (optional) gives the id of the `wait` to unpause. If not + given, unpauses all compatible wait events. +- `reset_wait`: resets a wait counter (only a wait with duration). If the wait + was paused, it will stay paused and start at the beginning once it is + unpaused. Parameters: + * `wait_id: name` (optional) gives the id of the `wait` to reset. If not + given, resets all compatible wait events. - `run_command` : Run a command. Parameters: * `command: my_command` : Gives the command to run. * `wait: true/false` (optional, default false) if true, waits for the -- cgit v1.2.3