Class SubmitCustomGeometryEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.client.event.SubmitCustomGeometryEvent

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

This event can be used to submit custom geometry outside of BlockEntityRenderers, EntityRenderers and Particles. Custom render state used by the submits must be extracted in ExtractLevelRenderStateEvent and stored in the provided LevelRenderState

This event is fired between particle submission and rendering of opaque submits.

This event is not cancellable

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

Field Summary

Fields

Modifier and Type	Field	Description
private final LevelRenderState	levelRenderState
private final PoseStack	poseStack
private final Iterable<? extends IRenderableSection>	renderableSections
private final SubmitNodeCollector	submitNodeCollector

Constructor Summary

Constructors

Constructor	Description
SubmitCustomGeometryEvent(LevelRenderState levelRenderState, SubmitNodeCollector submitNodeCollector, PoseStack poseStack, Iterable<? extends IRenderableSection> renderableSections)

Method Summary

Modifier and Type	Method	Description
LevelRenderState	getLevelRenderState()	Returns the level render state.
PoseStack	getPoseStack()	Returns the pose stack to use for geometry submission.
Iterable<? extends IRenderableSection>	getRenderableSections()	Returns an iterable of all visible sections.
SubmitNodeCollector	getSubmitNodeCollector()	Returns the submit node collector to submit the geometry to.

Methods inherited from class Object

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

Field Details

levelRenderState

private final LevelRenderState levelRenderState

submitNodeCollector

private final SubmitNodeCollector submitNodeCollector

poseStack

private final PoseStack poseStack

renderableSections

private final Iterable<? extends IRenderableSection> renderableSections

Constructor Details

SubmitCustomGeometryEvent

@Internal
public SubmitCustomGeometryEvent(LevelRenderState levelRenderState,
 SubmitNodeCollector submitNodeCollector,
 PoseStack poseStack,
 Iterable<? extends IRenderableSection> renderableSections)

Method Details

getLevelRenderState

public LevelRenderState getLevelRenderState()

Returns the level render state.

Returns:

the level render state

getSubmitNodeCollector

public SubmitNodeCollector getSubmitNodeCollector()

Returns the submit node collector to submit the geometry to.

Returns:

the submit node collector to submit the geometry to

getPoseStack

public PoseStack getPoseStack()

Returns the pose stack to use for geometry submission.

Returns:

the pose stack to use for geometry submission

getRenderableSections

public Iterable<? extends IRenderableSection> getRenderableSections()

Returns an iterable of all visible sections.

Calling Iterable.forEach(Consumer) on the returned iterable allows the underlying renderer to optimize how it fetches the visible sections, and is recommended.