PocketMine-MP 5.23.3 git-f7687af337d001ddbcc47b8e773f014a33faa662
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
pocketmine\command\defaults\VanillaCommand Class Reference
+ Inheritance diagram for pocketmine\command\defaults\VanillaCommand:
+ Collaboration diagram for pocketmine\command\defaults\VanillaCommand:

Public Member Functions

 __toString ()
 
 execute (CommandSender $sender, string $commandLabel, array $args)
 
 getAliases ()
 
 getDescription ()
 
 getLabel ()
 
 getName ()
 
 getPermissionMessage ()
 
 getPermissions ()
 
 getUsage ()
 
 isRegistered ()
 
 register (CommandMap $commandMap)
 
 setAliases (array $aliases)
 
 setDescription (Translatable|string $description)
 
 setLabel (string $name)
 
 setPermission (?string $permission)
 
 setPermissionMessage (string $permissionMessage)
 
 setPermissions (array $permissions)
 
 setUsage (Translatable|string $usage)
 
 testPermission (CommandSender $target, ?string $permission=null)
 
 testPermissionSilent (CommandSender $target, ?string $permission=null)
 
 unregister (CommandMap $commandMap)
 

Static Public Member Functions

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

Public Attributes

const MAX_COORD = 30000000
 
const MIN_COORD = -30000000
 

Protected Member Functions

 fetchPermittedPlayerTarget (CommandSender $sender, ?string $target, string $selfPermission, string $otherPermission)
 
 getBoundedInt (CommandSender $sender, string $input, int $min, int $max)
 
 getDouble (CommandSender $sender, string $value, float $min=self::MIN_COORD, float $max=self::MAX_COORD)
 
 getInteger (CommandSender $sender, string $value, int $min=self::MIN_COORD, int $max=self::MAX_COORD)
 
 getRelativeDouble (float $original, CommandSender $sender, string $input, float $min=self::MIN_COORD, float $max=self::MAX_COORD)
 

Protected Attributes

Translatable string $description = ""
 
Translatable string $usageMessage
 

Detailed Description

Definition at line 35 of file VanillaCommand.php.

Member Function Documentation

◆ __toString()

pocketmine\command\Command::__toString ( )
inherited

Definition at line 251 of file Command.php.

◆ broadcastCommandMessage()

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

Definition at line 233 of file Command.php.

◆ execute()

pocketmine\command\Command::execute ( CommandSender $sender,
string $commandLabel,
array $args )
abstractinherited
Parameters
string[]$args
Returns
mixed
Exceptions
CommandException

Reimplemented in pocketmine\command\ClosureCommand, pocketmine\command\defaults\BanCommand, pocketmine\command\defaults\BanIpCommand, pocketmine\command\defaults\BanListCommand, pocketmine\command\defaults\ClearCommand, pocketmine\command\defaults\DefaultGamemodeCommand, pocketmine\command\defaults\DeopCommand, pocketmine\command\defaults\DifficultyCommand, pocketmine\command\defaults\DumpMemoryCommand, pocketmine\command\defaults\EffectCommand, pocketmine\command\defaults\EnchantCommand, pocketmine\command\defaults\GamemodeCommand, pocketmine\command\defaults\GarbageCollectorCommand, pocketmine\command\defaults\GiveCommand, pocketmine\command\defaults\HelpCommand, pocketmine\command\defaults\KickCommand, pocketmine\command\defaults\KillCommand, pocketmine\command\defaults\ListCommand, pocketmine\command\defaults\MeCommand, pocketmine\command\defaults\OpCommand, pocketmine\command\defaults\PardonCommand, pocketmine\command\defaults\PardonIpCommand, pocketmine\command\defaults\ParticleCommand, pocketmine\command\defaults\PluginsCommand, pocketmine\command\defaults\SaveCommand, pocketmine\command\defaults\SaveOffCommand, pocketmine\command\defaults\SaveOnCommand, pocketmine\command\defaults\SayCommand, pocketmine\command\defaults\SeedCommand, pocketmine\command\defaults\SetWorldSpawnCommand, pocketmine\command\defaults\SpawnpointCommand, pocketmine\command\defaults\StatusCommand, pocketmine\command\defaults\StopCommand, pocketmine\command\defaults\TeleportCommand, pocketmine\command\defaults\TellCommand, pocketmine\command\defaults\TimeCommand, pocketmine\command\defaults\TimingsCommand, pocketmine\command\defaults\TitleCommand, pocketmine\command\defaults\TransferServerCommand, pocketmine\command\defaults\VersionCommand, pocketmine\command\defaults\WhitelistCommand, pocketmine\command\defaults\XpCommand, pocketmine\command\FormattedCommandAlias, and pocketmine\command\PluginCommand.

◆ fetchPermittedPlayerTarget()

pocketmine\command\defaults\VanillaCommand::fetchPermittedPlayerTarget ( CommandSender $sender,
?string $target,
string $selfPermission,
string $otherPermission )
protected

Definition at line 39 of file VanillaCommand.php.

◆ getAliases()

pocketmine\command\Command::getAliases ( )
inherited
Returns
string[] @phpstan-return list<string>

Definition at line 194 of file Command.php.

◆ getBoundedInt()

pocketmine\command\defaults\VanillaCommand::getBoundedInt ( CommandSender $sender,
string $input,
int $min,
int $max )
protected

Definition at line 95 of file VanillaCommand.php.

◆ getDescription()

pocketmine\command\Command::getDescription ( )
inherited

Definition at line 202 of file Command.php.

◆ getDouble()

pocketmine\command\defaults\VanillaCommand::getDouble ( CommandSender $sender,
string $value,
float $min = self::MIN_COORD,
float $max = self::MAX_COORD )
protected

Definition at line 83 of file VanillaCommand.php.

◆ getInteger()

pocketmine\command\defaults\VanillaCommand::getInteger ( CommandSender $sender,
string $value,
int $min = self::MIN_COORD,
int $max = self::MAX_COORD )
protected

Definition at line 61 of file VanillaCommand.php.

◆ getLabel()

pocketmine\command\Command::getLabel ( )
inherited

Definition at line 142 of file Command.php.

◆ getName()

pocketmine\command\Command::getName ( )
inherited

Definition at line 89 of file Command.php.

◆ getPermissionMessage()

pocketmine\command\Command::getPermissionMessage ( )
inherited

Definition at line 198 of file Command.php.

◆ getPermissions()

pocketmine\command\Command::getPermissions ( )
inherited
Returns
string[]

Definition at line 96 of file Command.php.

◆ getRelativeDouble()

pocketmine\command\defaults\VanillaCommand::getRelativeDouble ( float $original,
CommandSender $sender,
string $input,
float $min = self::MIN_COORD,
float $max = self::MAX_COORD )
protected

Definition at line 73 of file VanillaCommand.php.

◆ getUsage()

pocketmine\command\Command::getUsage ( )
inherited

Definition at line 206 of file Command.php.

◆ isRegistered()

pocketmine\command\Command::isRegistered ( )
inherited

Definition at line 186 of file Command.php.

◆ register()

pocketmine\command\Command::register ( CommandMap $commandMap)
inherited

Registers the command into a Command map

Definition at line 160 of file Command.php.

◆ setAliases()

pocketmine\command\Command::setAliases ( array $aliases)
inherited
Parameters
string[]$aliases@phpstan-param list<string> $aliases

Definition at line 214 of file Command.php.

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

+ Here is the caller graph for this function:

◆ setDescription()

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

Definition at line 221 of file Command.php.

◆ setLabel()

pocketmine\command\Command::setLabel ( string $name)
inherited

Definition at line 146 of file Command.php.

◆ setPermission()

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

Definition at line 113 of file Command.php.

◆ setPermissionMessage()

pocketmine\command\Command::setPermissionMessage ( string $permissionMessage)
inherited

Definition at line 225 of file Command.php.

◆ setPermissions()

pocketmine\command\Command::setPermissions ( array $permissions)
inherited
Parameters
string[]$permissions

Definition at line 103 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 $usage)
inherited

Definition at line 229 of file Command.php.

◆ testPermission()

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

Definition at line 117 of file Command.php.

◆ testPermissionSilent()

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

Definition at line 131 of file Command.php.

◆ unregister()

pocketmine\command\Command::unregister ( CommandMap $commandMap)
inherited

Definition at line 170 of file Command.php.

Member Data Documentation

◆ $description

Translatable string pocketmine\command\Command::$description = ""
protectedinherited

Definition at line 61 of file Command.php.

◆ $usageMessage

Translatable string pocketmine\command\Command::$usageMessage
protectedinherited

Definition at line 63 of file Command.php.

◆ MAX_COORD

const pocketmine\command\defaults\VanillaCommand::MAX_COORD = 30000000

Definition at line 36 of file VanillaCommand.php.

◆ MIN_COORD

const pocketmine\command\defaults\VanillaCommand::MIN_COORD = -30000000

Definition at line 37 of file VanillaCommand.php.

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