FormattedCommandAlias Class Reference

Public Member Functions
	__construct ($alias, array $formatStrings)
	execute (CommandSender $sender, $commandLabel, array $args)
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	(		$alias,
		array	$formatStrings
	)

Parameters

string	$alias
	string[]	$formatStrings

                                                             {
        parent::__construct($alias);
        $this->formatStrings = $formatStrings;
    }

Member Function Documentation

execute()

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

Parameters

CommandSender	$sender
string	$commandLabel
array	$args

Returns

bool

                                                                              {

        $commands = [];
        $result = false;

        foreach($this->formatStrings as $formatString){
            try{
                $commands[] = $this->buildCommand($formatString, $args);
            }catch(\Throwable $e){
                if($e instanceof \InvalidArgumentException){
                    $sender->sendMessage(TextFormat::RED . $e->getMessage());
                }else{
                    $sender->sendMessage(new TranslationContainer(TextFormat::RED . "%commands.generic.exception"));
                    $logger = $sender->getServer()->getLogger();
                    if($logger instanceof MainLogger){
                        $logger->logException($e);
                    }
                }

                return false;
            }
        }

        foreach($commands as $command){
            $result |= Server::getInstance()->dispatchCommand($sender, $command);
        }

        return (bool) $result;
    }

---

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

• src/pocketmine/command/FormattedCommandAlias.php