Package net.minestom.server.event.player

Class PlayerItemAnimationEvent

java.lang.Object

net.minestom.server.event.player.PlayerItemAnimationEvent

All Implemented Interfaces:

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

public class PlayerItemAnimationEvent
extends Object
implements PlayerInstanceEvent, CancellableEvent

Used when a Player starts the animation of an item.

See Also:

• PlayerItemAnimationEvent.ItemAnimationType

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PlayerItemAnimationEvent.ItemAnimationType

Constructor Summary

Constructors

Constructor	Description
PlayerItemAnimationEvent(@NotNull Player player, @NotNull PlayerItemAnimationEvent.ItemAnimationType itemAnimationType, @NotNull PlayerHand hand)

Method Summary

Modifier and Type	Method	Description
@NotNull PlayerHand	getHand()	Gets the hand that was used.
@NotNull PlayerItemAnimationEvent.ItemAnimationType	getItemAnimationType()	Gets the animation.
@NotNull Player	getPlayer()	Gets the player.
boolean	isCancelled()	Gets if the Event should be cancelled or not.
void	setCancelled(boolean cancel)	Marks the Event as cancelled or not.

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

PlayerItemAnimationEvent

public PlayerItemAnimationEvent(@NotNull
 @NotNull Player player,
 @NotNull
 @NotNull PlayerItemAnimationEvent.ItemAnimationType itemAnimationType,
 @NotNull
 @NotNull PlayerHand hand)

Method Details

getItemAnimationType

@NotNull
public @NotNull PlayerItemAnimationEvent.ItemAnimationType getItemAnimationType()

Gets the animation.

Returns:

the animation

getHand

@NotNull
public @NotNull PlayerHand getHand()

Gets the hand that was used.

Returns:

the hand

getPlayer

@NotNull
public @NotNull Player getPlayer()

Description copied from interface: PlayerEvent

Gets the player.

Specified by:

getPlayer in interface PlayerEvent

Returns:

the player

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 cancel)

Description copied from interface: CancellableEvent

Marks the Event as cancelled or not.

Specified by:

setCancelled in interface CancellableEvent

Parameters:

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