PaperMC/patches/api/0405-Add-PlayerFailMoveEvent.patch

131 lines
3.7 KiB
Diff
Raw Normal View History

From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
From: Moulberry <james.jenour@protonmail.com>
Date: Wed, 26 Jul 2023 20:57:11 +0800
Subject: [PATCH] Add PlayerFailMoveEvent
diff --git a/src/main/java/io/papermc/paper/event/player/PlayerFailMoveEvent.java b/src/main/java/io/papermc/paper/event/player/PlayerFailMoveEvent.java
new file mode 100644
2024-02-01 10:15:57 +01:00
index 0000000000000000000000000000000000000000..c848fa029bac07f80eef870c98eebc2596b90aed
--- /dev/null
+++ b/src/main/java/io/papermc/paper/event/player/PlayerFailMoveEvent.java
2024-02-01 10:15:57 +01:00
@@ -0,0 +1,118 @@
+package io.papermc.paper.event.player;
+
+import org.bukkit.Location;
+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;
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * Runs when a player attempts to move, but is prevented from doing so by the server
+ */
+public class PlayerFailMoveEvent extends PlayerEvent {
+
+ private static final HandlerList HANDLER_LIST = new HandlerList();
+
+ private final FailReason failReason;
+ private final Location from;
+ private final Location to;
2024-02-01 10:15:57 +01:00
+ private boolean allowed;
+ private boolean logWarning;
+
2024-02-01 10:15:57 +01:00
+ @ApiStatus.Internal
+ public PlayerFailMoveEvent(@NotNull Player player, @NotNull FailReason failReason, boolean allowed,
+ boolean logWarning, @NotNull Location from, @NotNull Location to) {
2024-02-01 10:15:57 +01:00
+ super(player);
+ this.failReason = failReason;
+ this.allowed = allowed;
+ this.logWarning = logWarning;
+ this.from = from;
+ this.to = to;
+ }
+
+ /**
+ * Gets the reason this movement was prevented by the server
2024-02-01 10:15:57 +01:00
+ *
+ * @return The reason the movement was prevented
+ */
+ @NotNull
+ public FailReason getFailReason() {
2024-02-01 10:15:57 +01:00
+ return this.failReason;
+ }
+
+ /**
+ * Gets the location this player moved from
2024-02-01 10:15:57 +01:00
+ *
+ * @return Location the player moved from
+ */
+ @NotNull
+ public Location getFrom() {
2024-02-01 10:15:57 +01:00
+ return this.from.clone();
+ }
+
+ /**
+ * Gets the location this player tried to move to
2024-02-01 10:15:57 +01:00
+ *
+ * @return Location the player tried to move to
+ */
+ @NotNull
+ public Location getTo() {
2024-02-01 10:15:57 +01:00
+ return this.to.clone();
+ }
+
+ /**
+ * Gets if the check should be bypassed, allowing the movement
2024-02-01 10:15:57 +01:00
+ *
+ * @return whether to bypass the check
+ */
+ public boolean isAllowed() {
2024-02-01 10:15:57 +01:00
+ return this.allowed;
+ }
+
+ /**
+ * Set if the check should be bypassed and the movement should be allowed
2024-02-01 10:15:57 +01:00
+ *
+ * @param allowed whether to bypass the check
+ */
+ public void setAllowed(boolean allowed) {
+ this.allowed = allowed;
+ }
+
+ /**
2024-02-01 10:15:57 +01:00
+ * Gets if warnings will be printed to console. e.g. "Player123 moved too quickly!"
+ *
+ * @return whether to log warnings
+ */
+ public boolean getLogWarning() {
2024-02-01 10:15:57 +01:00
+ return this.logWarning;
+ }
+
+ /**
2024-02-01 10:15:57 +01:00
+ * Set if a warning is printed to console. e.g. "Player123 moved too quickly!"
+ *
+ * @param logWarning whether to log warnings
+ */
+ public void setLogWarning(boolean logWarning) {
+ this.logWarning = logWarning;
+ }
+
+ @NotNull
+ @Override
+ public HandlerList getHandlers() {
+ return HANDLER_LIST;
+ }
+
+ @NotNull
+ public static HandlerList getHandlerList() {
+ return HANDLER_LIST;
+ }
+
+ public enum FailReason {
+ MOVED_INTO_UNLOADED_CHUNK, // Only fired if the world setting prevent-moving-into-unloaded-chunks is true
+ MOVED_TOO_QUICKLY,
+ MOVED_WRONGLY,
+ CLIPPED_INTO_BLOCK
+ }
+
+}