SentinelTrait.java

package org.mcmonkey.sentinel;

import com.google.common.base.Function;
import net.citizensnpcs.api.CitizensAPI;
import net.citizensnpcs.api.ai.Navigator;
import net.citizensnpcs.api.ai.TeleportStuckAction;
import net.citizensnpcs.api.ai.speech.SpeechContext;
import net.citizensnpcs.api.event.DespawnReason;
import net.citizensnpcs.api.npc.NPC;
import net.citizensnpcs.api.persistence.Persist;
import net.citizensnpcs.api.persistence.PersistenceLoader;
import net.citizensnpcs.api.persistence.Persister;
import net.citizensnpcs.api.trait.Trait;
import net.citizensnpcs.api.trait.trait.Spawned;
import net.citizensnpcs.api.util.DataKey;
import net.citizensnpcs.trait.CurrentLocation;
import net.citizensnpcs.trait.waypoint.WanderWaypointProvider;
import net.citizensnpcs.trait.waypoint.Waypoint;
import net.citizensnpcs.trait.waypoint.WaypointProvider;
import net.citizensnpcs.trait.waypoint.Waypoints;
import net.citizensnpcs.util.NMS;
import net.citizensnpcs.util.PlayerAnimation;
import org.bukkit.*;
import org.bukkit.configuration.file.FileConfiguration;
import org.bukkit.enchantments.Enchantment;
import org.bukkit.entity.*;
import org.bukkit.event.entity.EntityDamageByEntityEvent;
import org.bukkit.event.entity.EntityDamageEvent;
import org.bukkit.event.entity.EntityDeathEvent;
import org.bukkit.event.entity.PlayerDeathEvent;
import org.bukkit.event.player.PlayerMoveEvent;
import org.bukkit.event.player.PlayerTeleportEvent;
import org.bukkit.inventory.ItemStack;
import org.bukkit.projectiles.ProjectileSource;
import org.bukkit.scheduler.BukkitRunnable;
import org.bukkit.util.Vector;
import org.mcmonkey.sentinel.targeting.SentinelTarget;
import org.mcmonkey.sentinel.targeting.SentinelTargetList;
import org.mcmonkey.sentinel.targeting.SentinelTargetingHelper;
import org.mcmonkey.sentinel.utilities.SentinelNMSHelper;
import org.mcmonkey.sentinel.utilities.SentinelVersionCompat;

import java.util.*;

/**
 * The main Sentinel trait.
 */
public class SentinelTrait extends Trait {

    /**
     * Constant: the smallest health value that can be given to an NPC.
     */
    public static final double healthMin = 0.01;

    /**
     * Constant: the maximum attack rate value (in ticks).
     */
    public static final int attackRateMax = 2000;

    /**
     * Constant: the maximum heal rate value (in ticks).
     */
    public static final int healRateMax = 2000;

    /**
     * Helper for targeting logic.
     */
    public SentinelTargetingHelper targetingHelper;

    /**
     * Helper for items.
     */
    public SentinelItemHelper itemHelper;

    /**
     * Helper for weapons.
     */
    public SentinelWeaponHelper weaponHelper;

    /**
     * Helper for attacking.
     */
    public SentinelAttackHelper attackHelper;

    /**
     * Constructs the Sentinel Trait object - should only be called by the Citizens API internal functionality.
     * To add Sentinel to an NPC, use {@code npc.addTrait(SentinelTrait.class)}.
     */
    public SentinelTrait() {
        super("sentinel");
        targetingHelper = new SentinelTargetingHelper();
        itemHelper = new SentinelItemHelper();
        weaponHelper = new SentinelWeaponHelper();
        attackHelper = new SentinelAttackHelper();
        targetingHelper.setTraitObject(this);
        itemHelper.setTraitObject(this);
        weaponHelper.setTraitObject(this);
        attackHelper.setTraitObject(this);
    }

    /**
     * Statistics value: how long (in ticks) this NPC has ever been in the world, in total.
     */
    @Persist("stats_ticksSpawned")
    public long stats_ticksSpawned = 0;

    /**
     * Statistics value: how many times this NPC has spawned into the world.
     */
    @Persist("stats_timesSpawned")
    public long stats_timesSpawned = 0;

    /**
     * Statistics value: how many arrows this NPC has fired.
     */
    @Persist("stats_arrowsFired")
    public long stats_arrowsFired = 0;

    /**
     * Statistics value: how many potions this NPC has thrown.
     */
    @Persist("stats_potionsThrow")
    public long stats_potionsThrown = 0;

    /**
     * Statistics value: how many fireballs this NPC has fired.
     */
    @Persist("stats_fireballsFired")
    public long stats_fireballsFired = 0;

    /**
     * Statistics value: how many snowballs this NPC has thrown.
     */
    @Persist("stats_snowballsThrown")
    public long stats_snowballsThrown = 0;

    /**
     * Statistics value: how many eggs this NPC has thrown.
     */
    @Persist("stats_eggsThrown")
    public long stats_eggsThrown = 0;

    /**
     * Statistics value: how many skulls this NPC has thrown.
     */
    @Persist("stats_skullsThrown")
    public long stats_skullsThrown = 0;

    /**
     * Statistics value: how many pearls this NPC has used.
     */
    @Persist("stats_pearlsUsed")
    public long stats_pearlsUsed = 0;

    /**
     * Statistics value: how many times this NPC has punched a target.
     */
    @Persist("stats_punches")
    public long stats_punches = 0;

    /**
     * Statistics value: how many attacks this NPC has attempted.
     */
    @Persist("stats_attackAttempts")
    public long stats_attackAttempts = 0;

    /**
     * Statistics value: how much damage this NPC has taken.
     */
    @Persist("stats_damageTaken")
    public double stats_damageTaken = 0;

    /**
     * Statistics value: how much damage this NPC has given.
     */
    @Persist("stats_damageGiven")
    public double stats_damageGiven = 0;

    /**
     * Updater for older Sentinel saves (up to 1.7.2)
     */
    @Override
    public void load(final DataKey key) {
        new BukkitRunnable() {
            @Override
            public void run() {
                updateOld(key);
            }
        }.runTaskLater(SentinelPlugin.instance, 1);
    }

    @Override
    public void save(DataKey key) {
        for (DataKey subkey : key.getSubKeys()) {
            if (subkey.name().equals("targets")
                    || subkey.name().equals("ignores")
                    || subkey.name().endsWith("Targets")
                    || subkey.name().endsWith("Ignores")) {
                key.removeKey(subkey.name());
            }
        }
    }

    /**
     * Updater for older Sentinel saves (up to 1.7.2)
     */
    public void updateOld(DataKey key) {
        for (DataKey subkey : key.getSubKeys()) {
            if (subkey.name().equals("targets")) {
                for (DataKey listEntry : subkey.getSubKeys()) {
                    allTargets.targets.add(listEntry.getRaw("").toString());
                }
                allTargets.recalculateTargetsCache();
            }
            else if (subkey.name().equals("ignores")) {
                for (DataKey listEntry : subkey.getSubKeys()) {
                    allIgnores.targets.add(listEntry.getRaw("").toString());
                }
                allIgnores.recalculateTargetsCache();
            }
            if (subkey.name().endsWith("Targets")) {
                allTargets.updateOld(subkey, subkey.name().substring(0, subkey.name().length() - "Targets".length()));
            }
            else if (subkey.name().endsWith("Ignores")) {
                allIgnores.updateOld(subkey, subkey.name().substring(0, subkey.name().length() - "Ignores".length()));
            }
        }
    }

    @Persist("allTargets")
    public SentinelTargetList allTargets = new SentinelTargetList();

    @Persist("allIgnores")
    public SentinelTargetList allIgnores = new SentinelTargetList();

    @Persist("allAvoids")
    public SentinelTargetList allAvoids = new SentinelTargetList();

    public static class SentinelTargetListPersister implements Persister<SentinelTargetList> {
        @Override
        public SentinelTargetList create(DataKey dataKey) {
            SentinelTargetList list = PersistenceLoader.load(new SentinelTargetList(), dataKey);
            list.init();
            return list;
        }

        @Override
        public void save(SentinelTargetList o, DataKey dataKey) {
            PersistenceLoader.save(o, dataKey);
        }
    }

    static {
        PersistenceLoader.registerPersistDelegate(SentinelTargetList.class, SentinelTargetListPersister.class);
    }

    /**
     * How far to stay from avoid targets.
     */
    @Persist
    public double avoidRange = 10.0;

    /**
     * Maximum range to trigger attacks from.
     */
    @Persist("range")
    public double range = 20.0;

    /**
     * The NPC's damage value (-1 means automatically calculated from weapon, anything else is equal to the HP lost by an unarmored target).
     */
    @Persist("damage")
    public double damage = -1.0;

    /**
     * The NPC's armor value (-1 means automatically calculated from equipment, 0 means no armor and 1 means invincible armor... decimals between 0 and 1 are normal).
     */
    @Persist("armor")
    public double armor = -1.0;

    /**
     * The NPC's maximum health (NOT its current health when the NPC is spawned and injured).
     */
    @Persist("health")
    public double health = 20.0;

    /**
     * Whether the NPC chases targets when using ranged weapons.
     */
    @Persist("ranged_chase")
    public boolean rangedChase = false;

    /**
     * Whether the NPC chases targets when using melee weapons.
     */
    @Persist("close_chase")
    public boolean closeChase = true;

    /**
     * Whether the NPC cannot be harmed (true = no harm, false = receives damage normally).
     */
    @Persist("invincible")
    public boolean invincible = false;

    /**
     * Whether the NPC "fights back" against attacks (targets anyone that damages it).
     */
    @Persist("fightback")
    public boolean fightback = true;

    /**
     * Whether the NPC runs away when attacked.
     */
    @Persist("runaway")
    public boolean runaway = false;

    /**
     * How long (in ticks) between using melee attacks.
     */
    @Persist("attackRate")
    public int attackRate = 30;

    /**
     * How long (in ticks) between firing ranged shots.
     */
    @Persist("attackRateRanged")
    public int attackRateRanged = 30;

    /**
     * How long (in ticks) before the NPC heals by 1 HP (when damaged).
     */
    @Persist("healRate")
    public int healRate = 100;

    /**
     * Upper 64 bits of the guarded player's UUID.
     */
    @Persist("guardingUpper")
    public long guardingUpper = 0;

    /**
     * Lower 64 bits of the guarded player's UUID.
     */
    @Persist("guardingLower")
    public long guardingLower = 0;

    /**
     * ID of an NPC to guard, if any.
     */
    @Persist("guardedNPC")
    public int guardedNPC = -1;

    /**
     * Whether the NPC needs ammo to fire ranged weapons (otherwise, infinite ammo).
     */
    @Persist("needsAmmo")
    public boolean needsAmmo = false;

    /**
     * Whether to protect NPC arrow shots from damaging targets that weren't meant to be hit.
     */
    @Persist("safeShot")
    public boolean safeShot = true;

    /**
     * How long (in ticks) after death before the NPC respawns.
     */
    @Persist("respawnTime")
    public long respawnTime = 100;

    /**
     * The maximum distance from a guard point the NPC can run (when chasing a target).
     */
    @Persist("chaseRange")
    public double chaseRange = 100;

    /**
     * The NPC's respawn location (null = respawn where the NPC died at).
     */
    @Persist("spawnPoint")
    public Location spawnPoint = null;

    /**
     * The NPC's avoid return point (null = just run away).
     */
    @Persist("avoidReturnPoint")
    public Location avoidReturnPoint = null;

    /**
     * What the NPC drops when dead.
     */
    @Persist("drops")
    public ArrayList<ItemStack> drops = new ArrayList<>();

    /**
     * Chances of item drops, matched to the 'drops' list.
     */
    @Persist("dropChances")
    public ArrayList<Double> dropChances = new ArrayList<>();

    /**
     * Whether mob targets killed by the NPC can drop items.
     */
    @Persist("enemyDrops")
    public boolean enemyDrops = false;

    /**
     * How long (in ticks) to retain an enemy target when out-of-view.
     */
    @Persist("enemyTargetTime")
    public long enemyTargetTime = 0;

    /**
     * How fast the NPC moves when chasing (1 = normal speed).
     */
    @Persist("speed")
    public double speed = 1;

    /**
     * The text to warn enemy players with (empty string = no greeting).
     */
    @Persist("warning_text")
    public String warningText = "";

    /**
     * The text to greet friendly players with (empty string = no greeting).
     */
    @Persist("greeting_text")
    public String greetingText = "";

    /**
     * The range this NPC gives greetings or warnings at.
     */
    @Persist("greet_range")
    public double greetRange = 10;

    /**
     * The rate in ticks this NPC gives greetings or warnings at.
     */
    @Persist("greet_rate")
    public int greetRate = 100;

    /**
     * Whether this NPC automatically switches weapons.
     */
    @Persist("autoswitch")
    public boolean autoswitch = false;

    /**
     * The name of the squad this NPC is in (null for no squad).
     */
    @Persist("squad")
    public String squad = null;

    /**
     * The NPC's accuracy value (0 = perfectly accurate).
     */
    @Persist("accuracy")
    public double accuracy = 0;

    /**
     * Whether this NPC should have 'realistic' targeting.
     */
    @Persist("realistic")
    public boolean realistic = false;

    /**
     * Whether this NPC should ignore Line of Sight requirement. If set true, the NPC can see targets through walls.
     */
    @Persist("ignore_los")
    public boolean ignoreLOS = false;

    /**
     * How far this NPC's punches can reach.
     */
    @Persist("reach")
    public double reach = 3;

    /**
     * How far this NPC is willing to fire projectiles.
     */
    @Persist("projectileRange")
    public double projectileRange = 100;

    /**
     * Minimum distance before choosing a new point (relative to guarded player).
     */
    @Persist("guard_distance_minimum")
    public double guardDistanceMinimum = 7;

    /**
     * Maximum possible distance of point to choose (relative to the guarded player).
     */
    @Persist("guard_selection_range")
    public double guardSelectionRange = 4;

    @Persist("retain_target")
    public boolean retainTarget = false;

    /**
     * Map of weapon material names to custom damage amount.
     */
    @Persist("weapon_damage_map")
    public HashMap<String, Double> weaponDamage = new HashMap<>();

    /**
     * Map of held weapon material names to redirect 'work like' material names.
     */
    @Persist("weapon_redirect_map")
    public HashMap<String, String> weaponRedirects = new HashMap<>();

    /**
     * If set 'true', the NPC will never teleport through Sentinel logic.
     * When enabling this, you should set the Citizens "stuckAction" NavigatorParameter to "null" as well.
     */
    @Persist("disable_teleporting")
    public boolean disableTeleporting = false;

    /**
     * Ticks before a new target is properly noticed.
     * 0 = no slowdown applied.
     */
    @Persist("reaction_slowdown")
    public int reactionSlowdown = 0;

    /**
     * Whether the NPC can receive knockback.
     */
    @Persist("allow_knockback")
    public boolean allowKnockback = true;

    /**
     * The target entity this NPC is chasing (if any).
     */
    public LivingEntity chasing = null;

    /**
     * Whether the NPC is currently trying to block with a shield.
     */
    public boolean isBlocking = false;

    /**
     * Causes the NPC to start blocking with a shield (if it has one).
     */
    public void startBlocking() {
        if (!npc.isSpawned() || !(getLivingEntity() instanceof Player) || !itemHelper.hasShield()) {
            isBlocking = false;
            return;
        }
        if (SentinelPlugin.debugMe && !isBlocking) {
            debug("I'm scared! I'll block with my shield!");
        }
        isBlocking = true;
        PlayerAnimation.START_USE_OFFHAND_ITEM.play((Player) getLivingEntity());
        autoSpeedModifier();
    }

    /**
     * Causes the NPC to stop blocking with a shield (if it has one).
     */
    public void stopBlocking() {
        if (!isBlocking) {
            return;
        }
        if (SentinelPlugin.debugMe) {
            debug("No more threat ahead. I'll put my shield down.");
        }
        isBlocking = false;
        if (!npc.isSpawned() || !(getLivingEntity() instanceof Player) || !itemHelper.hasShield()) {
            return;
        }
        PlayerAnimation.STOP_USE_ITEM.play((Player) getLivingEntity());
        autoSpeedModifier();
    }

    /**
     * Sets the NPC's local parameter speed modifier to its proper current value.
     */
    public void autoSpeedModifier() {
        double speedMod = isBlocking ? 0.6 : 1.0;
        getNPC().getNavigator().getLocalParameters().speedModifier((float) (speed * speedMod));
    }

    /**
     * Gets the UUID of the player this Sentinel is set to be guarding.
     * Null indicates not guarding anyone.
     */
    public UUID getGuarding() {
        if (guardedNPC >= 0) {
            NPC npc = CitizensAPI.getNPCRegistry().getById(guardedNPC);
            if (npc != null) {
                return npc.getUniqueId();
            }
        }
        if (guardingLower == 0 && guardingUpper == 0) {
            return null;
        }
        return new UUID(guardingUpper, guardingLower);
    }

    /**
     * Sets the NPC to be guarding an NPC.
     * -1 indicates not guarding anyone.
     */
    public void setGuarding(int npcID) {
        guardingUpper = 0;
        guardingLower = 0;
        guardedNPC = npcID;
    }

    /**
     * Sets the NPC to be guarding an entity.
     * Null indicates not guarding anyone.
     */
    public void setGuarding(UUID uuid) {
        guardedNPC = -1;
        if (uuid == null) {
            guardingUpper = 0;
            guardingLower = 0;
        }
        else {
            guardingUpper = uuid.getMostSignificantBits();
            guardingLower = uuid.getLeastSignificantBits();
        }
    }

    /**
     * Internally tracks whether the damage enforcement system can be used (protects against infinite loops).
     */
    private boolean canEnforce = false;

    private static EntityDamageEvent.DamageModifier[] modifiersToZero = new EntityDamageEvent.DamageModifier[]{
            EntityDamageEvent.DamageModifier.HARD_HAT, EntityDamageEvent.DamageModifier.BLOCKING,
            EntityDamageEvent.DamageModifier.RESISTANCE, EntityDamageEvent.DamageModifier.MAGIC,
            EntityDamageEvent.DamageModifier.ABSORPTION
    };

    /**
     * How long ago (in ticks) the NPC was last burned.
     */
    public int ticksSinceLastBurn = 0;

    /**
     * Called when this sentinel gets hurt.
     */
    public void whenImHurt(EntityDamageEvent event) {
        if (SentinelPlugin.debugMe) {
            debug("I'm hurt! By " + event.getCause().name() + " for " + event.getFinalDamage() + " hp");
        }
        switch (event.getCause()) {
            case FIRE:
            case FIRE_TICK:
            case LAVA:
            case MELTING:
                if (ticksSinceLastBurn <= 20) {
                    event.setDamage(0);
                    event.setCancelled(true);
                    return;
                }
                ticksSinceLastBurn = 0;
                break;
        }
    }

    /**
     * Returns a boolean indicating whether a hit from the given damager should be blocked by a shield.
     */
    public boolean hitIsBlocked(Entity damager) {
        if (!isBlocking) {
            return false;
        }
        if (!itemHelper.hasShield()) {
            isBlocking = false;
            return false;
        }
        if (!SentinelUtilities.isLookingTowards(getLivingEntity().getEyeLocation(), damager.getLocation(), 45, 45)) {
            return false;
        }
        if (SentinelVersionCompat.v1_14 && damager instanceof Arrow && ((Arrow) damager).getPierceLevel() > 0) {
            return false;
        }
        return true;
    }

    private static Vector VECTOR_ZERO = new Vector(0, 0, 0);

    /**
     * Called when this sentinel gets attacked, to correct the armor handling.
     */
    public void whenAttacksAreHappeningToMe(EntityDamageByEntityEvent event) {
        if (event.isCancelled()) {
            return;
        }
        if (!getNPC().isSpawned()) {
            return;
        }
        double armorLevel = getArmor(getLivingEntity());
        if (hitIsBlocked(event.getDamager())) {
            armorLevel = (1.0 - armorLevel) * 0.5 + armorLevel;
        }
        if (!event.isApplicable(EntityDamageEvent.DamageModifier.ARMOR)) {
            event.setDamage(EntityDamageEvent.DamageModifier.BASE, (1.0 - armorLevel) * event.getDamage(EntityDamageEvent.DamageModifier.BASE));
        }
        else {
            event.setDamage(EntityDamageEvent.DamageModifier.ARMOR, -armorLevel * event.getDamage(EntityDamageEvent.DamageModifier.BASE));
        }
        for (EntityDamageEvent.DamageModifier modifier : modifiersToZero) {
            if (event.isApplicable(modifier)) {
                event.setDamage(modifier, 0);
            }
        }
        if (!allowKnockback) {
            getLivingEntity().setVelocity(VECTOR_ZERO);
            Bukkit.getScheduler().scheduleSyncDelayedTask(SentinelPlugin.instance, () -> {
                if (npc.isSpawned()) {
                    getLivingEntity().setVelocity(VECTOR_ZERO);
                }
            }, 1);
        }
    }

    /**
     * Called when this sentinel attacks something, to correct damage handling.
     */
    public void whenAttacksAreHappeningFromMe(EntityDamageByEntityEvent event) {
        if (event.isCancelled()) {
            return;
        }
        if (!npc.isSpawned()) {
            return;
        }
        if (SentinelPlugin.instance.alternateDamage) {
            if (canEnforce) {
                canEnforce = false;
                whenAttacksHappened(event);
                if (!event.isCancelled()) {
                    ((LivingEntity) event.getEntity()).damage(event.getFinalDamage());
                    if (event.getEntity() instanceof LivingEntity) {
                        weaponHelper.knockback((LivingEntity) event.getEntity(), 1f);
                    }
                }
                if (SentinelPlugin.debugMe) {
                    debug("enforce damage value to " + event.getFinalDamage());
                }
            }
            else {
                if (SentinelPlugin.debugMe) {
                    debug("refuse damage enforcement");
                }
            }
            event.setDamage(0);
            event.setCancelled(true);
            return;
        }
        event.setDamage(EntityDamageEvent.DamageModifier.BASE, getDamage(false));
    }

    /**
     * Called when this sentinel attacks something with a projectile, to correct damage handling.
     */
    public void whenAttacksAreHappeningFromMyArrow(EntityDamageByEntityEvent event) {
        if (event.isCancelled()) {
            return;
        }
        if (!npc.isSpawned()) {
            return;
        }
        if (SentinelPlugin.instance.alternateDamage) {
            if (canEnforce) {
                canEnforce = false;
                whenAttacksHappened(event);
                if (!event.isCancelled()) {
                    ((LivingEntity) event.getEntity()).damage(getDamage(true));
                    if (event.getEntity() instanceof LivingEntity) {
                        weaponHelper.knockback((LivingEntity) event.getEntity(), 1f);
                    }
                }
                if (SentinelPlugin.debugMe) {
                    debug("enforce damage value to " + getDamage(true));
                }
            }
            else {
                if (SentinelPlugin.debugMe) {
                    debug("refuse damage enforcement");
                }
            }
            event.setDamage(0);
            event.setCancelled(true);
            return;
        }
        double dam = getDamage(true);
        double modder = event.getDamage(EntityDamageEvent.DamageModifier.BASE);
        double rel = modder == 0.0 ? 1.0 : dam / modder;
        event.setDamage(EntityDamageEvent.DamageModifier.BASE, dam);
        for (EntityDamageEvent.DamageModifier mod : EntityDamageEvent.DamageModifier.values()) {
            if (mod != EntityDamageEvent.DamageModifier.BASE && event.isApplicable(mod)) {
                event.setDamage(mod, event.getDamage(mod) * rel);
                if (SentinelPlugin.debugMe) {
                    debug("Set damage for " + mod + " to " + event.getDamage(mod));
                }
            }
        }
    }

    private EntityDamageByEntityEvent damageDeDup = null;

    public void whenAttacksHappened(EntityDamageByEntityEvent event) {
        if (!npc.isSpawned()) {
            return;
        }
        if (event.isCancelled()) {
            return;
        }
        if (event == damageDeDup) {
            return;
        }
        damageDeDup = event;
        Entity damager = event.getDamager();
        LivingEntity projectileSource = null;
        if (damager instanceof Projectile) {
            ProjectileSource source = ((Projectile) damager).getShooter();
            if (source instanceof LivingEntity) {
                projectileSource = (LivingEntity) source;
                damager = projectileSource;
            }
        }
        boolean isMe = event.getEntity().getUniqueId().equals(getLivingEntity().getUniqueId());
        if (SentinelPlugin.instance.protectFromIgnores && isMe) {
            if (damager instanceof LivingEntity && targetingHelper.isIgnored((LivingEntity) damager)) {
                event.setCancelled(true);
                return;
            }
            else if (projectileSource != null && targetingHelper.isIgnored(projectileSource)) {
                event.setCancelled(true);
                return;
            }
        }
        boolean isKilling = event.getEntity() instanceof LivingEntity && event.getFinalDamage() >= ((LivingEntity) event.getEntity()).getHealth();
        boolean isFriend = getGuarding() != null && event.getEntity().getUniqueId().equals(getGuarding());
        boolean attackerIsMe = damager.getUniqueId().equals(getLivingEntity().getUniqueId());
        if (projectileSource != null && projectileSource.getUniqueId().equals(getLivingEntity().getUniqueId())) {
            attackerIsMe = true;
        }
        if (isMe || isFriend) {
            if (attackerIsMe) {
                if (SentinelPlugin.debugMe) {
                    debug("Ignoring damage I did to " + (isMe ? "myself." : "my friend."));
                }
                event.setCancelled(true);
                return;
            }
            if (getGuarding() != null && damager.getUniqueId().equals(getGuarding())) {
                if (isMe && SentinelPlugin.instance.noGuardDamage) {
                    if (SentinelPlugin.debugMe) {
                        debug("Ignoring damage from the player we're guarding.");
                    }
                    event.setCancelled(true);
                }
                return;
            }
            if (isMe) {
                stats_damageTaken += event.getFinalDamage();
                if (runaway) {
                    if (SentinelPlugin.debugMe) {
                        debug("Ow! They hit me! Run!");
                    }
                    targetingHelper.addAvoid(damager.getUniqueId());
                }
            }
            if (fightback && (damager instanceof LivingEntity) && !targetingHelper.isIgnored((LivingEntity) damager)) {
                if (SentinelPlugin.debugMe) {
                    debug("Fighting back against attacker: " + damager.getUniqueId() + "! They hurt " + (isMe ? "me!" : "my friend!"));
                }
                targetingHelper.addTarget(damager.getUniqueId());
            }
            if (SentinelPlugin.debugMe && isMe) {
                debug("Took damage of " + event.getFinalDamage() + " with currently remaining health " + getLivingEntity().getHealth()
                    + (isKilling ? ". This will kill me." : "."));
            }
            if (isKilling && isMe && SentinelPlugin.instance.blockEvents) {
                // We're going to die but we've been requested to avoid letting a death event fire.
                // The solution at this point is to fake our death: remove the NPC entity from existence and trigger our internal death handling sequence.
                // We also mark the damage event cancelled to reduce trouble (ensure event doesn't try to apply damage to our now-gone entity).
                if (SentinelPlugin.debugMe) {
                    debug("Died! Applying death workaround (due to config setting)");
                }
                generalDeathHandler(getLivingEntity());
                npc.despawn(DespawnReason.PLUGIN);
                event.setCancelled(true);
                return;
            }
            return;
        }
        if (attackerIsMe) {
            if (safeShot && !targetingHelper.shouldTarget((LivingEntity) event.getEntity())) {
                event.setCancelled(true);
                return;
            }
            stats_damageGiven += event.getFinalDamage();
            if (!enemyDrops && event.getEntity().getType() != EntityType.PLAYER) {
                needsDropsClear.add(event.getEntity().getUniqueId());
                if (SentinelPlugin.debugMe) {
                    debug("This " + event.getEntity().getType() + " with id " + event.getEntity().getUniqueId() + " is being tracked for potential drops removal.");
                }
            }
            return;
        }
    }

    private SentinelCurrentTarget tempTarget = new SentinelCurrentTarget();

    /**
     * Called when a target dies to remove them from the target list.
     */
    public void whenAnEnemyDies(UUID dead) {
        tempTarget.targetID = dead;
        targetingHelper.removeTargetNoBounce(tempTarget);
        targetingHelper.currentAvoids.remove(tempTarget);
        if (chasing != null && chasing.getUniqueId().equals(dead)) {
            chasing = null;
        }
        Bukkit.getScheduler().scheduleSyncDelayedTask(SentinelPlugin.instance, () -> {
            tempTarget.targetID = dead;
            targetingHelper.removeTargetNoBounce(tempTarget);
            targetingHelper.currentAvoids.remove(tempTarget);
        }, 4);
    }

    /**
     * Called when the Sentinel trait is attached to the NPC - fills all default values from config.
     */
    @Override
    public void onAttach() {
        FileConfiguration config = SentinelPlugin.instance.getConfig();
        attackRate = config.getInt("sentinel defaults.attack rate", 30);
        healRate = config.getInt("sentinel defaults.heal rate", 100);
        respawnTime = config.getInt("sentinel defaults.respawn time", 100);
        rangedChase = config.getBoolean("sentinel defaults.ranged chase target", false);
        closeChase = config.getBoolean("sentinel defaults.close chase target", true);
        armor = config.getDouble("sentinel defaults.armor", -1);
        damage = config.getDouble("sentinel defaults.damage", -1);
        health = config.getDouble("sentinel defaults.health", 20);
        if (npc.isSpawned()) {
            getLivingEntity().setMaxHealth(health);
            getLivingEntity().setHealth(health);
        }
        setInvincible(config.getBoolean("sentinel defaults.invincible", false));
        fightback = config.getBoolean("sentinel defaults.fightback", true);
        needsAmmo = config.getBoolean("sentinel defaults.needs ammo", false);
        safeShot = config.getBoolean("sentinel defaults.safe shot", true);
        enemyDrops = config.getBoolean("sentinel defaults.enemy drops", false);
        enemyTargetTime = config.getInt("sentinel defaults.enemy target time", 0);
        speed = config.getInt("sentinel defaults.speed", 1);
        if (speed <= 0) {
            speed = 1;
        }
        autoswitch = config.getBoolean("sentinel defaults.autoswitch", false);
        allIgnores.targets.add(SentinelTarget.OWNER.name());
        allIgnores.recalculateTargetsCache();
        reach = config.getDouble("sentinel defaults.reach", 3);
        projectileRange = config.getDouble("sentinel defaults.projectile range", 100);
        avoidRange = config.getDouble("sentinel defaults.avoid range", 10);
        runaway = config.getBoolean("sentinel defaults.runaway", false);
        greetRange = config.getDouble("sentinel defaults.greet range", 10);
        greetRate = config.getInt("sentinel defaults.greet rate", 100);
        retainTarget = config.getBoolean("random.retain target", false);
        reactionSlowdown = config.getInt("sentinel defaults.reaction slowdown", 0);
        allowKnockback = config.getBoolean("sentinel defaults.allow knockback", true);
        guardDistanceMinimum = SentinelPlugin.instance.guardDistanceMinimum;
        guardSelectionRange = SentinelPlugin.instance.guardDistanceSelectionRange;
        if (npc.isSpawned()) {
            SentinelPlugin.instance.currentSentinelNPCs.add(this);
            lastEntityUUID = getLivingEntity().getUniqueId();
        }
    }

    /**
     * Called when the Sentinel trait is removed from an NPC.
     */
    @Override
    public void onRemove() {
        SentinelPlugin.instance.currentSentinelNPCs.remove(this);
        if (!invincible) {
            npc.setProtected(true);
        }
    }

    /**
     * Animates the NPC using their item, and stops the animation 10 ticks later (useful for replicating bow draws, etc).
     */
    public void useItem() {
        if (npc.isSpawned() && getLivingEntity() instanceof Player) {
            if (SentinelVersionCompat.v1_9) {
                PlayerAnimation.START_USE_MAINHAND_ITEM.play((Player) getLivingEntity());
                BukkitRunnable runner = new BukkitRunnable() {
                    @Override
                    public void run() {
                        if (npc.isSpawned() && getLivingEntity() instanceof Player) {
                            PlayerAnimation.STOP_USE_ITEM.play((Player) getLivingEntity());
                        }
                    }
                };
                runner.runTaskLater(SentinelPlugin.instance, 10);
            }
        }
    }

    /**
     * Swings the NPC's weapon (plays an ARM_SWING animation if possible - otherwise, does nothing).
     */
    public void swingWeapon() {
        if (!npc.isSpawned()) {
            return;
        }
        if (getLivingEntity() instanceof Player) {
            PlayerAnimation.ARM_SWING.play((Player) getLivingEntity());
        }
        else if (getLivingEntity() instanceof IronGolem) {
            SentinelNMSHelper.animateIronGolemSwing((IronGolem) getLivingEntity());
        }
        else if (SentinelVersionCompat.v1_15) {
            getLivingEntity().swingMainHand();
        }
    }

    /**
     * Gets the minimum distance from the NPC's head to launch a projectile from (to avoid it colliding with the NPC's own collision box).
     */
    public double firingMinimumRange() {
        EntityType type = getLivingEntity().getType();
        if (type == EntityType.WITHER || type == EntityType.GHAST) {
            return 8; // Yikes!
        }
        if (type == EntityType.BLAZE) {
            return 3;
        }
        if (type == EntityType.PLAYER && SentinelVersionCompat.v1_16) {
            return 0.1;
        }
        return 2;
    }

    /**
     * Gets a 'launch detail' (starting location for the projectile position, and a vector holding the exact launch vector, scaled to the correct speed).
     */
    public HashMap.SimpleEntry<Location, Vector> getLaunchDetail(Location target, Vector lead) {
        faceLocation(target);
        Location start = getLivingEntity().getEyeLocation().clone().add(getLivingEntity().getEyeLocation().getDirection().multiply(firingMinimumRange()));
        return SentinelUtilities.getLaunchDetail(start, target, lead);
    }

    /**
     * Returns a random decimal number within acceptable accuracy range (can be negative).
     */
    public double randomAcc() {
        return SentinelUtilities.random.nextDouble() * accuracy * 2 - accuracy;
    }

    /**
     * Alters a vector per accuracy potential (makes the vector less accurate).
     */
    public Vector fixForAcc(Vector input) {
        if (Double.isInfinite(input.getX()) || Double.isNaN(input.getX())) {
            return new Vector(0, 0, 0);
        }
        return new Vector(input.getX() + randomAcc(), input.getY() + randomAcc(), input.getZ() + randomAcc());
    }

    /**
     * Rotates an NPC to face a target location.
     */
    public void faceLocation(Location l) {
        Location faceTowards = l.clone().subtract(0, getLivingEntity().getEyeHeight(), 0);
        npc.faceLocation(faceTowards);
        if (npc.getNavigator().isNavigating()) {
            Function<Navigator, Location> altLookFunction = n -> faceTowards;
            Function<Navigator, Location> origLookFunction = npc.getNavigator().getLocalParameters().lookAtFunction();
            npc.getNavigator().getLocalParameters().lookAtFunction(altLookFunction);
            Bukkit.getScheduler().scheduleSyncDelayedTask(SentinelPlugin.instance, () -> {
                if (npc.getNavigator().isNavigating() && npc.getNavigator().getLocalParameters().lookAtFunction() == altLookFunction) {
                    npc.getNavigator().getLocalParameters().lookAtFunction(origLookFunction);
                }
            }, 2);
        }
    }

    /**
     * Gets the NPC's current damage value (based on held weapon if calculation is required).
     */
    public double getDamage() {
        return getDamage(false);
    }

    /**
     * Gets the NPC's current damage value (based on held weapon if calculation is required).
     */
    public double getDamage(boolean forRangedAttacks) {
        ItemStack weapon = itemHelper.getHeldItem();
        if (weapon == null) {
            if (damage >= 0) {
                return damage;
            }
            return 1;
        }
        Double customDamage = weaponDamage.get(weapon.getType().name().toLowerCase());
        if (customDamage != null) {
            damage = customDamage;
        }
        if (damage >= 0) {
            return damage;
        }
        // TODO: Less arbitrary values, more game-like calculations.
        double multiplier = 1;
        multiplier += weapon.getItemMeta() == null || !weapon.getItemMeta().hasEnchant(Enchantment.DAMAGE_ALL)
                ? 0 : weapon.getItemMeta().getEnchantLevel(Enchantment.DAMAGE_ALL) * 0.2;
        Material weaponType = weapon.getType();
        if (SentinelVersionCompat.BOW_MATERIALS.contains(weaponType)) {
            if (!forRangedAttacks) {
                return 1;
            }
            return 6 * (1 + (weapon.getItemMeta() == null || !weapon.getItemMeta().hasEnchant(Enchantment.ARROW_DAMAGE)
                    ? 0 : weapon.getItemMeta().getEnchantLevel(Enchantment.ARROW_DAMAGE) * 0.3));
        }
        Double damageMult = SentinelVersionCompat.WEAPON_DAMAGE_MULTIPLIERS.get(weaponType);
        if (damageMult == null) {
            return multiplier;
        }
        return multiplier * damageMult;
    }

    /**
     * Gets the NPC's current armor value (based on worn armor if calculation is required).
     */
    public double getArmor(LivingEntity ent) {
        if (armor < 0) {
            if (ent.getEquipment() == null) {
                return 0;
            }
            // TODO: Enchantments!
            double baseArmor = 0;
            ItemStack helmet = ent.getEquipment().getHelmet();
            Double helmetAdder = helmet == null ? null : SentinelVersionCompat.ARMOR_PROTECTION_MULTIPLIERS.get(helmet.getType());
            if (helmetAdder != null) {
                baseArmor += helmetAdder;
            }
            ItemStack chestplate = ent.getEquipment().getChestplate();
            Double chestplateAdder = chestplate == null ? null : SentinelVersionCompat.ARMOR_PROTECTION_MULTIPLIERS.get(chestplate.getType());
            if (chestplateAdder != null) {
                baseArmor += chestplateAdder;
            }
            ItemStack leggings = ent.getEquipment().getLeggings();
            Double leggingsAdder = leggings == null ? null : SentinelVersionCompat.ARMOR_PROTECTION_MULTIPLIERS.get(leggings.getType());
            if (leggingsAdder != null) {
                baseArmor += leggingsAdder;
            }
            ItemStack boots = ent.getEquipment().getBoots();
            Double bootsAdder = boots == null ? null : SentinelVersionCompat.ARMOR_PROTECTION_MULTIPLIERS.get(boots.getType());
            if (bootsAdder != null) {
                baseArmor += bootsAdder;
            }
            return Math.min(baseArmor, 0.80);
        }
        return armor;
    }

    /**
     * Gets the living entity for the NPC.
     */
    public LivingEntity getLivingEntity() {
        // Not a good idea to turn a non-living NPC into a Sentinel for now.
        return (LivingEntity) npc.getEntity();
    }

    /**
     * Players in range of the NPC that have already been greeted.
     */
    public HashSet<UUID> greetedAlready = new HashSet<>();

    /**
     * Map of player UUIDs to the last ticks-alive stamp they were greeted at.
     */
    public HashMap<UUID, Long> lastGreetTime = new HashMap<>();

    /**
     * Time since the last attack.
     */
    public long timeSinceAttack = 0;

    /**
     * Time since the last heal.
     */
    public long timeSinceHeal = 0;

    /**
     * Tick counter for use with giving up on targets that can't be seen
     * (to avoid being overly 'clever' and chasing a target the NPC shouldn't be able to locate).
     */
    int cleverTicks = 0;

    /**
     * Whether the NPC has chased a target during the most recent update.
     */
    public boolean chased = false;

    /**
     * Marks that the NPC can see a target (Changes the state of som entity types, eg opening a shulker box).
     */
    public void specialMarkVision() {
        if (SentinelPlugin.debugMe && !visionMarked) {
            debug("Target! I see you, " + (chasing == null ? "(Unknown)" : chasing.getName()));
        }
        if (SentinelVersionCompat.v1_11 && getLivingEntity().getType() == EntityType.SHULKER) {
            NMS.setPeekShulker(getLivingEntity(), 100);
        }
        visionMarked = true;
    }

    private boolean visionMarked;

    /**
     * Marks that the NPC can no longer see a target (Changes the state of som entity types, eg closing a shulker box).
     */
    public void specialUnmarkVision() {
        if (SentinelPlugin.debugMe && visionMarked) {
            debug("Goodbye, visible target " + (chasing == null ? "(Unknown)" : chasing.getName()));
        }
        if (SentinelVersionCompat.v1_11 && getLivingEntity().getType() == EntityType.SHULKER) {
            NMS.setPeekShulker(getLivingEntity(), 0);
        }
        visionMarked = false;
    }

    /**
     * Tick counter for the NPC guarding a player (to avoid updating positions too quickly).
     */
    public int ticksCountGuard = 0;

    /**
     * Set true when waypoints are paused by Sentinel, to indicate that an unpause is needed
     * (to avoid over-doing the unpause call, which can disrupt unrelated unpauses).
     */
    public boolean needsToUnpause = false;

    /**
     * Special case for where the NPC has been forced to run to in certain situations.
     */
    public Location pathingTo = null;

    /**
     * Causes the NPC to immediately path over to a position.
     */
    public void pathTo(Location target) {
        pauseWaypoints();
        pathingTo = target;
        getNPC().getNavigator().setTarget(target);
        npc.getNavigator().getLocalParameters().distanceMargin(1.5);
        autoSpeedModifier();
        chasing = null;
        needsSafeReturn = true;
    }

    /**
     * Pauses waypoint navigation if currrently navigating.
     */
    public void pauseWaypoints() {
        Waypoints wp = npc.getTraitNullable(Waypoints.class);
        if (wp == null) {
            return;
        }
        if (!wp.getCurrentProvider().isPaused()) {
            wp.getCurrentProvider().setPaused(true);
        }
        needsToUnpause = true;
        needsSafeReturn = true;
    }

    /**
     * Indicates that the NPC needs to return to safety when next possible.
     */
    public boolean needsSafeReturn = true;

    /**
     * Gets the entity this NPC is guarding, or null.
     */
    public LivingEntity getGuardingEntity() {
        if (guardedNPC >= 0) {
            NPC npc = CitizensAPI.getNPCRegistry().getById(guardedNPC);
            if (npc != null && npc.isSpawned()) {
                return (LivingEntity) npc.getEntity();
            }
        }
        UUID guardId = getGuarding();
        if (guardId == null) {
            return null;
        }
        Player player = Bukkit.getPlayer(guardId);
        if (player != null) {
            return player;
        }
        if (SentinelVersionCompat.v1_12) {
            Entity entity = Bukkit.getEntity(guardId);
            if (entity instanceof LivingEntity) {
                return (LivingEntity) entity;
            }
        }
        return null;
    }

    /**
     * Runs a full update cycle on the NPC.
     */
    public void runUpdate() {
        // Basic prep and tracking
        canEnforce = true;
        ticksSinceLastBurn += SentinelPlugin.instance.tickRate;
        timeSinceAttack += SentinelPlugin.instance.tickRate;
        timeSinceHeal += SentinelPlugin.instance.tickRate;
        LivingEntity guarded = getGuardingEntity();
        // Protection against falling below the world
        if (getLivingEntity().getLocation().getY() <= 0) {
            if (SentinelPlugin.debugMe) {
                debug("Injuring self, I'm below the map!");
            }
            getLivingEntity().damage(1);
            if (!npc.isSpawned()) {
                if (guarded != null) {
                    if (respawnTime > 0 && respawnMe == null) {
                        npc.spawn(guarded.getLocation());
                    }
                }
                return;
            }
        }
        // Settings enforcement
        if (health != getLivingEntity().getMaxHealth()) {
            getLivingEntity().setMaxHealth(health);
        }
        // Healing
        if (healRate > 0 && timeSinceHeal > healRate && getLivingEntity().getHealth() < health) {
            getLivingEntity().setHealth(Math.min(getLivingEntity().getHealth() + 1.0, health));
            timeSinceHeal = 0;
        }
        // Pathing and waypoints management
        if (!npc.getNavigator().isNavigating()) {
            pathingTo = null;
        }
        if ((guarded != null || chasing != null || pathingTo != null) && npc.hasTrait(Waypoints.class)) {
            pauseWaypoints();
        }
        else if (needsToUnpause && npc.hasTrait(Waypoints.class)) {
            Waypoints wp = npc.getOrAddTrait(Waypoints.class);
            wp.getCurrentProvider().setPaused(false);
            needsToUnpause = false;
        }
        // Targets updating
        targetingHelper.updateTargets();
        targetingHelper.updateAvoids();
        double crsq = chaseRange * chaseRange;
        boolean goHome = chased;
        if (chasing != null) {
            if (!chasing.isValid() || !targetingHelper.shouldTarget(chasing)) {
                chasing = null;
            }
        }
        targetingHelper.processAllMultiTargets();
        LivingEntity target = targetingHelper.findBestTarget();
        if (target != null) {
            Location near = nearestPathPoint();
            if (SentinelPlugin.debugMe) {
                debug("target selected to be " + target.getName());
            }
            if (crsq <= 0 || near == null || near.distanceSquared(target.getLocation()) <= crsq) {
                if (SentinelPlugin.debugMe) {
                    debug("Attack target within range of safe zone: " + (near == null ? "Any" : near.distanceSquared(target.getLocation())));
                }
                if (chasing == null) {
                    specialMarkVision();
                }
                chasing = target;
                needsSafeReturn = true;
                cleverTicks = 0;
                attackHelper.tryDefendFrom(target);
                attackHelper.tryAttack(target);
                goHome = false;
            }
            else {
                if (SentinelPlugin.debugMe) {
                    debug("Actually, that target is bad!");
                }
                specialUnmarkVision();
                target = null;
                chasing = null;
                cleverTicks = 0;
            }
        }
        else if (chasing != null && chasing.isValid()) {
            needsSafeReturn = true;
            if (SentinelPlugin.instance.workaroundEntityChasePathfinder) {
                attackHelper.rechase();
            }
            cleverTicks++;
            if (cleverTicks >= SentinelPlugin.instance.cleverTicks) {
                specialUnmarkVision();
                chasing = null;
            }
            else {
                Location near = nearestPathPoint();
                if (crsq <= 0 || near == null || near.distanceSquared(chasing.getLocation()) <= crsq) {
                    attackHelper.tryDefendFrom(chasing);
                    attackHelper.tryAttack(chasing);
                    goHome = false;
                }
            }
        }
        else if (chasing == null) {
            specialUnmarkVision();
        }
        // Special guarding handling
        if (guarded != null) {
            Location myLoc = getLivingEntity().getLocation();
            Location theirLoc = guarded.getLocation();
            double dist = theirLoc.getWorld().equals(myLoc.getWorld()) ? myLoc.distanceSquared(theirLoc) : MAX_DIST;
            if (dist > 60 * 60 && !disableTeleporting) {
                npc.teleport(guarded.getLocation(), PlayerTeleportEvent.TeleportCause.PLUGIN);
            }
            if (dist > guardDistanceMinimum * guardDistanceMinimum) {
                ticksCountGuard += SentinelPlugin.instance.tickRate;
                if (ticksCountGuard >= 30) {
                    ticksCountGuard = 0;
                    npc.getNavigator().getDefaultParameters().range(100);
                    if (!disableTeleporting) {
                        npc.getNavigator().getDefaultParameters().stuckAction(TeleportStuckAction.INSTANCE);
                    }
                    Location picked = SentinelUtilities.pickNear(guarded.getLocation(), guardSelectionRange);
                    if (SentinelPlugin.debugMe) {
                        debug("Guard movement chosen to go to " + picked.toVector().toBlockVector().toString());
                    }
                    npc.getNavigator().setTarget(picked);
                    autoSpeedModifier();
                    npc.getNavigator().getLocalParameters().distanceMargin(guardDistanceMinimum * 0.75);
                    chased = true;
                }
            }
            needsSafeReturn = true;
            goHome = false;
        }
        // Avoidance handling
        targetingHelper.processAvoidance();
        if (pathingTo != null) {
            goHome = false;
            needsSafeReturn = true;
        }
        // Handling for when NPC has no targets
        if (goHome && chaseRange > 0 && target == null && needsSafeReturn) {
            Location near = nearestPathPoint();
            if (near != null && (chasing == null || near.distanceSquared(chasing.getLocation()) > crsq)) {
                if (SentinelPlugin.debugMe) {
                    if (near.distanceSquared(getLivingEntity().getLocation()) > 3 * 3) {
                        debug("screw you guys, I'm going home!");
                    }
                }
                if (!disableTeleporting) {
                    npc.getNavigator().getDefaultParameters().stuckAction(TeleportStuckAction.INSTANCE);
                }
                npc.getNavigator().setTarget(near);
                autoSpeedModifier();
                needsSafeReturn = false;
                chased = false;
            }
            else {
                if (pathingTo == null && npc.getNavigator().isNavigating() && guarded == null) {
                    npc.getNavigator().cancelNavigation();
                    needsSafeReturn = false;
                }
                if (SentinelPlugin.debugMe) {
                    if (near != null && near.distanceSquared(getLivingEntity().getLocation()) > 3 * 3) {
                        debug("I'll just stand here and hope they come out...");
                    }
                }
            }
        }
        else if (chasing == null && guarded == null && pathingTo == null && npc.getNavigator().isNavigating() && needsSafeReturn) {
            npc.getNavigator().cancelNavigation();
            needsSafeReturn = false;
        }
    }

    /**
     * The maximum distance value (squared) for some distance calculations. Equal to ten-thousand (10000) blocks, squared (so: 100000000).
     */
    private final static double MAX_DIST = 100000000;

    /**
     * Gets the location this NPC is guarding (the NPC's own location if nothing else to guard).
     */
    public Location getGuardZone() {
        LivingEntity guarded = getGuardingEntity();
        if (guarded != null) {
            return guarded.getLocation();
        }
        if (chaseRange > 0) {
            Location goal = nearestPathPoint();
            if (goal != null) {
                return goal;
            }
        }
        return getLivingEntity().getLocation();
    }

    /**
     * Whether the waypoints helper (up-to-date Citizens) is available.
     */
    private Boolean waypointHelperAvailable = null;

    /**
     * Gets the nearest pathing point to this NPC.
     */
    public Location nearestPathPoint() {
        if (!SentinelVersionCompat.v1_9) {
            if (waypointHelperAvailable == null) {
                try {
                    Class.forName("net.citizensnpcs.trait.waypoint.WaypointProvider$EnumerableWaypointProvider");
                    waypointHelperAvailable = true;
                }
                catch (ClassNotFoundException ex) {
                    waypointHelperAvailable = false;
                    SentinelPlugin.instance.getLogger().warning("Citizens installation is **very outdated** and does not contain newer useful APIs. Please update your installation of the Citizens plugin!");
                }
            }
            if (!waypointHelperAvailable) {
                return null;
            }
        }
        if (!npc.hasTrait(Waypoints.class)) {
            return null;
        }
        if (getGuarding() != null) {
            return null;
        }
        Location baseloc = getLivingEntity().getLocation();
        Location nearest = null;
        double dist = MAX_DIST;
        Waypoints wp = npc.getOrAddTrait(Waypoints.class);
        if (wp.getCurrentProvider() instanceof WaypointProvider.EnumerableWaypointProvider) {
            for (Waypoint wayp : ((WaypointProvider.EnumerableWaypointProvider) wp.getCurrentProvider()).waypoints()) {
                Location l = wayp.getLocation();
                if (!l.getWorld().equals(baseloc.getWorld())) {
                    continue;
                }
                double d = baseloc.distanceSquared(l);
                if (d < dist) {
                    dist = d;
                    nearest = l;
                }
            }
        }
        else if (wp.getCurrentProvider() instanceof WanderWaypointProvider) {
            for (Location loc : ((WanderWaypointProvider) wp.getCurrentProvider()).getRegionCentres()) {
                if (!loc.getWorld().equals(baseloc.getWorld())) {
                    continue;
                }
                double d = baseloc.distanceSquared(loc);
                if (d < dist) {
                    dist = d;
                    nearest = loc;
                }
            }
        }
        else {
            return null;
        }
        return nearest;
    }

    /**
     * Tick counter for the {@code run} method.
     */
    public int cTick = 0;

    /**
     * Called every tick to run Sentinel updates if needed.
     */
    @Override
    public void run() {
        if (!npc.isSpawned()) {
            return;
        }
        stats_ticksSpawned++;
        cTick++;
        if (cTick >= SentinelPlugin.instance.tickRate) {
            cTick = 0;
            runUpdate();
        }
    }

    /**
     * Runnable for respawning, if needed.
     */
    public BukkitRunnable respawnMe;

    /**
     * Last known entity UUID for this Sentinel NPC.
     */
    public UUID lastEntityUUID;

    /**
     * Called when the NPC spawns in.
     */
    @Override
    public void onSpawn() {
        lastEntityUUID = getLivingEntity().getUniqueId();
        stats_timesSpawned++;
        setHealth(health);
        setInvincible(invincible);
        if (respawnMe != null) {
            respawnMe.cancel();
            respawnMe = null;
        }
        SentinelPlugin.instance.currentSentinelNPCs.add(this);
    }

    /**
     * Causes the NPC to speak a message to a player.
     */
    public void sayTo(Player player, String message) {
        SpeechContext sc = new SpeechContext(npc, message, player);
        npc.getDefaultSpeechController().speak(sc, "chat");
    }

    /**
     * Called whenever a player teleports, for use with NPC guarding logic.
     */
    public void onPlayerTeleports(final PlayerTeleportEvent event) {
        if (event.getFrom().getWorld().equals(event.getTo().getWorld())) {
            if (!disableTeleporting) {
                npc.teleport(event.getTo(), PlayerTeleportEvent.TeleportCause.PLUGIN);
            }
        }
        else { // World loading up can cause glitches.
            event.getFrom().getChunk().load();
            event.getTo().getChunk().load();
            Bukkit.getScheduler().runTaskLater(SentinelPlugin.instance, new Runnable() {
                @Override
                public void run() {
                    if (!event.getPlayer().getWorld().equals(event.getTo().getWorld())) {
                        return;
                    }
                    event.getFrom().getChunk().load();
                    event.getTo().getChunk().load();
                    npc.spawn(event.getTo());
                }
            }, 1);
        }
    }

    /**
     * Called every time a player moves at all, for use with monitoring if players move into range of an NPC.
     */
    public void onPlayerMovesInRange(PlayerMoveEvent event) {
        if (!event.getTo().getWorld().equals(getLivingEntity().getLocation().getWorld())) {
            return;
        }
        double dist = event.getTo().distanceSquared(getLivingEntity().getLocation());
        boolean known = greetedAlready.contains(event.getPlayer().getUniqueId());
        if (dist < greetRange * greetRange && !known && targetingHelper.canSee(event.getPlayer())) {
            greetedAlready.add(event.getPlayer().getUniqueId());
            Long lastGreet = lastGreetTime.get(event.getPlayer().getUniqueId());
            if (lastGreet != null && lastGreet + greetRate > stats_ticksSpawned) {
                return;
            }
            lastGreetTime.put(event.getPlayer().getUniqueId(), stats_ticksSpawned);
            boolean enemy = targetingHelper.shouldTarget(event.getPlayer());
            if (enemy && warningText != null && warningText.length() > 0) {
                sayTo(event.getPlayer(), warningText);
            }
            else if (!enemy && greetingText != null && greetingText.length() > 0) {
                sayTo(event.getPlayer(), greetingText);
            }
        }
        else if (dist >= greetRange * greetRange + 1 && known) {
            greetedAlready.remove(event.getPlayer().getUniqueId());
            // TODO: Farewell text perhaps?
        }
    }

    /**
     * Entities that will need their drops cleared if they die soon (because they were killed by this NPC).
     */
    public HashSet<UUID> needsDropsClear = new HashSet<>();

    /**
     * Called when an entity might die from damage (called before Sentinel detects that an NPC might have killed an entity).
     */
    public void whenSomethingMightDie(UUID mightDie) {
        if (!needsDropsClear.contains(mightDie)) {
            return;
        }
        if (SentinelPlugin.debugMe) {
            debug("ID " + mightDie + " is no longer being tracked.");
        }
        needsDropsClear.remove(mightDie);
    }

    /**
     * Outputs a debug message (if debug is enabled).
     */
    public void debug(String message) {
        if (SentinelPlugin.debugMe) {
            SentinelPlugin.instance.getLogger().info("Sentinel Debug: " + npc.getId() + "/" + npc.getName() + ": " + message);
        }
    }

    /**
     * Gets a list of items to drop (factoring in the drop chance values).
     */
    public List<ItemStack> getDrops() {
        List<ItemStack> items = new ArrayList<>(drops.size());
        if (dropChances.isEmpty()) {
            for (ItemStack item : drops) {
                items.add(item.clone());
            }
            return items;
        }
        for (int i = 0; i < drops.size(); i++) {
            if (i < dropChances.size()) {
                double chance = dropChances.get(i);
                if (SentinelUtilities.random.nextDouble() > chance) {
                    continue;
                }
            }
            items.add(drops.get(i).clone());
        }
        return items;
    }

    /**
     * Called when the NPC dies.
     */
    public void whenWeDie(EntityDeathEvent event) {
        if (SentinelPlugin.debugMe) {
            debug("Died! Death event received.");
        }
        event.getDrops().clear();
        if (event instanceof PlayerDeathEvent) {
            if (!SentinelPlugin.instance.deathMessages) {
                ((PlayerDeathEvent) event).setDeathMessage("");
            }
            else if (npc.requiresNameHologram() && ((PlayerDeathEvent) event).getDeathMessage() != null) {
                String message = ((PlayerDeathEvent) event).getDeathMessage().replace(event.getEntity().getName(), npc.getFullName());
                ((PlayerDeathEvent) event).setDeathMessage(message);
            }
        }
        if (!SentinelPlugin.instance.workaroundDrops) {
            event.getDrops().addAll(getDrops());
        }
        event.setDroppedExp(0);
        generalDeathHandler(event.getEntity());
    }

    /**
     * Handles some basics for when the NPC died.
     */
    public void generalDeathHandler(LivingEntity entity) {
        if (spawnPoint != null) {
            npc.getOrAddTrait(CurrentLocation.class).setLocation(spawnPoint.clone());
        }
        if (SentinelPlugin.instance.workaroundDrops) {
            for (ItemStack item : getDrops()) {
                entity.getWorld().dropItemNaturally(entity.getLocation(), item);
            }
        }
        onDeath();
    }

    /**
     * Called when any entity dies.
     */
    public void whenSomethingDies(EntityDeathEvent event) {
        UUID id = event.getEntity().getUniqueId();
        if (needsDropsClear.contains(id)) {
            needsDropsClear.remove(id);
            if (event.getEntity().getType() != EntityType.PLAYER) {
                if (SentinelPlugin.debugMe) {
                    debug("A " + event.getEntity().getType() + " with id " + id + " died. Clearing its drops.");
                }
                event.getDrops().clear();
                event.setDroppedExp(0);
            }
        }
        else {
            if (SentinelPlugin.debugMe) {
                debug("A " + event.getEntity().getType() + " with id " + id + " died, but that's none of my business.");
            }
        }
        targetingHelper.removeTarget(id);
    }

    /**
     * Handler for when the NPC died.
     */
    public void onDeath() {
        greetedAlready.clear();
        targetingHelper.currentTargets.clear();
        targetingHelper.currentAvoids.clear();
        if (respawnTime < 0) {
            BukkitRunnable removeMe = new BukkitRunnable() {
                @Override
                public void run() {
                    npc.destroy();
                }
            };
            removeMe.runTaskLater(SentinelPlugin.instance, 1);
        }
        else if (respawnTime > 0) {
            final long rsT = respawnTime;
            respawnMe = new BukkitRunnable() {
                long timer = 0;

                @Override
                public void run() {
                    if (CitizensAPI.getNPCRegistry().getById(npc.getId()) != null) {
                        if (npc.isSpawned()) {
                            this.cancel();
                            respawnMe = null;
                            return;
                        }
                        if (timer >= rsT) {
                            if (spawnPoint == null && npc.getStoredLocation() == null) {
                                SentinelPlugin.instance.getLogger().warning("NPC " + npc.getId() + " has a null spawn point and can't be spawned. Perhaps the world was deleted?");
                                this.cancel();
                                return;
                            }
                            npc.spawn(spawnPoint == null ? npc.getStoredLocation() : spawnPoint);
                            this.cancel();
                            respawnMe = null;
                            return;
                        }
                        timer += 10;
                    }
                    else {
                        respawnMe = null;
                        this.cancel();
                        return;
                    }
                }
            };
            respawnMe.runTaskTimer(SentinelPlugin.instance, 10, 10);
        }
        else { // respawnTime == 0
            npc.getOrAddTrait(Spawned.class).setSpawned(false);
        }
    }

    /**
     * Called when the NPC despawns.
     */
    @Override
    public void onDespawn() {
        targetingHelper.currentTargets.clear();
        targetingHelper.currentAvoids.clear();
        SentinelPlugin.instance.currentSentinelNPCs.remove(this);
    }

    /**
     * Sets the NPC's maximum health.
     */
    public void setHealth(double heal) {
        health = heal;
        if (npc.isSpawned()) {
            if (SentinelPlugin.debugMe) {
                debug("Setting spawned NPC health to " + health);
            }
            getLivingEntity().setMaxHealth(health);
            getLivingEntity().setHealth(health);
        }
    }

    /**
     * Sets whether the NPC is invincible.
     */
    public void setInvincible(boolean inv) {
        invincible = inv;
        npc.setProtected(invincible);
    }

    /**
     * Validates this Sentinel NPC's presence on the current NPCs list.
     */
    public boolean validateOnList() {
        if (npc == null || !npc.isSpawned() || getLivingEntity() == null) {
            SentinelPlugin.instance.currentSentinelNPCs.remove(this);
            return false;
        }
        return true;
    }
}