Package net.neoforged.neoforge.client.event

Class ScreenEvent.BackgroundRendered

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.client.event.ScreenEvent

net.neoforged.neoforge.client.event.ScreenEvent.BackgroundRendered

Enclosing class:

ScreenEvent

@Deprecated(forRemoval=true,
            since="21.0")
public static class ScreenEvent.BackgroundRendered
extends ScreenEvent

Deprecated, for removal: This API element is subject to removal in a future version.

Planned on being removed in 1.21.1 due to extreme maintenance burden to make this event fire consistently for most screens.

Fired directly after the background of the screen is drawn. (Only when the screen calls Screen.renderBackground(net.minecraft.client.gui.GuiGraphics, int, int, float)) Can be used for drawing above the background but below the tooltips.

This event is not cancellable, and does not

invalid reference

have a result

.

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

Nested Class Summary

Nested classes/interfaces inherited from class net.neoforged.neoforge.client.event.ScreenEvent

ScreenEvent.BackgroundRendered, ScreenEvent.CharacterTyped, ScreenEvent.Closing, ScreenEvent.Init, ScreenEvent.KeyPressed, ScreenEvent.KeyReleased, ScreenEvent.MouseButtonPressed, ScreenEvent.MouseButtonReleased, ScreenEvent.MouseDragged, ScreenEvent.MouseScrolled, ScreenEvent.Opening, ScreenEvent.Render, ScreenEvent.RenderInventoryMobEffects

Field Summary

Fields

Modifier and Type	Field	Description
private final GuiGraphics	guiGraphics	Deprecated, for removal: This API element is subject to removal in a future version.

Constructor Summary

Constructors

Constructor	Description
BackgroundRendered(Screen screen, GuiGraphics guiGraphics)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
GuiGraphics	getGuiGraphics()	Deprecated, for removal: This API element is subject to removal in a future version. Returns the gui graphics used for rendering.

Methods inherited from class net.neoforged.neoforge.client.event.ScreenEvent

getScreen

Methods inherited from class java.lang.Object

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

Field Details

guiGraphics

private final GuiGraphics guiGraphics

Deprecated, for removal: This API element is subject to removal in a future version.

Constructor Details

BackgroundRendered

@Internal
public BackgroundRendered(Screen screen,
 GuiGraphics guiGraphics)

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

getGuiGraphics

public GuiGraphics getGuiGraphics()

Deprecated, for removal: This API element is subject to removal in a future version.

Returns the gui graphics used for rendering.

Returns:

the gui graphics used for rendering