mirror of https://github.com/PaperMC/Paper.git
206 lines
6.2 KiB
Diff
206 lines
6.2 KiB
Diff
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..6a823008deaf26f751e598bc967f19c15525acce
|
|
--- /dev/null
|
|
+++ b/src/main/java/com/destroystokyo/paper/event/player/PlayerSetSpawnEvent.java
|
|
@@ -0,0 +1,178 @@
|
|
+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.jetbrains.annotations.NotNull;
|
|
+import org.jetbrains.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.
|
|
+ */
|
|
+public class PlayerSetSpawnEvent extends PlayerEvent implements Cancellable {
|
|
+
|
|
+ private static final HandlerList HANDLER_LIST = new HandlerList();
|
|
+
|
|
+ private final Cause cause;
|
|
+ private Location location;
|
|
+ private boolean forced;
|
|
+ private boolean notifyPlayer;
|
|
+ private Component notification;
|
|
+
|
|
+ private boolean cancelled;
|
|
+
|
|
+ @ApiStatus.Internal
|
|
+ public PlayerSetSpawnEvent(@NotNull Player player, @NotNull Cause cause, @Nullable Location location, boolean forced, boolean notifyPlayer, @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
|
|
+ */
|
|
+ @NotNull
|
|
+ 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
|
|
+ */
|
|
+ @Nullable
|
|
+ public 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(@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(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(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
|
|
+ */
|
|
+ @Nullable
|
|
+ public 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(@Nullable Component notification) {
|
|
+ this.notification = notification;
|
|
+ }
|
|
+
|
|
+ @Override
|
|
+ public boolean isCancelled() {
|
|
+ return this.cancelled;
|
|
+ }
|
|
+
|
|
+ @Override
|
|
+ public void setCancelled(boolean cancel) {
|
|
+ this.cancelled = cancel;
|
|
+ }
|
|
+
|
|
+ @Override
|
|
+ public @NotNull HandlerList getHandlers() {
|
|
+ return HANDLER_LIST;
|
|
+ }
|
|
+
|
|
+ @NotNull
|
|
+ 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 c2884bc20f0040b15dc035f4761d021e7343960d..3ea03540ce2882bbb482d9bd69a015a7fc040bfd 100644
|
|
--- a/src/main/java/org/bukkit/event/player/PlayerSpawnChangeEvent.java
|
|
+++ b/src/main/java/org/bukkit/event/player/PlayerSpawnChangeEvent.java
|
|
@@ -12,8 +12,10 @@ import org.jetbrains.annotations.Nullable;
|
|
/**
|
|
* This event is fired when the spawn point of the player is changed.
|
|
* @apiNote draft API
|
|
+ * @deprecated use {@link com.destroystokyo.paper.event.player.PlayerSetSpawnEvent}
|
|
*/
|
|
@ApiStatus.Experimental
|
|
+@Deprecated(forRemoval = true) // Paper
|
|
public class PlayerSpawnChangeEvent extends PlayerEvent implements Cancellable {
|
|
|
|
private static final HandlerList handlers = new HandlerList();
|