Package net.neoforged.neoforge.client.event

Class ExtractBlockOutlineRenderStateEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.client.event.ExtractBlockOutlineRenderStateEvent

All Implemented Interfaces:

net.neoforged.bus.api.ICancellableEvent

public final class ExtractBlockOutlineRenderStateEvent
extends net.neoforged.bus.api.Event
implements net.neoforged.bus.api.ICancellableEvent

Fired after the BlockOutlineRenderState is extracted.

To perform custom outline rendering, a CustomBlockOutlineRenderer needs to be added through this event.

This event is cancellable. If it is canceled, then no outline render state will be submitted and no outline will be rendered.

Field Summary

Fields

Modifier and Type	Field	Description
private final Camera	camera
private final CollisionContext	collisionContext
private final List<CustomBlockOutlineRenderer>	customRenderers
private final boolean	highContrast
private final BlockHitResult	hitResult
private final boolean	inTranslucentPass
private final ClientLevel	level
private final LevelRenderer	levelRenderer
private final LevelRenderState	levelRenderState
private final BlockPos	pos
private final BlockState	state

Constructor Summary

Constructors

Constructor	Description
ExtractBlockOutlineRenderStateEvent(LevelRenderer levelRenderer, ClientLevel level, BlockPos pos, BlockState state, BlockHitResult hitResult, CollisionContext collisionContext, boolean inTranslucentPass, boolean highContrast, Camera camera, LevelRenderState levelRenderState)

Method Summary

Modifier and Type	Method	Description
void	addCustomRenderer(CustomBlockOutlineRenderer renderer)	Add a custom outline renderer to perform non-standard outline rendering.
BlockPos	getBlockPos()	Returns the position of the block whose outline is being extracted.
BlockState	getBlockState()	Returns the state of the block whose outline is being extracted.
Camera	getCamera()
CollisionContext	getCollisionContext()	Returns the CollisionContext to use for resolving the block's VoxelShapes.
List<CustomBlockOutlineRenderer>	getCustomRenderers()
BlockHitResult	getHitResult()	Returns the BlockHitResult holding the exact position the crosshair points at.
ClientLevel	getLevel()	Returns the ClientLevel holding the block whose outline is being extracted.
LevelRenderer	getLevelRenderer()	Returns the LevelRenderer performing the extraction.
LevelRenderState	getLevelRenderState()
boolean	isHighContrast()	Returns whether the high-contrast outline setting is enabled in the accessibility settings.
boolean	isInTranslucentPass()	Returns whether the targeted block has translucent geometry and therefore needs to render its outline in the translucent pass.

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

levelRenderer

private final LevelRenderer levelRenderer

level

private final ClientLevel level

pos

private final BlockPos pos

state

private final BlockState state

hitResult

private final BlockHitResult hitResult

collisionContext

private final CollisionContext collisionContext

inTranslucentPass

private final boolean inTranslucentPass

highContrast

private final boolean highContrast

camera

private final Camera camera

levelRenderState

private final LevelRenderState levelRenderState

customRenderers

private final List<CustomBlockOutlineRenderer> customRenderers

Constructor Details

ExtractBlockOutlineRenderStateEvent

@Internal
public ExtractBlockOutlineRenderStateEvent(LevelRenderer levelRenderer,
 ClientLevel level,
 BlockPos pos,
 BlockState state,
 BlockHitResult hitResult,
 CollisionContext collisionContext,
 boolean inTranslucentPass,
 boolean highContrast,
 Camera camera,
 LevelRenderState levelRenderState)

Method Details

addCustomRenderer

public void addCustomRenderer(CustomBlockOutlineRenderer renderer)

Add a custom outline renderer to perform non-standard outline rendering.

getLevelRenderer

public LevelRenderer getLevelRenderer()

Returns the LevelRenderer performing the extraction.

Returns:

the LevelRenderer performing the extraction

getLevel

public ClientLevel getLevel()

Returns the ClientLevel holding the block whose outline is being extracted.

Returns:

the ClientLevel holding the block whose outline is being extracted

getBlockPos

public BlockPos getBlockPos()

Returns the position of the block whose outline is being extracted.

Returns:

the position of the block whose outline is being extracted

getBlockState

public BlockState getBlockState()

Returns the state of the block whose outline is being extracted.

Returns:

the state of the block whose outline is being extracted

getHitResult

public BlockHitResult getHitResult()

Returns the BlockHitResult holding the exact position the crosshair points at.

Returns:

the BlockHitResult holding the exact position the crosshair points at

getCollisionContext

public CollisionContext getCollisionContext()

Returns the CollisionContext to use for resolving the block's VoxelShapes.

Returns:

the CollisionContext to use for resolving the block's VoxelShapes

isInTranslucentPass

public boolean isInTranslucentPass()

Returns whether the targeted block has translucent geometry and therefore needs to render its outline in the translucent pass.

Returns:

whether the targeted block has translucent geometry and therefore needs to render its outline in the translucent pass

isHighContrast

public boolean isHighContrast()

Returns whether the high-contrast outline setting is enabled in the accessibility settings.

Returns:

whether the high-contrast outline setting is enabled in the accessibility settings

getCamera

public Camera getCamera()

getLevelRenderState

public LevelRenderState getLevelRenderState()

getCustomRenderers

@Internal
public List<CustomBlockOutlineRenderer> getCustomRenderers()