endstone.command

Classes relating to handling specialized non-chat player input.

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
`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.

`class`BlockCommandSender

Bases: CommandSender

BlockCommandSender()

Represents a block command sender.

Attributes

Name	Type	Description
`block`	`Block`	Returns the block this command sender belongs to

`attr`blockproperty

block: Block

Returns the block this command sender belongs to

`class`Command

Command(name: str, description: str | None = None, usages: list[str] | None = None, aliases: list[str] | None = None, permissions: list[str] | None = None, *args, **kwargs)

Represents a Command, which executes various tasks upon user input

Methods

Name	Description
`execute`	Executes the command, returning its success
`test_permission`	Tests the given CommandSender to see if they can perform this command.
`test_permission_silently`	Tests the given CommandSender to see if they can perform this command. No error is sent to the sender.

Attributes

Name	Type	Description
`aliases`	`list[str]`	List of aliases of this command
`description`	`str`	Brief description of this command
`is_registered`	`bool`	Returns the current registered state of this command
`name`	`str`	Name of this command.
`permissions`	`list[str]`	The permissions required by users to be able to perform this command
`usages`	`list[str]`	List of usages of this command

`attr`aliasesproperty

aliases: list[str]

List of aliases of this command

`attr`descriptionproperty

description: str

Brief description of this command

`attr`is_registeredproperty

is_registered: bool

Returns the current registered state of this command

`attr`nameproperty

name: str

Name of this command.

`attr`permissionsproperty

permissions: list[str]

The permissions required by users to be able to perform this command

`attr`usagesproperty

usages: list[str]

List of usages of this command

`meth`execute

execute(sender: CommandSender, args: list[str]) -> bool

Executes the command, returning its success

`meth`test_permission

test_permission(target: CommandSender) -> bool

Tests the given CommandSender to see if they can perform this command.

`meth`test_permission_silently

test_permission_silently(target: CommandSender) -> bool

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

`class`CommandExecutor

CommandExecutor()

Represents a class which contains a single method for executing commands

Methods

Name	Description
`on_command`	Executes the given command, returning its success.

`meth`on_command

on_command(sender: CommandSender, command: Command, args: list[str]) -> bool

Executes the given command, returning its success.

`class`CommandSender

Bases: Permissible

CommandSender()

Represents a command sender.

Methods

Name	Description
`send_error_message`	Sends this sender an error message
`send_message`	Sends this sender a message

Attributes

Name	Type	Description
`name`	`str`	Gets the name of this command sender
`server`	`Server`	Returns the server instance that this command is running on

`attr`nameproperty

name: str

Gets the name of this command sender

`attr`serverproperty

server: Server

Returns the server instance that this command is running on

`meth`send_error_message

send_error_message(message: str | Translatable) -> None

Sends this sender an error message

`meth`send_message

send_message(message: str | Translatable) -> None

Sends this sender a message

`class`CommandSenderWrapper

Bases: CommandSender

CommandSenderWrapper(sender: CommandSender, on_message: Callable[[str | Translatable], None] = None, on_error: Callable[[str | Translatable], None] = None)

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

`class`ConsoleCommandSender

Bases: CommandSender

ConsoleCommandSender()

Represents a console command sender.

classBlockCommandSender

attrblockproperty

classCommand

attraliasesproperty

attrdescriptionproperty

attris_registeredproperty

attrnameproperty

attrpermissionsproperty

attrusagesproperty

methexecute

methtest_permission

methtest_permission_silently

classCommandExecutor

methon_command

classCommandSender

attrnameproperty

attrserverproperty

methsend_error_message

methsend_message

classCommandSenderWrapper

classConsoleCommandSender

On this page

`class`BlockCommandSender

`attr`blockproperty

`class`Command

`attr`aliasesproperty

`attr`descriptionproperty

`attr`is_registeredproperty

`attr`nameproperty

`attr`permissionsproperty

`attr`usagesproperty

`meth`execute

`meth`test_permission

`meth`test_permission_silently

`class`CommandExecutor

`meth`on_command

`class`CommandSender

`attr`nameproperty

`attr`serverproperty

`meth`send_error_message

`meth`send_message

`class`CommandSenderWrapper

`class`ConsoleCommandSender