Class ScriptUiOverlay

All Implemented Interfaces:

IUpdateable, Subscription, AutoCloseable

public final class ScriptUiOverlay
extends Object
implements IUpdateable, Subscription

Manages transient UI elements, floating combat text, banners, and script-driven overlays.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ScriptUiOverlay.ScreenText

Field Summary

Fields inherited from interface IUpdateable

DEFAULT_UPDATE_PRIORITY

Constructor Summary

Constructors

Constructor	Description
ScriptUiOverlay()

Method Summary

Modifier and Type	Method	Description
void	clear()
void	close()
ScriptUiOverlay.ScreenText	drawScreenText(String text, double screenX, double screenY, Color color)
ScriptUiOverlay.ScreenText	drawScreenText(String text, double screenX, double screenY, Color color, Font font, int durationMs)
FloatingText	floatText(String text, IEntity entity, Color color)
FloatingText	floatText(String text, Point2D location, Color color)
FloatingText	floatText(String text, Point2D location, Color color, Font font, int durationMs, double velocityY)
List<FloatingText>	getFloatingTexts()
List<ScriptUiOverlay.ScreenText>	getScreenTexts()
void	render(Graphics2D g)
void	showBanner(String title, String subtitle, int durationMs)
void	update()	This method is called by the game loop on all objects that are attached to the loop.

Methods inherited from class Object

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

Methods inherited from interface IUpdateable

getUpdatePriority

Methods inherited from interface Subscription

unsubscribe

Constructor Details

ScriptUiOverlay

public ScriptUiOverlay()

Method Details

floatText

public FloatingText floatText(String text,
 Point2D location,
 Color color)

floatText

public FloatingText floatText(String text,
 IEntity entity,
 Color color)

floatText

public FloatingText floatText(String text,
 Point2D location,
 Color color,
 Font font,
 int durationMs,
 double velocityY)

drawScreenText

public ScriptUiOverlay.ScreenText drawScreenText(String text,
 double screenX,
 double screenY,
 Color color)

drawScreenText

public ScriptUiOverlay.ScreenText drawScreenText(String text,
 double screenX,
 double screenY,
 Color color,
 Font font,
 int durationMs)

showBanner

public void showBanner(String title,
 String subtitle,
 int durationMs)

clear

public void clear()

getFloatingTexts

public List<FloatingText> getFloatingTexts()

getScreenTexts

public List<ScriptUiOverlay.ScreenText> getScreenTexts()

update

public void update()

Description copied from interface: IUpdateable

This method is called by the game loop on all objects that are attached to the loop. It's called on every tick of the loop and the frequency can be configured using the ClientConfiguration.

Specified by:

update in interface IUpdateable

See Also:

• ClientConfiguration.setMaxFps(int)

render

public void render(Graphics2D g)

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Subscription

classapijava