net.risingworld.api.events.player.inventory

Class PlayerInventoryToChestEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.inventory.PlayerInventoryToChestEvent

All Implemented Interfaces:

Cancellable

public class PlayerInventoryToChestEvent
extends PlayerEvent
implements Cancellable

Called when an item is moved from the player inventory to a chest.

Constructor Summary

Constructors

Constructor and Description
PlayerInventoryToChestEvent(Player player, Item originItem, Item exchangeItem, int amount, int inventorySlot, Inventory.SlotType inventorySlotType, int chestID, int chestSlot)

Method Summary

Modifier and Type	Method and Description
int	getAmount() Gets the amount of items that will be moved to the chest.
int	getChestID() Gets the ID of the target chest.
int	getChestSlot() Gets the item slot in the target chest.
Item	getExchangeItem() Gets the item this item will be exchanged with, i.e. when the player exchanges a chest item with an inventory item (the chest item will be moved to the inventory, and the inventory item will be moved to the chest).
int	getInventorySlot() Gets the inventory slot (where the item was moved from).
Inventory.SlotType	getInventorySlotType() Gets the inventory slot type (e.g. quickslot, equipment etc).
Item	getItem() Gets the item the player tries to move to the chest.
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

PlayerInventoryToChestEvent

public PlayerInventoryToChestEvent(Player player,
                                   Item originItem,
                                   Item exchangeItem,
                                   int amount,
                                   int inventorySlot,
                                   Inventory.SlotType inventorySlotType,
                                   int chestID,
                                   int chestSlot)

Method Detail

getAmount

public int getAmount()

Gets the amount of items that will be moved to the chest. This is only relevant if the player splits a stack and only moves a single item to the chest, for example.

Returns:

the amount of items that will be moved to the chest.

getItem

public Item getItem()

Gets the item the player tries to move to the chest.

Returns:

the item.

getExchangeItem

public Item getExchangeItem()

Gets the item this item will be exchanged with, i.e. when the player exchanges a chest item with an inventory item (the chest item will be moved to the inventory, and the inventory item will be moved to the chest). Returns null if there is no exchange item (i.e. when the player moves the item to an empty slot in the chest).

Returns:

the exchange item, or null if this item was moved to an empty slot.

getInventorySlot

public int getInventorySlot()

Gets the inventory slot (where the item was moved from).

Returns:

the item slot in the player inventory.

getInventorySlotType

public Inventory.SlotType getInventorySlotType()

Gets the inventory slot type (e.g. quickslot, equipment etc).

Returns:

the inventory slot type (where the item was moved from).

getChestID

public int getChestID()

Gets the ID of the target chest.

Returns:

the target chest ID.

getChestSlot

public int getChestSlot()

Gets the item slot in the target chest.

Returns:

the target 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.