Package net.minestom.server.event.item

Class PlayerBeginItemUseEvent

java.lang.Object

net.minestom.server.event.item.PlayerBeginItemUseEvent

All Implemented Interfaces:

Event, CancellableEvent, EntityEvent, EntityInstanceEvent, InstanceEvent, ItemEvent, PlayerEvent, PlayerInstanceEvent

public class PlayerBeginItemUseEvent
extends Object
implements PlayerInstanceEvent, ItemEvent, CancellableEvent

Called when a player begins using an item with the item, animation, and duration.

Setting the use duration to zero or cancelling the event will prevent consumption.

Constructor Summary

Constructors

Constructor	Description
PlayerBeginItemUseEvent(@NotNull Player player, @NotNull PlayerHand hand, @NotNull ItemStack itemStack, @NotNull ItemAnimation animation, long itemUseDuration)

Method Summary

Modifier and Type	Method	Description
@NotNull ItemAnimation	getAnimation()
@NotNull PlayerHand	getHand()
@NotNull ItemStack	getItemStack()
long	getItemUseDuration()	Returns the item use duration, in ticks.
@NotNull Player	getPlayer()	Gets the player.
boolean	isCancelled()	Gets if the Event should be cancelled or not.
void	setCancelled(boolean cancelled)	Marks the Event as cancelled or not.
void	setItemUseDuration(long itemUseDuration)	Sets the item use duration, in ticks.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.minestom.server.event.trait.EntityInstanceEvent

getInstance

Methods inherited from interface net.minestom.server.event.trait.PlayerEvent

getEntity

Constructor Details

PlayerBeginItemUseEvent

public PlayerBeginItemUseEvent(@NotNull
 @NotNull Player player,
 @NotNull
 @NotNull PlayerHand hand,
 @NotNull
 @NotNull ItemStack itemStack,
 @NotNull
 @NotNull ItemAnimation animation,
 long itemUseDuration)

Method Details

getPlayer

@NotNull
public @NotNull Player getPlayer()

Description copied from interface: PlayerEvent

Gets the player.

Specified by:

getPlayer in interface PlayerEvent

Returns:

the player

getHand

@NotNull
public @NotNull PlayerHand getHand()

getItemStack

@NotNull
public @NotNull ItemStack getItemStack()

Specified by:

getItemStack in interface ItemEvent

getAnimation

@NotNull
public @NotNull ItemAnimation getAnimation()

getItemUseDuration

public long getItemUseDuration()

Returns the item use duration, in ticks. A duration of zero will prevent consumption (same effect as cancellation).

Returns:

the current item use duration

setItemUseDuration

public void setItemUseDuration(long itemUseDuration)

Sets the item use duration, in ticks.

isCancelled

public boolean isCancelled()

Description copied from interface: CancellableEvent

Gets if the Event should be cancelled or not.

Specified by:

isCancelled in interface CancellableEvent

Returns:

true if the event should be cancelled

setCancelled

public void setCancelled(boolean cancelled)

Description copied from interface: CancellableEvent

Marks the Event as cancelled or not.

Specified by:

setCancelled in interface CancellableEvent

Parameters:

cancelled - true if the event should be cancelled, false otherwise