net.minecraftforge.event.entity.player

Class PlayerInteractEvent

java.lang.Object

net.minecraftforge.fml.common.eventhandler.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 and 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.onItemRightClick(net.minecraft.world.World, net.minecraft.entity.player.EntityPlayer, net.minecraft.util.EnumHand).

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

PlayerEvent.BreakSpeed, PlayerEvent.Clone, PlayerEvent.HarvestCheck, PlayerEvent.LoadFromFile, PlayerEvent.NameFormat, PlayerEvent.SaveToFile, PlayerEvent.StartTracking, PlayerEvent.StopTracking, PlayerEvent.Visibility

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

LivingEvent.LivingJumpEvent, LivingEvent.LivingUpdateEvent

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

EntityEvent.CanUpdate, EntityEvent.EnteringChunk, EntityEvent.EntityConstructing

Nested classes/interfaces inherited from class net.minecraftforge.fml.common.eventhandler.Event

Event.HasResult, Event.Result

Field Summary

Fields

Modifier and Type	Field and Description
private EnumActionResult	cancellationResult
private EnumFacing	face
private EnumHand	hand
private BlockPos	pos

Constructor Summary

Constructors

Modifier	Constructor and Description
private	PlayerInteractEvent(EntityPlayer player, EnumHand hand, BlockPos pos, EnumFacing face)

Method Summary

Modifier and Type	Method and Description
EnumActionResult	getCancellationResult()
EnumFacing	getFace()
EnumHand	getHand()
ItemStack	getItemStack()
BlockPos	getPos() If the interaction was on an entity, will be a BlockPos centered on the entity.
Side	getSide()
World	getWorld()
void	setCancellationResult(EnumActionResult result) Set the EnumActionResult 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

getEntityPlayer

Methods inherited from class net.minecraftforge.event.entity.living.LivingEvent

getEntityLiving

Methods inherited from class net.minecraftforge.event.entity.EntityEvent

getEntity

Methods inherited from class net.minecraftforge.fml.common.eventhandler.Event

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

Methods inherited from class java.lang.Object

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

Field Detail

hand

private final EnumHand hand

pos

private final BlockPos pos

face

@Nullable
private final EnumFacing face

cancellationResult

private EnumActionResult cancellationResult

Constructor Detail

PlayerInteractEvent

private PlayerInteractEvent(EntityPlayer player,
                            EnumHand hand,
                            BlockPos pos,
                            @Nullable
                            EnumFacing face)

Method Detail

getHand

@Nonnull
public EnumHand getHand()

Returns:

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

getItemStack

@Nonnull
public ItemStack getItemStack()

Returns:

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

getPos

@Nonnull
public 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 EnumFacing getFace()

Returns:

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

getWorld

public World getWorld()

Returns:

Convenience method to get the world of this interaction.

getSide

public Side getSide()

Returns:

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

getCancellationResult

public EnumActionResult getCancellationResult()

Returns:

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

setCancellationResult

public void setCancellationResult(EnumActionResult result)

Set the EnumActionResult 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.