Package io.papermc.paper.event.player

Class AbstractRespawnEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.player.PlayerEvent

io.papermc.paper.event.player.AbstractRespawnEvent

Direct Known Subclasses:

PlayerPostRespawnEvent, PlayerRespawnEvent

@NullMarked
public abstract class AbstractRespawnEvent
extends PlayerEvent

Nested Class Summary

Nested classes/interfaces inherited from class org.bukkit.event.Event

Event.Result

Field Summary

Fields

Modifier and Type	Field	Description
protected Location	respawnLocation

Fields inherited from class org.bukkit.event.player.PlayerEvent

player

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractRespawnEvent(Player respawnPlayer, Location respawnLocation, boolean isBedSpawn, boolean isAnchorSpawn, boolean missingRespawnBlock, PlayerRespawnEvent.RespawnReason respawnReason)

Method Summary

Modifier and Type	Method	Description
@Unmodifiable Set<PlayerRespawnEvent.RespawnFlag>	getRespawnFlags()	Deprecated. in favour of getRespawnReason()/isBedSpawn/isAnchorSpawn()
Location	getRespawnLocation()	Gets the current respawn location.
PlayerRespawnEvent.RespawnReason	getRespawnReason()	Gets the reason this respawn event was called.
boolean	isAnchorSpawn()	Gets whether the respawn location is the player's respawn anchor.
boolean	isBedSpawn()	Gets whether the respawn location is the player's bed.
boolean	isMissingRespawnBlock()	Gets whether the player is missing a valid respawn block.

Methods inherited from class org.bukkit.event.player.PlayerEvent

getPlayer

Methods inherited from class org.bukkit.event.Event

callEvent, getEventName, getHandlers, isAsynchronous

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

respawnLocation

protected Location respawnLocation

Constructor Details

AbstractRespawnEvent

protected AbstractRespawnEvent(Player respawnPlayer,
 Location respawnLocation,
 boolean isBedSpawn,
 boolean isAnchorSpawn,
 boolean missingRespawnBlock,
 PlayerRespawnEvent.RespawnReason respawnReason)

Method Details

getRespawnLocation

public Location getRespawnLocation()

Gets the current respawn location.

Returns:

the current respawn location

isBedSpawn

public boolean isBedSpawn()

Gets whether the respawn location is the player's bed.

Returns:

true if the respawn location is the player's bed

isAnchorSpawn

public boolean isAnchorSpawn()

Gets whether the respawn location is the player's respawn anchor.

Returns:

true if the respawn location is the player's respawn anchor

isMissingRespawnBlock

public boolean isMissingRespawnBlock()

Gets whether the player is missing a valid respawn block.

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.

Returns:

whether the player is missing a valid respawn block

getRespawnReason

public PlayerRespawnEvent.RespawnReason getRespawnReason()

Gets the reason this respawn event was called.

Returns:

the reason the event was called

getRespawnFlags

@Deprecated
public @Unmodifiable Set<PlayerRespawnEvent.RespawnFlag> getRespawnFlags()

Deprecated.

in favour of getRespawnReason()/isBedSpawn/isAnchorSpawn()

Gets the set of flags that apply to this respawn.

Returns:

an immutable set of the flags that apply to this respawn