Slider

Slider is a vanilla slider over a range of numbers with an optional step and custom value text, like the game's FOV and volume sliders.

A vanilla slider over a range of numbers, showing "label: value" on the slider itself, like vanilla's FOV or volume sliders. The player drags the knob, clicks the track, or uses the arrow keys while it is focused.

// Whole numbers: step 1, cast in onChange
Slider.builder("renderDistance")
        .label(Text.translatable("mymod.distance", "Distance"))
        .range(2, 32).step(1)
        .value(() -> config.distance)
        .onChange(v -> config.distance = (int) v)
        .build();

// A fraction shown as a percentage
Slider.builder("opacity")
        .label(Text.translatable("mymod.opacity", "Opacity"))
        .range(0, 1).step(0.05)
        .value(() -> config.opacity)
        .valueText(v -> Text.literal(Math.round(v * 100) + "%"))
        .onChange(v -> config.opacity = v)
        .build();

Builder#

build() throws if a required field is missing, the range is empty or infinite, or the step is negative or larger than the range.

Behaviour#

• Values are doubles in [min, max]. With a step they are min + k * step; if the step doesn't divide the range, the highest value is the last step below max.
• onChange runs for every distinct snapped value while the player drags, not only on release, and only when the value changes. Keep it fast; save to disk from the screen's Done button.
• A value outside the range shows clamped.
• An arrow key moves the value by one step, or by 1% of the range without a step.
• The default text has as many decimals as the step (none for whole steps, two without a step), so 12 or 0.25. Use valueText for units or names: v -> Text.literal((int) v + " chunks"), or v -> v == 0 ? Text.translatable("mymod.off", "Off") : Text.literal(String.valueOf((int) v)).
• Steps such as 0.1 give exact values (0.3, not 0.30000000000000004).
• Footer: no.

Test it#

host.slide("renderDistance", 12);      // snapped and clamped as a drag would be

Rendered as [slider renderDistance] Distance: 12.

See also#

• Javadoc: Slider
• NumberField: for a number the player types exactly.