net.minecraftforge.event.entity.player

Class PlayerInteractEvent.RightClickBlock

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

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.block.BlockState, net.minecraft.world.World, net.minecraft.util.math.BlockPos, net.minecraft.entity.player.PlayerEntity, net.minecraft.util.Hand, net.minecraft.util.math.BlockRayTraceResult) and/or Item.onItemUse(net.minecraft.item.ItemUseContext) will be called after IForgeItem.onItemUseFirst(net.minecraft.item.ItemStack, net.minecraft.item.ItemUseContext) 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.ItemCraftedEvent, PlayerEvent.ItemPickupEvent, PlayerEvent.ItemSmeltedEvent, PlayerEvent.LoadFromFile, PlayerEvent.NameFormat, PlayerEvent.PlayerChangedDimensionEvent, PlayerEvent.PlayerLoggedInEvent, PlayerEvent.PlayerLoggedOutEvent, PlayerEvent.PlayerRespawnEvent, 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, EntityEvent.EyeHeight

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 and Description
private net.minecraftforge.eventbus.api.Event.Result	useBlock
private net.minecraftforge.eventbus.api.Event.Result	useItem

Constructor Summary

Constructors

Constructor and Description
RightClickBlock(PlayerEntity player, Hand hand, BlockPos pos, Direction face)

Method Summary

Modifier and Type	Method and Description
net.minecraftforge.eventbus.api.Event.Result	getUseBlock()
net.minecraftforge.eventbus.api.Event.Result	getUseItem()
void	setCanceled(boolean canceled)
void	setUseBlock(net.minecraftforge.eventbus.api.Event.Result triggerBlock) DENY: Block will never be used.
void	setUseItem(net.minecraftforge.eventbus.api.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

getPlayer

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.eventbus.api.Event

getListenerList, getParentListenerList, 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 net.minecraftforge.eventbus.api.Event.Result useBlock

useItem

private net.minecraftforge.eventbus.api.Event.Result useItem

Constructor Detail

RightClickBlock

public RightClickBlock(PlayerEntity player,
                       Hand hand,
                       BlockPos pos,
                       Direction face)

Method Detail

getUseBlock

public net.minecraftforge.eventbus.api.Event.Result getUseBlock()

Returns:

If Block.onBlockActivated(net.minecraft.block.BlockState, net.minecraft.world.World, net.minecraft.util.math.BlockPos, net.minecraft.entity.player.PlayerEntity, net.minecraft.util.Hand, net.minecraft.util.math.BlockRayTraceResult) should be called

getUseItem

public net.minecraftforge.eventbus.api.Event.Result getUseItem()

Returns:

If IForgeItem.onItemUseFirst(net.minecraft.item.ItemStack, net.minecraft.item.ItemUseContext) and Item.onItemUse(net.minecraft.item.ItemUseContext) should be called

setUseBlock

public void setUseBlock(net.minecraftforge.eventbus.api.Event.Result triggerBlock)

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

setUseItem

public void setUseItem(net.minecraftforge.eventbus.api.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)

Overrides:

setCanceled in class net.minecraftforge.eventbus.api.Event