Package me.hackware.api.hud

Class TemplateTextHud

java.lang.Object

me.hackware.api.hud.HUDElement

me.hackware.api.hud.TextHUDElement

me.hackware.api.hud.TemplateTextHud

All Implemented Interfaces:

SettingContainer

public class TemplateTextHud
extends TextHUDElement

A HUD text element whose content is a user-editable template string. The template grammar (variables, functions, arithmetic) is evaluated by the

invalid reference

TemplateEngine

scripting package; this class only owns the element's persisted template + colour and wires evaluation into the HUD render path.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TemplateTextHud.Effect
static enum	TemplateTextHud.EffectDirection	Which end of the string the effect works from.

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<TemplateTextHud.Effect>	effect
final NumberSetting<Double>	effectDelay
final EnumSetting<TemplateTextHud.EffectDirection>	effectDirection
final NumberSetting<Double>	effectSpeed
final SettingGroup	general
final NumberSetting<Double>	scaleSetting
final StringSetting	text
final ColorSetting	textColor	Not exposed in the properties window (visible(false)); persists all the same.

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

Constructor	Description
TemplateTextHud(String id, int defaultX, int defaultY, String defaultTemplate)

Method Summary

Modifier and Type	Method	Description
protected net.minecraft.network.chat.Component	buildSizingText()	Measure against the full string so the box stays put while the text types/erases.
protected String	buildText()	The text string to display.
protected String	evaluateTemplate(String rawTemplate)
protected int	getColor()	The ARGB color for the text.
float	getScale()	The element scale rides the Scale setting (base slider is unused here).
String	getTemplate()
int	getTextColor()
void	setScale(float v)	Set the per-element scale, snapping to the same GUI-scale-aware fraction stops as the Client tab.
void	setTemplate(String template)
protected int	textX(net.minecraft.client.gui.Font font, net.minecraft.network.chat.Component text)	Aligns the partial text inside the box the full string reserved, following the element's resolved expand anchor — the same AUTO rule the editor uses, so an element parked on the right of the screen types against its right edge, one in the middle grows from the centre, and one on the left stays flush left.

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

buildDisplayText, renderContent, 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, getSettings, getVisibilityKey, getVisibilityKeyMode, getWidth, getX, getY, graphicalScale, hudScale, isDraggable, isEditorHidden, isVisibilityHoldShows, loadElementSettings, migrateArgbColorKey, migrateColorSettingKey, migrateEnumSettingKey, migrateOpacityIntoColorAlpha, migrateOverrideColorKey, migrateSettingKey, migrateSettingKey, removeCondition, render, render, renderEditor, renderEditor, resetClampSides, resetToDefault, resolve, resolvedExpandX, resolvedExpandY, resolveEditor, saveConditions, saveContainerSettings, savePosition, saveVisibilityKey, scalesWithTextScale, setClampSides, setEditorAlpha, setExpandAnchorX, setExpandAnchorY, setExpandOverrides, setPosition, setVisibilityHoldShows, setVisibilityKey, setVisibilityKeyMode, snapshotAnchor, updateEditorSize, usesBaseScaleSlider, wrapperScale

Methods inherited from class java.lang.Object

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

Field Details

general

public final SettingGroup general

text

public final StringSetting text

effect

public final EnumSetting<TemplateTextHud.Effect> effect

effectDirection

public final EnumSetting<TemplateTextHud.EffectDirection> effectDirection

effectSpeed

public final NumberSetting<Double> effectSpeed

effectDelay

public final NumberSetting<Double> effectDelay

scaleSetting

public final NumberSetting<Double> scaleSetting

textColor

public final ColorSetting textColor

Not exposed in the properties window (visible(false)); persists all the same.

Constructor Details

TemplateTextHud

public TemplateTextHud(String id,
 int defaultX,
 int defaultY,
 String defaultTemplate)

Method Details

getScale

public float getScale()

The element scale rides the Scale setting (base slider is unused here).

Overrides:

getScale in class HUDElement

setScale

public void setScale(float v)

Description copied from class: HUDElement

Set the per-element scale, snapping to the same GUI-scale-aware fraction stops as the Client tab.

Overrides:

setScale in class HUDElement

getTemplate

public String getTemplate()

setTemplate

public void setTemplate(String template)

getTextColor

public int getTextColor()

buildText

protected String buildText()

Description copied from class: TextHUDElement

The text string to display. Called every frame.

Specified by:

buildText in class TextHUDElement

buildSizingText

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

Measure against the full string so the box stays put while the text types/erases.

Overrides:

buildSizingText 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

textX

protected int textX(net.minecraft.client.gui.Font font,
 net.minecraft.network.chat.Component text)

Aligns the partial text inside the box the full string reserved, following the element's resolved expand anchor — the same AUTO rule the editor uses, so an element parked on the right of the screen types against its right edge, one in the middle grows from the centre, and one on the left stays flush left. Without this the text would always hug the left edge of a box sized for the full string, leaving it visually detached from the edge it's anchored to.

Overrides:

textX in class TextHUDElement

evaluateTemplate

protected String evaluateTemplate(String rawTemplate)