From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001 From: Jedediah Smith Date: Sat, 2 Apr 2016 05:08:36 -0400 Subject: [PATCH] Add PlayerUseUnknownEntityEvent Adds the PlayerUseUnknownEntityEvent to be used by plugins dealing with virtual entities/entities that are not actually known to the server. Co-authored-by: Nassim Jahnke diff --git a/src/main/java/com/destroystokyo/paper/event/player/PlayerUseUnknownEntityEvent.java b/src/main/java/com/destroystokyo/paper/event/player/PlayerUseUnknownEntityEvent.java new file mode 100644 index 0000000000000000000000000000000000000000..dbb635686e9108b9d3df5d373e6972cca07c0621 --- /dev/null +++ b/src/main/java/com/destroystokyo/paper/event/player/PlayerUseUnknownEntityEvent.java @@ -0,0 +1,86 @@ +package com.destroystokyo.paper.event.player; + +import org.bukkit.entity.Player; +import org.bukkit.event.HandlerList; +import org.bukkit.event.player.PlayerEvent; +import org.bukkit.event.player.PlayerInteractAtEntityEvent; +import org.bukkit.inventory.EquipmentSlot; +import org.bukkit.util.Vector; +import org.jetbrains.annotations.ApiStatus; +import org.jetbrains.annotations.NotNull; +import org.jetbrains.annotations.Nullable; + +/** + * Represents an event that is called when a player right-clicks an unknown entity. + * Useful for plugins dealing with virtual entities (entities that aren't actually spawned on the server). + *
+ * This event may be called multiple times per interaction with different interaction hands + * and with or without the clicked position. + */ +public class PlayerUseUnknownEntityEvent extends PlayerEvent { + + private static final HandlerList HANDLER_LIST = new HandlerList(); + + private final int entityId; + private final boolean attack; + private final @NotNull EquipmentSlot hand; + private final @Nullable Vector clickedPosition; + + @ApiStatus.Internal + public PlayerUseUnknownEntityEvent(@NotNull Player player, int entityId, boolean attack, @NotNull EquipmentSlot hand, @Nullable Vector clickedPosition) { + super(player); + this.entityId = entityId; + this.attack = attack; + this.hand = hand; + this.clickedPosition = clickedPosition; + } + + /** + * Returns the entity id of the unknown entity that was interacted with. + * + * @return the entity id of the entity that was interacted with + */ + public int getEntityId() { + return this.entityId; + } + + /** + * Returns whether the interaction was an attack. + * + * @return {@code true} if the player is attacking the entity, {@code false} if the player is interacting with the entity + */ + public boolean isAttack() { + return this.attack; + } + + /** + * Returns the hand used to perform this interaction. + * + * @return the hand used to interact + */ + public @NotNull EquipmentSlot getHand() { + return this.hand; + } + + /** + * Returns the position relative to the entity that was clicked, or {@code null} if not available. + * See {@link PlayerInteractAtEntityEvent} for more details. + * + * @return the position relative to the entity that was clicked, or {@code null} if not available + * @see PlayerInteractAtEntityEvent + */ + public @Nullable Vector getClickedRelativePosition() { + return this.clickedPosition != null ? this.clickedPosition.clone() : null; + } + + @NotNull + @Override + public HandlerList getHandlers() { + return HANDLER_LIST; + } + + @NotNull + public static HandlerList getHandlerList() { + return HANDLER_LIST; + } +}