Package net.minecraftforge.event.entity.player

Class PlayerInteractEvent

java.lang.Object

net.minecraftforge.eventbus.api.Event

net.minecraftforge.event.entity.EntityEvent

net.minecraftforge.event.entity.living.LivingEvent

net.minecraftforge.event.entity.player.PlayerEvent

net.minecraftforge.event.entity.player.PlayerInteractEvent

Direct Known Subclasses:

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

public class PlayerInteractEvent
extends PlayerEvent

PlayerInteractEvent is fired when a player interacts in some way. All subclasses are fired on MinecraftForge.EVENT_BUS. See the individual documentation on each subevent for more details.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PlayerInteractEvent.EntityInteract	This event is fired on both sides when the player right clicks an entity.
static class	PlayerInteractEvent.EntityInteractSpecific	This event is fired on both sides whenever a player right clicks an entity.
static class	PlayerInteractEvent.LeftClickBlock	This event is fired when a player left clicks while targeting a block.
static class	PlayerInteractEvent.LeftClickEmpty	This event is fired on the client side when the player left clicks empty space with any ItemStack.
static class	PlayerInteractEvent.RightClickBlock	This event is fired on both sides whenever the player right clicks while targeting a block.
static class	PlayerInteractEvent.RightClickEmpty	This event is fired on the client side when the player right clicks empty space with an empty hand.
static class	PlayerInteractEvent.RightClickItem	This event is fired on both sides before the player triggers Item.use(Level, Player, InteractionHand).

Nested classes/interfaces inherited from class net.minecraftforge.event.entity.player.PlayerEvent

PlayerEvent.BreakSpeed, PlayerEvent.Clone, PlayerEvent.HarvestCheck, PlayerEvent.ItemCraftedEvent, PlayerEvent.ItemPickupEvent, 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 net.minecraftforge.event.entity.living.LivingEvent

LivingEvent.LivingJumpEvent, LivingEvent.LivingTickEvent, LivingEvent.LivingVisibilityEvent

Nested classes/interfaces inherited from class net.minecraftforge.event.entity.EntityEvent

EntityEvent.EnteringSection, EntityEvent.EntityConstructing, EntityEvent.EyeHeight, EntityEvent.Size

Nested classes/interfaces inherited from class net.minecraftforge.eventbus.api.Event

net.minecraftforge.eventbus.api.Event.HasResult, net.minecraftforge.eventbus.api.Event.Result

Field Summary

Fields

Modifier and Type	Field	Description
private InteractionResult	cancellationResult
private final @Nullable Direction	face
private final InteractionHand	hand
private final BlockPos	pos

Constructor Summary

Constructors

Modifier	Constructor	Description
private	PlayerInteractEvent(Player player, InteractionHand hand, BlockPos pos, @Nullable Direction face)

Method Summary

Modifier and Type	Method	Description
InteractionResult	getCancellationResult()
@Nullable Direction	getFace()
@NotNull InteractionHand	getHand()
@NotNull ItemStack	getItemStack()
Level	getLevel()
@NotNull BlockPos	getPos()	If the interaction was on an entity, will be a BlockPos centered on the entity.
LogicalSide	getSide()
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 net.minecraftforge.event.entity.player.PlayerEvent

getEntity

Methods inherited from class net.minecraftforge.eventbus.api.Event

getListenerList, getPhase, getResult, hasResult, isCancelable, isCanceled, setCanceled, setPhase, setResult

Methods inherited from class java.lang.Object

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

Field Details

hand

private final InteractionHand hand

pos

private final BlockPos pos

face

@Nullable
private final @Nullable Direction face

cancellationResult

private InteractionResult cancellationResult

Constructor Details

PlayerInteractEvent

private PlayerInteractEvent(Player player,
 InteractionHand hand,
 BlockPos pos,
 @Nullable
 @Nullable Direction face)

Method Details

getHand

@NotNull
public @NotNull InteractionHand getHand()

Returns:

The hand involved in this interaction. Will never be null.

getItemStack

@NotNull
public @NotNull ItemStack getItemStack()

Returns:

The itemstack involved in this interaction, ItemStack.EMPTY if the hand was empty.

getPos

@NotNull
public @NotNull BlockPos getPos()

If the interaction was on an entity, will be a BlockPos centered on the entity. If the interaction was on a block, will be the position of that block. Otherwise, will be a BlockPos centered on the player. Will never be null.

Returns:

The position involved in this interaction.

getFace

@Nullable
public @Nullable Direction getFace()

Returns:

The face involved in this interaction. For all non-block interactions, this will return null.

getLevel

public Level getLevel()

Returns:

Convenience method to get the level of this interaction.

getSide

public LogicalSide getSide()

Returns:

The effective, i.e. logical, side of this interaction. This will be LogicalSide.CLIENT on the client thread, and LogicalSide.SERVER on the server thread.

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. Note that this only has an effect on PlayerInteractEvent.RightClickBlock, PlayerInteractEvent.RightClickItem, PlayerInteractEvent.EntityInteract, and PlayerInteractEvent.EntityInteractSpecific.