Parity for respawn events (#11792)

paper-api/src/main/java/com/destroystokyo/paper/event/player/PlayerPostRespawnEvent.java

@@ -1,9 +1,10 @@
 package com.destroystokyo.paper.event.player;
 
+import io.papermc.paper.event.player.AbstractRespawnEvent;
 import org.bukkit.Location;
 import org.bukkit.entity.Player;
 import org.bukkit.event.HandlerList;
-import org.bukkit.event.player.PlayerEvent;
+import org.bukkit.event.player.PlayerRespawnEvent;
 import org.jetbrains.annotations.ApiStatus;
 import org.jspecify.annotations.NullMarked;
 
@@ -11,36 +12,31 @@ import org.jspecify.annotations.NullMarked;
  * Fired after a player has respawned
  */
 @NullMarked
-public class PlayerPostRespawnEvent extends PlayerEvent {
+public class PlayerPostRespawnEvent extends AbstractRespawnEvent {
 
     private static final HandlerList HANDLER_LIST = new HandlerList();
 
-    private final Location respawnedLocation;
-    private final boolean isBedSpawn;
-
     @ApiStatus.Internal
-    public PlayerPostRespawnEvent(final Player respawnPlayer, final Location respawnedLocation, final boolean isBedSpawn) {
-        super(respawnPlayer);
-        this.respawnedLocation = respawnedLocation;
-        this.isBedSpawn = isBedSpawn;
+    public PlayerPostRespawnEvent(
+        final Player respawnPlayer,
+        final Location respawnLocation,
+        final boolean isBedSpawn,
+        final boolean isAnchorSpawn,
+        final boolean missingRespawnBlock,
+        final PlayerRespawnEvent.RespawnReason respawnReason
+    ) {
+        super(respawnPlayer, respawnLocation, isBedSpawn, isAnchorSpawn, missingRespawnBlock, respawnReason);
     }
 
     /**
-     * Returns the location of the respawned player
+     * Returns the location of the respawned player.
      *
      * @return location of the respawned player
+     * @see #getRespawnLocation()
      */
+    @ApiStatus.Obsolete
     public Location getRespawnedLocation() {
-        return this.respawnedLocation.clone();
-    }
-
-    /**
-     * Checks if the player respawned to their bed
-     *
-     * @return whether the player respawned to their bed
-     */
-    public boolean isBedSpawn() {
-        return this.isBedSpawn;
+        return super.getRespawnLocation();
     }
 
     @Override

paper-api/src/main/java/io/papermc/paper/event/player/AbstractRespawnEvent.java

@@ -0,0 +1,98 @@
+package io.papermc.paper.event.player;
+
+import com.google.common.collect.ImmutableSet;
+import org.bukkit.Location;
+import org.bukkit.entity.Player;
+import org.bukkit.event.player.PlayerEvent;
+import org.bukkit.event.player.PlayerRespawnEvent;
+import org.jetbrains.annotations.Unmodifiable;
+import org.jspecify.annotations.NullMarked;
+import java.util.Set;
+
+@NullMarked
+public abstract class AbstractRespawnEvent extends PlayerEvent {
+
+    protected Location respawnLocation;
+    private final boolean isBedSpawn;
+    private final boolean isAnchorSpawn;
+    private final boolean missingRespawnBlock;
+    private final PlayerRespawnEvent.RespawnReason respawnReason;
+    private final Set<PlayerRespawnEvent.RespawnFlag> respawnFlags;
+
+    protected AbstractRespawnEvent(
+        final Player respawnPlayer, final Location respawnLocation, final boolean isBedSpawn,
+        final boolean isAnchorSpawn, final boolean missingRespawnBlock, final PlayerRespawnEvent.RespawnReason respawnReason
+    ) {
+        super(respawnPlayer);
+        this.respawnLocation = respawnLocation;
+        this.isBedSpawn = isBedSpawn;
+        this.isAnchorSpawn = isAnchorSpawn;
+        this.missingRespawnBlock = missingRespawnBlock;
+        this.respawnReason = respawnReason;
+        ImmutableSet.Builder<PlayerRespawnEvent.RespawnFlag> builder = ImmutableSet.builder();
+        if (respawnReason == PlayerRespawnEvent.RespawnReason.END_PORTAL) builder.add(PlayerRespawnEvent.RespawnFlag.END_PORTAL);
+        if (this.isBedSpawn) builder.add(PlayerRespawnEvent.RespawnFlag.BED_SPAWN);
+        if (this.isAnchorSpawn) builder.add(PlayerRespawnEvent.RespawnFlag.ANCHOR_SPAWN);
+        this.respawnFlags = builder.build();
+    }
+
+    /**
+     * Gets the current respawn location.
+     *
+     * @return the current respawn location
+     */
+    public Location getRespawnLocation() {
+        return this.respawnLocation.clone();
+    }
+
+    /**
+     * Gets whether the respawn location is the player's bed.
+     *
+     * @return {@code true} if the respawn location is the player's bed
+     */
+    public boolean isBedSpawn() {
+        return this.isBedSpawn;
+    }
+
+    /**
+     * Gets whether the respawn location is the player's respawn anchor.
+     *
+     * @return {@code true} if the respawn location is the player's respawn anchor
+     */
+    public boolean isAnchorSpawn() {
+        return this.isAnchorSpawn;
+    }
+
+    /**
+     * Gets whether the player is missing a valid respawn block.
+     * <p>
+     * This will occur if the players respawn block is obstructed,
+     * or it is the first death after it was either destroyed or
+     * in case of a respawn anchor, ran out of charges.
+     *
+     * @return whether the player is missing a valid respawn block
+     */
+    public boolean isMissingRespawnBlock() {
+        return this.missingRespawnBlock;
+    }
+
+    /**
+     * Gets the reason this respawn event was called.
+     *
+     * @return the reason the event was called
+     */
+    public PlayerRespawnEvent.RespawnReason getRespawnReason() {
+        return this.respawnReason;
+    }
+
+    /**
+     * Gets the set of flags that apply to this respawn.
+     *
+     * @return an immutable set of the flags that apply to this respawn
+     * @deprecated in favour of {@link #getRespawnReason()}/{@link #isBedSpawn}/{@link #isAnchorSpawn()}
+     */
+    @Deprecated
+    public @Unmodifiable Set<PlayerRespawnEvent.RespawnFlag> getRespawnFlags() {
+        return this.respawnFlags;
+    }
+}

paper-api/src/main/java/org/bukkit/event/player/PlayerRespawnEvent.java

@@ -1,6 +1,7 @@
 package org.bukkit.event.player;
 
 import com.google.common.base.Preconditions;
+import io.papermc.paper.event.player.AbstractRespawnEvent;
 import org.bukkit.Location;
 import org.bukkit.entity.Player;
 import org.bukkit.event.HandlerList;
@@ -15,17 +16,10 @@ import java.util.Set;
  * If changing player state, see {@link com.destroystokyo.paper.event.player.PlayerPostRespawnEvent}
  * because the player is "reset" between this event and that event and some changes won't persist.
  */
-public class PlayerRespawnEvent extends PlayerEvent {
+public class PlayerRespawnEvent extends AbstractRespawnEvent {
 
     private static final HandlerList HANDLER_LIST = new HandlerList();
 
-    private final boolean isBedSpawn;
-    private final boolean isAnchorSpawn;
-    private final boolean missingRespawnBlock;
-    private final RespawnReason respawnReason;
-    private final Set<RespawnFlag> respawnFlags;
-    private Location respawnLocation;
-
     @ApiStatus.Internal
     @Deprecated(since = "1.16.1", forRemoval = true)
     public PlayerRespawnEvent(@NotNull final Player respawnPlayer, @NotNull final Location respawnLocation, final boolean isBedSpawn) {
@@ -35,40 +29,16 @@ public class PlayerRespawnEvent extends PlayerEvent {
     @ApiStatus.Internal
     @Deprecated(since = "1.19.4", forRemoval = true)
     public PlayerRespawnEvent(@NotNull final Player respawnPlayer, @NotNull final Location respawnLocation, final boolean isBedSpawn, final boolean isAnchorSpawn) {
-        this(respawnPlayer, respawnLocation, isBedSpawn, isAnchorSpawn, RespawnReason.PLUGIN);
+        this(respawnPlayer, respawnLocation, isBedSpawn, isAnchorSpawn, false, RespawnReason.PLUGIN);
     }
 
     @ApiStatus.Internal
-    @Deprecated(forRemoval = true)
-    public PlayerRespawnEvent(@NotNull final Player respawnPlayer, @NotNull final Location respawnLocation, final boolean isBedSpawn, final boolean isAnchorSpawn, @NotNull final RespawnReason respawnReason) {
-        this(respawnPlayer, respawnLocation, isBedSpawn, isAnchorSpawn, false, respawnReason, com.google.common.collect.ImmutableSet.builder());
-    }
-
-    @ApiStatus.Internal
-    public PlayerRespawnEvent(@NotNull final Player respawnPlayer, @NotNull final Location respawnLocation, final boolean isBedSpawn, final boolean isAnchorSpawn, final boolean missingRespawnBlock, @NotNull final RespawnReason respawnReason, @NotNull final com.google.common.collect.ImmutableSet.Builder<org.bukkit.event.player.PlayerRespawnEvent.RespawnFlag> respawnFlags) {
-        super(respawnPlayer);
-        this.respawnLocation = respawnLocation;
-        this.isBedSpawn = isBedSpawn;
-        this.isAnchorSpawn = isAnchorSpawn;
-        this.respawnReason = respawnReason;
-        this.missingRespawnBlock = missingRespawnBlock;
-        if (this.isBedSpawn) { respawnFlags.add(RespawnFlag.BED_SPAWN); }
-        if (this.isAnchorSpawn) { respawnFlags.add(RespawnFlag.ANCHOR_SPAWN); }
-        this.respawnFlags = respawnFlags.build();
+    public PlayerRespawnEvent(@NotNull final Player respawnPlayer, @NotNull final Location respawnLocation, final boolean isBedSpawn, final boolean isAnchorSpawn, final boolean missingRespawnBlock, @NotNull final RespawnReason respawnReason) {
+        super(respawnPlayer, respawnLocation, isBedSpawn, isAnchorSpawn, missingRespawnBlock, respawnReason);
     }
 
     /**
-     * Gets the current respawn location
-     *
-     * @return Location current respawn location
-     */
-    @NotNull
-    public Location getRespawnLocation() {
-        return this.respawnLocation;
-    }
-
-    /**
-     * Sets the new respawn location
+     * Sets the new respawn location.
      *
      * @param respawnLocation new location for the respawn
      */
@@ -79,57 +49,6 @@ public class PlayerRespawnEvent extends PlayerEvent {
         this.respawnLocation = respawnLocation.clone();
     }
 
-    /**
-     * Gets whether the respawn location is the player's bed.
-     *
-     * @return {@code true} if the respawn location is the player's bed.
-     */
-    public boolean isBedSpawn() {
-        return this.isBedSpawn;
-    }
-
-    /**
-     * Gets whether the respawn location is the player's respawn anchor.
-     *
-     * @return {@code true} if the respawn location is the player's respawn anchor.
-     */
-    public boolean isAnchorSpawn() {
-        return this.isAnchorSpawn;
-    }
-
-    /**
-     * Gets whether the player is missing a valid respawn block.
-     * <p>
-     * This will occur if the players respawn block is obstructed,
-     * or it is the first death after it was either destroyed or
-     * in case of a respawn anchor, ran out of charges.
-     *
-     * @return whether the player is missing a valid respawn block
-     */
-    public boolean isMissingRespawnBlock() {
-        return this.missingRespawnBlock;
-    }
-
-    /**
-     * Gets the reason this respawn event was called.
-     *
-     * @return the reason the event was called.
-     */
-    @NotNull
-    public RespawnReason getRespawnReason() {
-        return this.respawnReason;
-    }
-
-    /**
-     * Get the set of flags that apply to this respawn.
-     *
-     * @return an immutable set of the flags that apply to this respawn
-     */
-    @NotNull
-    public @Unmodifiable Set<RespawnFlag> getRespawnFlags() {
-        return this.respawnFlags;
-    }
-
     @NotNull
     @Override
     public HandlerList getHandlers() {

paper-server/patches/features/0015-Moonrise-optimisation-patches.patch

@@ -26798,7 +26798,7 @@ index c50a1a01d167696134bd65b2d28db323d81d6ebd..5d63bf024cbcbd2f627c64fee77553c9
      }
  }
 diff --git a/net/minecraft/server/level/ServerEntity.java b/net/minecraft/server/level/ServerEntity.java
-index 3f83a589442a80e9c16b5e9cd0f50792defd12bc..0005a1784ccaa00e5d6d67e7be98445150487982 100644
+index 69fbcd734c269bbc9858b0ad0b3b268ddb81fcc6..a1ae77b70f69852d9e4332bf1cb3409c33b21de0 100644
 --- a/net/minecraft/server/level/ServerEntity.java
 +++ b/net/minecraft/server/level/ServerEntity.java
 @@ -104,6 +104,11 @@ public class ServerEntity {
@@ -26814,7 +26814,7 @@ index 3f83a589442a80e9c16b5e9cd0f50792defd12bc..0005a1784ccaa00e5d6d67e7be984451
          if (!passengers.equals(this.lastPassengers)) {
              List<UUID> list = this.mountedOrDismounted(passengers).map(Entity::getUUID).toList();
 diff --git a/net/minecraft/server/level/ServerLevel.java b/net/minecraft/server/level/ServerLevel.java
-index fe9b4484d683fe48f435a053c9c90557fdf80e7b..8afe96bfdc37e57129f1bb4af5b6d5cc22c11aee 100644
+index 085040aa98704f2874bcd95b751b0a81dcdb15ad..cd72273468f596b640bd2d10d846fbe8813846a6 100644
 --- a/net/minecraft/server/level/ServerLevel.java
 +++ b/net/minecraft/server/level/ServerLevel.java
 @@ -166,7 +166,7 @@ import net.minecraft.world.phys.shapes.VoxelShape;
@@ -27565,7 +27565,7 @@ index fe9b4484d683fe48f435a053c9c90557fdf80e7b..8afe96bfdc37e57129f1bb4af5b6d5cc
      }
  
 diff --git a/net/minecraft/server/level/ServerPlayer.java b/net/minecraft/server/level/ServerPlayer.java
-index a8c73bdf8fb130eed8922cb537a35cda07e66da5..3e73c69c9db8cbded28a001b20d9989acb11c638 100644
+index 8bbbd1d64df1f4f4aecdbb1d1d65e258af018ca9..9eff33c3f552da794370d48a6ef526eecd2b131c 100644
 --- a/net/minecraft/server/level/ServerPlayer.java
 +++ b/net/minecraft/server/level/ServerPlayer.java
 @@ -187,7 +187,7 @@ import net.minecraft.world.scores.Team;
@@ -28202,10 +28202,10 @@ index b30f56fbc1fd17259a1d05dc9155fffcab292ca1..11fed81a4696ba18440e755c3b8a5ca3
          this.generatingStep = generatingStep;
          this.cache = cache;
 diff --git a/net/minecraft/server/players/PlayerList.java b/net/minecraft/server/players/PlayerList.java
-index 5ec9e3b37e575e9805bf9f0ce5cae5c1284461d8..78201407a37eced73998b97d5d5c412eaba69af1 100644
+index eda176c96bcf3d67650722ffce33863edfbdea9e..a7a07ebe6ceed99fa768b6834e350fe2f51a6950 100644
 --- a/net/minecraft/server/players/PlayerList.java
 +++ b/net/minecraft/server/players/PlayerList.java
-@@ -1320,7 +1320,7 @@ public abstract class PlayerList {
+@@ -1332,7 +1332,7 @@ public abstract class PlayerList {
  
      public void setViewDistance(int viewDistance) {
          this.viewDistance = viewDistance;
@@ -28214,7 +28214,7 @@ index 5ec9e3b37e575e9805bf9f0ce5cae5c1284461d8..78201407a37eced73998b97d5d5c412e
  
          for (ServerLevel serverLevel : this.server.getAllLevels()) {
              if (serverLevel != null) {
-@@ -1331,7 +1331,7 @@ public abstract class PlayerList {
+@@ -1343,7 +1343,7 @@ public abstract class PlayerList {
  
      public void setSimulationDistance(int simulationDistance) {
          this.simulationDistance = simulationDistance;

paper-server/patches/features/0023-Incremental-chunk-and-player-saving.patch

@@ -50,7 +50,7 @@ index 094ef7f54ad71795a2d8c2a8d03a32bef6ff2164..79bc1b7d9f640d2322814177eb3e921d
          ProfilerFiller profilerFiller = Profiler.get();
          this.runAllTasks(); // Paper - move runAllTasks() into full server tick (previously for timings)
 diff --git a/net/minecraft/server/level/ServerLevel.java b/net/minecraft/server/level/ServerLevel.java
-index 32db2b9e375c12cbf7abab69cc01e8ac2c7c3b6e..d50d2928ad9f8b34a14621b1fe5c188547e04bd1 100644
+index 32c8d4675de341d5edad7dbd9c0bf4bce5037733..3c8a1fe9831d6cf9e622e3ac2aede4e5c657c18f 100644
 --- a/net/minecraft/server/level/ServerLevel.java
 +++ b/net/minecraft/server/level/ServerLevel.java
 @@ -1317,6 +1317,28 @@ public class ServerLevel extends Level implements ServerEntityGetter, WorldGenLe
@@ -83,7 +83,7 @@ index 32db2b9e375c12cbf7abab69cc01e8ac2c7c3b6e..d50d2928ad9f8b34a14621b1fe5c1885
          // Paper start - add close param
          this.save(progress, flush, skipSave, false);
 diff --git a/net/minecraft/server/level/ServerPlayer.java b/net/minecraft/server/level/ServerPlayer.java
-index 3e73c69c9db8cbded28a001b20d9989acb11c638..d1de5aff81da465be79f2f747466734e80ec50dc 100644
+index 9eff33c3f552da794370d48a6ef526eecd2b131c..222bfe0a04b5d583852ea2c167d52d0e907cf006 100644
 --- a/net/minecraft/server/level/ServerPlayer.java
 +++ b/net/minecraft/server/level/ServerPlayer.java
 @@ -189,6 +189,7 @@ import org.slf4j.Logger;
@@ -95,7 +95,7 @@ index 3e73c69c9db8cbded28a001b20d9989acb11c638..d1de5aff81da465be79f2f747466734e
      private static final int NEUTRAL_MOB_DEATH_NOTIFICATION_RADII_Y = 10;
      private static final int FLY_STAT_RECORDING_SPEED = 25;
 diff --git a/net/minecraft/server/players/PlayerList.java b/net/minecraft/server/players/PlayerList.java
-index 78201407a37eced73998b97d5d5c412eaba69af1..f057e682ccd378f11710dc2e7129cba95788bb18 100644
+index a7a07ebe6ceed99fa768b6834e350fe2f51a6950..9ca3c55a3b5b1a532b86b08eb92460df4cb54f2a 100644
 --- a/net/minecraft/server/players/PlayerList.java
 +++ b/net/minecraft/server/players/PlayerList.java
 @@ -486,6 +486,7 @@ public abstract class PlayerList {
@@ -106,7 +106,7 @@ index 78201407a37eced73998b97d5d5c412eaba69af1..f057e682ccd378f11710dc2e7129cba9
          this.playerIo.save(player);
          ServerStatsCounter serverStatsCounter = player.getStats(); // CraftBukkit
          if (serverStatsCounter != null) {
-@@ -1067,9 +1068,23 @@ public abstract class PlayerList {
+@@ -1079,9 +1080,23 @@ public abstract class PlayerList {
      }
  
      public void saveAll() {

paper-server/patches/sources/net/minecraft/server/level/ServerPlayer.java.patch

@@ -491,7 +491,7 @@
          }
      }
  
-@@ -914,23 +_,82 @@
+@@ -914,23 +_,77 @@
      }
  
      private boolean isPvpAllowed() {
@@ -541,18 +541,13 @@
 +        );
 +
 +        // Paper start - respawn flags
-+        com.google.common.collect.ImmutableSet.Builder<org.bukkit.event.player.PlayerRespawnEvent.RespawnFlag> builder = com.google.common.collect.ImmutableSet.builder();
-+        if (respawnReason == org.bukkit.event.player.PlayerRespawnEvent.RespawnReason.END_PORTAL) {
-+            builder.add(org.bukkit.event.player.PlayerRespawnEvent.RespawnFlag.END_PORTAL);
-+        }
 +        org.bukkit.event.player.PlayerRespawnEvent respawnEvent = new org.bukkit.event.player.PlayerRespawnEvent(
 +            respawnPlayer,
 +            location,
 +            isBedSpawn,
 +            isAnchorSpawn,
 +            teleportTransition.missingRespawnBlock(),
-+            respawnReason,
-+            builder
++            respawnReason
 +        );
 +        // Paper end - respawn flags
 +        this.level().getCraftServer().getPluginManager().callEvent(respawnEvent);

paper-server/patches/sources/net/minecraft/server/players/PlayerList.java.patch

@@ -524,7 +524,7 @@
              IpBanListEntry ipBanListEntry = this.ipBans.get(socketAddress);
              MutableComponent mutableComponent = Component.translatable("multiplayer.disconnect.banned_ip.reason", ipBanListEntry.getReason());
              if (ipBanListEntry.getExpires() != null) {
-@@ -381,69 +_,130 @@
+@@ -381,69 +_,131 @@
                  );
              }
  
@@ -649,6 +649,7 @@
 +        // Paper start - Add PlayerPostRespawnEvent
 +        boolean isBedSpawn = false;
 +        boolean isRespawn = false;
++        boolean isAnchorSpawn = false;
 +        // Paper end - Add PlayerPostRespawnEvent
 +
 +        // CraftBukkit start - fire PlayerRespawnEvent
@@ -714,13 +715,17 @@
          serverPlayer.setHealth(serverPlayer.getHealth());
          ServerPlayer.RespawnConfig respawnConfig = serverPlayer.getRespawnConfig();
          if (!keepInventory && respawnConfig != null) {
-@@ -477,8 +_,41 @@
+@@ -477,8 +_,52 @@
                              )
                          );
                  }
 +                // Paper start - Add PlayerPostRespawnEvent
-+                if (blockState.is(net.minecraft.tags.BlockTags.BEDS) && !teleportTransition.missingRespawnBlock()) {
++                if (!teleportTransition.missingRespawnBlock()) {
++                    if (blockState.is(net.minecraft.tags.BlockTags.BEDS)) {
 +                        isBedSpawn = true;
++                    } else if (blockState.is(Blocks.RESPAWN_ANCHOR)) {
++                        isAnchorSpawn = true;
++                    }
 +                }
 +                // Paper end - Add PlayerPostRespawnEvent
              }
@@ -748,7 +753,14 @@
 +
 +        // Paper start - Add PlayerPostRespawnEvent
 +        if (isRespawn) {
-+            cserver.getPluginManager().callEvent(new com.destroystokyo.paper.event.player.PlayerPostRespawnEvent(player.getBukkitEntity(), location, isBedSpawn));
++            new com.destroystokyo.paper.event.player.PlayerPostRespawnEvent(
++                player.getBukkitEntity(),
++                location,
++                isBedSpawn,
++                isAnchorSpawn,
++                teleportTransition.missingRespawnBlock(),
++                eventReason
++            ).callEvent();
 +        }
 +        // Paper end - Add PlayerPostRespawnEvent
 +