Class CustomizeGuiOverlayEvent.BossEventProgress

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.client.event.CustomizeGuiOverlayEvent

net.neoforged.neoforge.client.event.CustomizeGuiOverlayEvent.BossEventProgress

All Implemented Interfaces:

net.neoforged.bus.api.ICancellableEvent

Enclosing class:

CustomizeGuiOverlayEvent

public static class CustomizeGuiOverlayEvent.BossEventProgress
extends CustomizeGuiOverlayEvent
implements net.neoforged.bus.api.ICancellableEvent

Fired before a boss health bar is rendered to the screen.

This event is cancellable. Cancelling this event will prevent the given bar from rendering. The Y position increment is always applied, even if the event is canceled, to give way for any custom elements rendered in place of vanilla's bar rendering.

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

Nested Class Summary

Nested classes/interfaces inherited from class CustomizeGuiOverlayEvent

CustomizeGuiOverlayEvent.BossEventProgress, CustomizeGuiOverlayEvent.Chat

Field Summary

Fields

Modifier and Type	Field	Description
private final LerpingBossEvent	bossEvent
private int	increment
private final int	x
private final int	y

Constructor Summary

Constructors

Constructor	Description
BossEventProgress(Window window, GuiGraphicsExtractor guiGraphics, DeltaTracker partialTick, LerpingBossEvent bossEvent, int x, int y, int increment)

Method Summary

Modifier and Type	Method	Description
LerpingBossEvent	getBossEvent()	Returns the boss health bar currently being rendered.
int	getIncrement()	Returns the Y position increment, applied before rendering the next boss health bar.
int	getX()	Returns the X position of the boss health bar.
int	getY()	Returns the Y position of the boss health bar.
void	setIncrement(int increment)	Sets the Y position increment, which is applied before rendering the next boss health bar.

Methods inherited from class CustomizeGuiOverlayEvent

getGuiGraphics, getPartialTick, getWindow

Methods inherited from class 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

bossEvent

private final LerpingBossEvent bossEvent

x

private final int x

y

private final int y

increment

private int increment

Constructor Details

BossEventProgress

@Internal
public BossEventProgress(Window window,
 GuiGraphicsExtractor guiGraphics,
 DeltaTracker partialTick,
 LerpingBossEvent bossEvent,
 int x,
 int y,
 int increment)

Method Details

getBossEvent

public LerpingBossEvent getBossEvent()

Returns the boss health bar currently being rendered.

Returns:

the boss health bar currently being rendered

getX

public int getX()

Returns the X position of the boss health bar.

Returns:

the X position of the boss health bar

getY

public int getY()

Returns the Y position of the boss health bar.

Returns:

the Y position of the boss health bar

getIncrement

public int getIncrement()

Returns the Y position increment, applied before rendering the next boss health bar. This is always applied, even if the event is canceled.

Returns:

the Y position increment, applied before rendering the next boss health bar

setIncrement

public void setIncrement(int increment)

Sets the Y position increment, which is applied before rendering the next boss health bar.

Parameters:

increment - the new Y position increment