SummonCommand Class Reference

Public Member Functions
	__construct ($name)
	execute (CommandSender $sender, $currentAlias, array $args)
Public Member Functions inherited from VanillaCommand
	__construct ($name, $description="", $usageMessage=null, array $aliases=[])
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 VanillaCommand
const	MAX_COORD = 30000000
const	MIN_COORD = -30000000
Data Fields inherited from Command
	$timings
Protected Member Functions inherited from VanillaCommand
	getInteger (CommandSender $sender, $value, $min=self::MIN_COORD, $max=self::MAX_COORD)
	getRelativeDouble ($original, CommandSender $sender, $input, $min=self::MIN_COORD, $max=self::MAX_COORD)
	getDouble (CommandSender $sender, $value, $min=self::MIN_COORD, $max=self::MAX_COORD)
Protected Attributes inherited from Command
	$commandData = null
	$description = ""
	$usageMessage

Constructor & Destructor Documentation

__construct()

__construct

(

$name

)

SummonCommand constructor.

Parameters

$name

                                      {
        parent::__construct(
            $name,
            "%pocketmine.command.summon.description",
            "%pocketmine.command.summon.usage"
        );
        $this->setPermission("pocketmine.command.summon");
    }

Member Function Documentation

execute()

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

Parameters

CommandSender	$sender
string	$currentAlias
array	$args

Returns

bool

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

        if(count($args) != 1 and count($args) != 4 and count($args) != 5){
            $sender->sendMessage(new TranslationContainer("commands.generic.usage", [$this->usageMessage]));
            return true;
        }

        $x = 0;
        $y = 0;
        $z = 0;
        if(count($args) == 4 or count($args) == 5){            //position is set
            //TODO:simpilify them to one piece of code
            //Code for setting $x
            if(is_numeric($args[1])){                            //x is given directly
                $x = $args[1];
            }elseif(strcmp($args[1], "~") >= 0){    //x is given with a "~"
                $offset_x = trim($args[1], "~");
                if($sender instanceof Player){            //using in-game
                    $x = is_numeric($offset_x) ? ($sender->x + $offset_x) : $sender->x;
                }else{                                                            //using in console
                    $sender->sendMessage(TextFormat::RED . "You must specify a position where the entity is spawned to when using in console");
                    return false;
                }
            }else{                                                                //other circumstances
                $sender->sendMessage(TextFormat::RED . "Argument error");
                return false;
            }

            //Code for setting $y
            if(is_numeric($args[2])){                            //y is given directly
                $y = $args[2];
            }elseif(strcmp($args[2], "~") >= 0){    //y is given with a "~"
                $offset_y = trim($args[2], "~");
                if($sender instanceof Player){            //using in-game
                    $y = is_numeric($offset_y) ? ($sender->y + $offset_y) : $sender->y;
                    $y = min(128, max(0, $y));
                }else{                                                            //using in console
                    $sender->sendMessage(TextFormat::RED . "You must specify a position where the entity is spawned to when using in console");
                    return false;
                }
            }else{                                                                //other circumstances
                $sender->sendMessage(TextFormat::RED . "Argument error");
                return false;
            }

            //Code for setting $z
            if(is_numeric($args[3])){                            //z is given directly
                $z = $args[3];
            }elseif(strcmp($args[3], "~") >= 0){    //z is given with a "~"
                $offset_z = trim($args[3], "~");
                if($sender instanceof Player){            //using in-game
                    $z = is_numeric($offset_z) ? ($sender->z + $offset_z) : $sender->z;
                }else{                                                            //using in console
                    $sender->sendMessage(TextFormat::RED . "You must specify a position where the entity is spawned to when using in console");
                    return false;
                }
            }else{                                                                //other circumstances
                $sender->sendMessage(TextFormat::RED . "Argument error");
                return false;
            }
        }    //finish setting the location

        if(count($args) == 1){
            if($sender instanceof Player){
                $x = $sender->x;
                $y = $sender->y;
                $z = $sender->z;
            }else{
                $sender->sendMessage(TextFormat::RED . "You must specify a position where the entity is spawned to when using in console");
                return false;
            }
        } //finish setting the location

        $entity = null;
        $type = $args[0];
        $level = ($sender instanceof Player) ? $sender->getLevel() : $sender->getServer()->getDefaultLevel();
        $nbt = new CompoundTag("", [
            "Pos" => new ListTag("Pos", [
                new DoubleTag("", $x),
                new DoubleTag("", $y),
                new DoubleTag("", $z)
            ]),
            "Motion" => new ListTag("Motion", [
                new DoubleTag("", 0),
                new DoubleTag("", 0),
                new DoubleTag("", 0)
            ]),
            "Rotation" => new ListTag("Rotation", [
                new FloatTag("", lcg_value() * 360),
                new FloatTag("", 0)
            ]),
        ]);
        if(count($args) == 5 and $args[4]{0} == "{"){//Tags are found
            $nbtExtra = NBT::parseJSON($args[4]);
            $nbt = NBT::combineCompoundTags($nbt, $nbtExtra, true);
        }

        $entity = Entity::createEntity($type, $level, $nbt);
        if($entity instanceof Entity){
            $entity->spawnToAll();
            $sender->sendMessage("Successfully spawned entity $type at ($x, $y, $z)");
            return true;
        }else{
            $sender->sendMessage(TextFormat::RED . "An error occurred when spawning the entity $type");
            return false;
        }
    }

---

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

• src/pocketmine/command/defaults/SummonCommand.php