Package org.bukkit.event.player

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

Nested Class Summary

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

Constructors

Constructor	Description
PlayerAttemptPickupItemEvent(Player player, Item item)	Deprecated, for removal: This API element is subject to removal in a future version.
PlayerAttemptPickupItemEvent(Player player, Item item, int remaining)

Method Summary

Modifier and Type	Method	Description
boolean	getFlyAtPlayer()	Gets if the item will fly at the player
static HandlerList	getHandlerList()
HandlerList	getHandlers()
Item	getItem()	Gets the Item attempted by the player.
int	getRemaining()	Gets the amount that will remain on the ground, if any
boolean	isCancelled()	Gets the cancellation state of this event.
void	setCancelled(boolean cancel)	Sets the cancellation state of this event.
void	setFlyAtPlayer(boolean flyAtPlayer)	Set if the item will fly at the player

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

getPlayer

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

PlayerAttemptPickupItemEvent

@Internal
@Deprecated(forRemoval=true)
public PlayerAttemptPickupItemEvent(Player player,
 Item item)

Deprecated, for removal: This API element is subject to removal in a future version.

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()