endstone/command

Classes

Name	Description
`BlockCommandSender`	Represents a block command sender.
`Command`	Represents a Command, which executes various tasks upon user input.
`CommandExecutor`	Represents a class which contains a single method for executing commands.
`CommandMap`	Represents a command map that manages all commands of the Server.
`CommandSender`	Represents a command sender.
`CommandSenderWrapper`	Represents a wrapper that forwards commands to the wrapped CommandSender and captures its output.
`ConsoleCommandSender`	Represents a console command sender.
`PluginCommand`	Represents a Command belonging to a Plugin.

`class`BlockCommandSender

Defined in <endstone/command/block_command_sender.h>

Bases: CommandSender

Represents a block command sender.

Methods

Name	Description
`getBlock`	Returns the block this command sender belongs to.

`meth`getBlockabstractconst

std::unique_ptr<Block> getBlock() const =0

Returns the block this command sender belongs to.

Returns

Type	Description
`std::unique_ptr<Block>`	Block for the command sender

`class`Command

Defined in <endstone/command/command.h>

Represents a Command, which executes various tasks upon user input.

Methods

Name	Description
`Command`
`~Command`
`execute`
`getName`
`setName`
`getDescription`
`setDescription`
`getAliases`
`setAliases`
`getUsages`
`setUsages`
`getPermissions`
`setPermissions`
`testPermission`
`testPermissionSilently`
`registerTo`
`unregisterFrom`
`isRegistered`
`asPluginCommand`

`meth`Commandexplicit

Command(std::string name, std::string description = "", std::vector<std::string> usages = {}, std::vector<std::string> aliases = {}, std::vector<std::string> permissions = {})

`meth`~Commandvirtual

~Command() =default

`meth`executevirtualconst

bool execute(CommandSender& sender, const std::vector<std::string>& args) const

Executes the command, returning its success

Parameters

Name	Type	Description
`sender`	`CommandSender&`	Source of the command
`args`	`const std::vector<std::string>&`	Arguments passed to the command

Returns

Type	Description
`bool`	true if the execution was successful, otherwise false

`meth`getNameconst

std::string getName() const

Returns the name of this command

Returns

Type	Description
`std::string`	Name of this command

`meth`setName

void setName(std::string name)

Sets the name of this command.

May only be used before registering the command.

Parameters

Name	Type	Description
`name`	`std::string`	New command name

`meth`getDescriptionconst

std::string getDescription() const

Gets a brief description of this command

Returns

Type	Description
`std::string`	Description of this command

`meth`setDescription

void setDescription(std::string description)

Sets a brief description of this command.

Parameters

Name	Type	Description
`description`	`std::string`	new command description

`meth`getAliasesconst

std::vector<std::string> getAliases() const

Returns a list of aliases of this command

Returns

Type	Description
`std::vector<std::string>`	List of aliases

`meth`setAliases

void setAliases(Alias... aliases)

Sets the list of aliases to request on registration for this command.

Parameters

Name	Type	Description
`aliases`	`Alias...`	aliases to register to this command

`meth`getUsagesconst

std::vector<std::string> getUsages() const

Returns a list of usages of this command

Returns

Type	Description
`std::vector<std::string>`	List of usages

`meth`setUsages

void setUsages(Usage... usages)

Sets the usages of this command

Parameters

Name	Type	Description
`usages`	`Usage...`	List of usages

`meth`getPermissionsconst

std::vector<std::string> getPermissions() const

Gets the permissions required by users to be able to perform this command

Returns

Type	Description
`std::vector<std::string>`	List of permission names, or empty if none

`meth`setPermissions

void setPermissions(Permission... permissions)

Sets the permissions required by users to be able to perform this command

Parameters

Name	Type	Description
`permissions`	`Permission...`	List of permission names

`meth`testPermissionconst

bool testPermission(const CommandSender& target) const

Tests the given CommandSender to see if they can perform this command. If they do not have permission, they will be informed that they cannot do this.

Parameters

Name	Type	Description
`target`	`const CommandSender&`	User to test

Returns

Type	Description
`bool`	true if they can use it, otherwise false

`meth`testPermissionSilentlyconst

bool testPermissionSilently(const CommandSender& target) const

Tests the given CommandSender to see if they can perform this command. No error is sent to the sender.

Parameters

Name	Type	Description
`target`	`const CommandSender&`	User to test

Returns

Type	Description
`bool`	true if they can use it, otherwise false

`meth`registerTo

bool registerTo(const CommandMap& command_map)

Registers this command to a CommandMap.

Parameters

Name	Type	Description
`command_map`	`const CommandMap&`	the CommandMap to register to

Returns

Type	Description
`bool`	true if the registration was successful, false otherwise

`meth`unregisterFrom

bool unregisterFrom(const CommandMap& command_map)

Unregisters this command from a CommandMap

Parameters

Name	Type	Description
`command_map`	`const CommandMap&`	the CommandMap to unregister from

Returns

Type	Description
`bool`	true if the unregistration was successful, false otherwise

`meth`isRegisteredconst

bool isRegistered() const

Returns the current registered state of this command

Returns

Type	Description
`bool`	true if this command is currently registered false otherwise

`meth`asPluginCommandvirtualconst

PluginCommand* asPluginCommand() const

`class`CommandExecutor

Defined in <endstone/command/command_executor.h>

Represents a class which contains a single method for executing commands.

Methods

Name	Description
`~CommandExecutor`
`onCommand`

`meth`~CommandExecutorvirtual

~CommandExecutor() =default

`meth`onCommandvirtual

bool onCommand(CommandSender& sender, const Command& command, const std::vector<std::string>& args)

Executes the given command, returning its success.

Parameters

Name	Type	Description
`sender`	`CommandSender&`	Source of the command
`command`	`const Command&`	Command which was executed
`args`	`const std::vector<std::string>&`	Passed command arguments

Returns

Type	Description
`bool`	true if the execution is successful, otherwise false

`class`CommandMap

Defined in <endstone/command/command_map.h>

Represents a command map that manages all commands of the Server.

Methods

Name	Description
`CommandMap`
`CommandMap`
`operator=`
`CommandMap`
`operator=`
`~CommandMap`
`registerCommand`
`dispatch`	Looks for the requested command and executes it if found.
`clearCommands`
`getCommand`

`meth`CommandMap

CommandMap() =default

`meth`CommandMap

CommandMap(const CommandMap&) =delete

`meth`operator=

CommandMap& operator=(const CommandMap&) =delete

`meth`CommandMap

CommandMap(CommandMap&&) =default

`meth`operator=

CommandMap& operator=(CommandMap&&) =default

`meth`~CommandMapvirtual

~CommandMap() =default

`meth`registerCommandabstract

bool registerCommand(std::shared_ptr<Command> command) =0

Registers a command.

Parameters

Name	Type	Description
`command`	`std::shared_ptr<Command>`	the command to register

Returns

Type	Description
`bool`	true on success, false if a command with the same name is already registered

`meth`dispatchabstractconst

bool dispatch(CommandSender& sender, std::string command_line) const =0

Looks for the requested command and executes it if found.

Parameters

Name	Type	Description
`sender`	`CommandSender&`	The command's sender
`command_line`	`std::string`	command + arguments. Example: "/test abc 123"

Returns

Type	Description
`bool`	true if execution is successful, false otherwise

`meth`clearCommandsabstract

void clearCommands() =0

Clears all registered commands.

`meth`getCommandabstractconst

std::shared_ptr<Command> getCommand(std::string name) const =0

Gets the command registered to the specified name

Parameters

Name	Type	Description
`name`	`std::string`	Name of the command to retrieve

Returns

Type	Description
`std::shared_ptr<Command>`	Command with the specified name or nullptr if a command with that label doesn't exist

`class`CommandSender

Defined in <endstone/command/command_sender.h>

Bases: Permissible

Represents a command sender.

Methods

Name	Description
`asCommandSender`	Casts a Permissible as CommandSender.
`asConsole`	Gets a CommandSender as ConsoleCommandSender.
`asBlock`	Gets a CommandSender as BlockCommandSender.
`asActor`	Gets a CommandSender as Actor.
`asPlayer`	Gets a CommandSender as Player.
`sendMessage`	Sends this sender a message.
`sendMessage`
`sendErrorMessage`	Sends this sender a error message.
`sendErrorMessage`
`getServer`	Returns the server instance that this command is running on.
`getName`	Gets the name of this command sender.

`meth`asCommandSendervirtualconstoverride

CommandSender* asCommandSender() const override

Casts a Permissible as CommandSender.

Returns

Type	Description
`CommandSender*`	CommandSender, nullptr if not a CommandSender

`meth`asConsoleabstractconst

ConsoleCommandSender* asConsole() const =0

Gets a CommandSender as ConsoleCommandSender.

Returns

Type	Description
`ConsoleCommandSender*`	CommandSender, nullptr if not a ConsoleCommandSender

`meth`asBlockabstractconst

BlockCommandSender* asBlock() const =0

Gets a CommandSender as BlockCommandSender.

Returns

Type	Description
`BlockCommandSender*`	CommandSender, nullptr if not a BlockCommandSender

`meth`asActorabstractconst

Actor* asActor() const =0

Gets a CommandSender as Actor.

Returns

Type	Description
`Actor*`	Actor, nullptr if not an Actor

`meth`asPlayerabstractconst

Player* asPlayer() const =0

Gets a CommandSender as Player.

Returns

Type	Description
`Player*`	Player, nullptr if not a Player

`meth`sendMessageabstractconst

void sendMessage(const Message& message) const =0

Sends this sender a message.

Parameters

Name	Type	Description
`message`	`const Message&`	Message to be displayed

`meth`sendMessageconst

void sendMessage(const std::format_string<Args...> format, Args&&... args) const

`meth`sendErrorMessageabstractconst

void sendErrorMessage(const Message& message) const =0

Sends this sender a error message.

Parameters

Name	Type	Description
`message`	`const Message&`	Error message to be displayed

`meth`sendErrorMessageconst

void sendErrorMessage(const std::format_string<Args...> format, Args&&... args) const

`meth`getServerabstractconst

Server& getServer() const =0

Returns the server instance that this command is running on.

Returns

Type	Description
`Server&`	Server instance

`meth`getNameabstractconst

std::string getName() const =0

Gets the name of this command sender.

Returns

Type	Description
`std::string`	Name of the sender

`class`CommandSenderWrapper

Defined in <endstone/command/command_sender_wrapper.h>

Bases: CommandSender

Represents a wrapper that forwards commands to the wrapped CommandSender and captures its output.

Type Aliases

Name	Description
`Callback`

Methods

Name	Description
`CommandSenderWrapper`
`sendMessage`	Sends this sender a message.
`sendErrorMessage`	Sends this sender a error message.
`getPermissionLevel`	Gets the permission level of this object.
`isPermissionSet`	Checks if this object contains an override for the specified permission, by fully qualified name.
`isPermissionSet`	Checks if this object contains an override for the specified Permission.
`hasPermission`	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.
`hasPermission`	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.
`addAttachment`	Adds a new PermissionAttachment with a single permission by name and value.
`addAttachment`	Adds a new empty PermissionAttachment to this object.
`removeAttachment`	Removes the given PermissionAttachment from this object.
`recalculatePermissions`	Recalculates the permissions for this object, if the attachments have changed values. This should very rarely need to be called from a plugin.
`getEffectivePermissions`	Gets a set containing all the permissions currently in effect by this object.
`asConsole`	Gets a CommandSender as ConsoleCommandSender.
`asBlock`	Gets a CommandSender as BlockCommandSender.
`asActor`	Gets a CommandSender as Actor.
`asPlayer`	Gets a CommandSender as Player.
`getServer`	Returns the server instance that this command is running on.
`getName`	Gets the name of this command sender.

`type`Callback

std::function<void(const Message&)> Callback

`meth`CommandSenderWrapperexplicit

CommandSenderWrapper(CommandSender& sender, Callback on_message = {}, Callback on_error = {})

`meth`sendMessagevirtualconstoverride

void sendMessage(const Message& message) const override

Sends this sender a message.

Parameters

Name	Type	Description
`message`	`const Message&`	Message to be displayed

`meth`sendErrorMessagevirtualconstoverride

void sendErrorMessage(const Message& message) const override

Sends this sender a error message.

Parameters

Name	Type	Description
`message`	`const Message&`	Error message to be displayed

`meth`getPermissionLevelvirtualconstoverride

PermissionLevel getPermissionLevel() const override

Gets the permission level of this object.

Returns

Type	Description
`PermissionLevel`	The permission level

`meth`isPermissionSetvirtualconstoverride

bool isPermissionSet(std::string name) const override

Checks if this object contains an override for the specified permission, by fully qualified name.

Parameters

Name	Type	Description
`name`	`std::string`	Name of the permission

Returns

Type	Description
`bool`	true if the permission is set, otherwise false

`meth`isPermissionSetvirtualconstoverride

bool isPermissionSet(const Permission& perm) const override

Checks if this object contains an override for the specified Permission.

Parameters

Name	Type	Description
`perm`	`const Permission&`	Permission to check

Returns

Type	Description
`bool`	true if the permission is set, otherwise false

`meth`hasPermissionvirtualconstoverride

bool hasPermission(std::string name) const override

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.

Parameters

Name	Type	Description
`name`	`std::string`	Name of the permission

Returns

Type	Description
`bool`	Value of the permission

`meth`hasPermissionvirtualconstoverride

bool hasPermission(const Permission& perm) const override

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.

Parameters

Name	Type	Description
`perm`	`const Permission&`	Permission to get

Returns

Type	Description
`bool`	Value of the permission

`meth`addAttachmentvirtualoverride

PermissionAttachment* addAttachment(Plugin& plugin, const std::string& name, bool value) override

Adds a new PermissionAttachment with a single permission by name and value.

Parameters

Name	Type	Description
`plugin`	`Plugin&`	Plugin responsible for this attachment, may not be null or disabled
`name`	`const std::string&`	Name of the permission to attach
`value`	`bool`	Value of the permission

Returns

Type	Description
`PermissionAttachment*`	The PermissionAttachment that was just created

`meth`addAttachmentvirtualoverride

PermissionAttachment* addAttachment(Plugin& plugin) override

Adds a new empty PermissionAttachment to this object.

Parameters

Name	Type	Description
`plugin`	`Plugin&`	Plugin responsible for this attachment, may not be null or disabled

Returns

Type	Description
`PermissionAttachment*`	The PermissionAttachment that was just created

`meth`removeAttachmentvirtualoverride

bool removeAttachment(PermissionAttachment& attachment) override

Removes the given PermissionAttachment from this object.

Parameters

Name	Type	Description
`attachment`	`PermissionAttachment&`	Attachment to remove

Returns

Type	Description
`bool`	true if the specified attachment was removed successfully, false when it isn't part of this object

`meth`recalculatePermissionsvirtualoverride

void recalculatePermissions() override

Recalculates the permissions for this object, if the attachments have changed values. This should very rarely need to be called from a plugin.

`meth`getEffectivePermissionsvirtualconstoverride

std::unordered_set<PermissionAttachmentInfo*> getEffectivePermissions() const override

Gets a set containing all the permissions currently in effect by this object.

Returns

Type	Description
`std::unordered_set<PermissionAttachmentInfo*>`	Set of currently effective permissions

`meth`asConsolevirtualconstoverride

ConsoleCommandSender* asConsole() const override

Gets a CommandSender as ConsoleCommandSender.

Returns

Type	Description
`ConsoleCommandSender*`	CommandSender, nullptr if not a ConsoleCommandSender

`meth`asBlockvirtualconstoverride

BlockCommandSender* asBlock() const override

Gets a CommandSender as BlockCommandSender.

Returns

Type	Description
`BlockCommandSender*`	CommandSender, nullptr if not a BlockCommandSender

`meth`asActorvirtualconstoverride

Actor* asActor() const override

Gets a CommandSender as Actor.

Returns

Type	Description
`Actor*`	Actor, nullptr if not an Actor

`meth`asPlayervirtualconstoverride

Player* asPlayer() const override

Gets a CommandSender as Player.

Returns

Type	Description
`Player*`	Player, nullptr if not a Player

`meth`getServervirtualconstoverride

Server& getServer() const override

Returns the server instance that this command is running on.

Returns

Type	Description
`Server&`	Server instance

`meth`getNamevirtualconstoverride

std::string getName() const override

Gets the name of this command sender.

Returns

Type	Description
`std::string`	Name of the sender

`class`ConsoleCommandSender

Defined in <endstone/command/console_command_sender.h>

Bases: CommandSender

Represents a console command sender.

`class`PluginCommand

Defined in <endstone/command/plugin_command.h>

Bases: Command

Represents a Command belonging to a Plugin.

Methods

Name	Description
`PluginCommand`
`execute`
`setExecutor`
`getExecutor`
`getPlugin`
`asPluginCommand`

`meth`PluginCommand

PluginCommand(const Command& command, Plugin& owner)

`meth`executevirtualconstoverride

bool execute(CommandSender& sender, const std::vector<std::string>& args) const override

Executes the command, returning its success

Parameters

Name	Type	Description
`sender`	`CommandSender&`	Source of the command
`args`	`const std::vector<std::string>&`	Arguments passed to the command

Returns

Type	Description
`bool`	true if the execution was successful, otherwise false

`meth`setExecutorvirtual

void setExecutor(std::shared_ptr<CommandExecutor> executor)

Sets the CommandExecutor to run when parsing this command

Parameters

Name	Type	Description
`executor`	`std::shared_ptr<CommandExecutor>`	New executor to run

`meth`getExecutorvirtualconst

CommandExecutor& getExecutor() const

Gets the CommandExecutor associated with this command

Returns

Type	Description
`CommandExecutor&`	CommandExecutor object linked to this command

`meth`getPluginconst

Plugin& getPlugin() const

Gets the owner of this PluginCommand

Returns

Type	Description
`Plugin&`	Plugin that owns this command

`meth`asPluginCommandvirtualconstoverride

PluginCommand* asPluginCommand() const override

classBlockCommandSender

methgetBlockabstractconst

classCommand

methCommandexplicit

meth~Commandvirtual

methexecutevirtualconst

methgetNameconst

methsetName

methgetDescriptionconst

methsetDescription

methgetAliasesconst

methsetAliases

methgetUsagesconst

methsetUsages

methgetPermissionsconst

methsetPermissions

methtestPermissionconst

methtestPermissionSilentlyconst

methregisterTo

methunregisterFrom

methisRegisteredconst

methasPluginCommandvirtualconst

classCommandExecutor

meth~CommandExecutorvirtual

methonCommandvirtual

classCommandMap

methCommandMap

methCommandMap

methoperator=

methCommandMap

methoperator=

meth~CommandMapvirtual

methregisterCommandabstract

methdispatchabstractconst

methclearCommandsabstract

methgetCommandabstractconst

classCommandSender

methasCommandSendervirtualconstoverride

methasConsoleabstractconst

methasBlockabstractconst

methasActorabstractconst

methasPlayerabstractconst

methsendMessageabstractconst

methsendMessageconst

methsendErrorMessageabstractconst

methsendErrorMessageconst

methgetServerabstractconst

methgetNameabstractconst

classCommandSenderWrapper

typeCallback

methCommandSenderWrapperexplicit

methsendMessagevirtualconstoverride

methsendErrorMessagevirtualconstoverride

methgetPermissionLevelvirtualconstoverride

methisPermissionSetvirtualconstoverride

methisPermissionSetvirtualconstoverride

methhasPermissionvirtualconstoverride

methhasPermissionvirtualconstoverride

methaddAttachmentvirtualoverride

methaddAttachmentvirtualoverride

methremoveAttachmentvirtualoverride

methrecalculatePermissionsvirtualoverride

methgetEffectivePermissionsvirtualconstoverride

methasConsolevirtualconstoverride

methasBlockvirtualconstoverride

methasActorvirtualconstoverride

methasPlayervirtualconstoverride

methgetServervirtualconstoverride

methgetNamevirtualconstoverride

classConsoleCommandSender

classPluginCommand

methPluginCommand

methexecutevirtualconstoverride

methsetExecutorvirtual

methgetExecutorvirtualconst

methgetPluginconst

methasPluginCommandvirtualconstoverride

On this page

`class`BlockCommandSender

`meth`getBlockabstractconst

`class`Command

`meth`Commandexplicit

`meth`~Commandvirtual

`meth`executevirtualconst

`meth`getNameconst

`meth`setName

`meth`getDescriptionconst

`meth`setDescription

`meth`getAliasesconst

`meth`setAliases

`meth`getUsagesconst

`meth`setUsages

`meth`getPermissionsconst

`meth`setPermissions

`meth`testPermissionconst

`meth`testPermissionSilentlyconst

`meth`registerTo

`meth`unregisterFrom

`meth`isRegisteredconst

`meth`asPluginCommandvirtualconst

`class`CommandExecutor

`meth`~CommandExecutorvirtual

`meth`onCommandvirtual

`class`CommandMap

`meth`CommandMap

`meth`CommandMap

`meth`operator=

`meth`CommandMap

`meth`operator=

`meth`~CommandMapvirtual

`meth`registerCommandabstract

`meth`dispatchabstractconst

`meth`clearCommandsabstract

`meth`getCommandabstractconst

`class`CommandSender

`meth`asCommandSendervirtualconstoverride

`meth`asConsoleabstractconst

`meth`asBlockabstractconst

`meth`asActorabstractconst

`meth`asPlayerabstractconst

`meth`sendMessageabstractconst

`meth`sendMessageconst

`meth`sendErrorMessageabstractconst

`meth`sendErrorMessageconst

`meth`getServerabstractconst

`meth`getNameabstractconst

`class`CommandSenderWrapper

`type`Callback

`meth`CommandSenderWrapperexplicit

`meth`sendMessagevirtualconstoverride

`meth`sendErrorMessagevirtualconstoverride

`meth`getPermissionLevelvirtualconstoverride

`meth`isPermissionSetvirtualconstoverride

`meth`isPermissionSetvirtualconstoverride

`meth`hasPermissionvirtualconstoverride

`meth`hasPermissionvirtualconstoverride

`meth`addAttachmentvirtualoverride

`meth`addAttachmentvirtualoverride

`meth`removeAttachmentvirtualoverride

`meth`recalculatePermissionsvirtualoverride

`meth`getEffectivePermissionsvirtualconstoverride

`meth`asConsolevirtualconstoverride

`meth`asBlockvirtualconstoverride

`meth`asActorvirtualconstoverride

`meth`asPlayervirtualconstoverride

`meth`getServervirtualconstoverride

`meth`getNamevirtualconstoverride

`class`ConsoleCommandSender

`class`PluginCommand

`meth`PluginCommand

`meth`executevirtualconstoverride

`meth`setExecutorvirtual

`meth`getExecutorvirtualconst

`meth`getPluginconst

`meth`asPluginCommandvirtualconstoverride