endstone::CommandSender
Represents a command sender.
Bases: endstone::Permissible
Functions:
Name | Description |
---|---|
asActor | Gets a CommandSender as Actor . |
asBlock | Gets a CommandSender as BlockCommandSender . |
asCommandSender | Casts a Permissible as CommandSender . |
asConsole | Gets a CommandSender as ConsoleCommandSender . |
asPlayer | Gets a CommandSender as Player . |
getName | Gets the name of this command sender. |
getServer | Returns the server instance that this command is running on. |
sendErrorMessage | Sends this sender a error message. |
sendErrorMessage | |
sendMessage | Sends this sender a message. |
sendMessage |
asActor
Actor *asActor() const
Gets a CommandSender as Actor .
Returns:
Actor, nullptr if not an Actor
asBlock
BlockCommandSender *asBlock() const
Gets a CommandSender as BlockCommandSender .
Returns:
CommandSender, nullptr if not a BlockCommandSender
asCommandSender
CommandSender *asCommandSender() override const
Casts a Permissible as CommandSender .
Returns:
CommandSender, nullptr if not a CommandSender
asConsole
ConsoleCommandSender *asConsole() const
Gets a CommandSender as ConsoleCommandSender .
Returns:
CommandSender, nullptr if not a ConsoleCommandSender
asPlayer
Player *asPlayer() const
Gets a CommandSender as Player .
Returns:
Player, nullptr if not a Player
getName
std::string getName() const
Gets the name of this command sender.
Returns:
Name of the sender
getServer
Server &getServer() const
Returns the server instance that this command is running on.
Returns:
Server instance
sendErrorMessage
void sendErrorMessage(const Message &message) const
Sends this sender a error message.
Parameters:
message
Error message to be displayed
template <typename... Args>
void sendErrorMessage(const fmt::format_string<Args...> format,
Args &&...args) const
sendMessage
void sendMessage(const Message &message) const
Sends this sender a message.
Parameters:
message
Message to be displayed
template <typename... Args>
void sendMessage(const fmt::format_string<Args...> format, Args &&...args) const
Last updated on