wait actions are now pausable and resettable

[perso/Immae/Projets/Python/MusicSampler.git] / documentation_en.md

diff --git a/documentation_en.md b/documentation_en.md
index 899ef1ad77ba8eda0fc58a8073fe0ca30dc652b5..e92b85c60d69a53cd489336c9fb0dae722440749 100644 (file)
--- 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