ClickableWidgetHelper
com.jsmacrosce.jsmacros.client.api.helper.screen.ClickableWidgetHelper
Wraps a game widget so scripts can inspect and control it; other widget helpers extend this base. Use the Widgets types, such as Widgets.Button and Widgets.Slider, to identify a specific widget helper.
Each helper refers to its wrapped widget, so changes through a helper affect that widget. Screens may return new helpers for the same widget on separate queries.
Tooltips and zIndex are held by the helper for JsMacros' rendering; the wrapped widget state comes from the game.
A script builds its own widgets with a builder rather than by hand: IScreen.buttonBuilder() and its siblings hand back a builder whose build() puts the widget on the screen and gives the helper to go on with. Because opening a screen clears earlier elements, build widgets inside IScreen.setOnInit.
js
// a button on a screen of the script's own
const screen = Hud.createScreen("a screen", true);
screen.setOnInit(JavaWrapper.methodToJava(function (self) {
self.buttonBuilder()
.pos(10, 20)
.size(100, 20)
.message("press me")
.action(JavaWrapper.methodToJava(function (btn) {
// the callback is given the button, so it can change the button
btn.setLabel("pressed");
btn.setActive(false);
}))
.build();
// and the same button widget, wrapped as the screen hands it over
for (const widget of self.getButtonWidgets()) {
if (!(widget instanceof Widgets.Button)) continue;
Chat.log(`button ${widget.getLabel()} at ${widget.getX()}, ${widget.getY()}`);
}
}));
Hud.openScreen(screen);Available in scripts as Widgets.Clickable.
Type Parameters
B: the concrete helper type, used for fluent method returnsT: the wrapped Minecraft widget type
Constructors
new ClickableWidgetHelper
new ClickableWidgetHelper(T extends AbstractWidget btn)#Wraps
btn with z-index 0 and an empty tooltip list.Parameters:
btn: the widget to wrap
new ClickableWidgetHelper(T extends AbstractWidget btn, int zIndex)#Wraps
btn with the supplied helper draw-ordering value and an empty tooltip list.Parameters:
btn: the widget to wrapzIndex: the helper's draw-ordering value
Fields
tooltips
zIndex
zIndex: int#The value used by this helper's screen for widget draw ordering.
Methods
addTooltip
appends a tooltip, preserving insertion order. TextBuilder and TextHelper values retain styling; other values are converted with
toString() to plain text.Parameters:
tooltip: the tooltip to add
Returns: self for chaining.
click
sends a left-button press and release at the widget's top-left coordinates. Off the client thread, waits for the queued input task to run; on the client thread it runs immediately.
Returns: self for chaining.
sends a left-button press and release at the widget's top-left coordinates. Off the client thread, queues the input task;
await controls whether this call waits for that task. On the client thread, the input runs immediately and the flag has no effect.Parameters:
await: should wait for button to finish clicking.
Returns: self for chaining.
clickedOn
Marks the next release to be skipped on a container screen. Other screen types are unchanged.
const screen = Hud.createScreen("a screen", true);
screen.setOnInit(JavaWrapper.methodToJava(function (self) {
self.buttonBuilder()
.pos(10, 20)
.size(100, 20)
.message("press me")
.action(JavaWrapper.methodToJava(function (btn) {
Widgets.Clickable.clickedOn(self);
}))
.build();
}));
Hud.openScreen(screen);Parameters:
screen: the screen the widget belongs to
getActive
returns the widget's active flag. Inactive widgets reject mouse clicks; this flag does not indicate whether the button's action will succeed.
Returns: button clickable state.
getHeight
Returns the widget's height in pixels.
Returns: the height of the button in pixels.
getLabel
returns the button's label as a text wrapper, preserving its styling. Use
getStringStripFormatting() on the result for plain text without formatting.Returns: current button text.
getParentHeight
Returns the open screen's height for parent-relative alignment. Requires an open screen.
Returns: the height of the parent element
getParentWidth
Returns the open screen's width for parent-relative alignment. Requires an open screen.
Returns: the width of the parent element
getScaledHeight
Returns the widget height used by alignment; this helper applies no scaling.
Returns: the scaled height of the widget
getScaledLeft
Returns the widget's
x coordinate; this helper applies no scaling.Returns: the position of the scaled element's left side
getScaledTop
Returns the widget's top edge; this class has no scaling, so it is its
y coordinate.Returns: the top edge in screen-coordinate pixels
getScaledWidth
Returns the widget width used by alignment; this helper applies no scaling.
Returns: the scaled width of the widget
getTooltips
Returns wrappers for the current tooltips in insertion order. The returned list is independent; modifying it does not change the widget.
Returns: a copy of the tooltips.
getWidth
Returns the widget's width in pixels.
Returns: the width of the button in pixels.
getX
Returns the widget's left edge in screen-coordinate pixels.
Returns: the
x coordinate of the button.getY
Returns the widget's top edge in screen-coordinate pixels.
Returns: the
y coordinate of the button.getZIndex
Returns this helper's z-index, used by its screen for widget draw ordering.
Returns: the z-index of this widget
moveTo
Moves the widget to the given screen-coordinate pixel position without changing its size. This is equivalent to setPos(int, int) and supports the alignment methods.
Parameters:
x: the new x positiony: the new y position
Returns: self for chaining.
removeTooltip
Removes the tooltip at the zero-based index. An invalid index returns
false; duplicate tooltips can be distinguished by their positions.Parameters:
index: the index of the tooltip to remove
Returns:
true if the tooltip was removed successfully, false otherwise.Removes the first tooltip whose underlying text component equals the supplied component. Returns
false if no match exists.Parameters:
tooltip: the tooltip to remove
Returns:
true if the tooltip was removed successfully, false otherwise.render
Renders the wrapped widget and requests tooltip rendering when the pointer is over it and its tooltip list is non-empty.
Parameters:
drawContext: the graphics the widget is drawn intomouseX: the pointer's position on the x axismouseY: the pointer's position on the y axisdelta: how far through the current tick the drawing is
setActive
sets the widget's active flag, controlling whether it accepts mouse clicks.
Parameters:
t: whether the button should be clickable
Returns: self for chaining.
setLabel
setLabel(TextHelper helper): B extends ClickableWidgetHelper<B, T extends AbstractWidget>Since1.3.1#Sets the label from the supplied text component, preserving its styling.
Parameters:
helper: the styled text to show on the button
Returns: self for chaining.
setPos
Moves the widget to the given screen-coordinate pixel position without changing its size.
Parameters:
x: the new left edgey: the new top edge
Returns: self for chaining.
setTooltip
setTooltip(Object... tooltips): B extends ClickableWidgetHelper<B, T extends AbstractWidget>Since1.8.4#replaces the helper's tooltip list. TextBuilder and TextHelper values retain styling; other values are converted with
toString() to plain text. The tooltip list is drawn while the widget is hovered.Parameters:
tooltips: the tooltips to set
Returns: self for chaining.
setWidth
sets the widget's width in pixels without changing its height.
Parameters:
width: the new width in pixels
Returns: self for chaining.