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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
From: Jake Potrebic <jake.m.potrebic@gmail.com>
Date: Wed, 19 May 2021 18:58:24 -0700
Subject: [PATCH] Add PlayerSetSpawnEvent
diff --git a/src/main/java/com/destroystokyo/paper/event/player/PlayerSetSpawnEvent.java b/src/main/java/com/destroystokyo/paper/event/player/PlayerSetSpawnEvent.java
new file mode 100644
index 0000000000000000000000000000000000000000..41d42d73cf65e9b8acac9d0b2dfd6537b532be74
--- /dev/null
+++ b/src/main/java/com/destroystokyo/paper/event/player/PlayerSetSpawnEvent.java
@@ -0,0 +1,175 @@
+package com.destroystokyo.paper.event.player;
+
+import net.kyori.adventure.text.Component;
+import org.bukkit.Location;
+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.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
+
+/**
+ * Called when a player's spawn is set, either by themselves or otherwise.
+ * <br>
+ * Cancelling this event will prevent the spawn from being set.
+ */
+@NullMarked
+public class PlayerSetSpawnEvent extends PlayerEvent implements Cancellable {
+
+ private static final HandlerList HANDLER_LIST = new HandlerList();
+
+ private final Cause cause;
+ private @Nullable Location location;
+ private boolean forced;
+ private boolean notifyPlayer;
+ private @Nullable Component notification;
+
+ private boolean cancelled;
+
+ @ApiStatus.Internal
+ public PlayerSetSpawnEvent(final Player player, final Cause cause, final @Nullable Location location, final boolean forced, final boolean notifyPlayer, final @Nullable Component notification) {
+ super(player);
+ this.cause = cause;
+ this.location = location;
+ this.forced = forced;
+ this.notifyPlayer = notifyPlayer;
+ this.notification = notification;
+ }
+
+ /**
+ * Gets the cause of this event.
+ *
+ * @return the cause
+ */
+ public Cause getCause() {
+ return this.cause;
+ }
+
+ /**
+ * Gets the location that the spawn is set to. The yaw
+ * of this location is the spawn angle. Mutating this location
+ * will change the resulting spawn point of the player. Use
+ * {@link Location#clone()} to get a copy of this location.
+ *
+ * @return the spawn location, or {@code null} if removing the location
+ */
+ public @Nullable Location getLocation() {
+ return this.location;
+ }
+
+ /**
+ * Sets the location to be set as the spawn location. The yaw
+ * of this location is the spawn angle.
+ *
+ * @param location the spawn location, or {@code null} to remove the spawn location
+ */
+ public void setLocation(final @Nullable Location location) {
+ this.location = location;
+ }
+
+ /**
+ * Gets if this is a force spawn location
+ *
+ * @return {@code true} if forced
+ */
+ public boolean isForced() {
+ return this.forced;
+ }
+
+ /**
+ * Sets if this is a forced spawn location
+ *
+ * @param forced {@code true} to force
+ */
+ public void setForced(final boolean forced) {
+ this.forced = forced;
+ }
+
+ /**
+ * Gets if this action will notify the player their spawn
+ * has been set.
+ *
+ * @return {@code true} to notify
+ */
+ public boolean willNotifyPlayer() {
+ return this.notifyPlayer;
+ }
+
+ /**
+ * Sets if this action will notify the player that their spawn
+ * has been set.
+ *
+ * @param notifyPlayer {@code true} to notify
+ */
+ public void setNotifyPlayer(final boolean notifyPlayer) {
+ this.notifyPlayer = notifyPlayer;
+ }
+
+ /**
+ * Gets the notification message that will be sent to the player
+ * if {@link #willNotifyPlayer()} returns true.
+ *
+ * @return {@code null} if no notification
+ */
+ public @Nullable Component getNotification() {
+ return this.notification;
+ }
+
+ /**
+ * Sets the notification message that will be sent to the player.
+ *
+ * @param notification {@code null} to send no message
+ */
+ public void setNotification(final @Nullable Component notification) {
+ this.notification = notification;
+ }
+
+ @Override
+ public boolean isCancelled() {
+ return this.cancelled;
+ }
+
+ @Override
+ public void setCancelled(final boolean cancel) {
+ this.cancelled = cancel;
+ }
+
+ @Override
+ public HandlerList getHandlers() {
+ return HANDLER_LIST;
+ }
+
+ public static HandlerList getHandlerList() {
+ return HANDLER_LIST;
+ }
+
+ public enum Cause {
+ /**
+ * When a player interacts successfully with a bed.
+ */
+ BED,
+ /**
+ * When a player interacts successfully with a respawn anchor.
+ */
+ RESPAWN_ANCHOR,
+ /**
+ * When a player respawns.
+ */
+ PLAYER_RESPAWN,
+ /**
+ * When the {@code /spawnpoint} command is used on a player.
+ */
+ COMMAND,
+ /**
+ * When a plugin uses {@link Player#setRespawnLocation(Location)} or
+ * {@link Player#setRespawnLocation(Location, boolean)}.
+ */
+ PLUGIN,
+ /**
+ * Fallback cause.
+ */
+ UNKNOWN,
+ }
+}
diff --git a/src/main/java/org/bukkit/event/player/PlayerSpawnChangeEvent.java b/src/main/java/org/bukkit/event/player/PlayerSpawnChangeEvent.java
index b22feeda89df7a40d9e684923030230d1dd0a0fb..a57aaf09a2ce29aaeb29f8587509170dbcad24e9 100644
--- a/src/main/java/org/bukkit/event/player/PlayerSpawnChangeEvent.java
+++ b/src/main/java/org/bukkit/event/player/PlayerSpawnChangeEvent.java
@@ -10,7 +10,9 @@ import org.jetbrains.annotations.Nullable;
/**
* This event is fired when the spawn point of the player is changed.
+ * @deprecated use {@link com.destroystokyo.paper.event.player.PlayerSetSpawnEvent}
*/
+@Deprecated(forRemoval = true) // Paper
public class PlayerSpawnChangeEvent extends PlayerEvent implements Cancellable {
private static final HandlerList handlers = new HandlerList();
|
