aboutsummaryrefslogtreecommitdiffhomepage
path: root/patches/api/0361-More-Teleport-API.patch
diff options
context:
space:
mode:
Diffstat (limited to 'patches/api/0361-More-Teleport-API.patch')
-rw-r--r--patches/api/0361-More-Teleport-API.patch275
1 files changed, 275 insertions, 0 deletions
diff --git a/patches/api/0361-More-Teleport-API.patch b/patches/api/0361-More-Teleport-API.patch
new file mode 100644
index 0000000000..eb36f5ee5d
--- /dev/null
+++ b/patches/api/0361-More-Teleport-API.patch
@@ -0,0 +1,275 @@
+From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
+From: Owen1212055 <[email protected]>
+Date: Sun, 5 Sep 2021 00:36:05 -0400
+Subject: [PATCH] More Teleport API
+
+
+diff --git a/src/main/java/io/papermc/paper/entity/LookAnchor.java b/src/main/java/io/papermc/paper/entity/LookAnchor.java
+new file mode 100644
+index 0000000000000000000000000000000000000000..544eec787ea837f7d29df6519255840d6fe087d7
+--- /dev/null
++++ b/src/main/java/io/papermc/paper/entity/LookAnchor.java
+@@ -0,0 +1,24 @@
++package io.papermc.paper.entity;
++
++import io.papermc.paper.math.Position;
++import org.bukkit.entity.Entity;
++import org.bukkit.entity.LivingEntity;
++
++/**
++ * Represents what part of the entity should be used when determining where to face a position/entity.
++ *
++ * @see org.bukkit.entity.Player#lookAt(Position, LookAnchor)
++ * @see org.bukkit.entity.Player#lookAt(Entity, LookAnchor, LookAnchor)
++ */
++public enum LookAnchor {
++ /**
++ * Represents the entity's feet.
++ * @see LivingEntity#getLocation()
++ */
++ FEET,
++ /**
++ * Represents the entity's eyes.
++ * @see LivingEntity#getEyeLocation()
++ */
++ EYES;
++}
+diff --git a/src/main/java/io/papermc/paper/entity/TeleportFlag.java b/src/main/java/io/papermc/paper/entity/TeleportFlag.java
+new file mode 100644
+index 0000000000000000000000000000000000000000..c8b5b570d44da9524bfc59c7e11b2ae59d4b79b9
+--- /dev/null
++++ b/src/main/java/io/papermc/paper/entity/TeleportFlag.java
+@@ -0,0 +1,79 @@
++package io.papermc.paper.entity;
++
++import org.bukkit.Location;
++import org.bukkit.event.player.PlayerTeleportEvent;
++
++/**
++ * Represents a flag that can be set on teleportation that may
++ * slightly modify the behavior.
++ *
++ * @see EntityState
++ * @see Relative
++ */
++public sealed interface TeleportFlag permits TeleportFlag.EntityState, TeleportFlag.Relative {
++
++ /**
++ * Note: These flags only work on {@link org.bukkit.entity.Player} entities.
++ * <p>
++ * Represents coordinates in a teleportation that should be handled relatively.
++ * <p>
++ * Coordinates of the location that the client should handle as relative teleportation
++ * Relative teleportation flags are only used client side, and cause the player to not lose velocity in that
++ * specific coordinate. The location of the teleportation will not change.
++ *
++ * @see org.bukkit.entity.Player#teleport(Location, PlayerTeleportEvent.TeleportCause, TeleportFlag...)
++ */
++ enum Relative implements TeleportFlag {
++ /**
++ * Represents the player's X coordinate
++ */
++ X,
++ /**
++ * Represents the player's Y coordinate
++ */
++ Y,
++ /**
++ * Represents the player's Z coordinate
++ */
++ Z,
++ /**
++ * Represents the player's yaw
++ */
++ YAW,
++ /**
++ * Represents the player's pitch
++ */
++ PITCH;
++ }
++
++ /**
++ * Represents flags that effect the entity's state on
++ * teleportation.
++ */
++ enum EntityState implements TeleportFlag {
++ /**
++ * If all passengers should not be required to be removed prior to teleportation.
++ * <p>
++ * Note:
++ * Teleporting to a different world with this flag present while the entity has entities riding it
++ * will cause this teleportation to return false and not occur.
++ */
++ RETAIN_PASSENGERS,
++ /**
++ * If the entity should not be dismounted if they are riding another entity.
++ * <p>
++ * Note:
++ * Teleporting to a different world with this flag present while this entity is riding another entity will
++ * cause this teleportation to return false and not occur.
++ */
++ RETAIN_VEHICLE,
++ /**
++ * Indicates that a player should not have their current open inventory closed when teleporting.
++ * <p>
++ * Note:
++ * This option will be ignored when teleported to a different world.
++ */
++ RETAIN_OPEN_INVENTORY;
++ }
++
++}
+diff --git a/src/main/java/org/bukkit/entity/Entity.java b/src/main/java/org/bukkit/entity/Entity.java
+index 0cbf946c4f0f47ddfb59b23905968313f25294b1..a2223907c6e6780ca25dae255f321f9add11c912 100644
+--- a/src/main/java/org/bukkit/entity/Entity.java
++++ b/src/main/java/org/bukkit/entity/Entity.java
+@@ -126,10 +126,32 @@ public interface Entity extends Metadatable, CommandSender, Nameable, Persistent
+ *
+ * @param yaw the yaw
+ * @param pitch the pitch
+- * @throws UnsupportedOperationException if used for players
+ */
+ public void setRotation(float yaw, float pitch);
+
++ // Paper start - Teleport API
++ /**
++ * Teleports this entity to the given location.
++ *
++ * @param location New location to teleport this entity to
++ * @param teleportFlags Flags to be used in this teleportation
++ * @return <code>true</code> if the teleport was successful
++ */
++ default boolean teleport(@NotNull Location location, @NotNull io.papermc.paper.entity.TeleportFlag @NotNull... teleportFlags) {
++ return this.teleport(location, TeleportCause.PLUGIN, teleportFlags);
++ }
++
++ /**
++ * Teleports this entity to the given location.
++ *
++ * @param location New location to teleport this entity to
++ * @param cause The cause of this teleportation
++ * @param teleportFlags Flags to be used in this teleportation
++ * @return <code>true</code> if the teleport was successful
++ */
++ boolean teleport(@NotNull Location location, @NotNull TeleportCause cause, @NotNull io.papermc.paper.entity.TeleportFlag @NotNull... teleportFlags);
++ // Paper end - Teleport API
++
+ /**
+ * Teleports this entity to the given location. If this entity is riding a
+ * vehicle, it will be dismounted prior to teleportation.
+diff --git a/src/main/java/org/bukkit/entity/Player.java b/src/main/java/org/bukkit/entity/Player.java
+index cd2d59a8a098227ec7725d121a63cc90e2a139fa..25064aafd5871a7168e8a0ba3e87d6de89e2b083 100644
+--- a/src/main/java/org/bukkit/entity/Player.java
++++ b/src/main/java/org/bukkit/entity/Player.java
+@@ -3468,6 +3468,45 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM
+ String getClientBrandName();
+ // Paper end
+
++ // Paper start - Teleport API
++ /**
++ * Sets the player's rotation.
++ *
++ * @param yaw the yaw
++ * @param pitch the pitch
++ */
++ void setRotation(float yaw, float pitch);
++
++ /**
++ * Causes the player to look towards the given position.
++ *
++ * @param x x coordinate
++ * @param y y coordinate
++ * @param z z coordinate
++ * @param playerAnchor What part of the player should face the given position
++ */
++ void lookAt(double x, double y, double z, @NotNull io.papermc.paper.entity.LookAnchor playerAnchor);
++
++ /**
++ * Causes the player to look towards the given position.
++ *
++ * @param position Position to look at in the player's current world
++ * @param playerAnchor What part of the player should face the given position
++ */
++ default void lookAt(@NotNull io.papermc.paper.math.Position position, @NotNull io.papermc.paper.entity.LookAnchor playerAnchor) {
++ this.lookAt(position.x(), position.y(), position.z(), playerAnchor);
++ }
++
++ /**
++ * Causes the player to look towards the given entity.
++ *
++ * @param entity Entity to look at
++ * @param playerAnchor What part of the player should face the entity
++ * @param entityAnchor What part of the entity the player should face
++ */
++ void lookAt(@NotNull org.bukkit.entity.Entity entity, @NotNull io.papermc.paper.entity.LookAnchor playerAnchor, @NotNull io.papermc.paper.entity.LookAnchor entityAnchor);
++ // Paper end - Teleport API
++
+ @NotNull
+ @Override
+ Spigot spigot();
+diff --git a/src/main/java/org/bukkit/event/player/PlayerTeleportEvent.java b/src/main/java/org/bukkit/event/player/PlayerTeleportEvent.java
+index 2deae344c88920ab95eefd2f65df5c858e04750b..ccfb08af8c57ddac3062c2cec28d7ff428082709 100644
+--- a/src/main/java/org/bukkit/event/player/PlayerTeleportEvent.java
++++ b/src/main/java/org/bukkit/event/player/PlayerTeleportEvent.java
+@@ -13,8 +13,14 @@ public class PlayerTeleportEvent extends PlayerMoveEvent {
+ private static final HandlerList handlers = new HandlerList();
+ private TeleportCause cause = TeleportCause.UNKNOWN;
+
++ // Paper start - Teleport API
++ private boolean dismounted = true;
++ private final java.util.Set<io.papermc.paper.entity.TeleportFlag.Relative> teleportFlagSet;
++ // Paper end
++
+ public PlayerTeleportEvent(@NotNull final Player player, @NotNull final Location from, @Nullable final Location to) {
+ super(player, from, to);
++ teleportFlagSet = java.util.Collections.emptySet(); // Paper - Teleport API
+ }
+
+ public PlayerTeleportEvent(@NotNull final Player player, @NotNull final Location from, @Nullable final Location to, @NotNull final TeleportCause cause) {
+@@ -23,6 +29,15 @@ public class PlayerTeleportEvent extends PlayerMoveEvent {
+ this.cause = cause;
+ }
+
++ // Paper start - Teleport API
++ @org.jetbrains.annotations.ApiStatus.Internal
++ public PlayerTeleportEvent(@NotNull final Player player, @NotNull final Location from, @Nullable final Location to, @NotNull final TeleportCause cause, @NotNull java.util.Set<io.papermc.paper.entity.TeleportFlag.@NotNull Relative> teleportFlagSet) {
++ super(player, from, to);
++ this.teleportFlagSet = teleportFlagSet;
++ this.cause = cause;
++ }
++ // Paper end
++
+ /**
+ * Gets the cause of this teleportation event
+ *
+@@ -88,6 +103,30 @@ public class PlayerTeleportEvent extends PlayerMoveEvent {
+ UNKNOWN;
+ }
+
++ // Paper start - Teleport API
++ /**
++ * Gets if the player will be dismounted in this teleportation.
++ *
++ * @return dismounted or not
++ * @deprecated dismounting on tp is no longer controlled by the server
++ */
++ @Deprecated(forRemoval = true)
++ public boolean willDismountPlayer() {
++ return this.dismounted;
++ }
++
++ /**
++ * Returns the relative teleportation flags used in this teleportation.
++ * This determines which axis the player will not lose their velocity in.
++ *
++ * @return an immutable set of relative teleportation flags
++ */
++ @NotNull
++ public java.util.Set<io.papermc.paper.entity.TeleportFlag.@NotNull Relative> getRelativeTeleportationFlags() {
++ return this.teleportFlagSet;
++ }
++ // Paper end
++
+ @NotNull
+ @Override
+ public HandlerList getHandlers() {