Bukkit-API  1.7.9-R0.2
The inofficial Bukkit-API
org.bukkit.event.player.PlayerPickupItemEvent Class Reference
Inheritance diagram for org.bukkit.event.player.PlayerPickupItemEvent:
org.bukkit.event.player.PlayerEvent org.bukkit.event.Cancellable org.bukkit.event.Event

Public Member Functions

 PlayerPickupItemEvent (final Player player, final Item item, final int remaining)
 
Item getItem ()
 
int getRemaining ()
 
boolean isCancelled ()
 
void setCancelled (boolean cancel)
 
HandlerList getHandlers ()
 
- Public Member Functions inherited from org.bukkit.event.player.PlayerEvent
 PlayerEvent (final Player who)
 
final Player getPlayer ()
 
- Public Member Functions inherited from org.bukkit.event.Event
 Event ()
 
 Event (boolean isAsync)
 
String getEventName ()
 
abstract HandlerList getHandlers ()
 
final boolean isAsynchronous ()
 

Static Public Member Functions

static HandlerList getHandlerList ()
 

Additional Inherited Members

- Protected Attributes inherited from org.bukkit.event.player.PlayerEvent
Player player
 

Detailed Description

Thrown when a player picks an item up from the ground

Definition at line 11 of file PlayerPickupItemEvent.java.

Member Function Documentation

Item org.bukkit.event.player.PlayerPickupItemEvent.getItem ( )

Gets the Item picked up by the player.

Returns
Item

Definition at line 28 of file PlayerPickupItemEvent.java.

28  {
29  return item;
30  }
int org.bukkit.event.player.PlayerPickupItemEvent.getRemaining ( )

Gets the amount remaining on the ground, if any

Returns
amount remaining on the ground

Definition at line 37 of file PlayerPickupItemEvent.java.

37  {
38  return remaining;
39  }
boolean org.bukkit.event.player.PlayerPickupItemEvent.isCancelled ( )

Gets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins

Returns
true if this event is cancelled

Implements org.bukkit.event.Cancellable.

Definition at line 41 of file PlayerPickupItemEvent.java.

41  {
42  return cancel;
43  }
void org.bukkit.event.player.PlayerPickupItemEvent.setCancelled ( boolean  cancel)

Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.

Parameters
canceltrue if you wish to cancel this event

Implements org.bukkit.event.Cancellable.

Definition at line 45 of file PlayerPickupItemEvent.java.

45  {
46  this.cancel = cancel;
47  }

The documentation for this class was generated from the following file: