Class CommandGroup`Abstract`

A type of command which groups other commands and runs them together.

Hierarchy

CommandBase
- CommandGroup
  - ParallelCommandGroup
  - SequentialCommandGroup

Index

Constructors

Properties

_requirements commands

Accessors

Methods

addRequirements execute then

Constructors

constructor

new CommandGroup(commands: Command[]): CommandGroup
Parameters
- commands: Command[]
Returns CommandGroup
Overrides CommandBase.constructor
- Defined in src/server/command/command.ts:75

Properties

`Protected` _requirements

_requirements: Set<object> = ...

`Readonly` commands

commands: Command[]

Accessors

requirements

get requirements(): Set<object>
The set of objects that this command requires to execute. Used to place mutexes on common resources to ensure they don't receive multiple inputs at once.

Returns Set<object>
Inherited from CommandBase.requirements
- Defined in src/server/command/command.ts:46

Methods

`Protected` addRequirements

addRequirements(reqs: object[]): void
A utility method for adding multiple requirements at once.
Parameters
- reqs: object[]
Returns void
Inherited from CommandBase.addRequirements
- Defined in src/server/command/command.ts:53

`Abstract` execute

execute(): Promise<void>
Executes the command.

Returns Promise<void>
Inherited from CommandBase.execute
- Defined in src/server/command/command.ts:40

then

then(next: Command): SequentialCommandGroup
Implicitly wraps a Command into a Sequential Command.
Parameters
- next: Command
  
  The command which is run next.
Returns SequentialCommandGroup
Inherited from CommandBase.then
- Defined in src/server/command/command.ts:42

Generated using TypeDoc