Class TextHudWidget

java.lang.Object

net.lynxclient.api.module.Module<TextHudWidget.Config>

net.lynxclient.api.hud.HudWidget<TextHudWidget.Config>

net.lynxclient.api.hud.TextHudWidget

public abstract class TextHudWidget
extends HudWidget<TextHudWidget.Config>

The common "Label value" widget (FPS, Ping, Coordinates, …). Subclasses only provide the texts.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TextHudWidget.Config
static enum	TextHudWidget.Style	How a text widget looks

Field Summary

Fields inherited from class HudWidget

NOT_CACHEABLE

Modifier and Type	Field	Description
static final long	NOT_CACHEABLE	Fingerprint of HudWidget.stateHash(): this widget changes every frame and cannot be cached

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TextHudWidget(String id, boolean enabledByDefault, HudWidgetConfig.Anchor anchor, float offsetX, float offsetY)

Method Summary

Modifier and Type	Method	Description
int	height(RenderContext ctx)
protected abstract String	label()	Short label, e.g.
void	render(RenderContext ctx, boolean editor)	Draw at (0, 0).
long	stateHash()	Fingerprint of what the widget shows right now (values, pressed keys …).
protected abstract String	value(boolean editor)	Current value; editor = true → a sample value is fine when there is no world
int	width(RenderContext ctx)

Methods inherited from class HudWidget

hasContent

Modifier and Type	Method	Description
boolean	hasContent()	false = nothing to show right now (no potion effects, no armour …) – skipped entirely in game, still shown in the editor

Methods inherited from class Module

category, config, dispatchEnabled, id, isEnabled, isSettingVisible, isToggleable, onDisable, onEnable

Modifier and Type	Method	Description
final Category	category()
final TextHudWidget.Config	config()
final void	dispatchEnabled(boolean enabled)	Called by LynxClient – not for addons.
final String	id()	Stable id, also the translation prefix and the config file name
final boolean	isEnabled()
boolean	isSettingVisible(String key)	false hides a setting in the menu, e.g.
boolean	isToggleable()	false for modules that are always on (e.g.
protected void	onDisable()	After the module was switched off.
protected void	onEnable()	After the module was switched on (also at start-up when it is on).

Methods inherited from class Object

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

Constructor Details

TextHudWidget

protected TextHudWidget(String id,
 boolean enabledByDefault,
 HudWidgetConfig.Anchor anchor,
 float offsetX,
 float offsetY)

Method Details

label

protected abstract String label()

Short label, e.g. "FPS"

value

protected abstract String value(boolean editor)

Current value; editor = true → a sample value is fine when there is no world

stateHash

public long stateHash()

Description copied from class: HudWidget

Fingerprint of what the widget shows right now (values, pressed keys …). LynxClient may keep the drawn HUD and skip drawing while every fingerprint stays the same. Settings, position and size are covered by LynxClient. Default: HudWidget.NOT_CACHEABLE.

Overrides:

stateHash in class HudWidget<TextHudWidget.Config>

width

public int width(RenderContext ctx)

Specified by:

width in class HudWidget<TextHudWidget.Config>

height

public int height(RenderContext ctx)

Specified by:

height in class HudWidget<TextHudWidget.Config>

render

public void render(RenderContext ctx,
 boolean editor)

Description copied from class: HudWidget

Draw at (0, 0). editor = true in the HUD editor (show sample values even outside a world)

Specified by:

render in class HudWidget<TextHudWidget.Config>