Module cmd

This module handles client-side chat commands and command processing.

It provides functionality for:

• Defining client-side chat commands
• Processing and executing commands (both client and server commands)
• Command argument parsing and validation
• Tab completion for command arguments
• Entity targeting via special syntax (e.g., @target, @self)

The command system allows players to interact with the game through text commands prefixed with a slash (e.g., /help, /wiki).

Structs

ClientChatCommandIter

An iterator over the variants of ClientChatCommand

ClientEntityTargetIter 🔒

An iterator over the variants of ClientEntityTarget

Enums

ChatCommandKind

Represents either a client-side or server-side command.

ClientChatCommand

Represents all available client-side chat commands.

ClientEntityTarget 🔒

Special entity targets that can be referenced in commands using @ syntax.

Traits

TabComplete 🔒

Trait for types that can provide tab completion suggestions.

Functions

complete

Main tab completion function for chat input.

complete_command 🔒

Returns a list of ClientChatCommand and ServerChatCommand names that start with the given partial input.

complete_player 🔒

Returns a list of player names that start with the given partial input.

complete_site 🔒

Returns a list of site names that start with the given partial input.

handle_clear 🔒

Handles ClientChatCommand::Unmute

handle_experimental_shader 🔒

Handles ClientChatCommand::ExperimentalShader

handle_help 🔒

Handles ClientChatCommand::Help

handle_mute 🔒

Handles ClientChatCommand::Mute

handle_unmute 🔒

Handles ClientChatCommand::Unmute

handle_waypoint 🔒

Handles ClientChatCommand::Waypoint

handle_wiki 🔒

Handles ClientChatCommand::Wiki

invalid_command_message 🔒

Generates a helpful error message when an invalid command is entered.

nth_word 🔒

Gets the byte index of the nth word in a string.

preproccess_command 🔒

Preprocesses command arguments before execution.

run_client_command 🔒

Executes a client-side command.

run_command

Runs a command by either sending it to the server or processing it locally.

Type Aliases

CommandResult 🔒

Represents the feedback shown to the user of a command, if any. Server commands give their feedback as an event, so in those cases this will always be Ok(None). An Err variant will be be displayed with the error icon and text color.