Skip to main content

Class: ShuffleChildren

commands.ShuffleChildren

Hierarchy

Constructors

constructor

new ShuffleChildren(container)

Parameters

NameType
containerTarget<ParentTrait>

Overrides

Command.constructor

Properties

target

target: TargetHolder<ParentTrait>

Accessors

name

get name(): string

Returns

string

Inherited from

Command.name

Methods

execute

execute(state): Promise<void>

Parameters

NameType
stateState<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

NameType
stateState<Record<string, unknown>>
roomRoom<State<Record<string, unknown>>, Record<string, unknown>>
commandCommand<State<Record<string, unknown>>>

Returns

Promise<void>

Inherited from

Command.subExecute


undo

undo(state): 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

NameType
stateState<Record<string, unknown>>

Returns

Promise<void>

Overrides

Command.undo