aboutsummaryrefslogtreecommitdiffhomepage
path: root/patches/api/0397-More-Sign-Block-API.patch
blob: 57b372521cd8c6db41f148146c90f22e4075349d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
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 1fdb1144949adc3a2b5cbc3aca94d2f8e0c6d9ee..340e3adcc57227f2e570826681ea81b9159805de 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
 }