Class PlayerInteractEvent.EntityInteract

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.event.entity.EntityEvent

net.neoforged.neoforge.event.entity.living.LivingEvent

net.neoforged.neoforge.event.entity.player.PlayerEvent

net.neoforged.neoforge.event.entity.player.PlayerInteractEvent

net.neoforged.neoforge.event.entity.player.PlayerInteractEvent.EntityInteract

All Implemented Interfaces:

net.neoforged.bus.api.ICancellableEvent

Enclosing class:

PlayerInteractEvent

public static class PlayerInteractEvent.EntityInteract
extends PlayerInteractEvent
implements net.neoforged.bus.api.ICancellableEvent

This event is fired on both sides when a non-spectator player right-clicks an entity. It is responsible for all entity interactions.

This event's state affects whether Entity.interact(Player, InteractionHand, Vec3) and Item.interactLivingEntity(ItemStack, Player, LivingEntity, InteractionHand) are called.

Let result be InteractionResult.SUCCESS if Entity.interact(Player, InteractionHand, Vec3) or Item.interactLivingEntity(ItemStack, Player, LivingEntity, InteractionHand) return true, or cancellationResult if the event is cancelled. If we are on the client and result is not InteractionResult.SUCCESS, the client will then try PlayerInteractEvent.RightClickItem.

Nested Class Summary

Nested classes/interfaces inherited from class PlayerInteractEvent

PlayerInteractEvent.EntityInteract, PlayerInteractEvent.LeftClickBlock, PlayerInteractEvent.LeftClickEmpty, PlayerInteractEvent.RightClickBlock, PlayerInteractEvent.RightClickEmpty, PlayerInteractEvent.RightClickItem

Nested classes/interfaces inherited from class PlayerEvent

PlayerEvent.BreakSpeed, PlayerEvent.Clone, PlayerEvent.HarvestCheck, PlayerEvent.ItemCraftedEvent, PlayerEvent.ItemSmeltedEvent, PlayerEvent.LoadFromFile, PlayerEvent.NameFormat, PlayerEvent.PlayerChangedDimensionEvent, PlayerEvent.PlayerChangeGameModeEvent, PlayerEvent.PlayerLoggedInEvent, PlayerEvent.PlayerLoggedOutEvent, PlayerEvent.PlayerRespawnEvent, PlayerEvent.SaveToFile, PlayerEvent.StartTracking, PlayerEvent.StopTracking, PlayerEvent.TabListNameFormat

Nested classes/interfaces inherited from class LivingEvent

LivingEvent.LivingJumpEvent, LivingEvent.LivingVisibilityEvent

Nested classes/interfaces inherited from class EntityEvent

EntityEvent.EnteringSection, EntityEvent.EntityConstructing, EntityEvent.Size

Field Summary

Fields

Modifier and Type	Field	Description
private InteractionResult	cancellationResult
private final Vec3	location
private final Entity	target

Constructor Summary

Constructors

Constructor	Description
EntityInteract(Player player, InteractionHand hand, Entity target, Vec3 location)

Method Summary

Modifier and Type	Method	Description
InteractionResult	getCancellationResult()
Vec3	getLocation()	Returns the local interaction position.
Entity	getTarget()
void	setCancellationResult(InteractionResult result)	Set the InteractionResult that will be returned to vanilla if the event is cancelled, instead of calling the relevant method of the event.

Methods inherited from class PlayerInteractEvent

getFace, getHand, getItemStack, getLevel, getPos, getSide

Methods inherited from class PlayerEvent

getEntity

Methods inherited from class Object

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

Methods inherited from interface net.neoforged.bus.api.ICancellableEvent

isCanceled, setCanceled

Field Details

cancellationResult

private InteractionResult cancellationResult

target

private final Entity target

location

private final Vec3 location

Constructor Details

EntityInteract

public EntityInteract(Player player,
 InteractionHand hand,
 Entity target,
 Vec3 location)

Method Details

getTarget

public Entity getTarget()

getLocation

public Vec3 getLocation()

Returns the local interaction position. This is a 3D vector, where (0, 0, 0) is centered exactly at the center of the entity's bounding box at their feet. This means the X and Z values will be in the range [-width / 2, width / 2] while Y values will be in the range [0, height].

Returns:

the local interaction position

getCancellationResult

public InteractionResult getCancellationResult()

Returns:

The InteractionResult that will be returned to vanilla if the event is cancelled, instead of calling the relevant method of the event. By default, this is InteractionResult.PASS, meaning cancelled events will cause the client to keep trying more interactions until something works.

setCancellationResult

public void setCancellationResult(InteractionResult result)

Set the InteractionResult that will be returned to vanilla if the event is cancelled, instead of calling the relevant method of the event.