Skip to main content

Class: Noop

commands.Noop

Hierarchy

Constructors

constructor

new Noop(name?)

Parameters

NameTypeDescription
name?stringprovide only if you're using new Command() syntax. If you're extending command, just leave it empty - the name will be grabbed from class name.

Inherited from

Command.constructor

Accessors

name

get name(): string

Returns

string

Inherited from

Command.name

Methods

execute

execute(): Promise<void>

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, 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

NameType
stateState<Record<string, unknown>>
roomRoom<any, Record<string, unknown>>

Returns

Promise<void>

Inherited from

Command.undo