Cycle

Cycle steps through a few fixed values, one per click, showing the current one after its label like vanilla's Graphics button. Ideal for enums.

A button that steps through a fixed list of values, shown as "label: value" like vanilla's option buttons (for example "Graphics: Fancy"). Each click selects the next value, wrapping around after the last. Good for a handful of values, typically an enum.

Cycle.<Mode>builder("mode")
        .label(Text.translatable("mymod.mode", "Mode"))
        .values(Arrays.asList(Mode.values()))
        .value(() -> config.mode)
        .valueText(m -> Text.translatable("mymod.mode." + m.name().toLowerCase(Locale.ROOT), m.name()))
        .onChange(m -> config.mode = m)
        .build();

Builder#

build() throws if a required field is missing or values is empty.

Behaviour#

• Values are compared with equals. A current value that isn't in the list shows as the first one, and the next click selects the second.
• Later changes to the list you passed don't show; build the screen again to offer different values.
• Use translatable text in valueText for enum constants, so each value can be translated.
• For long lists use a Dropdown, which has the same builder.
• Footer: yes.

Test it#

host.click("mode");                    // selects the next value

Rendered as [cycle mode] Mode: Balanced.

See also#

• Javadoc: Cycle