PluginCommand Class Reference

Public Member Functions
	__construct ($name, Plugin $owner)
	execute (CommandSender $sender, $commandLabel, array $args)
	getExecutor ()
	setExecutor (CommandExecutor $executor)
	getPlugin ()
Public Member Functions inherited from Command
	__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 ()

Additional Inherited Members
Static Public Member Functions inherited from Command
static	generateDefaultData ()
static	broadcastCommandMessage (CommandSender $source, $message, $sendToSource=true)
Data Fields inherited from Command
	$timings
Protected Attributes inherited from Command
	$commandData = null
	$description = ""
	$usageMessage

Constructor & Destructor Documentation

__construct()

__construct	(		$name,
		Plugin	$owner
	)

Parameters

string	$name
Plugin	$owner

                                                     {
        parent::__construct($name);
        $this->owningPlugin = $owner;
        $this->executor = $owner;
        $this->usageMessage = "";
    }

Member Function Documentation

execute()

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

Parameters

CommandSender	$sender
string	$commandLabel
array	$args

Returns

bool

                                                                              {

        if(!$this->owningPlugin->isEnabled()){
            return false;
        }

        if(!$this->testPermission($sender)){
            return false;
        }

        $success = $this->executor->onCommand($sender, $this, $commandLabel, $args);

        if(!$success and $this->usageMessage !== ""){
            $sender->sendMessage(new TranslationContainer("commands.generic.usage", [$this->usageMessage]));
        }

        return $success;
    }

getExecutor()

getExecutor

(

)

Returns

CommandExecutor|Plugin

                                 {
        return $this->executor;
    }

getPlugin()

getPlugin

(

)

Returns

Plugin

Implements PluginIdentifiableCommand.

                               {
        return $this->owningPlugin;
    }

setExecutor()

setExecutor

(

CommandExecutor

$executor

)

Parameters

CommandExecutor

$executor

                                                          {
        $this->executor = ($executor != null) ? $executor : $this->owningPlugin;
    }

---

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

• src/pocketmine/command/PluginCommand.php