src/entity/Attribute.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;
 
use function max;
use function min;
 
class Attribute{
    public const MC_PREFIX = "minecraft:";
 
    public const ABSORPTION = self::MC_PREFIX . "absorption";
    public const SATURATION = self::MC_PREFIX . "player.saturation";
    public const EXHAUSTION = self::MC_PREFIX . "player.exhaustion";
    public const KNOCKBACK_RESISTANCE = self::MC_PREFIX . "knockback_resistance";
    public const HEALTH = self::MC_PREFIX . "health";
    public const MOVEMENT_SPEED = self::MC_PREFIX . "movement";
    public const FOLLOW_RANGE = self::MC_PREFIX . "follow_range";
    public const HUNGER = self::MC_PREFIX . "player.hunger";
    public const FOOD = self::HUNGER;
    public const ATTACK_DAMAGE = self::MC_PREFIX . "attack_damage";
    public const EXPERIENCE_LEVEL = self::MC_PREFIX . "player.level";
    public const EXPERIENCE = self::MC_PREFIX . "player.experience";
    public const UNDERWATER_MOVEMENT = self::MC_PREFIX . "underwater_movement";
    public const LUCK = self::MC_PREFIX . "luck";
    public const FALL_DAMAGE = self::MC_PREFIX . "fall_damage";
    public const HORSE_JUMP_STRENGTH = self::MC_PREFIX . "horse.jump_strength";
    public const ZOMBIE_SPAWN_REINFORCEMENTS = self::MC_PREFIX . "zombie.spawn_reinforcements";
    public const LAVA_MOVEMENT = self::MC_PREFIX . "lava_movement";
 
    protected float $currentValue;
    protected bool $desynchronized = true;
 
    public function __construct(
        protected string $id,
        protected float $minValue,
        protected float $maxValue,
        protected float $defaultValue,
        protected bool $shouldSend = true
    ){
        if($minValue > $maxValue || $defaultValue > $maxValue || $defaultValue < $minValue){
            throw new \InvalidArgumentException("Invalid ranges: min value: $minValue, max value: $maxValue, $defaultValue: $defaultValue");
        }
        $this->currentValue = $this->defaultValue;
    }
 
    public function getMinValue() : float{
        return $this->minValue;
    }
 
    public function setMinValue(float $minValue){
        if($minValue > ($max = $this->getMaxValue())){
            throw new \InvalidArgumentException("Minimum $minValue is greater than the maximum $max");
        }
 
        if($this->minValue != $minValue){
            $this->desynchronized = true;
            $this->minValue = $minValue;
        }
        return $this;
    }
 
    public function getMaxValue() : float{
        return $this->maxValue;
    }
 
    public function setMaxValue(float $maxValue){
        if($maxValue < ($min = $this->getMinValue())){
            throw new \InvalidArgumentException("Maximum $maxValue is less than the minimum $min");
        }
 
        if($this->maxValue != $maxValue){
            $this->desynchronized = true;
            $this->maxValue = $maxValue;
        }
        return $this;
    }
 
    public function getDefaultValue() : float{
        return $this->defaultValue;
    }
 
    public function setDefaultValue(float $defaultValue){
        if($defaultValue > $this->getMaxValue() || $defaultValue < $this->getMinValue()){
            throw new \InvalidArgumentException("Default $defaultValue is outside the range " . $this->getMinValue() . " - " . $this->getMaxValue());
        }
 
        if($this->defaultValue !== $defaultValue){
            $this->desynchronized = true;
            $this->defaultValue = $defaultValue;
        }
        return $this;
    }
 
    public function resetToDefault() : void{
        $this->setValue($this->getDefaultValue(), true);
    }
 
    public function getValue() : float{
        return $this->currentValue;
    }
 
    public function setValue(float $value, bool $fit = false, bool $forceSend = false){
        if($value > $this->getMaxValue() || $value < $this->getMinValue()){
            if(!$fit){
                throw new \InvalidArgumentException("Value $value is outside the range " . $this->getMinValue() . " - " . $this->getMaxValue());
            }
            $value = min(max($value, $this->getMinValue()), $this->getMaxValue());
        }
 
        if($this->currentValue != $value){
            $this->desynchronized = true;
            $this->currentValue = $value;
        }elseif($forceSend){
            $this->desynchronized = true;
        }
 
        return $this;
    }
 
    public function getId() : string{
        return $this->id;
    }
 
    public function isSyncable() : bool{
        return $this->shouldSend;
    }
 
    public function isDesynchronized() : bool{
        return $this->shouldSend && $this->desynchronized;
    }
 
    public function markSynchronized(bool $synced = true) : void{
        $this->desynchronized = !$synced;
    }
}