net.minecraftforge.event.entity.player

Class PlayerInteractEvent.RightClickBlock

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.RightClickBlock

Enclosing class:

PlayerInteractEvent

public static class PlayerInteractEvent.RightClickBlock
extends PlayerInteractEvent

This event is fired on both sides whenever the player right clicks while targeting a block. This event controls which of Block.onBlockActivated(net.minecraft.world.World, net.minecraft.util.math.BlockPos, net.minecraft.block.state.IBlockState, net.minecraft.entity.player.EntityPlayer, net.minecraft.util.EnumHand, net.minecraft.util.EnumFacing, float, float, float) and/or Item.onItemUse(net.minecraft.entity.player.EntityPlayer, net.minecraft.world.World, net.minecraft.util.math.BlockPos, net.minecraft.util.EnumHand, net.minecraft.util.EnumFacing, float, float, float) will be called after Item.onItemUseFirst(net.minecraft.entity.player.EntityPlayer, net.minecraft.world.World, net.minecraft.util.math.BlockPos, net.minecraft.util.EnumFacing, float, float, float, net.minecraft.util.EnumHand) is called. Canceling the event will cause none of the above three to be called Let result be a return value of the above three methods, or PlayerInteractEvent.cancellationResult if the event is cancelled. If we are on the client and result is not EnumActionResult.SUCCESS, the client will then try PlayerInteractEvent.RightClickItem. There are various results to this event, see the getters below. Note that handling things differently on the client vs server may cause desynchronizations!

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

Field Summary

Fields

Modifier and Type	Field and Description
private Vec3d	hitVec
private Event.Result	useBlock
private Event.Result	useItem

Constructor Summary

Constructors

Constructor and Description
RightClickBlock(EntityPlayer player, EnumHand hand, 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) DENY: Block will never be used.
void	setUseItem(Event.Result triggerItem) DENY: The item will never be used.

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

Field Detail

useBlock

private Event.Result useBlock

useItem

private Event.Result useItem

hitVec

private final Vec3d hitVec

Constructor Detail

RightClickBlock

public RightClickBlock(EntityPlayer player,
                       EnumHand hand,
                       BlockPos pos,
                       EnumFacing face,
                       Vec3d hitVec)

Method Detail

getHitVec

public Vec3d getHitVec()

Returns:

The hit vector of this click

getUseBlock

public Event.Result getUseBlock()

Returns:

If Block.onBlockActivated(net.minecraft.world.World, net.minecraft.util.math.BlockPos, net.minecraft.block.state.IBlockState, net.minecraft.entity.player.EntityPlayer, net.minecraft.util.EnumHand, net.minecraft.util.EnumFacing, float, float, float) should be called

getUseItem

public Event.Result getUseItem()

Returns:

If Item.onItemUseFirst(net.minecraft.entity.player.EntityPlayer, net.minecraft.world.World, net.minecraft.util.math.BlockPos, net.minecraft.util.EnumFacing, float, float, float, net.minecraft.util.EnumHand) and Item.onItemUse(net.minecraft.entity.player.EntityPlayer, net.minecraft.world.World, net.minecraft.util.math.BlockPos, net.minecraft.util.EnumHand, net.minecraft.util.EnumFacing, float, float, float) should be called

setUseBlock

public void setUseBlock(Event.Result triggerBlock)

DENY: Block will never be used. DEFAULT: Default behaviour (sneak will not use block, unless all items return true in Item.doesSneakBypassUse(net.minecraft.item.ItemStack, net.minecraft.world.IBlockAccess, net.minecraft.util.math.BlockPos, net.minecraft.entity.player.EntityPlayer)). ALLOW: Block will always be used, regardless of sneaking and doesSneakBypassUse.

setUseItem

public void setUseItem(Event.Result triggerItem)

DENY: The item will never be used. DEFAULT: The item will be used if the block fails. ALLOW: The item will always be used.

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