diff options
Diffstat (limited to 'documentation_en.md')
-rw-r--r-- | documentation_en.md | 19 |
1 files changed, 16 insertions, 3 deletions
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. | |||
386 | action. When false, it is thus useless to add actions after that one. | 386 | action. When false, it is thus useless to add actions after that one. |
387 | - `interrupt_wait`: stop a wait event (normal `wait` or fade out wait). The keys | 387 | - `interrupt_wait`: stop a wait event (normal `wait` or fade out wait). The keys |
388 | that were waiting will move to the next actions. Parameters: | 388 | that were waiting will move to the next actions. Parameters: |
389 | * `wait_id: name` (optional) gives the id of the `wait` to interrupt (defined with | 389 | * `wait_id: name` (optional) gives the id of the `wait` to interrupt |
390 | `set_wait_id`, see actions `wait` and `stop`). If not given, interrupts | 390 | (defined with `set_wait_id`, see actions `wait` and `stop`). If not given, |
391 | all wait events. | 391 | interrupts all wait events. |
392 | - `pause_wait`: pauses a wait event (only for a wait with duration). The key | ||
393 | that were waiting will keep waiting until the `wait` is unpaused. Parameters: | ||
394 | * `wait_id: name` (optional) gives the id of the `wait` to pause. If not | ||
395 | given, pauses all compatible wait events. | ||
396 | - `unpause_wait`: unpauses a paused wait event (only a wait with duration). The | ||
397 | countdown will resume for the corresponding keys. Parameters: | ||
398 | * `wait_id: name` (optional) gives the id of the `wait` to unpause. If not | ||
399 | given, unpauses all compatible wait events. | ||
400 | - `reset_wait`: resets a wait counter (only a wait with duration). If the wait | ||
401 | was paused, it will stay paused and start at the beginning once it is | ||
402 | unpaused. Parameters: | ||
403 | * `wait_id: name` (optional) gives the id of the `wait` to reset. If not | ||
404 | given, resets all compatible wait events. | ||
392 | - `run_command` : Run a command. Parameters: | 405 | - `run_command` : Run a command. Parameters: |
393 | * `command: my_command` : Gives the command to run. | 406 | * `command: my_command` : Gives the command to run. |
394 | * `wait: true/false` (optional, default false) if true, waits for the | 407 | * `wait: true/false` (optional, default false) if true, waits for the |