Class CommandBase`Abstract`

A command base class. Used to circumvent TypeScript abstract/interface weirdness by providing a version of Command which can be extended with attributes and constructors.

Hierarchy

CommandBase
- RobotCommand
- CommandGroup

Implements

Command

Index

Constructors

Properties

Accessors

Methods

addRequirements execute then

Constructors

constructor

new CommandBase(): CommandBase
Returns CommandBase

Properties

`Protected` _requirements

_requirements: Set<object> = ...

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>
Implementation of Command.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
- Defined in src/server/command/command.ts:53

`Abstract` execute

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

Returns Promise<void>
Implementation of Command.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
Implementation of Command.then
- Defined in src/server/command/command.ts:42

Generated using TypeDoc