Package dev.chicoferreira.lifestealer.events

Class LifestealerPostConsumeHeartEvent

java.lang.Object

org.bukkit.event.Event

dev.chicoferreira.lifestealer.events.LifestealerPostConsumeHeartEvent

public class LifestealerPostConsumeHeartEvent
extends org.bukkit.event.Event

Called after a player has consumed a heart. This event is called after the hearts have been added to the player and the heart item has been removed. This event is called even if the player's hearts have not changed (e.g. the player is already at maximum hearts). This event is not cancellable.

Thread-safety (WARNING): This event is called with no active locks on the user.

See Also:

• LifestealerPreConsumeHeartEvent
• LifestealerUserController.addHearts(LifestealerUser, LifestealerUserRules, int)

Nested Class Summary

Nested classes/interfaces inherited from class org.bukkit.event.Event

org.bukkit.event.Event.Result

Constructor Summary

Constructors

Constructor	Description
LifestealerPostConsumeHeartEvent(@NotNull org.bukkit.entity.Player player, @NotNull LifestealerUser user, int amount, @NotNull org.bukkit.inventory.ItemStack itemStack, LifestealerUserController.ChangeHeartsResult result)	Constructs a new LifestealerPostConsumeHeartEvent.

Method Summary

Modifier and Type	Method	Description
int	getAmount()	Gets the amount of hearts contained in the item.
LifestealerUserController.ChangeHeartsResult	getChangeResult()	Gets the result of the change of hearts.
int	getDifference()	Gets the difference between the new and previous amount of hearts.
static org.bukkit.event.HandlerList	getHandlerList()	Gets the handler list.
@NotNull org.bukkit.event.HandlerList	getHandlers()	Gets the handler list.
@NotNull org.bukkit.inventory.ItemStack	getItemStack()	Gets the itemStack that was involved in the event.
@NotNull org.bukkit.entity.Player	getPlayer()	Gets the player that consumed the heart.
@NotNull LifestealerUser	getUser()	Gets the user related to the player.
boolean	hasChanged()	Checks if the amount of hearts of the player has changed.

Methods inherited from class org.bukkit.event.Event

callEvent, getEventName, isAsynchronous

Methods inherited from class java.lang.Object

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

Constructor Details

LifestealerPostConsumeHeartEvent

public LifestealerPostConsumeHeartEvent(@NotNull
 @NotNull org.bukkit.entity.Player player,
 @NotNull
 @NotNull LifestealerUser user,
 int amount,
 @NotNull
 @NotNull org.bukkit.inventory.ItemStack itemStack,
 @NotNull
 LifestealerUserController.ChangeHeartsResult result)

Constructs a new LifestealerPostConsumeHeartEvent.

Parameters:

player - the player that consumed the heart

user - the user related to the player

amount - the amount of hearts contained in the item

itemStack - the item that was consumed

result - the result of the change of hearts

Method Details

getPlayer

@NotNull
public @NotNull org.bukkit.entity.Player getPlayer()

Gets the player that consumed the heart.

Returns:

the player that consumed the heart

getUser

@NotNull
public @NotNull LifestealerUser getUser()

Gets the user related to the player.

Returns:

the user related to the player

getAmount

public int getAmount()

Gets the amount of hearts contained in the item. Use getDifference() to get the final amount of hearts added to the player.

Returns:

the amount of hearts contained in the item (guaranteed to be higher than 0)

getItemStack

@NotNull
public @NotNull org.bukkit.inventory.ItemStack getItemStack()

Gets the itemStack that was involved in the event. The itemStack amount has already been decremented by 1 due to the consumption.

Returns:

the item that was consumed

getChangeResult

@NotNull
public LifestealerUserController.ChangeHeartsResult getChangeResult()

Gets the result of the change of hearts.

Returns:

the result of the change of hearts

hasChanged

public boolean hasChanged()

Checks if the amount of hearts of the player has changed. This will return true if the player's hearts have changed, or false if the player's hearts have not changed (e.g. the player is already at maximum hearts). Equivalent to event.getResult().hasChanged().

Returns:

if the amount of hearts of the player has changed

getDifference

public int getDifference()

Gets the difference between the new and previous amount of hearts. Equivalent to event.getChangeResult().difference().

Returns:

the difference between the new and previous amount of hearts (newHearts - previousHearts)

getHandlers

@NotNull
public @NotNull org.bukkit.event.HandlerList getHandlers()

Gets the handler list.

Specified by:

getHandlers in class org.bukkit.event.Event

Returns:

the handler list

getHandlerList

public static org.bukkit.event.HandlerList getHandlerList()

Gets the handler list.

Returns:

the handler list