PHP Класс pocketmine\command\Command

Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство	Тип	Описание
$timings	pocketmine\event\TimingsHandler

Защищенные свойства (Protected)

Свойство	Тип	Описание
$description	string
$usageMessage	string

Открытые методы

Метод	Описание
__construct ( string $name, string $description = "", string $usageMessage = null, array $aliases = [] )
__toString ( ) : string
broadcastCommandMessage ( pocketmine\command\CommandSender $source, string $message, boolean $sendToSource = true )
execute ( pocketmine\command\CommandSender $sender, string $commandLabel, array $args ) : mixed
getAliases ( ) : string[]
getDescription ( ) : string
getLabel ( ) : string
getName ( ) : string
getPermission ( ) : string
getPermissionMessage ( ) : string
getUsage ( ) : string
isRegistered ( ) : boolean
register ( pocketmine\command\CommandMap $commandMap ) : boolean	Registers the command into a Command map
setAliases ( array $aliases )
setDescription ( string $description )
setLabel ( $name )
setPermission ( string \| null $permission )
setPermissionMessage ( string $permissionMessage )
setUsage ( string $usage )
testPermission ( pocketmine\command\CommandSender $target ) : boolean
testPermissionSilent ( pocketmine\command\CommandSender $target ) : boolean
unregister ( pocketmine\command\CommandMap $commandMap ) : boolean

Приватные методы

Метод	Описание
allowChangesFrom ( pocketmine\command\CommandMap $commandMap ) : boolean

Описание методов

__construct() публичный Метод

public __construct ( string $name, string $description = "", string $usageMessage = null, array $aliases = [] )
$name	string
$description	string
$usageMessage	string
$aliases	array

__toString() публичный Метод

public __toString ( ) : string
Результат	string

broadcastCommandMessage() публичный статический Метод

public static broadcastCommandMessage ( pocketmine\command\CommandSender $source, string $message, boolean $sendToSource = true )
$source	pocketmine\command\CommandSender
$message	string
$sendToSource	boolean

execute() абстрактный публичный Метод

abstract public execute ( pocketmine\command\CommandSender $sender, string $commandLabel, array $args ) : mixed
$sender	pocketmine\command\CommandSender
$commandLabel	string
$args	array
Результат	mixed

getAliases() публичный Метод

public getAliases ( ) : string[]
Результат	string[]

getDescription() публичный Метод

public getDescription ( ) : string
Результат	string

getLabel() публичный Метод

public getLabel ( ) : string
Результат	string

getName() публичный Метод

public getName ( ) : string
Результат	string

getPermission() публичный Метод

public getPermission ( ) : string
Результат	string

getPermissionMessage() публичный Метод

public getPermissionMessage ( ) : string
Результат	string

getUsage() публичный Метод

public getUsage ( ) : string
Результат	string

isRegistered() публичный Метод

public isRegistered ( ) : boolean
Результат	boolean

register() публичный Метод

Registers the command into a Command map

public register ( pocketmine\command\CommandMap $commandMap ) : boolean
$commandMap	pocketmine\command\CommandMap
Результат	boolean

setAliases() публичный Метод

public setAliases ( array $aliases )
$aliases	array

setDescription() публичный Метод

public setDescription ( string $description )
$description	string

setLabel() публичный Метод

public setLabel ( $name )

setPermission() публичный Метод

public setPermission ( string \| null $permission )
$permission	string \| null

setPermissionMessage() публичный Метод

public setPermissionMessage ( string $permissionMessage )
$permissionMessage	string

setUsage() публичный Метод

public setUsage ( string $usage )
$usage	string

testPermission() публичный Метод

public testPermission ( pocketmine\command\CommandSender $target ) : boolean
$target	pocketmine\command\CommandSender
Результат	boolean

testPermissionSilent() публичный Метод

public testPermissionSilent ( pocketmine\command\CommandSender $target ) : boolean
$target	pocketmine\command\CommandSender
Результат	boolean

unregister() публичный Метод

public unregister ( pocketmine\command\CommandMap $commandMap ) : boolean
$commandMap	pocketmine\command\CommandMap
Результат	boolean

Описание свойств

$description защищенное свойство

protected string $description
Результат	string

$timings публичное свойство

public TimingsHandler,pocketmine\event $timings
Результат	pocketmine\event\TimingsHandler

$usageMessage защищенное свойство

protected string $usageMessage
Результат	string