Package wtf.choco.alchema.api.event.player

Class PlayerEssenceCollectEvent

java.lang.Object
org.bukkit.event.Event
org.bukkit.event.player.PlayerEvent
wtf.choco.alchema.api.event.player.PlayerEssenceCollectEvent
All Implemented Interfaces:
org.bukkit.event.Cancellable
public class PlayerEssenceCollectEvent
extends org.bukkit.event.player.PlayerEvent
implements org.bukkit.event.Cancellable
Called when a Player collects essence from an Entity with a vial of essence or an empty vial.
Author:
Parker Hawke - Choco

  • Nested Class Summary

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

    org.bukkit.event.Event.Result

  • Constructor Summary

    Constructors
    Constructor Description
    PlayerEssenceCollectEvent​(@NotNull org.bukkit.entity.Player player, @NotNull org.bukkit.inventory.EquipmentSlot hand, @NotNull org.bukkit.inventory.ItemStack item, @NotNull org.bukkit.entity.Entity entity, @NotNull EntityEssenceData essenceData, int essenceAmount)
    Construct a new PlayerEssenceCollectEvent.

  • Method Summary

    Modifier and Type Method Description
    @NotNull org.bukkit.entity.Entity getEntity()
    Get the Entity from which the essence is being collected.
    int getEssenceAmount()
    Get the amount of essence to be collected.
    @NotNull EntityEssenceData getEssenceData()
    Get the entity essence data that was consumed.
    @NotNull org.bukkit.inventory.EquipmentSlot getHand()
    Get the hand used in this event.
    static @NotNull org.bukkit.event.HandlerList getHandlerList()
    Get the HandlerList instance for this event.
    @NotNull org.bukkit.event.HandlerList getHandlers()  
    @NotNull org.bukkit.inventory.ItemStack getItem()
    Get the vial of entity essence ItemStack that was consumed to cause this event.
    boolean isCancelled()  
    void setCancelled​(boolean cancel)  
    void setEssenceAmount​(int essenceAmount)
    Set the amount of essence to be collected.

    Methods inherited from class org.bukkit.event.player.PlayerEvent

    getPlayer

    Methods inherited from class org.bukkit.event.Event

    getEventName, isAsynchronous

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • PlayerEssenceCollectEvent

      public PlayerEssenceCollectEvent​(@NotNull @NotNull org.bukkit.entity.Player player, @NotNull @NotNull org.bukkit.inventory.EquipmentSlot hand, @NotNull @NotNull org.bukkit.inventory.ItemStack item, @NotNull @NotNull org.bukkit.entity.Entity entity, @NotNull @NotNull EntityEssenceData essenceData, int essenceAmount)
      Construct a new PlayerEssenceCollectEvent.
      Parameters:
      player - the player collecting the essence
      hand - the hand used to collect the essence
      item - the item used to collect the essence
      entity - the entity from which the essence was collected
      essenceData - the essence data being collected
      essenceAmount - the amount of essence being collected

  • Method Details

    • getHand

      @NotNull public @NotNull org.bukkit.inventory.EquipmentSlot getHand()
      Get the hand used in this event.
      Returns:
      the hand

    • getItem

      @NotNull public @NotNull org.bukkit.inventory.ItemStack getItem()
      Get the vial of entity essence ItemStack that was consumed to cause this event.
      Returns:
      the item

    • getEntity

      @NotNull public @NotNull org.bukkit.entity.Entity getEntity()
      Get the Entity from which the essence is being collected.
      Returns:
      the entity

    • getEssenceData

      @NotNull public @NotNull EntityEssenceData getEssenceData()
      Get the entity essence data that was consumed.
      Returns:
      the essence data

    • setEssenceAmount

      public void setEssenceAmount​(int essenceAmount)
      Set the amount of essence to be collected.
      Parameters:
      essenceAmount - the amount of essence to collect

    • getEssenceAmount

      public int getEssenceAmount()
      Get the amount of essence to be collected.
      Returns:
      the amount of essence

    • setCancelled

      public void setCancelled​(boolean cancel)
      Specified by:
      setCancelled in interface org.bukkit.event.Cancellable

    • isCancelled

      public boolean isCancelled()
      Specified by:
      isCancelled in interface org.bukkit.event.Cancellable

    • getHandlers

      @NotNull public @NotNull org.bukkit.event.HandlerList getHandlers()
      Specified by:
      getHandlers in class org.bukkit.event.Event

    • getHandlerList

      @NotNull public static @NotNull org.bukkit.event.HandlerList getHandlerList()
      Get the HandlerList instance for this event.
      Returns:
      the handler list