Allows for the registration of custom console commands through the global object named commands
. Similarly to event subscriptions, these don't persist through a save-and-load cycle.
add_command(name, help, function) | Add a custom console command. | |
Add a custom console command. | ||
remove_command(name) | → boolean | Remove a custom console command. |
Remove a custom console command. | ||
commands [R] | :: dictionary[string → LocalisedString] | Lists the custom commands registered by scripts through |
Lists the custom commands registered by scripts through | ||
game_commands [R] | :: dictionary[string → LocalisedString] | Lists the built-in commands of the core game. [...] |
Lists the built-in commands of the core game. [...] | ||
object_name [R] | :: string | This object's name. |
This object's name. |
Add a custom console command.
name | :: string | The desired name of the command (case sensitive). |
The desired name of the command (case sensitive). | ||
help | :: LocalisedString | The localised help message. It will be shown to players using the |
The localised help message. It will be shown to players using the | ||
function | :: function(CustomCommandData) | The function that will be called when this command is invoked. |
The function that will be called when this command is invoked. |
This will register a custom event called
|
Trying to add a command with the name
of a game command or the name of a custom command that is already in use will result in an error.
Lists the custom commands registered by scripts through LuaCommandProcessor
.
Lists the built-in commands of the core game. The wiki has an overview of these.
This object's name.