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 x, int y, int width, int height, Component message, Component name, int index, T value, CycleButton.ValueListSupplier<T> values, Function<T,Component> valueStringifier, Function<CycleButton<T>,MutableComponent> narrationProvider, CycleButton.OnValueChange<T> onValueChange, OptionInstance.TooltipSupplier<T> tooltipSupplier, boolean displayOnlyValue)
Method Summary

Modifier and Type

Method

Description

static CycleButton.Builder<Boolean>

booleanBuilder(Component componentOn, Component componentOff)

static <T> CycleButton.Builder<T>

builder(Function<T,Component> valueStringifier)

MutableComponent

createDefaultNarrationMessage()

private MutableComponent

createFullName(T value)

private Component

createLabelForValue(T value)

protected MutableComponent

createNarrationMessage()

private void

cycleValue(int delta)

private T

getCycledValue(int delta)

T

getValue()

boolean

mouseScrolled(double mouseX, double mouseY, double scrollX, double scrollY)

static CycleButton.Builder<Boolean>

onOffBuilder()

static CycleButton.Builder<Boolean>

onOffBuilder(boolean initialValue)

void

onPress()

void

setValue(T value)

private void

updateTooltip()

private void

updateValue(T value)

void

updateWidgetNarration(NarrationElementOutput narrationElementOutput)

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 x, int y, int width, int height, Component message, Component name, int index, T value, CycleButton.ValueListSupplier<T> values, Function<T,Component> valueStringifier, Function<CycleButton<T>,MutableComponent> narrationProvider, CycleButton.OnValueChange<T> onValueChange, OptionInstance.TooltipSupplier<T> tooltipSupplier, boolean displayOnlyValue)
Method Details
- updateTooltip
  
  private void updateTooltip()
- onPress
  
  public void onPress()
  
  Specified by:
  
  onPress in class AbstractButton
- cycleValue
  
  private void cycleValue(int delta)
- getCycledValue
  
  private T getCycledValue(int delta)
- mouseScrolled
  
  public boolean mouseScrolled(double mouseX, double mouseY, double scrollX, double scrollY)
- setValue
  
  public void setValue(T value)
- updateValue
  
  private void updateValue(T value)
- createLabelForValue
  
  private Component createLabelForValue(T value)
- createFullName
  
  private MutableComponent createFullName(T value)
- getValue
  
  public T getValue()
- createNarrationMessage
  
  protected MutableComponent createNarrationMessage()
  
  Overrides:
  
  createNarrationMessage in class AbstractWidget
- updateWidgetNarration
  
  public void updateWidgetNarration(NarrationElementOutput narrationElementOutput)
  
  Specified by:
  
  updateWidgetNarration in class AbstractWidget
- createDefaultNarrationMessage
  
  public MutableComponent createDefaultNarrationMessage()
- builder
  
  public static <T> CycleButton.Builder<T> builder(Function<T,Component> valueStringifier)
- booleanBuilder
  
  public static CycleButton.Builder<Boolean> booleanBuilder(Component componentOn, Component componentOff)
- onOffBuilder
  
  public static CycleButton.Builder<Boolean> onOffBuilder()
- onOffBuilder
  
  public static CycleButton.Builder<Boolean> onOffBuilder(boolean initialValue)

Class CycleButton<T>

Nested Class Summary

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

Field Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

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

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

Field Details

DEFAULT_ALT_LIST_SELECTOR

BOOLEAN_OPTIONS

name

index

value

values

valueStringifier

narrationProvider

onValueChange

displayOnlyValue

tooltipSupplier

Constructor Details

CycleButton

Method Details

updateTooltip

onPress

cycleValue

getCycledValue

mouseScrolled

setValue

updateValue

createLabelForValue

createFullName

getValue

createNarrationMessage

updateWidgetNarration

createDefaultNarrationMessage

builder

booleanBuilder

onOffBuilder

onOffBuilder