Class ExtractLevelRenderStateEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.client.event.ExtractLevelRenderStateEvent

public final class ExtractLevelRenderStateEvent
extends net.neoforged.bus.api.Event

Fired when the LevelRenderer extracts level render state, after all vanilla states have been extracted. Use this event to extract custom render state for use in RenderLevelStageEvent or custom environmental effects. Custom data can be stored on and retrieved from the provided LevelRenderState via BaseRenderState.setRenderData(ContextKey, Object) and BaseRenderState.getRenderData(ContextKey) respectively.

This event is not cancellable.

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

Field Summary

Fields

Modifier and Type	Field	Description
private final Camera	camera
private final DeltaTracker	deltaTracker
private final Frustum	frustum
private final ClientLevel	level
private final LevelExtractor	levelExtractor
private final LevelRenderState	renderState

Constructor Summary

Constructors

Constructor	Description
ExtractLevelRenderStateEvent(LevelExtractor levelExtractor, LevelRenderState renderState, ClientLevel level, Camera camera, Frustum frustum, DeltaTracker deltaTracker)

Method Summary

Modifier and Type	Method	Description
Camera	getCamera()	Returns the Camera from which the world is being observed.
DeltaTracker	getDeltaTracker()	Returns the DeltaTracker providing partial tick and delta ticks.
Frustum	getFrustum()	Returns the active Frustum used for culling.
ClientLevel	getLevel()	Returns the ClientLevel whose state is being extracted.
LevelExtractor	getLevelExtractor()	Returns the LevelExtractor performing the extraction.
LevelRenderState	getRenderState()	Returns the LevelRenderState being extracted to.

Methods inherited from class Object

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

Field Details

levelExtractor

private final LevelExtractor levelExtractor

renderState

private final LevelRenderState renderState

level

private final ClientLevel level

camera

private final Camera camera

frustum

private final Frustum frustum

deltaTracker

private final DeltaTracker deltaTracker

Constructor Details

ExtractLevelRenderStateEvent

@Internal
public ExtractLevelRenderStateEvent(LevelExtractor levelExtractor,
 LevelRenderState renderState,
 ClientLevel level,
 Camera camera,
 Frustum frustum,
 DeltaTracker deltaTracker)

Method Details

getLevelExtractor

public LevelExtractor getLevelExtractor()

Returns the LevelExtractor performing the extraction.

Returns:

the LevelExtractor performing the extraction

getRenderState

public LevelRenderState getRenderState()

Returns the LevelRenderState being extracted to.

Returns:

the LevelRenderState being extracted to

getLevel

public ClientLevel getLevel()

Returns the ClientLevel whose state is being extracted.

Returns:

the ClientLevel whose state is being extracted

getCamera

public Camera getCamera()

Returns the Camera from which the world is being observed.

Returns:

the Camera from which the world is being observed

getFrustum

public Frustum getFrustum()

Returns the active Frustum used for culling.

Returns:

the active Frustum used for culling

getDeltaTracker

public DeltaTracker getDeltaTracker()

Returns the DeltaTracker providing partial tick and delta ticks.

Returns:

the DeltaTracker providing partial tick and delta ticks