Class CommandManager

Implements

Service

Index

Constructors

Methods

dispatchCommand getCommand getCommands getCommandsList getDispatcher registerCommand

Lifecycle

Constructors

constructor

new CommandManager(server: Server): CommandManager
Parameters
- server: Server
Returns CommandManager
- Defined in packages/prismarine/src/command/CommandManager.ts:21

Methods

dispatchCommand

dispatchCommand(
    sender: Player,
    target: Player | Entity,
    input?: string,
): Promise<void>
Dispatches a command and executes them.
Parameters
- sender: Player
  the player/console who executed the command
- target: Player | Entity
  the Player/entity/console who should execute the command
- input: string = ''
  the command input including arguments
Returns Promise<void>
- Defined in packages/prismarine/src/command/CommandManager.ts:209

getCommand

getCommand(id: string): Command
Get a registered command by ID.
Parameters
- id: string
  The command ID.
Returns Command
The command if found, otherwise undefined.

Remarks
This is case-insensitive, works with or without namespace, and also with aliases.
- Defined in packages/prismarine/src/command/CommandManager.ts:96

getCommands

getCommands(): Map<string, Command>
Get all enabled commands.

Returns Map<string, Command>
- Defined in packages/prismarine/src/command/CommandManager.ts:115

getCommandsList

getCommandsList(): [string, any, CommandArgument[][]][]
Get a list of all command variants.

Returns [string, any, CommandArgument[][]][]

Remarks
This is EXCLUDING legacy commands.
- Defined in packages/prismarine/src/command/CommandManager.ts:125

getDispatcher

getDispatcher(): CommandDispatcher<Player>
Get dispatcher

Returns CommandDispatcher<Player>
- Defined in packages/prismarine/src/command/CommandManager.ts:198

registerCommand

registerCommand(command?: Command): Promise<void>
Register a command into command manager by class.
Parameters
- Optionalcommand: Command
  The command class to register
Returns Promise<void>
- Defined in packages/prismarine/src/command/CommandManager.ts:71

Lifecycle

disable

disable(): Promise<void>
On disable hook.

Returns Promise<void>
Implementation of Service.disable
- Defined in packages/prismarine/src/command/CommandManager.ts:62

enable

enable(): Promise<void>
On enable hook.

Returns Promise<void>
Implementation of Service.enable
- Defined in packages/prismarine/src/command/CommandManager.ts:30