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 BlockState	blockForOverlay
private final BlockPos	blockPos
private final MatrixStack	mat
private final RenderBlockOverlayEvent.OverlayType	overlayType
private final PlayerEntity	player

Constructor Summary

Constructors

Constructor	Description
RenderBlockOverlayEvent(PlayerEntity player, MatrixStack mat, RenderBlockOverlayEvent.OverlayType type, BlockState block, BlockPos blockPos)

Method Summary

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

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 PlayerEntity player

mat

private final MatrixStack mat

overlayType

private final RenderBlockOverlayEvent.OverlayType overlayType

blockForOverlay

private final BlockState blockForOverlay

blockPos

private final BlockPos blockPos

Constructor Details

RenderBlockOverlayEvent

public RenderBlockOverlayEvent(PlayerEntity player,
 MatrixStack mat,
 RenderBlockOverlayEvent.OverlayType type,
 BlockState block,
 BlockPos blockPos)

Method Details

getPlayer

public PlayerEntity getPlayer()

The player which the overlay will apply to

getMatrixStack

public MatrixStack getMatrixStack()

getOverlayType

public RenderBlockOverlayEvent.OverlayType getOverlayType()

The type of overlay to occur

getBlockForOverlay

public BlockState getBlockForOverlay()

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

getBlockPos

public BlockPos getBlockPos()