net.minecraftforge.event.entity.player

Class PlayerInteractEvent.LeftClickBlock

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

net.minecraftforge.event.entity.player.PlayerInteractEvent.LeftClickBlock

Enclosing class:

PlayerInteractEvent

public static class PlayerInteractEvent.LeftClickBlock
extends PlayerInteractEvent

This event is fired when a player left clicks while targeting a block. This event controls which of Block.onBlockClicked(net.minecraft.world.World, net.minecraft.util.math.BlockPos, net.minecraft.entity.player.EntityPlayer) and/or the item harvesting methods will be called Canceling the event will cause none of the above noted methods to be called. There are various results to this event, see the getters below. Note that if the event is canceled and the player holds down left mouse, the event will continue to fire. This is due to how vanilla calls the left click handler methods. Also note that creative mode directly breaks the block without running any other logic. Therefore, in creative mode, setUseBlock(net.minecraftforge.fml.common.eventhandler.Event.Result) and setUseItem(net.minecraftforge.fml.common.eventhandler.Event.Result) have no effect.

Nested Class Summary

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

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

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

Constructor Summary

Constructors

Constructor and Description
LeftClickBlock(EntityPlayer player, BlockPos pos, EnumFacing face, Vec3d hitVec)

Method Summary

Modifier and Type	Method and Description
Vec3d	getHitVec()
Event.Result	getUseBlock()
Event.Result	getUseItem()
void	setCanceled(boolean canceled) Sets the cancel state of this event.
void	setUseBlock(Event.Result triggerBlock)
void	setUseItem(Event.Result triggerItem)

Methods inherited from class net.minecraftforge.event.entity.player.PlayerInteractEvent

getCancellationResult, getFace, getHand, getItemStack, getPos, getSide, getWorld, setCancellationResult

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, setPhase, setResult, setup

Methods inherited from class java.lang.Object

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

Constructor Detail

LeftClickBlock

public LeftClickBlock(EntityPlayer player,
                      BlockPos pos,
                      EnumFacing face,
                      Vec3d hitVec)

Method Detail

getHitVec

public Vec3d getHitVec()

Returns:

The local hit vector of this click

getUseBlock

public Event.Result getUseBlock()

Returns:

If Block.onBlockClicked(net.minecraft.world.World, net.minecraft.util.math.BlockPos, net.minecraft.entity.player.EntityPlayer) should be called. Changing this has no effect in creative mode

getUseItem

public Event.Result getUseItem()

Returns:

If the block should be attempted to be mined with the current item. Changing this has no effect in creative mode

setUseBlock

public void setUseBlock(Event.Result triggerBlock)

setUseItem

public void setUseItem(Event.Result triggerItem)

setCanceled

public void setCanceled(boolean canceled)

Description copied from class: Event

Sets the cancel state of this event. Note, not all events are cancelable, and any attempt to invoke this method on an event that is not cancelable (as determined by Event.isCancelable() will result in an UnsupportedOperationException. The functionality of setting the canceled state is defined on a per-event bases.

Overrides:

setCanceled in class Event

Parameters:

canceled - The new canceled value