Class: Sequence

commands.Sequence

Hierarchy

• Command

  ↳ Sequence

Constructors

constructor

• new Sequence(name, subCommands)

Parameters

Name	Type	Description
name	string	name this Sequence (useful for debugging)
subCommands	Command<State<Record<string, unknown>>>[]

Overrides

Command.constructor

Accessors

name

• get name(): string

Returns

string

Inherited from

Command.name

Methods

execute

▸ execute(state, room): Promise<void>

Run only registered sub commands. An un-doing of these will be handled by parent class Command

Parameters

Name	Type
state	State<Record<string, unknown>>
room	Room<any, Record<string, unknown>>

Returns

Promise<void>

Overrides

Command.execute

---

subExecute

▸ Protected subExecute(state, room, command): Promise<void>

Execute a sub command. Call ONLY during your commands execute method. Will also remember it internally for undoing.

Parameters

Name	Type
state	State<Record<string, unknown>>
room	Room<State<Record<string, unknown>>, Record<string, unknown>>
command	Command<State<Record<string, unknown>>>

Returns

Promise<void>

Inherited from

Command.subExecute

---

undo

▸ undo(state, room): Promise<void>

Undoes every remembered extra sub command. Command may gather new sub commands only while executing. Sequence will only gather sub commands upon construction.

Parameters

Name	Type
state	State<Record<string, unknown>>
room	Room<any, Record<string, unknown>>

Returns

Promise<void>

Inherited from

Command.undo