Class PlayerUseItemEvent

java.lang.Object

fr.fidorial.event.player.PlayerUseItemEvent

All Implemented Interfaces:

Cancellable, Event, PlayerEvent

public final class PlayerUseItemEvent
extends Object
implements PlayerEvent, Cancellable

Fired when a player uses what they hold without aiming at a block.

Since:

0.1.0

Constructor Summary

Constructors

Constructor	Description
PlayerUseItemEvent(Player player, EquipmentSlotGroup hand, ItemStack item)	Creates an event.

Method Summary

Modifier and Type	Method	Description
EquipmentSlotGroup	hand()	Returns the hand used, EquipmentSlotGroup.MAIN_HAND or EquipmentSlotGroup.OFF_HAND.
boolean	isCancelled()	Returns true if the action this event describes will not happen.
ItemStack	item()	Returns what the hand holds, ItemStack.EMPTY when nothing.
Player	player()	Returns the player involved in this event.
void	setCancelled(boolean cancelled)	Prevents or re-allows the action this event describes.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PlayerUseItemEvent

public PlayerUseItemEvent(Player player,
 EquipmentSlotGroup hand,
 ItemStack item)

Creates an event.

Parameters:

player - the player

hand - the hand used, EquipmentSlotGroup.MAIN_HAND or EquipmentSlotGroup.OFF_HAND

item - what that hand holds, ItemStack.EMPTY when nothing

Since:

0.1.0

Method Details

player

public Player player()

Description copied from interface: PlayerEvent

Returns the player involved in this event.

Specified by:

player in interface PlayerEvent

Returns:

the player involved in this event

hand

public EquipmentSlotGroup hand()

Returns the hand used, EquipmentSlotGroup.MAIN_HAND or EquipmentSlotGroup.OFF_HAND.

Returns:

the hand used, EquipmentSlotGroup.MAIN_HAND or EquipmentSlotGroup.OFF_HAND

Since:

0.1.0

item

public ItemStack item()

Returns what the hand holds, ItemStack.EMPTY when nothing.

Returns:

what the hand holds, ItemStack.EMPTY when nothing

Since:

0.1.0

isCancelled

public boolean isCancelled()

Description copied from interface: Cancellable

Returns true if the action this event describes will not happen.

Specified by:

isCancelled in interface Cancellable

Returns:

true if the action this event describes will not happen

setCancelled

public void setCancelled(boolean cancelled)

Description copied from interface: Cancellable

Prevents or re-allows the action this event describes.

Specified by:

setCancelled in interface Cancellable

Parameters:

cancelled - true to prevent it