Command Class Reference

Public Member Functions
	__construct ($name, $description="", $usageMessage=null, array $aliases=[])
	getDefaultCommandData ()
	generateCustomCommandData (Player $player)
	getOverloads ()
	execute (CommandSender $sender, $commandLabel, array $args)
	getName ()
	getPermission ()
	setPermission ($permission)
	testPermission (CommandSender $target)
	testPermissionSilent (CommandSender $target)
	getLabel ()
	setLabel ($name)
	register (CommandMap $commandMap)
	unregister (CommandMap $commandMap)
	isRegistered ()
	getAliases ()
	getPermissionMessage ()
	getDescription ()
	getUsage ()
	setAliases (array $aliases)
	setDescription ($description)
	setPermissionMessage ($permissionMessage)
	setUsage ($usage)
	__toString ()

Static Public Member Functions
static	generateDefaultData ()
static	broadcastCommandMessage (CommandSender $source, $message, $sendToSource=true)

Data Fields
	$timings

Protected Attributes
	$commandData = null
	$description = ""
	$usageMessage

Constructor & Destructor Documentation

__construct()

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

Parameters

string	$name
string	$description
string	$usageMessage
	string[]	$aliases

                                                                                                    {
        $this->commandData = self::generateDefaultData();
        $this->name = $this->nextLabel = $this->label = $name;
        $this->setDescription($description);
        $this->usageMessage = $usageMessage === null ? "/" . $name : $usageMessage;
        $this->setAliases($aliases);
        $this->timings = new TimingsHandler("** Command: " . $name);
    }

Member Function Documentation

__toString()

__toString

(

)

Returns

string

                                {
        return $this->name;
    }

broadcastCommandMessage()

static broadcastCommandMessage ( CommandSender  $source,   $message,   $sendToSource = true  )

static

Parameters

CommandSender	$source
string	$message
bool	$sendToSource

                                                                                                         {
        if($message instanceof TextContainer){
            $m = clone $message;
            $result = "[" . $source->getName() . ": " . ($source->getServer()->getLanguage()->get($m->getText()) !== $m->getText() ? "%" : "") . $m->getText() . "]";

            $users = $source->getServer()->getPluginManager()->getPermissionSubscriptions(Server::BROADCAST_CHANNEL_ADMINISTRATIVE);
            $colored = TextFormat::GRAY . TextFormat::ITALIC . $result;

            $m->setText($result);
            $result = clone $m;
            $m->setText($colored);
            $colored = clone $m;
        }else{
            $users = $source->getServer()->getPluginManager()->getPermissionSubscriptions(Server::BROADCAST_CHANNEL_ADMINISTRATIVE);
            $result = new TranslationContainer("chat.type.admin", [$source->getName(), $message]);
            $colored = new TranslationContainer(TextFormat::GRAY . TextFormat::ITALIC . "%chat.type.admin", [$source->getName(), $message]);
        }

        if($sendToSource === true and !($source instanceof ConsoleCommandSender)){
            $source->sendMessage($message);
        }

        foreach($users as $user){
            if($user instanceof CommandSender){
                if($user instanceof ConsoleCommandSender){
                    $user->sendMessage($result);
                }elseif($user !== $source){
                    $user->sendMessage($colored);
                }
            }
        }
    }

execute()

execute ( CommandSender  $sender,   $commandLabel, array  $args  )

abstract

Parameters

CommandSender	$sender
string	$commandLabel
	string[]	$args

Returns

mixed

generateCustomCommandData()

generateCustomCommandData

(

Player

$player

)

Generates modified command data for the specified player for AvailableCommandsPacket.

Parameters

Player

$player

Returns

|null

                                                             {
        //TODO: fix command permission filtering on join
        /*if(!$this->testPermissionSilent($player)){
            return null;
        }*/
        $customData = clone $this->commandData;
        $customData->aliases = $this->getAliases();
        /*foreach($customData->overloads as &$overload){
            if(isset($overload->pocketminePermission) and !$player->hasPermission($overload->pocketminePermission)){
                unset($overload);
            }
        }*/
        return $customData;
    }

generateDefaultData()

static generateDefaultData ( )

staticfinal

Returns

                                                       : \stdClass{
        if(self::$defaultDataTemplate === null){
            self::$defaultDataTemplate = json_decode(file_get_contents(Server::getInstance()->getFilePath() . "src/pocketmine/resources/command_default.json"));
        }
        return clone self::$defaultDataTemplate;
    }

getAliases()

getAliases

(

)

Returns

string[]

                                {
        return $this->activeAliases;
    }

getDefaultCommandData()

getDefaultCommandData

(

)

Returns an containing command data

Returns

                                            : \stdClass{
        return $this->commandData;
    }

getDescription()

getDescription

(

)

Returns

string

                                    {
        return $this->commandData->description;
    }

getLabel()

getLabel

(

)

Returns

string

                              {
        return $this->label;
    }

getName()

getName

(

)

Returns

string

                              : string{
        return $this->name;
    }

getOverloads()

getOverloads

(

)

Returns

                                   : \stdClass{
        return $this->commandData->overloads;
    }

getPermission()

getPermission

(

)

Returns

string

                                   {
        return $this->commandData->pocketminePermission ?? null;
    }

getPermissionMessage()

getPermissionMessage

(

)

Returns

string

                                          {
        return $this->permissionMessage;
    }

getUsage()

getUsage

(

)

Returns

string

                              {
        return $this->usageMessage;
    }

isRegistered()

isRegistered

(

)

Returns

bool

                                  {
        return $this->commandMap !== null;
    }

register()

register

(

CommandMap

$commandMap

)

Registers the command into a Command map

Parameters

CommandMap

$commandMap

Returns

bool

                                                    {
        if($this->allowChangesFrom($commandMap)){
            $this->commandMap = $commandMap;

            return true;
        }

        return false;
    }

setAliases()

setAliases

(

array

$aliases

)

Parameters

string[]

$aliases

                                              {
        $this->commandData->aliases = $aliases;
        if(!$this->isRegistered()){
            $this->activeAliases = (array) $aliases;
        }
    }

setDescription()

setDescription

(

$description

)

Parameters

string

$description

                                                {
        $this->commandData->description = $description;
    }

setLabel()

setLabel

(

$name

)

Parameters

$name

Returns

bool

                                   {
        $this->nextLabel = $name;
        if(!$this->isRegistered()){
            $this->timings = new TimingsHandler("** Command: " . $name);
            $this->label = $name;

            return true;
        }

        return false;
    }

setPermission()

setPermission

(

$permission

)

Parameters

string | null

$permission

                                              {
        if($permission !== null){
            $this->commandData->pocketminePermission = $permission;
        }else{
            unset($this->commandData->pocketminePermission);
        }
    }

setPermissionMessage()

setPermissionMessage

(

$permissionMessage

)

Parameters

string

$permissionMessage

                                                            {
        $this->permissionMessage = $permissionMessage;
    }

setUsage()

setUsage

(

$usage

)

Parameters

string

$usage

                                    {
        $this->usageMessage = $usage;
    }

testPermission()

testPermission

(

CommandSender

$target

)

Parameters

CommandSender

$target

Returns

bool

                                                         {
        if($this->testPermissionSilent($target)){
            return true;
        }

        if($this->permissionMessage === null){
            $target->sendMessage(new TranslationContainer(TextFormat::RED . "%commands.generic.permission"));
        }elseif($this->permissionMessage !== ""){
            $target->sendMessage(str_replace("<permission>", $this->getPermission(), $this->permissionMessage));
        }

        return false;
    }

testPermissionSilent()

testPermissionSilent

(

CommandSender

$target

)

Parameters

CommandSender

$target

Returns

bool

                                                               {
        if(($perm = $this->getPermission()) === null or $perm === ""){
            return true;
        }

        foreach(explode(";", $perm) as $permission){
            if($target->hasPermission($permission)){
                return true;
            }
        }

        return false;
    }

unregister()

unregister

(

CommandMap

$commandMap

)

Parameters

CommandMap

$commandMap

Returns

bool

                                                      {
        if($this->allowChangesFrom($commandMap)){
            $this->commandMap = null;
            $this->activeAliases = $this->commandData->aliases;
            $this->label = $this->nextLabel;

            return true;
        }

        return false;
    }

Field Documentation

$commandData

$commandData = null

protected

$description

$description = ""

protected

$timings

$timings

$usageMessage

$usageMessage

protected

---

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

• src/pocketmine/command/Command.php