mirror of
https://github.com/PaperMC/Paper.git
synced 2024-12-24 18:07:39 +01:00
e1c0033552
Upstream has released updates that appear to apply and compile correctly. This update has not been tested by PaperMC and as with ANY update, please do your own testing Bukkit Changes: 2b4b6d14 PR-1023: Convert InventoryView to interface CraftBukkit Changes: 68603b1c1 Use expanded interaction ranges for traced interact events eae9f760c PR-1414: Convert InventoryView to interface ee9eafe67 Fix Implementation for DamageSource#isIndirect for internal custom causing entity
136 lines
3.9 KiB
Diff
136 lines
3.9 KiB
Diff
From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
|
|
From: by77er <by77er@gmail.com>
|
|
Date: Sat, 10 Jun 2023 19:06:24 -0400
|
|
Subject: [PATCH] Add event for player editing sign
|
|
|
|
|
|
diff --git a/src/main/java/io/papermc/paper/event/player/PlayerOpenSignEvent.java b/src/main/java/io/papermc/paper/event/player/PlayerOpenSignEvent.java
|
|
new file mode 100644
|
|
index 0000000000000000000000000000000000000000..c38c32ae349e094ffef84386607f4b9d5fe361f5
|
|
--- /dev/null
|
|
+++ b/src/main/java/io/papermc/paper/event/player/PlayerOpenSignEvent.java
|
|
@@ -0,0 +1,108 @@
|
|
+package io.papermc.paper.event.player;
|
|
+
|
|
+import org.bukkit.block.Sign;
|
|
+import org.bukkit.block.sign.Side;
|
|
+import org.bukkit.entity.HumanEntity;
|
|
+import org.bukkit.entity.Player;
|
|
+import org.bukkit.event.Cancellable;
|
|
+import org.bukkit.event.HandlerList;
|
|
+import org.bukkit.event.player.PlayerEvent;
|
|
+import org.jetbrains.annotations.ApiStatus;
|
|
+import org.jetbrains.annotations.NotNull;
|
|
+
|
|
+/**
|
|
+ * Called when a player begins editing a sign's text.
|
|
+ * <p>
|
|
+ * Cancelling this event stops the sign editing menu from opening.
|
|
+ */
|
|
+public class PlayerOpenSignEvent extends PlayerEvent implements Cancellable {
|
|
+
|
|
+ private static final HandlerList HANDLER_LIST = new HandlerList();
|
|
+
|
|
+ private final Sign sign;
|
|
+ private final Side side;
|
|
+ private final Cause cause;
|
|
+
|
|
+ private boolean cancelled;
|
|
+
|
|
+ @ApiStatus.Internal
|
|
+ public PlayerOpenSignEvent(final @NotNull Player editor, final @NotNull Sign sign, final @NotNull Side side, final @NotNull Cause cause) {
|
|
+ super(editor);
|
|
+ this.sign = sign;
|
|
+ this.side = side;
|
|
+ this.cause = cause;
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * Gets the sign that was clicked.
|
|
+ *
|
|
+ * @return {@link Sign} that was clicked
|
|
+ */
|
|
+ @NotNull
|
|
+ public Sign getSign() {
|
|
+ return this.sign;
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * Gets which side of the sign was clicked.
|
|
+ *
|
|
+ * @return {@link Side} that was clicked
|
|
+ * @see Sign#getSide(Side)
|
|
+ */
|
|
+ @NotNull
|
|
+ public Side getSide() {
|
|
+ return this.side;
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * The cause of this sign open.
|
|
+ *
|
|
+ * @return the cause
|
|
+ */
|
|
+ public @NotNull Cause getCause() {
|
|
+ return this.cause;
|
|
+ }
|
|
+
|
|
+ @Override
|
|
+ public boolean isCancelled() {
|
|
+ return this.cancelled;
|
|
+ }
|
|
+
|
|
+ @Override
|
|
+ public void setCancelled(boolean cancel) {
|
|
+ this.cancelled = cancel;
|
|
+ }
|
|
+
|
|
+ @NotNull
|
|
+ @Override
|
|
+ public HandlerList getHandlers() {
|
|
+ return HANDLER_LIST;
|
|
+ }
|
|
+
|
|
+ @NotNull
|
|
+ public static HandlerList getHandlerList() {
|
|
+ return HANDLER_LIST;
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * The cause of the {@link PlayerOpenSignEvent}.
|
|
+ */
|
|
+ public enum Cause {
|
|
+ /**
|
|
+ * The event was triggered by the placement of a sign.
|
|
+ */
|
|
+ PLACE,
|
|
+ /**
|
|
+ * The event was triggered by an interaction with a sign.
|
|
+ */
|
|
+ INTERACT,
|
|
+ /**
|
|
+ * The event was triggered via a plugin with {@link HumanEntity#openSign(Sign, Side)}
|
|
+ */
|
|
+ PLUGIN,
|
|
+ /**
|
|
+ * Fallback cause for any unknown cause.
|
|
+ */
|
|
+ UNKNOWN,
|
|
+ }
|
|
+}
|
|
diff --git a/src/main/java/org/bukkit/event/player/PlayerSignOpenEvent.java b/src/main/java/org/bukkit/event/player/PlayerSignOpenEvent.java
|
|
index cf935d9c8d8f9a9684024507846a9754f0207986..72fe69c3830f07dd264cfd89e92410dc107034a4 100644
|
|
--- a/src/main/java/org/bukkit/event/player/PlayerSignOpenEvent.java
|
|
+++ b/src/main/java/org/bukkit/event/player/PlayerSignOpenEvent.java
|
|
@@ -9,7 +9,10 @@ import org.jetbrains.annotations.NotNull;
|
|
|
|
/**
|
|
* This event is fired when a sign is opened by the player.
|
|
+ * @deprecated use {@link io.papermc.paper.event.player.PlayerOpenSignEvent}
|
|
*/
|
|
+@Deprecated(forRemoval = true) // Paper
|
|
+@org.bukkit.Warning(false) // Paper
|
|
public class PlayerSignOpenEvent extends PlayerEvent implements Cancellable {
|
|
|
|
private static final HandlerList handlers = new HandlerList();
|