EffectInstance.php

<?php
 
/*
 *
 *  ____            _        _   __  __ _                  __  __ ____
 * |  _ \ ___   ___| | _____| |_|  \/  (_)_ __   ___      |  \/  |  _ \
 * | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
 * |  __/ (_) | (__|   <  __/ |_| |  | | | | | |  __/_____| |  | |  __/
 * |_|   \___/ \___|_|\_\___|\__|_|  |_|_|_| |_|\___|     |_|  |_|_|
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * @author PocketMine Team
 * @link http://www.pocketmine.net/
 *
 *
 */
 
declare(strict_types=1);
 
namespace pocketmine\entity\effect;
 
use pocketmine\color\Color;
use pocketmine\utils\Limits;
 
class EffectInstance{
    private Effect $effectType;
    private int $duration;
    private int $amplifier;
    private bool $visible;
    private bool $ambient;
    private Color $color;
    private bool $infinite;
 
    public function __construct(Effect $effectType, ?int $duration = null, int $amplifier = 0, bool $visible = true, bool $ambient = false, ?Color $overrideColor = null, bool $infinite = false){
        $this->effectType = $effectType;
        $this->setDuration($duration ?? $effectType->getDefaultDuration());
        $this->setAmplifier($amplifier);
        $this->visible = $visible;
        $this->ambient = $ambient;
        $this->color = $overrideColor ?? $effectType->getColor();
        $this->infinite = $infinite;
    }
 
    public function getType() : Effect{
        return $this->effectType;
    }
 
    public function getDuration() : int{
        return $this->duration;
    }
 
    public function setDuration(int $duration) : EffectInstance{
        if($duration < 0 || $duration > Limits::INT32_MAX){
            throw new \InvalidArgumentException("Effect duration must be in range 0 - " . Limits::INT32_MAX . ", got $duration");
        }
        $this->duration = $duration;
 
        return $this;
    }
 
    public function decreaseDuration(int $ticks) : EffectInstance{
        $newDuration = $this->duration - $ticks;
        if($newDuration <= 0){
            if($this->infinite){ //wrap around
                $newDuration += Limits::INT32_MAX;
            }else{
                $newDuration = 0;
            }
        }
        $this->duration = $newDuration;
 
        return $this;
    }
 
    public function hasExpired() : bool{
        return $this->duration <= 0;
    }
 
    public function getAmplifier() : int{
        return $this->amplifier;
    }
 
    public function getEffectLevel() : int{
        return $this->amplifier + 1;
    }
 
    public function setAmplifier(int $amplifier) : EffectInstance{
        if($amplifier < 0 || $amplifier > 255){
            throw new \InvalidArgumentException("Amplifier must be in range 0 - 255, got $amplifier");
        }
        $this->amplifier = $amplifier;
 
        return $this;
    }
 
    public function isVisible() : bool{
        return $this->visible;
    }
 
    public function setVisible(bool $visible = true) : EffectInstance{
        $this->visible = $visible;
 
        return $this;
    }
 
    public function isAmbient() : bool{
        return $this->ambient;
    }
 
    public function setAmbient(bool $ambient = true) : EffectInstance{
        $this->ambient = $ambient;
 
        return $this;
    }
 
    public function getColor() : Color{
        return $this->color;
    }
 
    public function setColor(Color $color) : EffectInstance{
        $this->color = $color;
 
        return $this;
    }
 
    public function resetColor() : EffectInstance{
        $this->color = $this->effectType->getColor();
 
        return $this;
    }
 
    public function isInfinite() : bool{
        return $this->infinite;
    }
}