Class UIHudWidget

java.lang.Object

com.hypixel.hytale.server.core.modules.ui.UISurface

com.hypixel.hytale.server.core.modules.ui.UIHudWidget

public abstract class UIHudWidget
extends UISurface

A server-driven Noesis HUD widget occupying a specific screen slot. Extend this class, call UISurface.registerCommand(String, UICommandHandler) for every command bound in your XAML, and override UISurface.createDataContext(Ref, Store) to supply the initial view model (or leave it returning null if the XAML binds only client-side state such as the inventory hotbar).

Register, remove, and toggle via HudManager.dev_registerWidget(PlayerRef, UIHudWidget) / HudManager.dev_unregisterWidget(PlayerRef, String) / HudManager.dev_setWidgetVisible(PlayerRef, String, boolean).

Nested Class Summary

Nested classes/interfaces inherited from class UISurface

UISurface.Batch

Method Summary

Modifier and Type	Method	Description
int	getOrder()
HudWidgetSlot	getSlot()
boolean	isVisible()
void	notifyVisibilityChanged(boolean visible)	Called by HudManager when it changes the client-side visibility of this widget.

Methods inherited from class UISurface

beginBatch, bind, createDataContext, executeCommand, getId, getPlayerRef, getXaml, onHide, onShow, unbind

Methods inherited from class Object

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

Method Details

getSlot

@Nonnull
public HudWidgetSlot getSlot()

getOrder

public int getOrder()

isVisible

public boolean isVisible()

Returns:

true if this widget is currently visible on the client.

notifyVisibilityChanged

public void notifyVisibilityChanged(boolean visible)

Called by HudManager when it changes the client-side visibility of this widget. Override to react to visibility changes; call super to keep the flag in sync.