Package me.hackware.api.hud

Class TextListHUDElement

java.lang.Object

me.hackware.api.hud.HUDElement

me.hackware.api.hud.TextHUDElement

me.hackware.api.hud.TextListHUDElement

All Implemented Interfaces:

SettingContainer

public abstract class TextListHUDElement
extends TextHUDElement

Base class for list-style HUD elements (potion timers, entity radar, item radar, visual range). Provides shared settings, config persistence helpers, editor state management, and utilities.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TextListHUDElement.Alignment
static enum	TextListHUDElement.IconMode
static enum	TextListHUDElement.SortOrder

Nested classes/interfaces inherited from class me.hackware.api.hud.HUDElement

HUDElement.Anchor, HUDElement.ConditionType, HUDElement.ExpandAnchorX, HUDElement.ExpandAnchorY, HUDElement.VisibilityCondition, HUDElement.VisibilityKeyMode

Field Summary

Fields

Modifier and Type	Field	Description
final EnumSetting<TextListHUDElement.Alignment>	alignment
final EnumSetting<TextListHUDElement.IconMode>	iconMode
final NumberSetting<Integer>	iconSize
final NumberSetting<Integer>	iconSpacing
protected boolean	inEditor
final NumberSetting<Integer>	itemIndent
final NumberSetting<Integer>	lineGap
final EnumSetting<TextListHUDElement.SortOrder>	sortOrder
final SettingGroup	title
final StringSetting	titleTemplate

Fields inherited from class me.hackware.api.hud.TextHUDElement

PAD_H, PAD_V

Fields inherited from class me.hackware.api.hud.HUDElement

height, id, SCALE_MAX, SCALE_MIN, width, x, y

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TextListHUDElement(String id, int defaultX, int defaultY)

Method Summary

Modifier and Type	Method	Description
protected static int	applyAlpha(int color, float alpha)
protected String	buildText()	The text string to display.
protected int	effectiveItemIndent()	Returns the effective item indent (0 when centered).
protected int	effectiveLineGap()	Effective gap used for rendering (user value + 2).
protected int	getColor()	The ARGB color for the text.
protected boolean	iconsShown()
protected String	key(String name)
protected static Object	legacyIdList(Object raw)	Legacy selected-ids value (real yml list or comma-joined string) → a real string list.
protected void	migrateIconKeys(String basePath, boolean defaultShown)	Legacy icon keys (iconMode / showIcons+iconPosition / size / spacing) → basePath.
protected void	migrateListKeys()	Legacy shared list keys → the standard slug paths.
protected void	registerListGroup(Setting<?> animate, Setting<?> filter, Setting<?> maxEntries, Setting<?> sortBy)	Registers the standard List group (Alignment, [Animate], [Filter], Gap, Indent, [Max Entries], Sorting{Order, [Sort By]}, Title).
void	render(net.minecraft.client.gui.GuiGraphics graphics, net.minecraft.client.gui.Font font, float textScale)
void	renderEditor(net.minecraft.client.gui.GuiGraphics graphics, net.minecraft.client.gui.Font font, float textScale)
protected TextListHUDElement.Alignment	resolveAlignment()
protected TextListHUDElement.Alignment	resolveAlignmentByScreenThirds()	Legacy screen-third alignment fallback retained for list implementations that need it.
protected abstract String	resolveTitle()
protected net.minecraft.network.chat.Component	resolveTitleComponent()
void	setInEditor(boolean inEditor)
protected boolean	sortDescending()	Whether the active sort order reverses the comparator.
void	updateEditorSize(net.minecraft.client.gui.Font font)	Update width/height as the editor would see them (with placeholder content).

Methods inherited from class me.hackware.api.hud.TextHUDElement

buildDisplayText, buildSizingText, renderContent, textX, updateSize

Methods inherited from class me.hackware.api.hud.HUDElement

addCondition, addSettings, addSettings, areConditionsMet, canResetToDefault, clamp, clearExpandOverrides, clearSavedPosition, contains, defaultTextColor, effHeight, effRenderScale, effWidth, getConditions, getEditorAlpha, getExpandAnchorX, getExpandAnchorY, getHeight, getId, getReservedHeight, getReservedWidth, getScale, getSettings, getVisibilityKey, getVisibilityKeyMode, getWidth, getX, getY, graphicalScale, hudScale, isDraggable, isEditorHidden, isVisibilityHoldShows, loadElementSettings, migrateArgbColorKey, migrateColorSettingKey, migrateEnumSettingKey, migrateOpacityIntoColorAlpha, migrateOverrideColorKey, migrateSettingKey, migrateSettingKey, removeCondition, render, renderEditor, resetClampSides, resetToDefault, resolve, resolvedExpandX, resolvedExpandY, resolveEditor, saveConditions, saveContainerSettings, savePosition, saveVisibilityKey, scalesWithTextScale, setClampSides, setEditorAlpha, setExpandAnchorX, setExpandAnchorY, setExpandOverrides, setPosition, setScale, setVisibilityHoldShows, setVisibilityKey, setVisibilityKeyMode, snapshotAnchor, usesBaseScaleSlider, wrapperScale

Methods inherited from class java.lang.Object

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

Field Details

alignment

public final EnumSetting<TextListHUDElement.Alignment> alignment

lineGap

public final NumberSetting<Integer> lineGap

itemIndent

public final NumberSetting<Integer> itemIndent

sortOrder

public final EnumSetting<TextListHUDElement.SortOrder> sortOrder

title

public final SettingGroup title

titleTemplate

public final StringSetting titleTemplate

iconMode

public final EnumSetting<TextListHUDElement.IconMode> iconMode

iconSize

public final NumberSetting<Integer> iconSize

iconSpacing

public final NumberSetting<Integer> iconSpacing

inEditor

protected boolean inEditor

Constructor Details

TextListHUDElement

protected TextListHUDElement(String id,
 int defaultX,
 int defaultY)

Method Details

registerListGroup

protected void registerListGroup(Setting<?> animate,
 Setting<?> filter,
 Setting<?> maxEntries,
 Setting<?> sortBy)

Registers the standard List group (Alignment, [Animate], [Filter], Gap, Indent, [Max Entries], Sorting{Order, [Sort By]}, Title). Null slots are omitted. Call from the element constructor AFTER its other groups so List lands last in the window.

migrateListKeys

protected void migrateListKeys()

Legacy shared list keys → the standard slug paths.

legacyIdList

protected static Object legacyIdList(Object raw)

Legacy selected-ids value (real yml list or comma-joined string) → a real string list.

migrateIconKeys

protected void migrateIconKeys(String basePath,
 boolean defaultShown)

Legacy icon keys (iconMode / showIcons+iconPosition / size / spacing) → basePath.

buildText

protected String buildText()

Description copied from class: TextHUDElement

The text string to display. Called every frame.

Specified by:

buildText in class TextHUDElement

getColor

protected int getColor()

Description copied from class: TextHUDElement

The ARGB color for the text. Called every frame.

Specified by:

getColor in class TextHUDElement

key

protected String key(String name)

effectiveLineGap

protected int effectiveLineGap()

Effective gap used for rendering (user value + 2).

sortDescending

protected boolean sortDescending()

Whether the active sort order reverses the comparator. Lists that always grow downward read AUTO as ascending; direction-aware lists override.

effectiveItemIndent

protected int effectiveItemIndent()

Returns the effective item indent (0 when centered).

iconsShown

protected boolean iconsShown()

setInEditor

public void setInEditor(boolean inEditor)

renderEditor

public void renderEditor(net.minecraft.client.gui.GuiGraphics graphics,
 net.minecraft.client.gui.Font font,
 float textScale)

Overrides:

renderEditor in class HUDElement

render

public void render(net.minecraft.client.gui.GuiGraphics graphics,
 net.minecraft.client.gui.Font font,
 float textScale)

Overrides:

render in class HUDElement

updateEditorSize

public void updateEditorSize(net.minecraft.client.gui.Font font)

Description copied from class: HUDElement

Update width/height as the editor would see them (with placeholder content). Subclasses that report 0 size outside the editor should override this.

Overrides:

updateEditorSize in class HUDElement

resolveTitle

protected abstract String resolveTitle()

resolveTitleComponent

protected net.minecraft.network.chat.Component resolveTitleComponent()

resolveAlignment

protected TextListHUDElement.Alignment resolveAlignment()

resolveAlignmentByScreenThirds

protected TextListHUDElement.Alignment resolveAlignmentByScreenThirds()

Legacy screen-third alignment fallback retained for list implementations that need it.

applyAlpha

protected static int applyAlpha(int color,
 float alpha)