Package net.neoforged.neoforge.client.event

Class RenderItemInFrameEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.client.event.RenderItemInFrameEvent

All Implemented Interfaces:

net.neoforged.bus.api.ICancellableEvent

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

Fired before an item stack is rendered in an item frame. This can be used to prevent normal rendering or add custom rendering.

This event is cancellable, and does not

invalid reference

have a result

. If the event is cancelled, then the item stack will not be rendered

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

See Also:

• ItemFrameRenderer

Field Summary

Fields

Modifier and Type	Field	Description
private final ItemFrameRenderState	frameRenderState
private final ItemStackRenderState	itemStack
private final PoseStack	poseStack
private final ItemFrameRenderer<?>	renderer
private final SubmitNodeCollector	submitNodeCollector

Constructor Summary

Constructors

Constructor	Description
RenderItemInFrameEvent(ItemFrameRenderState frameRenderState, ItemFrameRenderer<?> renderItemFrame, PoseStack poseStack, SubmitNodeCollector submitNodeCollector)

Method Summary

Modifier and Type	Method	Description
ItemFrameRenderState	getItemFrameRenderState()	Returns the item frame entity.
ItemStackRenderState	getItemStackRenderState()	Returns the item stack being rendered.
PoseStack	getPoseStack()	Returns the pose stack used for rendering.
ItemFrameRenderer<?>	getRenderer()	Returns the renderer for the item frame entity.
SubmitNodeCollector	getSubmitNodeCollector()	Returns the submit node collector.

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

itemStack

private final ItemStackRenderState itemStack

frameRenderState

private final ItemFrameRenderState frameRenderState

renderer

private final ItemFrameRenderer<?> renderer

poseStack

private final PoseStack poseStack

submitNodeCollector

private final SubmitNodeCollector submitNodeCollector

Constructor Details

RenderItemInFrameEvent

@Internal
public RenderItemInFrameEvent(ItemFrameRenderState frameRenderState,
 ItemFrameRenderer<?> renderItemFrame,
 PoseStack poseStack,
 SubmitNodeCollector submitNodeCollector)

Method Details

getItemStackRenderState

public ItemStackRenderState getItemStackRenderState()

Returns the item stack being rendered.

Returns:

the item stack being rendered

getItemFrameRenderState

public ItemFrameRenderState getItemFrameRenderState()

Returns the item frame entity.

Returns:

the item frame entity

getRenderer

public ItemFrameRenderer<?> getRenderer()

Returns the renderer for the item frame entity.

Returns:

the renderer for the item frame entity

getPoseStack

public PoseStack getPoseStack()

Returns the pose stack used for rendering.

Returns:

the pose stack used for rendering

getSubmitNodeCollector

public SubmitNodeCollector getSubmitNodeCollector()

Returns the submit node collector.

Returns:

the submit node collector