1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2024-12-21 05:55:08 +01:00
PaperMC/patches/api/0396-More-Sign-Block-API.patch
2024-12-03 17:58:41 +01:00

70 lines
2.6 KiB
Diff

From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
From: Jake Potrebic <jake.m.potrebic@gmail.com>
Date: Fri, 23 Jun 2023 12:16:35 -0700
Subject: [PATCH] More Sign Block API
Co-authored-by: SoSeDiK <mrsosedik@gmail.com>
diff --git a/src/main/java/org/bukkit/block/Sign.java b/src/main/java/org/bukkit/block/Sign.java
index be36f722c7e465fae09ae7c99d92bfa032b66cc3..859217e0109beb555e2357d806be96b53471955d 100644
--- a/src/main/java/org/bukkit/block/Sign.java
+++ b/src/main/java/org/bukkit/block/Sign.java
@@ -182,9 +182,58 @@ public interface Sign extends TileState, Colorable {
/**
* Gets the player that is currently allowed to edit this sign. <br>
* Edits from other players will be rejected if this value is not null.
+ * <br><br>You should prefer {@link #getAllowedEditorUniqueId()} if you don't
+ * need the player instance as this method will fetch the player from UUID.
*
* @return the player allowed to edit this sign, or null
*/
@Nullable
public Player getAllowedEditor();
+ // Paper start - More Sign Block API
+ /**
+ * Gets the allowed editor's UUID.
+ * <br>Edits from other players will be rejected if this value is not null.
+ *
+ * @return the allowed editor's UUID, or null
+ */
+ @Nullable java.util.UUID getAllowedEditorUniqueId();
+
+ /**
+ * Sets the allowed editor's UUID.
+ * <br><br><b>Note:</b> the server sets the UUID back to null if the player can't
+ * interact with the sign (is either offline or outside the allowed interaction range).
+ *
+ * @param uuid the allowed editor's UUID
+ */
+ void setAllowedEditorUniqueId(@Nullable java.util.UUID uuid);
+
+ /**
+ * Compute the side facing the specified entity.
+ *
+ * @param entity the entity
+ * @return the side it is facing
+ */
+ default @NotNull Side getInteractableSideFor(org.bukkit.entity.@NotNull Entity entity) {
+ return this.getInteractableSideFor(entity.getLocation());
+ }
+
+ /**
+ * Compute the side facing the specific position.
+ *
+ * @param position the position
+ * @return the side the position is facing
+ */
+ default @NotNull Side getInteractableSideFor(io.papermc.paper.math.@NotNull Position position) {
+ return this.getInteractableSideFor(position.x(), position.z());
+ }
+
+ /**
+ * Compute the side facing the specific x and z coordinates.
+ *
+ * @param x the x coord
+ * @param z the z coord
+ * @return the side the coordinates are facing
+ */
+ @NotNull Side getInteractableSideFor(double x, double z);
+ // Paper end - More Sign Block API
}