PHP Class pocketmine\command\Command

Afficher le fichier Open project: iTXTech/Genisys Class Usage Examples

Méthodes publiques

Свойство	Type	Description
$timings	pocketmine\event\TimingsHandler

Protected Properties

Свойство	Type	Description
$description	string
$usageMessage	string

Méthodes publiques

Méthode	Description
__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

Private Methods

Méthode	Description
allowChangesFrom ( pocketmine\command\CommandMap $commandMap ) : boolean

Method Details

__construct() public méthode

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

__toString() public méthode

public __toString ( ) : string
Résultat	string

broadcastCommandMessage() public static méthode

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

execute() abstract public méthode

abstract public execute ( pocketmine\command\CommandSender $sender, string $commandLabel, array $args ) : mixed
$sender	pocketmine\command\CommandSender
$commandLabel	string
$args	array
Résultat	mixed

getAliases() public méthode

public getAliases ( ) : string[]
Résultat	string[]

getDescription() public méthode

public getDescription ( ) : string
Résultat	string

getLabel() public méthode

public getLabel ( ) : string
Résultat	string

getName() public méthode

public getName ( ) : string
Résultat	string

getPermission() public méthode

public getPermission ( ) : string
Résultat	string

getPermissionMessage() public méthode

public getPermissionMessage ( ) : string
Résultat	string

getUsage() public méthode

public getUsage ( ) : string
Résultat	string

isRegistered() public méthode

public isRegistered ( ) : boolean
Résultat	boolean

register() public méthode

Registers the command into a Command map

public register ( pocketmine\command\CommandMap $commandMap ) : boolean
$commandMap	pocketmine\command\CommandMap
Résultat	boolean

setAliases() public méthode

public setAliases ( array $aliases )
$aliases	array

setDescription() public méthode

public setDescription ( string $description )
$description	string

setLabel() public méthode

public setLabel ( $name )

setPermission() public méthode

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

setPermissionMessage() public méthode

public setPermissionMessage ( string $permissionMessage )
$permissionMessage	string

setUsage() public méthode

public setUsage ( string $usage )
$usage	string

testPermission() public méthode

public testPermission ( pocketmine\command\CommandSender $target ) : boolean
$target	pocketmine\command\CommandSender
Résultat	boolean

testPermissionSilent() public méthode

public testPermissionSilent ( pocketmine\command\CommandSender $target ) : boolean
$target	pocketmine\command\CommandSender
Résultat	boolean

unregister() public méthode

public unregister ( pocketmine\command\CommandMap $commandMap ) : boolean
$commandMap	pocketmine\command\CommandMap
Résultat	boolean

Property Details

$description protected_oe property

protected string $description
Résultat	string

$timings public_oe property

public TimingsHandler,pocketmine\event $timings
Résultat	pocketmine\event\TimingsHandler

$usageMessage protected_oe property

protected string $usageMessage
Résultat	string