Class PlayerAttemptPickupItemEvent

java.lang.Object
org.bukkit.event.Event
org.bukkit.event.player.PlayerEvent
org.bukkit.event.player.PlayerAttemptPickupItemEvent
All Implemented Interfaces:
Cancellable

@NullMarked public class PlayerAttemptPickupItemEvent extends PlayerEvent implements Cancellable
Thrown when a player attempts to pick an item up from the ground
  • Constructor Details

    • PlayerAttemptPickupItemEvent

      @Deprecated @Internal public PlayerAttemptPickupItemEvent(Player player, Item item)
      Deprecated.
    • PlayerAttemptPickupItemEvent

      @Internal public PlayerAttemptPickupItemEvent(Player player, Item item, int remaining)
  • Method Details

    • getItem

      public Item getItem()
      Gets the Item attempted by the player.
      Returns:
      Item
    • getRemaining

      public int getRemaining()
      Gets the amount that will remain on the ground, if any
      Returns:
      amount that will remain on the ground
    • setFlyAtPlayer

      public void setFlyAtPlayer(boolean flyAtPlayer)
      Set if the item will fly at the player

      Cancelling the event will set this value to false.

      Parameters:
      flyAtPlayer - true for item to fly at player
    • getFlyAtPlayer

      public boolean getFlyAtPlayer()
      Gets if the item will fly at the player
      Returns:
      true if the item will fly at the player
    • 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 interface Cancellable
      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 interface Cancellable
      Parameters:
      cancel - true if you wish to cancel this event
    • getHandlers

      public HandlerList getHandlers()
      Specified by:
      getHandlers in class Event
    • getHandlerList

      public static HandlerList getHandlerList()