SimpleCommandMap Class Reference

Public Member Functions
	registerAll ($fallbackPrefix, array $commands)
	register ($fallbackPrefix, Command $command, $label=null, $overrideConfig=false)
	dispatch (CommandSender $sender, $commandLine)
	clearCommands ()
	getCommand ($name)
	getCommands ()
	registerServerAliases ()
Public Member Functions inherited from CommandMap
	register ($fallbackPrefix, Command $command, $label=null)

Protected Attributes
	$knownCommands = []
	$commandConfig = []

Member Function Documentation

clearCommands()

clearCommands

(

)

Returns

void

Implements CommandMap.

                                   {
        foreach($this->knownCommands as $command){
            $command->unregister($this);
        }
        $this->knownCommands = [];
        $this->setDefaultCommands();
    }

dispatch()

dispatch	(	CommandSender	$sender,
			$commandLine
	)

Parameters

CommandSender	$sender
string	$commandLine

Returns

bool

Implements CommandMap.

                                                                 {
        $args = explode(" ", $commandLine);

        if(count($args) === 0){
            return false;
        }

        $sentCommandLabel = strtolower(array_shift($args));
        $target = $this->getCommand($sentCommandLabel);

        if($target === null){
            return false;
        }

        $target->timings->startTiming();
        try{
            if($this->server->advancedCommandSelector){
                $this->dispatchAdvanced($sender, $target, $sentCommandLabel, $args);
            }else{
                $target->execute($sender, $sentCommandLabel, $args);
            }
        }catch(\Throwable $e){
            $sender->sendMessage(new TranslationContainer(TextFormat::RED . "%commands.generic.exception"));
            $this->server->getLogger()->critical($this->server->getLanguage()->translateString("pocketmine.command.exception", [$commandLine, (string) $target, $e->getMessage()]));
            $logger = $sender->getServer()->getLogger();
            if($logger instanceof MainLogger){
                $logger->logException($e);
            }
        }
        $target->timings->stopTiming();

        return true;
    }

getCommand()

getCommand

(

$name

)

Parameters

string

$name

Returns

null|Command

Implements CommandMap.

                                     {
        if(isset($this->knownCommands[$name])){
            return $this->knownCommands[$name];
        }

        return null;
    }

getCommands()

getCommands

(

)

Returns

Command[]

                                 {
        return $this->knownCommands;
    }

register()

register	(		$fallbackPrefix,
		Command	$command,
			$label = null,
			$overrideConfig = false
	)

Parameters

string	$fallbackPrefix
Command	$command
null	$label
bool	$overrideConfig

Returns

bool

                                                                                                       {
        if($label === null){
            $label = $command->getName();
        }
        $label = strtolower(trim($label));

        //Check if command was disabled in config and for override
        if(!(($this->commandConfig[$label] ?? $this->commandConfig["default"] ?? true) or $overrideConfig)){
            return false;
        }
        $fallbackPrefix = strtolower(trim($fallbackPrefix));

        $registered = $this->registerAlias($command, false, $fallbackPrefix, $label);

        $aliases = $command->getAliases();
        foreach($aliases as $index => $alias){
            if(!$this->registerAlias($command, true, $fallbackPrefix, $alias)){
                unset($aliases[$index]);
            }
        }
        $command->setAliases($aliases);

        if(!$registered){
            $command->setLabel($fallbackPrefix . ":" . $label);
        }

        $command->register($this);

        return $registered;
    }

registerAll()

registerAll	(		$fallbackPrefix,
		array	$commands
	)

Parameters

string	$fallbackPrefix
array	$commands

Implements CommandMap.

                                                                 {
        foreach($commands as $command){
            $this->register($fallbackPrefix, $command);
        }
    }

registerServerAliases()

registerServerAliases

(

)

Returns

void

                                           {
        $values = $this->server->getCommandAliases();

        foreach($values as $alias => $commandStrings){
            if(strpos($alias, ":") !== false or strpos($alias, " ") !== false){
                $this->server->getLogger()->warning($this->server->getLanguage()->translateString("pocketmine.command.alias.illegal", [$alias]));
                continue;
            }

            $targets = [];

            $bad = "";
            foreach($commandStrings as $commandString){
                $args = explode(" ", $commandString);
                $command = $this->getCommand($args[0]);

                if($command === null){
                    if(strlen($bad) > 0){
                        $bad .= ", ";
                    }
                    $bad .= $commandString;
                }else{
                    $targets[] = $commandString;
                }
            }

            if(strlen($bad) > 0){
                $this->server->getLogger()->warning($this->server->getLanguage()->translateString("pocketmine.command.alias.notFound", [$alias, $bad]));
                continue;
            }

            //These registered commands have absolute priority
            if(count($targets) > 0){
                $this->knownCommands[strtolower($alias)] = new FormattedCommandAlias(strtolower($alias), $targets);
            }else{
                unset($this->knownCommands[strtolower($alias)]);
            }

        }
    }

Field Documentation

$commandConfig

$commandConfig = []

protected

$knownCommands

$knownCommands = []

protected

---

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

• src/pocketmine/command/SimpleCommandMap.php