Struct LuaCommandProcessor 

pub struct LuaCommandProcessor;

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.

Implementations

impl LuaCommandProcessor

pub fn commands(&self) -> HashMap<String, String>

Lists the custom commands registered by scripts through LuaCommandProcessor.

pub fn game_commands(&self) -> HashMap<String, String>

Lists the built-in commands of the core game. The wiki has an overview of these.

pub fn object_name(&self) -> &str

The class name of this object. Available even when valid is false. For LuaStruct objects it may also be suffixed with a dotted path to a member of the struct.

pub fn add_command(&self, function: LuaAny, help: &str, name: &str)

Add a custom console command.

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.

This example command will register a custom event called print_tick that prints the current tick to either the player issuing the command or to everyone on the server, depending on the command parameter:

commands.add_command("print_tick", nil, function(command)
  if command.player_index ~= nil and command.parameter == "me" then
    game.get_player(command.player_index).print(command.tick)
  else
    game.print(command.tick)
  end
end)
```text


This shows the usage of the table that gets passed to any function handling a custom command. This specific example makes use of the `tick` and the optional `player_index` and `parameter` fields. The user is supposed to either call it without any parameter (`"/print_tick"`) or with the `"me"` parameter (`"/print_tick me"`).

pub fn remove_command(&self, name: &str) -> bool

Remove a custom console command.

Trait Implementations

impl Clone for LuaCommandProcessor

fn clone(&self) -> LuaCommandProcessor

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for LuaCommandProcessor

impl Debug for LuaCommandProcessor

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for LuaCommandProcessor

fn default() -> LuaCommandProcessor

Returns the “default value” for a type.

impl Eq for LuaCommandProcessor

impl From<LuaCommandProcessor> for LuaAny

fn from(_: LuaCommandProcessor) -> Self

Converts to this type from the input type.

impl LuaObject for LuaCommandProcessor

impl PartialEq for LuaCommandProcessor

fn eq(&self, other: &LuaCommandProcessor) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for LuaCommandProcessor