Package org.bukkit.event.player
Class PlayerBedEnterEvent
java.lang.Object
org.bukkit.event.Event
org.bukkit.event.player.PlayerEvent
org.bukkit.event.player.PlayerBedEnterEvent
- All Implemented Interfaces:
Cancellable
This event is fired when the player is almost about to enter the bed.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
Represents the default possible outcomes of this event.Nested classes/interfaces inherited from class org.bukkit.event.Event
Event.Result
-
Field Summary
Fields inherited from class org.bukkit.event.player.PlayerEvent
player
-
Constructor Summary
ConstructorDescriptionPlayerBedEnterEvent
(@NotNull Player who, @NotNull Block bed) Deprecated.PlayerBedEnterEvent
(@NotNull Player who, @NotNull Block bed, @NotNull PlayerBedEnterEvent.BedEnterResult bedEnterResult) -
Method Summary
Modifier and TypeMethodDescriptiongetBed()
Returns the bed block involved in this event.This describes the default outcome of this event.static @NotNull HandlerList
boolean
Gets the cancellation state of this event.void
setCancelled
(boolean cancel) Sets the cancellation state of this event.void
setUseBed
(@NotNull Event.Result useBed) Sets the action to take with the interacted bed.useBed()
This controls the action to take with the bed that was clicked on.Methods inherited from class org.bukkit.event.player.PlayerEvent
getPlayer
Methods inherited from class org.bukkit.event.Event
callEvent, getEventName, isAsynchronous
-
Constructor Details
-
PlayerBedEnterEvent
-
PlayerBedEnterEvent
Deprecated.
-
-
Method Details
-
getBedEnterResult
This describes the default outcome of this event.- Returns:
- the bed enter result representing the default outcome of this event
-
useBed
This controls the action to take with the bed that was clicked on.In case of
Event.Result.DEFAULT
, the default outcome is described bygetBedEnterResult()
.- Returns:
- the action to take with the interacted bed
- See Also:
-
setUseBed
Sets the action to take with the interacted bed.Event.Result.ALLOW
will result in the player sleeping, regardless of the default outcome described bygetBedEnterResult()
.
Event.Result.DENY
will prevent the player from sleeping. This has the same effect as canceling the event viasetCancelled(boolean)
.
Event.Result.DEFAULT
will result in the outcome described bygetBedEnterResult()
.- Parameters:
useBed
- the action to take with the interacted bed- See Also:
-
isCancelled
public boolean isCancelled()Gets the cancellation state of this event. Set to true if you want to prevent the player from sleeping.Canceling the event has the same effect as setting
useBed()
toEvent.Result.DENY
.For backwards compatibility reasons this also returns true if
useBed()
isEvent.Result.DEFAULT
and thedefault action
is to prevent bed entering.- Specified by:
isCancelled
in interfaceCancellable
- Returns:
- boolean cancellation state
-
setCancelled
public void setCancelled(boolean cancel) Sets the cancellation state of this event. A canceled event will not be executed in the server, but will still pass to other plugins.Canceling this event will prevent use of the bed.
- Specified by:
setCancelled
in interfaceCancellable
- Parameters:
cancel
- true if you wish to cancel this event
-
getBed
Returns the bed block involved in this event.- Returns:
- the bed block involved in this event
-
getHandlers
- Specified by:
getHandlers
in classEvent
-
getHandlerList
-