Class CanPlayerSleepEvent

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.CanPlayerSleepEvent

public class CanPlayerSleepEvent
extends PlayerEvent

Called from

invalid reference

ServerPlayer#startSleepInBed(BlockPos)

when a player attempts to sleep.

This event receives the result of vanilla checking if the sleep attempt is valid, and permits overriding it.

This event is only fired on the logical server.

Nested Class Summary

Nested classes/interfaces inherited from class PlayerEvent

PlayerEvent.BreakSpeed, PlayerEvent.Clone, PlayerEvent.HarvestCheck, PlayerEvent.ItemCraftedEvent, 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 LivingEvent

LivingEvent.LivingJumpEvent, LivingEvent.LivingVisibilityEvent

Nested classes/interfaces inherited from class EntityEvent

EntityEvent.EnteringSection, EntityEvent.EntityConstructing, EntityEvent.Size

Field Summary

Fields

Modifier and Type	Field	Description
private final BlockPos	pos
private @Nullable Player.BedSleepingProblem	problem
private final BlockState	state
private final @Nullable Player.BedSleepingProblem	vanillaProblem

Constructor Summary

Constructors

Constructor	Description
CanPlayerSleepEvent(ServerPlayer player, BlockPos pos, @Nullable Player.BedSleepingProblem problem)

Method Summary

Modifier and Type	Method	Description
ServerPlayer	getEntity()
Level	getLevel()
BlockPos	getPos()
@Nullable Player.BedSleepingProblem	getProblem()	Returns the current sleeping problem.
BlockState	getState()
@Nullable Player.BedSleepingProblem	getVanillaProblem()	Returns the default sleeping problem based on the vanilla checks.
void	setProblem(@Nullable Player.BedSleepingProblem problem)	Sets a new sleeping problem.

Methods inherited from class Object

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

Field Details

pos

private final BlockPos pos

state

private final BlockState state

vanillaProblem

private final @Nullable Player.BedSleepingProblem vanillaProblem

problem

private @Nullable Player.BedSleepingProblem problem

Constructor Details

CanPlayerSleepEvent

public CanPlayerSleepEvent(ServerPlayer player,
 BlockPos pos,
 @Nullable Player.BedSleepingProblem problem)

Method Details

getEntity

public ServerPlayer getEntity()

Overrides:

getEntity in class PlayerEvent

getLevel

public Level getLevel()

getPos

public BlockPos getPos()

getState

public BlockState getState()

getProblem

public @Nullable Player.BedSleepingProblem getProblem()

Returns the current sleeping problem.

Returns:

the current sleeping problem

setProblem

public void setProblem(@Nullable Player.BedSleepingProblem problem)

Sets a new sleeping problem. If the new problem is null, the player is allowed to sleep here.

getVanillaProblem

public @Nullable Player.BedSleepingProblem getVanillaProblem()

Returns the default sleeping problem based on the vanilla checks.

See Also:

• invalid reference

  to identify the cause of a problem.