Package net.neoforged.neoforge.client.event

Class RenderBlockScreenEffectEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.client.event.RenderBlockScreenEffectEvent

All Implemented Interfaces:

net.neoforged.bus.api.ICancellableEvent

public class RenderBlockScreenEffectEvent
extends net.neoforged.bus.api.Event
implements net.neoforged.bus.api.ICancellableEvent

Fired before a block texture will be overlaid on the player's view.

This event is cancellable. If this event is cancelled, then the overlay will not be rendered.

This event is fired on the main Forge event bus, only on the logical client.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	RenderBlockScreenEffectEvent.OverlayType	The type of the block overlay to be rendered.

Field Summary

Fields

Modifier and Type	Field	Description
private final BlockPos	blockPos
private final BlockState	blockState
private final MultiBufferSource	bufferSource
private final MaterialSet	materials
private final RenderBlockScreenEffectEvent.OverlayType	overlayType
private final Player	player
private final PoseStack	poseStack

Constructor Summary

Constructors

Constructor	Description
RenderBlockScreenEffectEvent(Player player, PoseStack poseStack, RenderBlockScreenEffectEvent.OverlayType type, BlockState block, BlockPos blockPos, MaterialSet materials, MultiBufferSource bufferSource)

Method Summary

Modifier and Type	Method	Description
BlockPos	getBlockPos()	Returns the position of the block which the overlay is gotten from.
BlockState	getBlockState()	Returns the block which the overlay is gotten from.
MultiBufferSource	getBufferSource()	Returns the buffer source used in rendering.
MaterialSet	getMaterials()	Returns the materials used in rendering.
RenderBlockScreenEffectEvent.OverlayType	getOverlayType()	Returns the type of the overlay.
Player	getPlayer()	Returns the player which the overlay will apply to.
PoseStack	getPoseStack()	Returns the pose stack used for rendering.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.neoforged.bus.api.ICancellableEvent

isCanceled, setCanceled

Field Details

player

private final Player player

poseStack

private final PoseStack poseStack

overlayType

private final RenderBlockScreenEffectEvent.OverlayType overlayType

blockState

private final BlockState blockState

blockPos

private final BlockPos blockPos

materials

private final MaterialSet materials

bufferSource

private final MultiBufferSource bufferSource

Constructor Details

RenderBlockScreenEffectEvent

@Internal
public RenderBlockScreenEffectEvent(Player player,
 PoseStack poseStack,
 RenderBlockScreenEffectEvent.OverlayType type,
 BlockState block,
 BlockPos blockPos,
 MaterialSet materials,
 MultiBufferSource bufferSource)

Method Details

getPlayer

public Player getPlayer()

Returns the player which the overlay will apply to.

Returns:

the player which the overlay will apply to

getPoseStack

public PoseStack getPoseStack()

Returns the pose stack used for rendering.

Returns:

the pose stack used for rendering

getOverlayType

public RenderBlockScreenEffectEvent.OverlayType getOverlayType()

Returns the type of the overlay.

Returns:

the type of the overlay

getBlockState

public BlockState getBlockState()

Returns the block which the overlay is gotten from.

Returns:

the block which the overlay is gotten from

getBlockPos

public BlockPos getBlockPos()

Returns the position of the block which the overlay is gotten from.

Returns:

the position of the block which the overlay is gotten from

getMaterials

public MaterialSet getMaterials()

Returns the materials used in rendering.

Returns:

the materials used in rendering

getBufferSource

public MultiBufferSource getBufferSource()

Returns the buffer source used in rendering.

Returns:

the buffer source used in rendering