net.risingworld.api.events.player

Class PlayerDropItemEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.PlayerDropItemEvent

All Implemented Interfaces:

Cancellable

public class PlayerDropItemEvent
extends PlayerEvent
implements Cancellable

Called when the player drops an item.
Note: If the item is dropped from a chest, a PlayerChestDropEvent will be triggered instead!

See Also:

PlayerChestDropEvent

Example: Spawn a different item

1	@EventMethod
2	public void onItemDrop(PlayerDropItemEvent event){
3	//Cancel the event, instead we want to handle the item drop manually
4	event.setCancelled(true);
5
6	//Remove the item from the inventory manually (optionally)
7	event.getPlayer().getInventory().removeItem(event.getInventorySlot(), event.getInventorySlotType(), event.getAmount());
8
9	//Spawn a different item instead, e.g. a repeater rifle
10	Definitions.ItemDefinition itemDef = Definitions.getItemDefinition("repeater");
11
12	if(itemDef != null){
13	WorldItem item = getWorld().spawnItem(itemDef.getID(), 0, 1, event.getPosition(), event.getRotation(), true);
14
15	//Apply a physical impulse to the item, so it feels like it was thrown away by the player (optional)
16	item.applyPhysicalImpulse(event.getPlayer().getViewDirection().mult(5f));
17	}
18	}

Constructor Summary

Constructors

Constructor and Description
PlayerDropItemEvent(Player player, Item item, int amount, int inventorySlot, Inventory.SlotType inventorySlotType, Vector3f position, Quaternion rotation)

Method Summary

Modifier and Type	Method and Description
int	getAmount() Gets the amount (stack size) the player wants to drop from the inventory.
int	getInventorySlot() Gets the slot in the inventory the item was removed from.
Inventory.SlotType	getInventorySlotType() Gets the inventory / slot type in the players inventory where the item was removed from.
Item	getItem() Gets the item the player wants to drop.
Vector3f	getPosition() Gets the item drop position.
Quaternion	getRotation() Gets the item drop rotation (rotation of 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

PlayerDropItemEvent

public PlayerDropItemEvent(Player player,
                           Item item,
                           int amount,
                           int inventorySlot,
                           Inventory.SlotType inventorySlotType,
                           Vector3f position,
                           Quaternion rotation)

Method Detail

getItem

public Item getItem()

Gets the item the player wants to drop.

Returns:

the item.

getAmount

public int getAmount()

Gets the amount (stack size) the player wants to drop from the inventory.

Returns:

the amount of items (from the stack) that will be dropped.

getInventorySlot

public int getInventorySlot()

Gets the slot in the inventory the item was removed from.

Returns:

the inventory slot.

getInventorySlotType

public Inventory.SlotType getInventorySlotType()

Gets the inventory / slot type in the players inventory where the item was removed from.

Returns:

the inventory slot type.

getPosition

public Vector3f getPosition()

Gets the item drop position.

Returns:

the global item drop position.

getRotation

public Quaternion getRotation()

Gets the item drop rotation (rotation of the item).

Returns:

the item drop rotation.

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.