Package net.neoforged.neoforge.event.entity.player

Class PlayerSetSpawnEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.event.entity.EntityEvent

net.neoforged.neoforge.event.entity.living.LivingEvent

net.neoforged.neoforge.event.entity.player.PlayerEvent

net.neoforged.neoforge.event.entity.player.PlayerSetSpawnEvent

All Implemented Interfaces:

net.neoforged.bus.api.ICancellableEvent

public class PlayerSetSpawnEvent
extends PlayerEvent
implements net.neoforged.bus.api.ICancellableEvent

This event is fired when a player's spawn point is set or reset.
The event can be canceled, which will prevent the spawn point from being changed.

Nested Class Summary

Nested classes/interfaces inherited from class net.neoforged.neoforge.event.entity.player.PlayerEvent

PlayerEvent.BreakSpeed, PlayerEvent.Clone, PlayerEvent.HarvestCheck, PlayerEvent.ItemCraftedEvent, PlayerEvent.ItemPickupEvent, PlayerEvent.ItemSmeltedEvent, PlayerEvent.LoadFromFile, PlayerEvent.NameFormat, PlayerEvent.PlayerChangedDimensionEvent, PlayerEvent.PlayerChangeGameModeEvent, PlayerEvent.PlayerLoggedInEvent, PlayerEvent.PlayerLoggedOutEvent, PlayerEvent.PlayerRespawnEvent, PlayerEvent.SaveToFile, PlayerEvent.StartTracking, PlayerEvent.StopTracking, PlayerEvent.TabListNameFormat

Nested classes/interfaces inherited from class net.neoforged.neoforge.event.entity.living.LivingEvent

LivingEvent.LivingJumpEvent, LivingEvent.LivingTickEvent, LivingEvent.LivingVisibilityEvent

Nested classes/interfaces inherited from class net.neoforged.neoforge.event.entity.EntityEvent

EntityEvent.EnteringSection, EntityEvent.EntityConstructing, EntityEvent.Size

Nested classes/interfaces inherited from class net.neoforged.bus.api.Event

net.neoforged.bus.api.Event.HasResult, net.neoforged.bus.api.Event.Result

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	forced
private final @Nullable BlockPos	newSpawn
private final ResourceKey<Level>	spawnLevel

Constructor Summary

Constructors

Constructor	Description
PlayerSetSpawnEvent(Player player, ResourceKey<Level> spawnLevel, @Nullable BlockPos newSpawn, boolean forced)

Method Summary

Modifier and Type	Method	Description
@Nullable BlockPos	getNewSpawn()	The new spawn position, or null if the spawn position is being reset.
ResourceKey<Level>	getSpawnLevel()
boolean	isForced()

Methods inherited from class net.neoforged.neoforge.event.entity.player.PlayerEvent

getEntity

Methods inherited from class net.neoforged.bus.api.Event

getResult, hasResult, setResult

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.neoforged.bus.api.ICancellableEvent

isCanceled, setCanceled

Field Details

spawnLevel

private final ResourceKey<Level> spawnLevel

forced

private final boolean forced

newSpawn

@Nullable
private final @Nullable BlockPos newSpawn

Constructor Details

PlayerSetSpawnEvent

public PlayerSetSpawnEvent(Player player,
 ResourceKey<Level> spawnLevel,
 @Nullable
 @Nullable BlockPos newSpawn,
 boolean forced)

Method Details

isForced

public boolean isForced()

getNewSpawn

@Nullable
public @Nullable BlockPos getNewSpawn()

The new spawn position, or null if the spawn position is being reset.

getSpawnLevel

public ResourceKey<Level> getSpawnLevel()