net.risingworld.api.events.player.inventory

Class PlayerInventoryAddEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.inventory.PlayerInventoryAddEvent

All Implemented Interfaces:

Cancellable

public class PlayerInventoryAddEvent
extends PlayerEvent
implements Cancellable

Called when an item is added to the players inventory.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PlayerInventoryAddEvent.Origin

Constructor Summary

Constructors

Constructor and Description
PlayerInventoryAddEvent(Player player, Item item, int inventorySlot, Inventory.SlotType inventorySlotType, PlayerInventoryAddEvent.Origin origin)

Method Summary

Modifier and Type	Method and Description
int	getInventorySlot() Gets the inventory slot.
Inventory.SlotType	getInventorySlotType() Gets the inventory slot type (e.g. quickslot, equipment etc).
Item	getItem() Gets the item.
PlayerInventoryAddEvent.Origin	getOrigin() Gets the origin of the item, i.e. where the player got this item from (i.e.
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

PlayerInventoryAddEvent

public PlayerInventoryAddEvent(Player player,
                               Item item,
                               int inventorySlot,
                               Inventory.SlotType inventorySlotType,
                               PlayerInventoryAddEvent.Origin origin)

Method Detail

getItem

public Item getItem()

Gets the item.

Returns:

the item.

getInventorySlot

public int getInventorySlot()

Gets the inventory slot.

Returns:

the item slot in the inventory.

getInventorySlotType

public Inventory.SlotType getInventorySlotType()

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

Returns:

the inventory slot type.

getOrigin

public PlayerInventoryAddEvent.Origin getOrigin()

Gets the origin of the item, i.e. where the player got this item from (i.e. if he picked it up, if he got the item by deconstructing an object or harvesting plants etc).

Returns:

the origin.

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.