Class PlayerPreEatEvent

java.lang.Object

net.minestom.server.event.player.PlayerPreEatEvent

All Implemented Interfaces:

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

public class PlayerPreEatEvent
extends Object
implements ItemEvent, PlayerInstanceEvent, CancellableEvent

Called before the PlayerEatEvent and can be used to change the eating time or to cancel its processing, cancelling the event means that the player will continue the animation indefinitely.

Constructor Summary

Constructors

Constructor	Description
PlayerPreEatEvent(Player player, ItemStack foodItem, PlayerHand hand, long eatingTime)

Method Summary

Modifier and Type	Method	Description
long	getEatingTime()	Gets the food eating time in ticks.
ItemStack	getFoodItem()	Deprecated. use getItemStack() for the eaten item
PlayerHand	getHand()
ItemStack	getItemStack()	The food item which will be eaten.
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.
void	setEatingTime(long eatingTime)	Changes the food eating time.

Methods inherited from class Object

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

Methods inherited from interface EntityInstanceEvent

getInstance

Methods inherited from interface PlayerEvent

getEntity

Constructor Details

PlayerPreEatEvent

public PlayerPreEatEvent(Player player,
 ItemStack foodItem,
 PlayerHand hand,
 long eatingTime)

Method Details

getFoodItem

@Deprecated
public ItemStack getFoodItem()

Deprecated.

use getItemStack() for the eaten item

The food item which will be eaten.

Returns:

the food item

getHand

public PlayerHand getHand()

getEatingTime

public long getEatingTime()

Gets the food eating time in ticks.

Returns:

the eating time

setEatingTime

public void setEatingTime(long eatingTime)

Changes the food eating time.

Parameters:

eatingTime - the new eating time 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 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

getPlayer

public Player getPlayer()

Description copied from interface: PlayerEvent

Gets the player.

Specified by:

getPlayer in interface PlayerEvent

Returns:

the player

getItemStack

public ItemStack getItemStack()

The food item which will be eaten.

Specified by:

getItemStack in interface ItemEvent

Returns:

the food item