pocketmine\command\PluginCommand Class Reference

Inheritance diagram for pocketmine\command\PluginCommand:

Collaboration diagram for pocketmine\command\PluginCommand:

Public Member Functions
	__construct (string $namespace, string $name, private Plugin $owner, private CommandExecutor $executor, Translatable|string $description="", Translatable|string|null $usageMessage=null)
	execute (CommandSender $sender, string $commandLabel, array $args)
	getDescription ()
	getExecutor ()
	getId ()
	getName ()
	getNamespace ()
	getOwningPlugin ()
	getPermissionMessage ()
	getPermissions ()
	getUsage ()
	setDescription (Translatable|string $description)
	setExecutor (CommandExecutor $executor)
	setPermission (?string $permission)
	setPermissionMessage (Translatable|string $permissionMessage)
	setPermissions (array $permissions)
	setUsage (Translatable|string|null $usage)
	testPermission (string $context, CommandSender $target, ?string $permission=null)
	testPermissionSilent (CommandSender $target, ?string $permission=null)

Static Public Member Functions
static	broadcastCommandMessage (CommandSender $source, Translatable|string $message, bool $sendToSource=true)

Detailed Description

Definition at line 31 of file PluginCommand.php.

Constructor & Destructor Documentation

__construct()

pocketmine\command\PluginCommand::__construct	(	string	$namespace,
		string	$name,
		private Plugin	$owner,
		private CommandExecutor	$executor,
		Translatable|string	$description = "",
		Translatable|string|null	$usageMessage = null )

Definition at line 32 of file PluginCommand.php.

Member Function Documentation

broadcastCommandMessage()

static pocketmine\command\Command::broadcastCommandMessage ( CommandSender $source, Translatable|string $message, bool $sendToSource = true )

staticinherited

Definition at line 175 of file Command.php.

execute()

pocketmine\command\PluginCommand::execute	(	CommandSender	$sender,
		string	$commandLabel,
		array	$args )

Parameters

string[]

$args

@phpstan-param list<string> $args

Returns

mixed

Exceptions

CommandException

Reimplemented from pocketmine\command\Command.

Definition at line 43 of file PluginCommand.php.

getDescription()

pocketmine\command\Command::getDescription ( )

inherited

Definition at line 155 of file Command.php.

getExecutor()

pocketmine\command\PluginCommand::getExecutor

(

)

Definition at line 60 of file PluginCommand.php.

getId()

pocketmine\command\Command::getId ( )

finalinherited

Returns the globally unique ID for the command. This typically looks like namespace:name

Definition at line 92 of file Command.php.

Referenced by pocketmine\command\defaults\CommandAliasCommand\execute().

Here is the caller graph for this function:

getName()

pocketmine\command\Command::getName ( )

finalinherited

Returns the local identifier of the command (without namespace or leading slash). This cannot be changed after creation.

Definition at line 85 of file Command.php.

getNamespace()

pocketmine\command\Command::getNamespace ( )

finalinherited

Definition at line 77 of file Command.php.

getOwningPlugin()

pocketmine\command\PluginCommand::getOwningPlugin

(

)

Implements pocketmine\plugin\PluginOwned.

Definition at line 56 of file PluginCommand.php.

getPermissionMessage()

pocketmine\command\Command::getPermissionMessage ( )

inherited

Definition at line 151 of file Command.php.

getPermissions()

pocketmine\command\Command::getPermissions ( )

inherited

Returns

string[]

Definition at line 99 of file Command.php.

getUsage()

pocketmine\command\Command::getUsage ( )

inherited

Definition at line 159 of file Command.php.

setDescription()

pocketmine\command\Command::setDescription ( Translatable|string $description )

inherited

Definition at line 163 of file Command.php.

setExecutor()

pocketmine\command\PluginCommand::setExecutor

(

CommandExecutor

$executor

)

Definition at line 64 of file PluginCommand.php.

setPermission()

pocketmine\command\Command::setPermission ( ?string $permission )

inherited

Definition at line 116 of file Command.php.

setPermissionMessage()

pocketmine\command\Command::setPermissionMessage ( Translatable|string $permissionMessage )

inherited

Definition at line 167 of file Command.php.

setPermissions()

pocketmine\command\Command::setPermissions ( array $permissions )

inherited

Parameters

string[]

$permissions

Definition at line 106 of file Command.php.

Referenced by pocketmine\command\ClosureCommand\__construct().

Here is the caller graph for this function:

setUsage()

pocketmine\command\Command::setUsage ( Translatable|string|null $usage )

inherited

Definition at line 171 of file Command.php.

testPermission()

pocketmine\command\Command::testPermission ( string $context, CommandSender $target, ?string $permission = null )

inherited

Parameters

string	$context	usually the command name, but may include extra args if useful (e.g. for subcommands)
CommandSender	$target	the target to check the permission for
string | null	$permission	the permission to check, if null, will check if the target has any of the command's permissions

Definition at line 125 of file Command.php.

Referenced by pocketmine\command\defaults\CommandAliasCommand\execute(), pocketmine\command\defaults\TimeCommand\execute(), and pocketmine\command\defaults\WhitelistCommand\execute().

Here is the caller graph for this function:

testPermissionSilent()

pocketmine\command\Command::testPermissionSilent ( CommandSender $target, ?string $permission = null )

inherited

Definition at line 140 of file Command.php.

---

The documentation for this class was generated from the following file:

• PluginCommand.php