net.risingworld.api.events.player.inventory

Class PlayerChestDropEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.inventory.PlayerChestDropEvent

All Implemented Interfaces:

Cancellable

public class PlayerChestDropEvent
extends PlayerEvent
implements Cancellable

Called when a player drops an item from a chest.

Constructor Summary

Constructors

Constructor and Description
PlayerChestDropEvent(Player player, Item item, int amount, int chestID, int chestSlot)

Method Summary

Modifier and Type	Method and Description
int	getChestID() Gets the ID of the chest.
int	getChestSlot() Gets the item slot in the chest (where the player got the item from).
Item	getItem() Gets the item.
boolean	isCancelled() Determines if the event is cancelled.
void	setCancelled(boolean cancel) Cancels this event.

Methods inherited from class net.risingworld.api.events.player.PlayerEvent

getPlayer

Methods inherited from class java.lang.Object

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

Constructor Detail

PlayerChestDropEvent

public PlayerChestDropEvent(Player player,
                            Item item,
                            int amount,
                            int chestID,
                            int chestSlot)

Method Detail

getItem

public Item getItem()

Gets the item.

Returns:

the item.

getChestID

public int getChestID()

Gets the ID of the chest.

Returns:

the chest ID.

getChestSlot

public int getChestSlot()

Gets the item slot in the chest (where the player got the item from).

Returns:

the item slot in the chest.

isCancelled

public boolean isCancelled()

Description copied from interface: Cancellable

Determines if the event is cancelled. If an event is cancelled, it will no longer be executed, but other plugins will still receive the event.

Please note: If the event is threaded, cancellation has no effect, i.e. the event will still be executed.

Specified by:

isCancelled in interface Cancellable

Returns:

true if the event is cancelled, or false if not.

setCancelled

public void setCancelled(boolean cancel)

Description copied from interface: Cancellable

Cancels this event. This means it will no longer be executed, but other plugins will still receive the event.

Please note: If the event is threaded, cancellation has no effect, i.e. the event will still be executed.

Specified by:

setCancelled in interface Cancellable

Parameters:

cancel - set to true if you want to cancel this event.