io.github.cottonmc.cotton.gui.client

Enum CottonHud

java.lang.Object

java.lang.Enum<CottonHud>

io.github.cottonmc.cotton.gui.client.CottonHud

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CottonHud>, net.fabricmc.fabric.api.client.rendering.v1.HudRenderCallback

@Environment(value=CLIENT)
public enum CottonHud
extends java.lang.Enum<CottonHud>
implements net.fabricmc.fabric.api.client.rendering.v1.HudRenderCallback

Manages widgets that are painted on the in-game HUD.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CottonHud.Positioner Positioners can be used to change the position of a widget based on the window dimensions.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Field Summary

Fields inherited from interface net.fabricmc.fabric.api.client.rendering.v1.HudRenderCallback

EVENT

Method Summary

Modifier and Type	Method and Description
void	add(WWidget widget) Adds a new widget to the HUD.
void	add(WWidget widget, CottonHud.Positioner positioner) Adds a new widget to the HUD with a custom positioner.
void	add(WWidget widget, CottonHud.Positioner positioner, int width, int height) Adds a new widget to the HUD with a custom positioner and resizes it.
void	add(WWidget widget, int x, int y) Adds a new widget to the HUD at the specified offsets.
void	add(WWidget widget, int x, int y, int width, int height) Adds a new widget to the HUD at the specified offsets and resizes it.
void	onHudRender(net.minecraft.client.util.math.MatrixStack matrices, float tickDelta)
void	remove(WWidget widget) Removes the widget from the HUD.
void	setPositioner(WWidget widget, CottonHud.Positioner positioner) Sets the positioner of the widget.
static CottonHud	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CottonHud[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final CottonHud INSTANCE

Method Detail

values

public static CottonHud[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CottonHud c : CottonHud.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CottonHud valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

add

public void add(WWidget widget)

Adds a new widget to the HUD.

Parameters:

widget - the widget

add

public void add(WWidget widget,
                int x,
                int y)

Adds a new widget to the HUD at the specified offsets.

Parameters:

widget - the widget

x - the x offset

y - the y offset

See Also:

documentation about the offsets

add

public void add(WWidget widget,
                int x,
                int y,
                int width,
                int height)

Adds a new widget to the HUD at the specified offsets and resizes it.

Parameters:

widget - the widget

x - the x offset

y - the y offset

width - the width of the widget

height - the height of the widget

See Also:

documentation about the offsets

add

public void add(WWidget widget,
                CottonHud.Positioner positioner)

Adds a new widget to the HUD with a custom positioner.

Parameters:

widget - the widget

positioner - the positioner

add

public void add(WWidget widget,
                CottonHud.Positioner positioner,
                int width,
                int height)

Adds a new widget to the HUD with a custom positioner and resizes it.

Parameters:

widget - the widget

positioner - the positioner

width - the width of the widget

height - the height of the widget

setPositioner

public void setPositioner(WWidget widget,
                          CottonHud.Positioner positioner)

Sets the positioner of the widget.

Parameters:

widget - the widget

positioner - the positioner

remove

public void remove(WWidget widget)

Removes the widget from the HUD.

Parameters:

widget - the widget

onHudRender

public void onHudRender(net.minecraft.client.util.math.MatrixStack matrices,
                        float tickDelta)

Specified by:

onHudRender in interface net.fabricmc.fabric.api.client.rendering.v1.HudRenderCallback