Class CyclingOption<T>

java.lang.Object

net.uku3lig.ukulib.config.option.CyclingOption<T>

Type Parameters:

T - The type of the value

All Implemented Interfaces:

WidgetCreator

public class CyclingOption<T>
extends Object
implements WidgetCreator

An option type based on a finite amount of cycling values of the same type.

Field Summary

Fields

Modifier and Type	Field	Description
static final Function<Boolean, net.minecraft.network.chat.Component>	BOOL_TO_TEXT	Boolean to text converter.

Constructor Summary

Constructors

Constructor	Description
CyclingOption(String key, Collection<T> values, T initialValue, Consumer<T> setter, Function<T, net.minecraft.network.chat.Component> valueToText)	Constructs a new generic cycling option, with no tooltip.
CyclingOption(String key, Collection<T> values, T initialValue, Consumer<T> setter, Function<T, net.minecraft.network.chat.Component> valueToText, net.minecraft.client.OptionInstance.TooltipSupplier<@NotNull T> tooltipSupplier)	Constructs a new generic cycling option.
CyclingOption(String key, Collection<T> values, T initialValue, Consumer<T> setter, Function<T, net.minecraft.network.chat.Component> valueToText, net.minecraft.client.OptionInstance.TooltipSupplier<@NotNull T> tooltipSupplier, boolean active)	Constructs a new generic cycling option.

Method Summary

Modifier and Type	Method	Description
net.minecraft.client.gui.components.AbstractWidget	createWidget(int x, int y, int width, int height)	Creates the widget.
static <T extends Enum<T>> net.minecraft.network.chat.Component	enumNameToText(T value)	Returns a text that contains the name of the enum constant.
static CyclingOption<Boolean>	ofBoolean(String key, boolean initialValue, Consumer<Boolean> setter)	Creates a new boolean option, with an empty tooltip.
static CyclingOption<Boolean>	ofBoolean(String key, boolean initialValue, Consumer<Boolean> setter, net.minecraft.client.OptionInstance.TooltipSupplier<@NotNull Boolean> tooltipSupplier)	Creates a new boolean option.
static <T extends Enum<T>> CyclingOption<T>	ofEnum(String key, Class<T> klass, T initialValue, Consumer<T> setter)	Creates a new option based on an enum's values, with an empty tooltip.
static <T extends Enum<T>> CyclingOption<T>	ofEnum(String key, Class<T> klass, T initialValue, Consumer<T> setter, Function<T, net.minecraft.network.chat.Component> valueToText)	Creates a new option based on an enum's values, with an empty tooltip.
static <T extends Enum<T>> CyclingOption<T>	ofEnum(String key, Class<T> klass, T initialValue, Consumer<T> setter, Function<T, net.minecraft.network.chat.Component> valueToText, net.minecraft.client.OptionInstance.TooltipSupplier<@NotNull T> tooltipSupplier)	Creates a new option based on an enum's values.
static <T extends StringTranslatable> CyclingOption<T>	ofTranslatable(String key, Collection<T> values, T initialValue, Consumer<T> setter)	Creates a new option from a StringTranslatable, with an empty tooltip.
static <T extends StringTranslatable> CyclingOption<T>	ofTranslatable(String key, Collection<T> values, T initialValue, Consumer<T> setter, net.minecraft.client.OptionInstance.TooltipSupplier<@NotNull T> tooltipSupplier)	Creates a new option from a StringTranslatable.
static <T extends Enum<T> & StringTranslatable> CyclingOption<T>	ofTranslatableEnum(String key, Class<T> klass, T initialValue, Consumer<T> setter)	Creates a new option based on a translatable enum's values, with an empty tooltip.
static <T extends Enum<T> & StringTranslatable> CyclingOption<T>	ofTranslatableEnum(String key, Class<T> klass, T initialValue, Consumer<T> setter, net.minecraft.client.OptionInstance.TooltipSupplier<@NotNull T> tooltipSupplier)	Creates a new option based on a translatable enum's values.

Methods inherited from class Object

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

Methods inherited from interface WidgetCreator

createWidget, wide

Field Details

BOOL_TO_TEXT

public static final Function<Boolean, net.minecraft.network.chat.Component> BOOL_TO_TEXT

Boolean to text converter.

Constructor Details

CyclingOption

public CyclingOption(String key,
 Collection<T> values,
 T initialValue,
 Consumer<T> setter,
 Function<T, net.minecraft.network.chat.Component> valueToText,
 net.minecraft.client.OptionInstance.TooltipSupplier<@NotNull T> tooltipSupplier,
 boolean active)

Constructs a new generic cycling option.

Parameters:

key - The translation key

values - The possible option values

initialValue - The initial displayed value

setter - The callback for the modified value

valueToText - The function that converts the value to human-readable text

tooltipSupplier - The tooltip supplier

active - Whether the button can be clicked

CyclingOption

public CyclingOption(String key,
 Collection<T> values,
 T initialValue,
 Consumer<T> setter,
 Function<T, net.minecraft.network.chat.Component> valueToText,
 net.minecraft.client.OptionInstance.TooltipSupplier<@NotNull T> tooltipSupplier)

Constructs a new generic cycling option.

Parameters:

key - The translation key

values - The possible option values

initialValue - The initial displayed value

setter - The callback for the modified value

valueToText - The function that converts the value to human-readable text

tooltipSupplier - The tooltip supplier

CyclingOption

public CyclingOption(String key,
 Collection<T> values,
 T initialValue,
 Consumer<T> setter,
 Function<T, net.minecraft.network.chat.Component> valueToText)

Constructs a new generic cycling option, with no tooltip.

Parameters:

key - The translation key

values - The possible option values

initialValue - The initial displayed value

setter - The callback for the modified value

valueToText - The function that converts the value to human-readable text

See Also:

• CyclingOption(String, Collection, Object, Consumer, Function, OptionInstance.TooltipSupplier)

Method Details

ofBoolean

public static CyclingOption<Boolean> ofBoolean(String key,
 boolean initialValue,
 Consumer<Boolean> setter,
 net.minecraft.client.OptionInstance.TooltipSupplier<@NotNull Boolean> tooltipSupplier)

Creates a new boolean option.

Parameters:

key - The translation key

initialValue - The initial boolean value

setter - The callback for the modified value

tooltipSupplier - The tooltip supplier

Returns:

The newly constructed option

ofBoolean

public static CyclingOption<Boolean> ofBoolean(String key,
 boolean initialValue,
 Consumer<Boolean> setter)

Creates a new boolean option, with an empty tooltip.

Parameters:

key - The translation key

initialValue - The initial boolean value

setter - The callback for the modified value

Returns:

The newly constructed option

See Also:

• ofBoolean(String, boolean, Consumer, OptionInstance.TooltipSupplier)

ofTranslatable

public static <T extends StringTranslatable>
CyclingOption<T> ofTranslatable(String key,
 Collection<T> values,
 T initialValue,
 Consumer<T> setter,
 net.minecraft.client.OptionInstance.TooltipSupplier<@NotNull T> tooltipSupplier)

Creates a new option from a StringTranslatable.

Type Parameters:

T - The type of the option

Parameters:

key - The translation key

values - The values to be displayed

initialValue - The initial value

setter - The callback for the modified value

tooltipSupplier - The tooltip supplier

Returns:

The newly constructed option

ofTranslatable

public static <T extends StringTranslatable>
CyclingOption<T> ofTranslatable(String key,
 Collection<T> values,
 T initialValue,
 Consumer<T> setter)

Creates a new option from a StringTranslatable, with an empty tooltip.

Type Parameters:

T - The type of the option

Parameters:

key - The translation key

values - The values to be displayed

initialValue - The initial value

setter - The callback for the modified value

Returns:

The newly constructed option

ofEnum

public static <T extends Enum<T>> CyclingOption<T> ofEnum(String key,
 Class<T> klass,
 T initialValue,
 Consumer<T> setter,
 Function<T, net.minecraft.network.chat.Component> valueToText,
 net.minecraft.client.OptionInstance.TooltipSupplier<@NotNull T> tooltipSupplier)

Creates a new option based on an enum's values.

Type Parameters:

T - The type of the enum

Parameters:

key - The translation key

klass - The class type of the enum

initialValue - The initial value

setter - The callback for the modified value

valueToText - The function that converts the value to human-readable text

tooltipSupplier - The tooltip supplier

Returns:

The newly created option

ofEnum

public static <T extends Enum<T>> CyclingOption<T> ofEnum(String key,
 Class<T> klass,
 T initialValue,
 Consumer<T> setter,
 Function<T, net.minecraft.network.chat.Component> valueToText)

Creates a new option based on an enum's values, with an empty tooltip.

Type Parameters:

T - The type of the enum

Parameters:

key - The translation key

klass - The class type of the enum

initialValue - The initial value

setter - The callback for the modified value

valueToText - The function that converts the value to human-readable text

Returns:

The newly created option

See Also:

• ofEnum(String, Class, Enum, Consumer, Function, OptionInstance.TooltipSupplier)

ofEnum

public static <T extends Enum<T>> CyclingOption<T> ofEnum(String key,
 Class<T> klass,
 T initialValue,
 Consumer<T> setter)

Creates a new option based on an enum's values, with an empty tooltip. The value text is the constant's name.

Type Parameters:

T - The type of the enum

Parameters:

key - The translation key

klass - The class type of the enum

initialValue - The initial value

setter - The callback for the modified value

Returns:

The newly created option

See Also:

• ofEnum(String, Class, Enum, Consumer, Function, OptionInstance.TooltipSupplier)
• enumNameToText(Enum)

ofTranslatableEnum

public static <T extends Enum<T> & StringTranslatable>
CyclingOption<T> ofTranslatableEnum(String key,
 Class<T> klass,
 T initialValue,
 Consumer<T> setter,
 net.minecraft.client.OptionInstance.TooltipSupplier<@NotNull T> tooltipSupplier)

Creates a new option based on a translatable enum's values.

Type Parameters:

T - The type of the enum

Parameters:

key - The translation key

klass - The class type of the enum

initialValue - The initial value

setter - The callback for the modified value

tooltipSupplier - The tooltip supplier

Returns:

The newly created option

ofTranslatableEnum

public static <T extends Enum<T> & StringTranslatable>
CyclingOption<T> ofTranslatableEnum(String key,
 Class<T> klass,
 T initialValue,
 Consumer<T> setter)

Creates a new option based on a translatable enum's values, with an empty tooltip.

Type Parameters:

T - The type of the enum

Parameters:

key - The translation key

klass - The class type of the enum

initialValue - The initial value

setter - The callback for the modified value

Returns:

The newly created option

See Also:

• ofTranslatableEnum(String, Class, Enum, Consumer, OptionInstance.TooltipSupplier)

createWidget

public net.minecraft.client.gui.components.AbstractWidget createWidget(int x,
 int y,
 int width,
 int height)

Description copied from interface: WidgetCreator

Creates the widget.

Specified by:

createWidget in interface WidgetCreator

Parameters:

x - The x position

y - The y position

width - The widget width

height - The widget height

Returns:

The created widget

enumNameToText

public static <T extends Enum<T>>
net.minecraft.network.chat.Component enumNameToText(T value)

Returns a text that contains the name of the enum constant.

Type Parameters:

T - The type of the enum

Parameters:

value - The enum constant

Returns:

The text