CommandMapping
Class: CommandMapping
Defined in: commandMapping.ts:16
CommandMapping provides a simple interface for developers to add and remove commands from the CommandLibrary.
This class allows you to:
- Create and add new commands to the library.
- Remove commands by name.
- Retrieve all commands or check if a command exists.
- Clear all commands from the library.
Command names are case-insensitive and stored in lowercase. Commands are stored in the CommandLibrary's HashMap.
Constructors
Constructor
new CommandMapping():
CommandMapping
Defined in: commandMapping.ts:23
Creates a new CommandMapping instance and connects to the CommandLibrary.
Returns
CommandMapping
Methods
addCommand()
addCommand(
name,action,options?):boolean
Defined in: commandMapping.ts:50
Creates and adds a new command to the CommandLibrary.
If a command with the same name already exists, it will not be added. The command name is case-insensitive and will be stored in lowercase.
Parameters
| Parameter | Type | Description |
|---|---|---|
name | string | Command name (case-insensitive) |
action | () => void | Callback function to execute for this command |
options? | { active?: boolean; description?: string; } | Optional configuration object |
options.active? | boolean | Whether the command is active (default: true) |
options.description? | string | Description of what the command does |
Returns
boolean
Returns true if command was added successfully, false if duplicate or invalid
clearAllCommands()
clearAllCommands():
void
Defined in: commandMapping.ts:141
Clears all commands from the CommandLibrary.
Returns
void
getAllCommands()
getAllCommands():
string[]
Defined in: commandMapping.ts:112
Retrieves all command names from the CommandLibrary.
Returns
string[]
Array of all command names
getCommand()
getCommand(
name):undefined|GameCommand
Defined in: commandMapping.ts:132
Retrieves a specific command from the CommandLibrary by name.
Parameters
| Parameter | Type | Description |
|---|---|---|
name | string | The name of the command to retrieve |
Returns
undefined | GameCommand
The GameCommand object if found, undefined otherwise
hasCommand()
hasCommand(
name):boolean
Defined in: commandMapping.ts:122
Checks if a command exists in the CommandLibrary.
Parameters
| Parameter | Type | Description |
|---|---|---|
name | string | The name of the command to check |
Returns
boolean
True if command exists, false otherwise
removeCommand()
removeCommand(
name):boolean
Defined in: commandMapping.ts:95
Removes a command from the CommandLibrary by name.
The command name is case-insensitive.
Parameters
| Parameter | Type | Description |
|---|---|---|
name | string | The name of the command to remove |
Returns
boolean
Returns true if command was removed, false if not found