Paper/patches/api/0388-Player-Entity-Tracking-Events.patch

129 lines
3.8 KiB
Diff
Raw Normal View History

2022-12-03 23:46:38 +01:00
From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
From: Yannick Lamprecht <yannicklamprecht@live.de>
Date: Wed, 30 Mar 2022 18:16:37 +0200
Subject: [PATCH] Player Entity Tracking Events
diff --git a/src/main/java/io/papermc/paper/event/player/PlayerTrackEntityEvent.java b/src/main/java/io/papermc/paper/event/player/PlayerTrackEntityEvent.java
new file mode 100644
2024-02-01 10:15:57 +01:00
index 0000000000000000000000000000000000000000..356f8933a7715b4fc123e3a4879bb2cd085835c5
2022-12-03 23:46:38 +01:00
--- /dev/null
+++ b/src/main/java/io/papermc/paper/event/player/PlayerTrackEntityEvent.java
2024-02-01 10:15:57 +01:00
@@ -0,0 +1,62 @@
2022-12-03 23:46:38 +01:00
+package io.papermc.paper.event.player;
+
+import org.bukkit.entity.Entity;
+import org.bukkit.entity.Player;
+import org.bukkit.event.Cancellable;
2022-12-03 23:46:38 +01:00
+import org.bukkit.event.HandlerList;
+import org.bukkit.event.player.PlayerEvent;
2024-02-01 10:15:57 +01:00
+import org.jetbrains.annotations.ApiStatus;
2022-12-03 23:46:38 +01:00
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * Is called when a {@link Player} tracks an {@link Entity}.
+ * <p>
+ * If cancelled entity is not shown to the player and interaction in both directions is not possible.
+ * <p>
+ * Adding or removing entities from the world at the point in time this event is called is completely
+ * unsupported and should be avoided.
2022-12-03 23:46:38 +01:00
+ */
+public class PlayerTrackEntityEvent extends PlayerEvent implements Cancellable {
2022-12-03 23:46:38 +01:00
+
2024-02-01 10:15:57 +01:00
+ private static final HandlerList HANDLER_LIST = new HandlerList();
+
2022-12-03 23:46:38 +01:00
+ private final Entity entity;
+ private boolean cancelled;
2022-12-03 23:46:38 +01:00
+
2024-02-01 10:15:57 +01:00
+ @ApiStatus.Internal
2022-12-03 23:46:38 +01:00
+ public PlayerTrackEntityEvent(@NotNull Player player, @NotNull Entity entity) {
+ super(player);
+ this.entity = entity;
+ }
+
+ /**
+ * Gets the entity that will be tracked
+ *
+ * @return the entity tracked
+ */
+ @NotNull
+ public Entity getEntity() {
2024-02-01 10:15:57 +01:00
+ return this.entity;
2022-12-03 23:46:38 +01:00
+ }
+
+ @Override
+ public boolean isCancelled() {
2024-02-01 10:15:57 +01:00
+ return this.cancelled;
+ }
+
+ @Override
+ public void setCancelled(boolean cancel) {
+ this.cancelled = cancel;
+ }
2024-02-01 10:15:57 +01:00
+
+ @NotNull
+ public static HandlerList getHandlerList() {
+ return HANDLER_LIST;
+ }
+
+ @NotNull
+ @Override
+ public HandlerList getHandlers() {
+ return HANDLER_LIST;
+ }
2022-12-03 23:46:38 +01:00
+}
diff --git a/src/main/java/io/papermc/paper/event/player/PlayerUntrackEntityEvent.java b/src/main/java/io/papermc/paper/event/player/PlayerUntrackEntityEvent.java
new file mode 100644
2024-02-01 10:15:57 +01:00
index 0000000000000000000000000000000000000000..c573eeaeb599ca717b09f9fd3f106a4800e9c386
2022-12-03 23:46:38 +01:00
--- /dev/null
+++ b/src/main/java/io/papermc/paper/event/player/PlayerUntrackEntityEvent.java
2024-02-01 10:15:57 +01:00
@@ -0,0 +1,48 @@
2022-12-03 23:46:38 +01:00
+package io.papermc.paper.event.player;
+
+import org.bukkit.entity.Entity;
+import org.bukkit.entity.Player;
+import org.bukkit.event.HandlerList;
+import org.bukkit.event.player.PlayerEvent;
2024-02-01 10:15:57 +01:00
+import org.jetbrains.annotations.ApiStatus;
2022-12-03 23:46:38 +01:00
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * Is called when a {@link Player} untracks an {@link Entity}.
+ * <p>
+ * Adding or removing entities from the world at the point in time this event is called is completely
+ * unsupported and should be avoided.
2022-12-03 23:46:38 +01:00
+ */
+public class PlayerUntrackEntityEvent extends PlayerEvent {
+
2024-02-01 10:15:57 +01:00
+ private static final HandlerList HANDLER_LIST = new HandlerList();
+
2022-12-03 23:46:38 +01:00
+ private final Entity entity;
+
2024-02-01 10:15:57 +01:00
+ @ApiStatus.Internal
2022-12-03 23:46:38 +01:00
+ public PlayerUntrackEntityEvent(@NotNull Player player, @NotNull Entity entity) {
+ super(player);
+ this.entity = entity;
+ }
+
2024-02-01 10:15:57 +01:00
+ /**
+ * Gets the entity that will be untracked
+ *
+ * @return the entity untracked
+ */
2022-12-03 23:46:38 +01:00
+ @NotNull
2024-02-01 10:15:57 +01:00
+ public Entity getEntity() {
+ return this.entity;
2022-12-03 23:46:38 +01:00
+ }
+
+ @NotNull
2024-02-01 10:15:57 +01:00
+ public static HandlerList getHandlerList() {
+ return HANDLER_LIST;
2022-12-03 23:46:38 +01:00
+ }
+
+ @NotNull
2024-02-01 10:15:57 +01:00
+ @Override
+ public HandlerList getHandlers() {
+ return HANDLER_LIST;
2022-12-03 23:46:38 +01:00
+ }
+}