Package net.minecraft.client.gui.components

Class CycleButton<T>

java.lang.Object

net.minecraft.client.gui.components.AbstractWidget

net.minecraft.client.gui.components.AbstractButton

net.minecraft.client.gui.components.CycleButton<T>

All Implemented Interfaces:

GuiEventListener, Renderable, TabOrderedElement, LayoutElement, NarratableEntry, NarrationSupplier, IAbstractWidgetExtension

public class CycleButton<T>
extends AbstractButton

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CycleButton.Builder<T>
static interface	CycleButton.OnValueChange<T>
static interface	CycleButton.ValueListSupplier<T>

Nested classes/interfaces inherited from interface net.minecraft.client.gui.narration.NarratableEntry

NarratableEntry.NarrationPriority

Field Summary

Fields

Modifier and Type	Field	Description
private static final List<Boolean>	BOOLEAN_OPTIONS
static final BooleanSupplier	DEFAULT_ALT_LIST_SELECTOR
private final boolean	displayOnlyValue
private int	index
private final Component	name
private final Function<CycleButton<T>,MutableComponent>	narrationProvider
private final CycleButton.OnValueChange<T>	onValueChange
private final OptionInstance.TooltipSupplier<T>	tooltipSupplier
private T	value
private final CycleButton.ValueListSupplier<T>	values
private final Function<T,Component>	valueStringifier

Fields inherited from class net.minecraft.client.gui.components.AbstractButton

SPRITES, TEXT_MARGIN

Fields inherited from class net.minecraft.client.gui.components.AbstractWidget

active, alpha, height, isHovered, packedFGColor, UNSET_FG_COLOR, visible, width

Fields inherited from interface net.minecraft.client.gui.components.events.GuiEventListener

DOUBLE_CLICK_THRESHOLD_MS

Constructor Summary

Constructors

Constructor	Description
CycleButton(int pX, int pY, int pWidth, int pHeight, Component pMessage, Component pName, int pIndex, T pValue, CycleButton.ValueListSupplier<T> pValues, Function<T,Component> pValueStringifier, Function<CycleButton<T>,MutableComponent> pNarrationProvider, CycleButton.OnValueChange<T> pOnValueChange, OptionInstance.TooltipSupplier<T> pTooltipSupplier, boolean pDisplayOnlyValue)

Method Summary

Modifier and Type	Method	Description
static CycleButton.Builder<Boolean>	booleanBuilder(Component pComponentOn, Component pComponentOff)
static <T> CycleButton.Builder<T>	builder(Function<T,Component> pValueStringifier)
MutableComponent	createDefaultNarrationMessage()
private MutableComponent	createFullName(T pValue)
private Component	createLabelForValue(T pValue)
protected MutableComponent	createNarrationMessage()
private void	cycleValue(int pDelta)
private T	getCycledValue(int pDelta)
T	getValue()
boolean	mouseScrolled(double pMouseX, double pMouseY, double pScrollX, double pScrollY)
static CycleButton.Builder<Boolean>	onOffBuilder()
static CycleButton.Builder<Boolean>	onOffBuilder(boolean pInitialValue)
void	onPress()
void	setValue(T pValue)
private void	updateTooltip()
private void	updateValue(T pValue)
void	updateWidgetNarration(NarrationElementOutput pNarrationElementOutput)

Methods inherited from class net.minecraft.client.gui.components.AbstractButton

keyPressed, onClick, renderString, renderWidget

Methods inherited from class net.minecraft.client.gui.components.AbstractWidget

clearFGColor, clicked, defaultButtonNarrationText, getBottom, getFGColor, getHeight, getMessage, getRectangle, getRight, getTabOrderGroup, getTooltip, getWidth, getX, getY, isActive, isFocused, isHovered, isHoveredOrFocused, isMouseOver, isValidClickButton, mouseClicked, mouseDragged, mouseReleased, narrationPriority, nextFocusPath, onDrag, onRelease, playDownSound, render, renderScrollingString, renderScrollingString, renderScrollingString, setAlpha, setFGColor, setFocused, setHeight, setMessage, setRectangle, setSize, setTabOrderGroup, setTooltip, setTooltipDelay, setWidth, setX, setY, updateNarration, visitWidgets, wrapDefaultNarrationMessage

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.minecraft.client.gui.components.events.GuiEventListener

charTyped, getCurrentFocusPath, keyReleased, mouseMoved

Methods inherited from interface net.neoforged.neoforge.client.extensions.IAbstractWidgetExtension

onClick

Methods inherited from interface net.minecraft.client.gui.layouts.LayoutElement

setPosition

Field Details

DEFAULT_ALT_LIST_SELECTOR

public static final BooleanSupplier DEFAULT_ALT_LIST_SELECTOR

BOOLEAN_OPTIONS

private static final List<Boolean> BOOLEAN_OPTIONS

name

private final Component name

index

private int index

value

private T value

values

private final CycleButton.ValueListSupplier<T> values

valueStringifier

private final Function<T,Component> valueStringifier

narrationProvider

private final Function<CycleButton<T>,MutableComponent> narrationProvider

onValueChange

private final CycleButton.OnValueChange<T> onValueChange

displayOnlyValue

private final boolean displayOnlyValue

tooltipSupplier

private final OptionInstance.TooltipSupplier<T> tooltipSupplier

Constructor Details

CycleButton

CycleButton(int pX,
 int pY,
 int pWidth,
 int pHeight,
 Component pMessage,
 Component pName,
 int pIndex,
 T pValue,
 CycleButton.ValueListSupplier<T> pValues,
 Function<T,Component> pValueStringifier,
 Function<CycleButton<T>,MutableComponent> pNarrationProvider,
 CycleButton.OnValueChange<T> pOnValueChange,
 OptionInstance.TooltipSupplier<T> pTooltipSupplier,
 boolean pDisplayOnlyValue)

Method Details

updateTooltip

private void updateTooltip()

onPress

public void onPress()

Specified by:

onPress in class AbstractButton

cycleValue

private void cycleValue(int pDelta)

getCycledValue

private T getCycledValue(int pDelta)

mouseScrolled

public boolean mouseScrolled(double pMouseX,
 double pMouseY,
 double pScrollX,
 double pScrollY)

setValue

public void setValue(T pValue)

updateValue

private void updateValue(T pValue)

createLabelForValue

private Component createLabelForValue(T pValue)

createFullName

private MutableComponent createFullName(T pValue)

getValue

public T getValue()

createNarrationMessage

protected MutableComponent createNarrationMessage()

Overrides:

createNarrationMessage in class AbstractWidget

updateWidgetNarration

public void updateWidgetNarration(NarrationElementOutput pNarrationElementOutput)

Specified by:

updateWidgetNarration in class AbstractWidget

createDefaultNarrationMessage

public MutableComponent createDefaultNarrationMessage()

builder

public static <T> CycleButton.Builder<T> builder(Function<T,Component> pValueStringifier)

booleanBuilder

public static CycleButton.Builder<Boolean> booleanBuilder(Component pComponentOn,
 Component pComponentOff)

onOffBuilder

public static CycleButton.Builder<Boolean> onOffBuilder()

onOffBuilder

public static CycleButton.Builder<Boolean> onOffBuilder(boolean pInitialValue)