Package net.minecraftforge.client.event

Class RenderBlockOverlayEvent

java.lang.Object

net.minecraftforge.eventbus.api.Event

net.minecraftforge.client.event.RenderBlockOverlayEvent

public class RenderBlockOverlayEvent
extends net.minecraftforge.eventbus.api.Event

Called when a block's texture is going to be overlaid on the player's HUD. Cancel this event to prevent the overlay.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	RenderBlockOverlayEvent.OverlayType

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	Description
private final BlockPos	blockPos
private final BlockState	blockState
private final RenderBlockOverlayEvent.OverlayType	overlayType
private final Player	player
private final PoseStack	poseStack

Constructor Summary

Constructors

Constructor	Description
RenderBlockOverlayEvent(Player player, PoseStack poseStack, RenderBlockOverlayEvent.OverlayType type, BlockState block, BlockPos blockPos)

Method Summary

Modifier and Type	Method	Description
BlockPos	getBlockPos()
BlockState	getBlockState()	If the overlay type is BLOCK, then this is the block which the overlay is getting it's icon from
RenderBlockOverlayEvent.OverlayType	getOverlayType()	The type of overlay to occur
Player	getPlayer()	The player which the overlay will apply to
PoseStack	getPoseStack()

Methods inherited from class net.minecraftforge.eventbus.api.Event

getListenerList, getParentListenerList, 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 Details

player

private final Player player

poseStack

private final PoseStack poseStack

overlayType

private final RenderBlockOverlayEvent.OverlayType overlayType

blockState

private final BlockState blockState

blockPos

private final BlockPos blockPos

Constructor Details

RenderBlockOverlayEvent

public RenderBlockOverlayEvent(Player player,
 PoseStack poseStack,
 RenderBlockOverlayEvent.OverlayType type,
 BlockState block,
 BlockPos blockPos)

Method Details

getPlayer

public Player getPlayer()

The player which the overlay will apply to

getPoseStack

public PoseStack getPoseStack()

getOverlayType

public RenderBlockOverlayEvent.OverlayType getOverlayType()

The type of overlay to occur

getBlockState

public BlockState getBlockState()

If the overlay type is BLOCK, then this is the block which the overlay is getting it's icon from

getBlockPos

public BlockPos getBlockPos()