Package me.hackware.api.hud

Interface HudServices

public interface HudServices

Client services the HUD element bases need but cannot see from the API: the hud.yml settings store, global HUD layout/scale state, the template scripting engine, and module lookups. The client installs its implementation once at startup via install(me.hackware.api.hud.HudServices); the built-in default is inert (no persistence, templates echo their input), so an un-bootstrapped environment stays functional but featureless.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	HudServices.Holder	Mutable holder (interfaces cannot own mutable statics).

Method Summary

Modifier and Type	Method	Description
void	advanceSelections(String owner)
void	applySettingValue(Setting<?> setting, Object value)	Deserialize value into setting (config wire format).
String	constantCase(String name)
float	effectiveTextScale(HUDElement element)
String	evaluateTemplate(String rawTemplate, boolean censor, String owner)
static HudServices	get()	The installed implementation (inert until install(me.hackware.api.hud.HudServices) is called).
int	getDefaultTextColor()
Object	getHudSetting(String key, Object defaultValue)
int	getScreenMargin()
int	getSnapDistance()
float	getTextScale()
List<String>	hudSettingKeys(String prefix)	All stored keys beginning with prefix.
static void	install(HudServices services)	Installed once by the client before any HUD element is constructed.
default boolean	isFrameStableExpression(String expr)	Whether resolving expr twice within one frame is known to return the same value with no side effect.
boolean	isModuleEnabled(String name, boolean fallback)	Whether the module named name is enabled; fallback if unknown.
void	removeHudSetting(String key)
String	resolveExpression(String expr)
void	saveHudSettings()
Object	serializeSettingValue(Setting<?> setting)	Serialize setting's current value into config wire format.
void	setHudSetting(String key, Object value)
String	slug(String name)
default int	templateVolatileSerial()	Moves whenever template or condition evaluation reaches a function, a method, or a variable that is not frame-stable.
default int	textRewriteEpoch()	Moves whenever the client starts rewriting rendered text differently (NameProtect).

Method Details

getHudSetting

Object getHudSetting(String key,
 Object defaultValue)

setHudSetting

void setHudSetting(String key,
 Object value)

removeHudSetting

void removeHudSetting(String key)

saveHudSettings

void saveHudSettings()

hudSettingKeys

List<String> hudSettingKeys(String prefix)

All stored keys beginning with prefix.

applySettingValue

void applySettingValue(Setting<?> setting,
 Object value)

Deserialize value into setting (config wire format).

serializeSettingValue

Object serializeSettingValue(Setting<?> setting)

Serialize setting's current value into config wire format.

slug

String slug(String name)

constantCase

String constantCase(String name)

getTextScale

float getTextScale()

effectiveTextScale

float effectiveTextScale(HUDElement element)

getDefaultTextColor

int getDefaultTextColor()

getSnapDistance

int getSnapDistance()

getScreenMargin

int getScreenMargin()

evaluateTemplate

String evaluateTemplate(String rawTemplate,
 boolean censor,
 String owner)

resolveExpression

String resolveExpression(String expr)

isFrameStableExpression

default boolean isFrameStableExpression(String expr)

Whether resolving expr twice within one frame is known to return the same value with no side effect. false whenever that is not known.

templateVolatileSerial

default int templateVolatileSerial()

Moves whenever template or condition evaluation reaches a function, a method, or a variable that is not frame-stable. Equal readings around an evaluation mean repeating it this frame gives the same text and changes nothing. The default moves on every call.

advanceSelections

void advanceSelections(String owner)

isModuleEnabled

boolean isModuleEnabled(String name,
 boolean fallback)

Whether the module named name is enabled; fallback if unknown.

textRewriteEpoch

default int textRewriteEpoch()

Moves whenever the client starts rewriting rendered text differently (NameProtect). Holders of a Component kept across frames drop it when this changes. Render thread only.

An implementation that does not track this inherits the default, which moves on every call: nothing is ever reused, which is how text was built before the method existed.

get

static HudServices get()

The installed implementation (inert until install(me.hackware.api.hud.HudServices) is called).

install

static void install(HudServices services)

Installed once by the client before any HUD element is constructed.