Class endstone::CommandSender¶

ClassList > endstone > CommandSender

Represents a command sender.

#include <endstone/command/command_sender.h>

Inherits the following classes: endstone::Permissible

Inherited by the following classes: endstone::Actor, endstone::BlockCommandSender, endstone::CommandSenderWrapper, endstone::ConsoleCommandSender

Public Functions¶

Type	Name
virtual Actor *	asActor () const Gets a CommandSender asActor .
virtual BlockCommandSender *	asBlock () const Gets a CommandSender asBlockCommandSender .
virtual CommandSender *	asCommandSender () override const Casts a Permissible asCommandSender .
virtual ConsoleCommandSender *	asConsole () const Gets a CommandSender asConsoleCommandSender .
virtual Player *	asPlayer () const Gets a CommandSender asPlayer .
virtual std::string	getName () const = 0 Gets the name of this command sender.
virtual Server &	getServer () const = 0 Returns the server instance that this command is running on.
virtual void	sendErrorMessage (const Message & message) const = 0 Sends this sender a error message.
void	sendErrorMessage (const fmt::format_string< Args... > format, Args &&... args) const
virtual void	sendMessage (const Message & message) const = 0 Sends this sender a message.
void	sendMessage (const fmt::format_string< Args... > format, Args &&... args) const

Public Functions inherited from endstone::Permissible¶

See endstone::Permissible

Type	Name
virtual PermissionAttachment *	addAttachment (Plugin & plugin, const std::string & name, bool value) = 0 Adds a new PermissionAttachment with a single permission by name and value.
virtual PermissionAttachment *	addAttachment (Plugin & plugin) = 0 Adds a new empty PermissionAttachment to this object.
virtual CommandSender *	asCommandSender () const = 0 Casts a Permissible asCommandSender .
virtual std::unordered_set< PermissionAttachmentInfo * >	getEffectivePermissions () const = 0 Gets a set containing all the permissions currently in effect by this object.
virtual PermissionLevel	getPermissionLevel () const = 0 Gets the permission level of this object.
virtual bool	hasPermission (std::string name) const = 0 Gets the value of the specified permission, if set. If a permission override is not set on this object, the default value of the permission will be returned.
virtual bool	hasPermission (const Permission & perm) const = 0 Gets the value of the specified permission, if set. If a permission override is not set on this object, the default value of the permission will be returned.
virtual bool	isPermissionSet (std::string name) const = 0 Checks if this object contains an override for the specified permission, by fully qualified name.
virtual bool	isPermissionSet (const Permission & perm) const = 0 Checks if this object contains an override for the specified Permission .
virtual void	recalculatePermissions () = 0 Recalculates the permissions for this object, if the attachments have changed values. This should very rarely need to be called from a plugin.
virtual Result< void >	removeAttachment (PermissionAttachment & attachment) = 0 Removes the given PermissionAttachment from this object.
virtual	~Permissible () = default

Public Functions Documentation¶

function asActor¶

Gets a CommandSender asActor .

inline virtual Actor * endstone::CommandSender::asActor () const

Returns:

Actor, nullptr if not an Actor

function asBlock¶

Gets a CommandSender asBlockCommandSender .

inline virtual BlockCommandSender * endstone::CommandSender::asBlock () const

Returns:

CommandSender, nullptr if not a BlockCommandSender

function asCommandSender¶

Casts a Permissible asCommandSender .

inline virtual CommandSender * endstone::CommandSender::asCommandSender () override const

Returns:

CommandSender, nullptr if not a CommandSender

Implements endstone::Permissible::asCommandSender

function asConsole¶

Gets a CommandSender asConsoleCommandSender .

inline virtual ConsoleCommandSender * endstone::CommandSender::asConsole () const

Returns:

CommandSender, nullptr if not a ConsoleCommandSender

function asPlayer¶

Gets a CommandSender asPlayer .

inline virtual Player * endstone::CommandSender::asPlayer () const

Returns:

Player, nullptr if not a Player

function getName¶

Gets the name of this command sender.

virtual std::string endstone::CommandSender::getName () const = 0

Returns:

Name of the sender

function getServer¶

Returns the server instance that this command is running on.

virtual Server & endstone::CommandSender::getServer () const = 0

Returns:

Server instance

function sendErrorMessage [½]¶

Sends this sender a error message.

virtual void endstone::CommandSender::sendErrorMessage (
    const Message & message
) const = 0

Parameters:

message Error message to be displayed

function sendErrorMessage [2/2]¶

template<typename... Args>
inline void endstone::CommandSender::sendErrorMessage (
    const fmt::format_string< Args... > format,
    Args &&... args
) const

function sendMessage [½]¶

Sends this sender a message.

virtual void endstone::CommandSender::sendMessage (
    const Message & message
) const = 0

Parameters:

message Message to be displayed

function sendMessage [2/2]¶

template<typename... Args>
inline void endstone::CommandSender::sendMessage (
    const fmt::format_string< Args... > format,
    Args &&... args
) const

The documentation for this class was generated from the following file include/endstone/command/command_sender.h