net.minecraftforge.event.entity.player

Class PlayerWakeUpEvent

java.lang.Object

net.minecraftforge.fml.common.eventhandler.Event

net.minecraftforge.event.entity.EntityEvent

net.minecraftforge.event.entity.living.LivingEvent

net.minecraftforge.event.entity.player.PlayerEvent

net.minecraftforge.event.entity.player.PlayerWakeUpEvent

public class PlayerWakeUpEvent
extends PlayerEvent

This event is fired when the player is waking up.
This is merely for purposes of listening for this to happen.
There is nothing that can be manipulated with this event.

Nested Class Summary

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

PlayerEvent.BreakSpeed, PlayerEvent.Clone, PlayerEvent.HarvestCheck, PlayerEvent.LoadFromFile, PlayerEvent.NameFormat, PlayerEvent.SaveToFile, PlayerEvent.StartTracking, PlayerEvent.StopTracking, PlayerEvent.Visibility

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

LivingEvent.LivingJumpEvent, LivingEvent.LivingUpdateEvent

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

EntityEvent.CanUpdate, EntityEvent.EnteringChunk, EntityEvent.EntityConstructing

Nested classes/interfaces inherited from class net.minecraftforge.fml.common.eventhandler.Event

Event.HasResult, Event.Result

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	setSpawn
private boolean	updateWorld
private boolean	wakeImmediately

Constructor Summary

Constructors

Constructor and Description
PlayerWakeUpEvent(EntityPlayer player, boolean wakeImmediately, boolean updateWorld, boolean setSpawn)

Method Summary

Modifier and Type	Method and Description
boolean	shouldSetSpawn() Indicates if the player's sleep was considered successful.
boolean	updateWorld() Indicates if the server should be notified of sleeping changes.
boolean	wakeImmediately() Used for the 'wake up animation'.

Methods inherited from class net.minecraftforge.event.entity.player.PlayerEvent

getEntityPlayer

Methods inherited from class net.minecraftforge.event.entity.living.LivingEvent

getEntityLiving

Methods inherited from class net.minecraftforge.event.entity.EntityEvent

getEntity

Methods inherited from class net.minecraftforge.fml.common.eventhandler.Event

getListenerList, getPhase, getResult, hasResult, isCancelable, isCanceled, setCanceled, setPhase, setResult, setup

Methods inherited from class java.lang.Object

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

Field Detail

wakeImmediately

private final boolean wakeImmediately

updateWorld

private final boolean updateWorld

setSpawn

private final boolean setSpawn

Constructor Detail

PlayerWakeUpEvent

public PlayerWakeUpEvent(EntityPlayer player,
                         boolean wakeImmediately,
                         boolean updateWorld,
                         boolean setSpawn)

Method Detail

wakeImmediately

public boolean wakeImmediately()

Used for the 'wake up animation'. This is false if the player is considered 'sleepy' and the overlay should slowly fade away.

updateWorld

public boolean updateWorld()

Indicates if the server should be notified of sleeping changes. This will only be false if the server is considered 'up to date' already, because, for example, it initiated the call.

shouldSetSpawn

public boolean shouldSetSpawn()

Indicates if the player's sleep was considered successful. In vanilla, this is used to determine if the spawn chunk is to be set to the bed's position.