ParticleCommand 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

)

ParticleCommand constructor.

Parameters

$name

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

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) < 7){
            $sender->sendMessage(new TranslationContainer("commands.generic.usage", [$this->usageMessage]));

            return true;
        }

        if($sender instanceof Player){
            $level = $sender->getLevel();
        }else{
            $level = $sender->getServer()->getDefaultLevel();
        }

        $name = strtolower($args[0]);

        $pos = new Vector3((float) $args[1], (float) $args[2], (float) $args[3]);

        $xd = (float) $args[4];
        $yd = (float) $args[5];
        $zd = (float) $args[6];

        $count = isset($args[7]) ? max(1, (int) $args[7]) : 1;

        $data = isset($args[8]) ? (int) $args[8] : null;

        $particle = $this->getParticle($name, $pos, $xd, $yd, $zd, $data);

        if($particle === null){
            $sender->sendMessage(new TranslationContainer(TextFormat::RED . "%commands.particle.notFound", [$name]));
            return true;
        }


        $sender->sendMessage(new TranslationContainer("commands.particle.success", [$name, $count]));

        $random = new Random((int) (microtime(true) * 1000) + mt_rand());

        for($i = 0; $i < $count; ++$i){
            $particle->setComponents(
                $pos->x + $random->nextSignedFloat() * $xd,
                $pos->y + $random->nextSignedFloat() * $yd,
                $pos->z + $random->nextSignedFloat() * $zd
            );
            $level->addParticle($particle);
        }

        return true;
    }

---

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

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