Class: Select
commands.Select
Hierarchy
↳
Select
Constructors
constructor
• new Select(parent, idx?)
Mark items as selected
Parameters
| Name | Type | Description |
|---|---|---|
parent | Target<ParentSelecta> | target parent of child elements you want to select |
idx? | number | number[] | single number or array of all entity indexes to select. Omit to SELECT ALL. These are not "selection indexes" but entity's index in its parent. |
Overrides
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
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
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>