Interface HudEditorSetting

All Known Implementing Classes:

HudEditorSetting.Slider, HudEditorSetting.Toggle

public sealed interface HudEditorSetting
permits HudEditorSetting.Slider, HudEditorSetting.Toggle

Developer-defined control shown in the managed HUD editor while its owning HudLayoutElement is selected.

Settings are runtime bindings, not RenderLib-persisted configuration. Use a change callback to update and persist mod state, or bind a getter and setter directly to a retained HUD component property.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	HudEditorSetting.Slider	Named numeric slider setting.
static final class	HudEditorSetting.Toggle	Named boolean toggle setting.

Method Summary

Modifier and Type	Method	Description
String	name()	Returns the label shown beside the editor control.
static HudEditorSetting.Slider	slider(String name, double initialValue, double min, double max, double step, DoubleConsumer onChange)	Creates a slider backed by an initial value retained by the setting.
static HudEditorSetting.Slider	slider(String name, double min, double max, double step, DoubleSupplier getter, DoubleConsumer setter)	Creates a slider bound to a live property.
static HudEditorSetting.Toggle	toggle(String name, boolean initialValue, Consumer<Boolean> onChange)	Creates a toggle backed by an initial value retained by the setting.
static HudEditorSetting.Toggle	toggle(String name, BooleanSupplier getter, Consumer<Boolean> setter)	Creates a toggle bound to a live property.

Method Details

name

String name()

Returns the label shown beside the editor control.

Returns:

nonblank setting name

slider

static HudEditorSetting.Slider slider(String name,
 double initialValue,
 double min,
 double max,
 double step,
 DoubleConsumer onChange)

Creates a slider backed by an initial value retained by the setting.

Parameters:

name - label shown in the editor

initialValue - initial slider value

min - minimum value

max - maximum value

step - step size, or 0 for continuous values

onChange - callback invoked for player changes

Returns:

slider setting

slider

static HudEditorSetting.Slider slider(String name,
 double min,
 double max,
 double step,
 DoubleSupplier getter,
 DoubleConsumer setter)

Creates a slider bound to a live property.

The getter is sampled while the element is selected, so changes made elsewhere remain reflected in the control.

Parameters:

name - label shown in the editor

min - minimum value

max - maximum value

step - step size, or 0 for continuous values

getter - current property value

setter - property change callback

Returns:

slider setting

toggle

static HudEditorSetting.Toggle toggle(String name,
 boolean initialValue,
 Consumer<Boolean> onChange)

Creates a toggle backed by an initial value retained by the setting.

Parameters:

name - label shown in the editor

initialValue - initial toggle value

onChange - callback invoked for player changes

Returns:

toggle setting

toggle

static HudEditorSetting.Toggle toggle(String name,
 BooleanSupplier getter,
 Consumer<Boolean> setter)

Creates a toggle bound to a live property.

Parameters:

name - label shown in the editor

getter - current property value

setter - property change callback

Returns:

toggle setting