Sequence api - xkp/Doc GitHub Wiki

Overview

Sequences are units of execution, they will run for a certain amount of time (could be forever) and they will do the deeds you want them to, at the appropriate times. Sequences have the following properties:

  • Controllable: you decide when your sequences are allowed to be running, use methods start, stop, and pause.
  • Parametric: Sequences are everyday objects, you can define them as many properties as needed.
  • Reusable: You can define classes out of sequences, and reuse them at will. Pair this with how parametric the sequences are and you get a pretty flexible system.
  • Nested: You can have sequences within sequences, it is the parent's responsibility to start/stop child sequences.

Properties

id: Mandatory, indicates the name of the sequence

running: Whether the sequence is running or not

Methods

start: the sequence will start running, will do nothing if already running

stop: the sequence will stop running if it is

pause: the sequence will pause

Usage

<sequence id="my_sequence">
   ...
</sequence>
⚠️ **GitHub.com Fallback** ⚠️