Class: ChangeParent
commands.ChangeParent
Hierarchy
↳
ChangeParent
Constructors
constructor
• new ChangeParent(entities
, target
, options?
)
Parameters
Name | Type |
---|---|
entities | Targets <ChildTrait > |
target | Target <ParentTrait > |
options | ChangeParentOptions |
Overrides
Accessors
name
• get
name(): string
Returns
string
Inherited from
Command.name
Methods
execute
▸ execute(state
): Promise
<void
>
Parameters
Name | Type |
---|---|
state | State <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
): 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 >> |
Returns
Promise
<void
>