net.risingworld.api.events.player.inventory

Class PlayerChestToInventoryEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.inventory.PlayerChestToInventoryEvent

All Implemented Interfaces:

Cancellable

public class PlayerChestToInventoryEvent
extends PlayerEvent
implements Cancellable

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
int	getAmount() Gets the amount of items that will be moved to the inventory.
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	getExchangeItem() Gets the item this item eventually gets 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 target inventory slot (where the player moved the item to).
Inventory.SlotType	getInventorySlotType() Gets the target inventory slot type (e.g. quickslot, equipment etc).
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

PlayerChestToInventoryEvent

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

Method Detail

getAmount

public int getAmount()

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

Returns:

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

getItem

public Item getItem()

Gets the item.

Returns:

the item.

getExchangeItem

public Item getExchangeItem()

Gets the item this item eventually gets 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 his inventory).

Returns:

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

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.

getInventorySlot

public int getInventorySlot()

Gets the target inventory slot (where the player moved the item to).

Returns:

the item slot in the target inventory.

getInventorySlotType

public Inventory.SlotType getInventorySlotType()

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

Returns:

the target inventory slot type.

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.