Add PlayerMoveControllableVehicleEvent

Useful if you want to actually control what the player is moving, because VehicleMoveEvent does not let you cancel nor change the location. Also useful to detect BoatFly hacks.
2025-12-19 15:09:27 +00:00 · 2025-01-05 00:02:19 -03:00
parent 0fd98d64ca
commit 81aca647ae
8 changed files with 407 additions and 0 deletions
--- a/patches/api/0004-Add-PlayerMoveControllableVehicleEvent.patch
+++ b/patches/api/0004-Add-PlayerMoveControllableVehicleEvent.patch
@@ -0,0 +1,141 @@
+From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
+From: MrPowerGamerBR <git@mrpowergamerbr.com>
+Date: Sat, 4 Jan 2025 23:58:34 -0300
+Subject: [PATCH] Add PlayerMoveControllableVehicleEvent
+
+
+diff --git a/src/main/java/net/sparklypower/sparklypaper/event/player/PlayerMoveControllableVehicleEvent.java b/src/main/java/net/sparklypower/sparklypaper/event/player/PlayerMoveControllableVehicleEvent.java
+new file mode 100644
+index 0000000000000000000000000000000000000000..a646251feb6b8bf7ff07e6b4b84bb5751ee4b90b
+--- /dev/null
+++ b/src/main/java/net/sparklypower/sparklypaper/event/player/PlayerMoveControllableVehicleEvent.java
+@@ -0,0 +1,129 @@
+package net.sparklypower.sparklypaper.event.player;
+
+import com.google.common.base.Preconditions;
+import org.bukkit.Location;
+import org.bukkit.entity.Entity;
+import org.bukkit.entity.Player;
+import org.bukkit.entity.Vehicle;
+import org.bukkit.event.Cancellable;
+import org.bukkit.event.HandlerList;
+import org.bukkit.event.player.PlayerEvent;
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * Raised when a player moves a controllable vehicle. Controllable vehicles are vehicles that the client can control, such as boats, horses, striders, pigs, etc.
+ * <p>
+ * Minecarts are NOT affected by this event!
+ */
+public class PlayerMoveControllableVehicleEvent extends PlayerEvent implements Cancellable {
+    private static final HandlerList handlers = new HandlerList();
+    private boolean cancel = false;
+    private final Vehicle vehicle;
+    private Location from;
+    private Location to;
+
+    public PlayerMoveControllableVehicleEvent(@NotNull final Player player, @NotNull final Vehicle vehicle, @NotNull final Location from, @NotNull final Location to) {
+        super(player);
+
+        this.vehicle = vehicle;
+        this.from = from;
+        this.to = to;
+    }
+
+    /**
+     * Get the previous position.
+     *
+     * @return Old position.
+     */
+    @NotNull
+    public Location getFrom() {
+        return from.clone(); // Paper - clone to avoid changes
+    }
+
+    /**
+     * Sets the location to mark as where the player moved from
+     *
+     * @param from New location to mark as the players previous location
+     */
+    public void setFrom(@NotNull Location from) {
+        validateLocation(from, this.from);
+        this.from = from;
+    }
+
+    /**
+     * Get the next position.
+     *
+     * @return New position.
+     */
+    @NotNull
+    public Location getTo() {
+        return to.clone(); // Paper - clone to avoid changes
+    }
+
+    /**
+     * Sets the location that this player will move to
+     *
+     * @param to New Location this player will move to
+     */
+    public void setTo(@NotNull Location to) {
+        validateLocation(to, this.to);
+        this.to = to;
+    }
+
+    /**
+     * Get the vehicle.
+     *
+     * @return the vehicle
+     */
+    @NotNull
+    public final Entity getVehicle() {
+        return vehicle;
+    }
+
+    /**
+     * Gets the cancellation state of this event. A cancelled event will not
+     * be executed in the server, but will still pass to other plugins
+     * <p>
+     * If a move or teleport event is cancelled, the vehicle and player will be moved or
+     * teleported back to the Location as defined by getFrom(). This will not
+     * fire an event
+     *
+     * @return true if this event is cancelled
+     */
+    @Override
+    public boolean isCancelled() {
+        return cancel;
+    }
+
+    /**
+     * Sets the cancellation state of this event. A cancelled event will not
+     * be executed in the server, but will still pass to other plugins
+     * <p>
+     * If a move or teleport event is cancelled, the vehicle and player will be moved or
+     * teleported back to the Location as defined by getFrom(). This will not
+     * fire an event
+     *
+     * @param cancel true if you wish to cancel this event
+     */
+    @Override
+    public void setCancelled(boolean cancel) {
+        this.cancel = cancel;
+    }
+
+    @NotNull
+    @Override
+    public HandlerList getHandlers() {
+        return handlers;
+    }
+
+    @NotNull
+    public static HandlerList getHandlerList() {
+        return handlers;
+    }
+
+    private void validateLocation(@NotNull Location loc, @NotNull Location originalLoc) {
+        Preconditions.checkArgument(loc != null, "Cannot use null location!");
+        Preconditions.checkArgument(loc.getWorld() != null, "Cannot use null location with null world!");
+        Preconditions.checkArgument(loc.getWorld() != originalLoc, "New location should be in the original world!");
+    }
+}