Class: ToggleSelection

commands.ToggleSelection

Hierarchy

• Command

  ↳ ToggleSelection

Constructors

constructor

• new ToggleSelection(parent, idx?)

Toggle selection marking of items

Parameters

Name	Type	Description
parent	Target<ParentSelecta>	target parent of child elements you want to toggle selection
idx?	number | number[]	single number or array of all indexes to toggle. Omit to TOGGLE ALL. These are not "selection indexes" but entity's index in its parent.

Overrides

Command.constructor

Accessors

name

• get name(): string

Returns

string

Inherited from

Command.name

Methods

execute

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

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>

Overrides

Command.undo