EffectCommand 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

)

EffectCommand constructor.

Parameters

$name

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

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

        $player = $sender->getServer()->getPlayer($args[0]);

        if($player === null){
            $sender->sendMessage(new TranslationContainer(TextFormat::RED . "%commands.generic.player.notFound"));
            return true;
        }

        if($player->getName() != $sender->getName() && !$sender->hasPermission("pocketmine.command.effect.other")){
            $sender->sendMessage("You don't have permission to give effect to other player .");
            return true;
        }

        if(strtolower($args[1]) === "clear"){
            foreach($player->getEffects() as $effect){
                $player->removeEffect($effect->getId());
            }

            $sender->sendMessage(new TranslationContainer("commands.effect.success.removed.all", [$player->getDisplayName()]));
            return true;
        }

        $effect = Effect::getEffectByName($args[1]);

        if($effect === null){
            $effect = Effect::getEffect((int) $args[1]);
        }

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

        $duration = 300;
        $amplification = 0;

        if(count($args) >= 3){
            $duration = (int) $args[2];
            if(!($effect instanceof InstantEffect)){
                $duration *= 20;
            }
        }elseif($effect instanceof InstantEffect){
            $duration = 1;
        }

        if(count($args) >= 4){
            $amplification = (int) $args[3];
        }

        if(count($args) >= 5){
            $v = strtolower($args[4]);
            if($v === "on" or $v === "true" or $v === "t" or $v === "1"){
                $effect->setVisible(false);
            }
        }

        if($duration === 0){
            if(!$player->hasEffect($effect->getId())){
                if(count($player->getEffects()) === 0){
                    $sender->sendMessage(new TranslationContainer("commands.effect.failure.notActive.all", [$player->getDisplayName()]));
                }else{
                    $sender->sendMessage(new TranslationContainer("commands.effect.failure.notActive", [$effect->getName(), $player->getDisplayName()]));
                }
                return true;
            }

            if($player->removeEffect($effect->getId())){
                $sender->sendMessage(new TranslationContainer("commands.effect.success.removed", [$effect->getName(), $player->getDisplayName()]));
            }
        }else{
            $effect->setDuration($duration)->setAmplifier($amplification);

            if($player->addEffect($effect)){
                self::broadcastCommandMessage($sender, new TranslationContainer("%commands.effect.success", [$effect->getName(), $effect->getId(), $effect->getAmplifier(), $player->getDisplayName(), $effect->getDuration() / 20]));
            }
        }


        return true;
    }

---

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

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