org.bukkit.event.player

Class PlayerPickupItemEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.player.PlayerEvent

org.bukkit.event.player.PlayerPickupItemEvent

All Implemented Interfaces:

Cancellable

Direct Known Subclasses:

PlayerPickupArrowEvent

public class PlayerPickupItemEvent
extends PlayerEvent
implements Cancellable

Thrown when a player picks 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 and Description
PlayerPickupItemEvent(Player player, Item item, int remaining)

Method Summary

Methods

Modifier and Type	Method and Description
static HandlerList	getHandlerList()
HandlerList	getHandlers()
Item	getItem() Gets the Item picked up by the player.
int	getRemaining() Gets the amount remaining 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.

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

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

Constructor Detail

PlayerPickupItemEvent

public PlayerPickupItemEvent(Player player,
                     Item item,
                     int remaining)

Method Detail

getItem

public Item getItem()

Gets the Item picked up by the player.

Returns:

Item

getRemaining

public int getRemaining()

Gets the amount remaining on the ground, if any

Returns:

amount remaining on the ground

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