X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=documentation_en.md;h=ac12909142ff535285ba2ff401ac3550016fae02;hb=b798117bb79038ae7495ea4fdb5254d15c7e4b63;hp=1cf5cfdc2e587e4c6476134a255acd681b329e7d;hpb=16847231fa5a85cbb0f792e6e461392879047c36;p=perso%2FImmae%2FProjets%2FPython%2FMusicSampler.git diff --git a/documentation_en.md b/documentation_en.md index 1cf5cfd..ac12909 100644 --- a/documentation_en.md +++ b/documentation_en.md @@ -225,6 +225,12 @@ protected for 2 seconds after each stroke. - `repeat_delay: x` (default 0) : protection delay. Once all its actions are done, the key will remain disabled (semi-transparent and crossed) for that amount of time (in seconds). +- `actions: list`: List of actions to run with the key. + +#### `common` key property + +A special entry `common` has its properties applying to all the keys. They can +be overriden individually. ### `keys` : actions related to keys @@ -232,6 +238,8 @@ This section lets you describe for each key, the list of actions associated to it. Note that except for `wait` and some particular cases (see below), all the actions are almost instantaneous. +*This section is deprecated and replaced by an `actions` key containing a list +in `key_properties` section for each key.* #### Examples @@ -381,9 +389,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` : gives the id of the `wait` to interrupt (defined with - `set_wait_id`, see actions `wait` and `stop`). To interrupt several waits, - use the same action several times. + * `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