net.risingworld.api.events.player

Class PlayerPickupItemEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.PlayerPickupItemEvent

All Implemented Interfaces:

Cancellable

public class PlayerPickupItemEvent
extends PlayerEvent
implements Cancellable

Called when the player picks up a world item.
Note that a PlayerInventoryAddEvent will also be called, unless you cancel this event.

See Also:

PlayerInventoryAddEvent

Constructor Summary

Constructors

Constructor and Description
PlayerPickupItemEvent(Player player, WorldItem item, int targetInventorySlot, Inventory.SlotType targetInventorySlotType)

Method Summary

Modifier and Type	Method and Description
WorldItem	getItem() Gets the item the player wants to pick up.
int	getTargetInventorySlot() Gets the destinated slot in the players inventory where the item will be added.
Inventory.SlotType	getTargetInventorySlotType() Gets the destinated inventory / slot type in the players inventory where the item will be added.
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

PlayerPickupItemEvent

public PlayerPickupItemEvent(Player player,
                             WorldItem item,
                             int targetInventorySlot,
                             Inventory.SlotType targetInventorySlotType)

Method Detail

getItem

public WorldItem getItem()

Gets the item the player wants to pick up.

Returns:

the item.

getTargetInventorySlot

public int getTargetInventorySlot()

Gets the destinated slot in the players inventory where the item will be added.

Returns:

the target slot.

getTargetInventorySlotType

public Inventory.SlotType getTargetInventorySlotType()

Gets the destinated inventory / slot type in the players inventory where the item will be added.

Returns:

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