Package org.bukkit.event.entity
Class EntityExhaustionEvent
java.lang.Object
org.bukkit.event.Event
org.bukkit.event.entity.EntityEvent
org.bukkit.event.entity.EntityExhaustionEvent
- All Implemented Interfaces:
Cancellable
Called when a human entity experiences exhaustion.
An exhaustion level greater than 4.0 causes a decrease in saturation by 1.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
The reason for why a PlayerExhaustionEvent takes placeNested classes/interfaces inherited from class org.bukkit.event.Event
Event.Result
-
Field Summary
Fields inherited from class org.bukkit.event.entity.EntityEvent
entity
-
Constructor Summary
ConstructorDescriptionEntityExhaustionEvent
(@NotNull HumanEntity who, @NotNull EntityExhaustionEvent.ExhaustionReason exhaustionReason, float exhaustion) -
Method Summary
Modifier and TypeMethodDescriptionReturns the Entity involved in this eventfloat
Get the amount of exhaustion to add to the player's current exhaustion.Gets theEntityExhaustionEvent.ExhaustionReason
for this eventstatic @NotNull HandlerList
boolean
Gets the cancellation state of this event.void
setCancelled
(boolean cancel) Sets the cancellation state of this event.void
setExhaustion
(float exhaustion) Set the exhaustion to apply to the player.Methods inherited from class org.bukkit.event.entity.EntityEvent
getEntityType
Methods inherited from class org.bukkit.event.Event
callEvent, getEventName, isAsynchronous
-
Constructor Details
-
EntityExhaustionEvent
public EntityExhaustionEvent(@NotNull @NotNull HumanEntity who, @NotNull @NotNull EntityExhaustionEvent.ExhaustionReason exhaustionReason, float exhaustion)
-
-
Method Details
-
getExhaustionReason
Gets theEntityExhaustionEvent.ExhaustionReason
for this event- Returns:
- the exhaustion reason
-
getExhaustion
public float getExhaustion()Get the amount of exhaustion to add to the player's current exhaustion.- Returns:
- amount of exhaustion
-
setExhaustion
public void setExhaustion(float exhaustion) Set the exhaustion to apply to the player. The maximum exhaustion that a player can have is 40. No error will be thrown if this limit is hit. This value may be negative, but there is unknown behavior for when exhaustion is below 0.- Parameters:
exhaustion
- new exhaustion to add
-
getEntity
Description copied from class:EntityEvent
Returns the Entity involved in this event- Overrides:
getEntity
in classEntityEvent
- Returns:
- Entity who is involved in this event
-
isCancelled
public boolean isCancelled()Description copied from interface:Cancellable
Gets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins- Specified by:
isCancelled
in interfaceCancellable
- Returns:
- true if this event is cancelled
-
setCancelled
public void setCancelled(boolean cancel) Description copied from interface:Cancellable
Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.- Specified by:
setCancelled
in interfaceCancellable
- Parameters:
cancel
- true if you wish to cancel this event
-
getHandlers
- Specified by:
getHandlers
in classEvent
-
getHandlerList
-