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

public class PlayerInteractEvent
extends PlayerEvent

PlayerInteractEvent is fired when a player interacts in some way.
This event is fired whenever a player interacts in Minecraft#rightClickMouse(), NetHandlerPlayServer#processPlayerBlockPlacement(C08PacketPlayerBlockPlacement), ItemInWorldManager#activateBlockOrUseItem(EntityPlayer, World, ItemStack, int, int, int, int, float, float, float), ItemInWorldManager#onBlockClicked(int, int, int, int).

This event is fired via the ForgeEventFactory#onPlayerInteract(EntityPlayer, Action, BlockPos, EnumFacing).
action contains the Action the player performed durin this interaction.
pos contains the coordinate of where this event occurred.
face contains the face of the block that was interacted with. May be null if unknown.
world contains the world in which this event is occurring.

This event is Cancelable.
If this event is canceled, the player does not interact.

This event does not have a result. HasResult

This event is fired on the MinecraftForge#EVENT_BUS.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PlayerInteractEvent.Action

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

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
PlayerInteractEvent.Action	action
EnumFacing	face
Vec3	localPos
BlockPos	pos
Event.Result	useBlock
Event.Result	useItem
World	world

Fields inherited from class net.minecraftforge.event.entity.player.PlayerEvent

entityPlayer

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

entityLiving

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

entity

Constructor Summary

Constructors

Constructor and Description
PlayerInteractEvent(EntityPlayer player, PlayerInteractEvent.Action action, BlockPos pos, EnumFacing face, World world) Deprecated.
PlayerInteractEvent(EntityPlayer player, PlayerInteractEvent.Action action, BlockPos pos, EnumFacing face, World world, Vec3 localPos)

Method Summary

Modifier and Type	Method and Description
void	setCanceled(boolean cancel) Sets the state of this event, not all events are cancelable, and any attempt to cancel a event that can't be will result in a IllegalArgumentException.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

action

public final PlayerInteractEvent.Action action

world

public final World world

pos

public final BlockPos pos

face

public final EnumFacing face

localPos

public final Vec3 localPos

useBlock

public Event.Result useBlock

useItem

public Event.Result useItem

Constructor Detail

PlayerInteractEvent

@Deprecated
public PlayerInteractEvent(EntityPlayer player,
                                        PlayerInteractEvent.Action action,
                                        BlockPos pos,
                                        EnumFacing face,
                                        World world)

Deprecated.

PlayerInteractEvent

public PlayerInteractEvent(EntityPlayer player,
                           PlayerInteractEvent.Action action,
                           BlockPos pos,
                           EnumFacing face,
                           World world,
                           Vec3 localPos)

Method Detail

setCanceled

public void setCanceled(boolean cancel)

Description copied from class: Event

Sets the state of this event, not all events are cancelable, and any attempt to cancel a event that can't be will result in a IllegalArgumentException. The functionality of setting the canceled state is defined on a per-event bases.

Overrides:

setCanceled in class Event

Parameters:

cancel - The new canceled value