From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001 From: Aikar <aikar@aikar.co> Date: Mon, 28 Mar 2016 21:15:34 -0400 Subject: [PATCH] EntityPathfindEvent Fires when an Entity decides to start moving to a location. diff --git a/src/main/java/com/destroystokyo/paper/event/entity/EntityPathfindEvent.java b/src/main/java/com/destroystokyo/paper/event/entity/EntityPathfindEvent.java new file mode 100644 index 0000000000000000000000000000000000000000..8267e8f1f0ade29a284831069e1268ee4b29e109 --- /dev/null +++ b/src/main/java/com/destroystokyo/paper/event/entity/EntityPathfindEvent.java @@ -0,0 +1,87 @@ +package com.destroystokyo.paper.event.entity; + +import org.bukkit.Location; +import org.bukkit.entity.Entity; +import org.bukkit.event.Cancellable; +import org.bukkit.event.HandlerList; +import org.bukkit.event.entity.EntityEvent; +import org.jetbrains.annotations.ApiStatus; +import org.jetbrains.annotations.NotNull; +import org.jetbrains.annotations.Nullable; + +/** + * Fired when an Entity decides to start moving towards a location. + * <p> + * This event does not fire for the entities actual movement. Only when it + * is choosing to start moving to a location. + */ +public class EntityPathfindEvent extends EntityEvent implements Cancellable { + + private static final HandlerList HANDLER_LIST = new HandlerList(); + + @Nullable private final Entity targetEntity; + @NotNull private final Location location; + private boolean cancelled; + + @ApiStatus.Internal + public EntityPathfindEvent(@NotNull Entity entity, @NotNull Location location, @Nullable Entity targetEntity) { + super(entity); + this.targetEntity = targetEntity; + this.location = location; + } + + /** + * The Entity that is pathfinding. + * + * @return The Entity that is pathfinding. + */ + @NotNull + public Entity getEntity() { + return this.entity; + } + + /** + * If the Entity is trying to pathfind to an entity, this is the entity in relation. + * <br> + * Otherwise this will return {@code null}. + * + * @return The entity target or {@code null} + */ + @Nullable + public Entity getTargetEntity() { + return this.targetEntity; + } + + /** + * The Location of where the entity is about to move to. + * <br> + * Note that if the target happened to of been an entity + * + * @return Location of where the entity is trying to pathfind to. + */ + @NotNull + public Location getLoc() { + return this.location.clone(); + } + + @Override + public boolean isCancelled() { + return this.cancelled; + } + + @Override + public void setCancelled(boolean cancel) { + this.cancelled = cancel; + } + + @NotNull + @Override + public HandlerList getHandlers() { + return HANDLER_LIST; + } + + @NotNull + public static HandlerList getHandlerList() { + return HANDLER_LIST; + } +}