Package net.minecraft.client.gui.widget
Class CyclingButtonWidget<T>
java.lang.Object
net.minecraft.client.gui.DrawableHelper
net.minecraft.client.gui.widget.ClickableWidget
net.minecraft.client.gui.widget.PressableWidget
net.minecraft.client.gui.widget.CyclingButtonWidget<T>
- All Implemented Interfaces:
Drawable
,Element
,Narratable
,Selectable
,OrderableTooltip
@Environment(CLIENT)
public class CyclingButtonWidget<T>
extends PressableWidget
implements OrderableTooltip
- Mappings:
Namespace Name official ehv
intermediary net/minecraft/class_5676
named net/minecraft/client/gui/widget/CyclingButtonWidget
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
A builder to easily create cycling button widgets.static interface
static interface
Nested classes/interfaces inherited from interface net.minecraft.client.gui.Selectable
Selectable.SelectionType
-
Field Summary
Modifier and TypeFieldDescriptionprivate final CyclingButtonWidget.UpdateCallback<T>
(package private) static final BooleanSupplier
private int
private final Function<CyclingButtonWidget<T>,
MutableText> private final Text
private final boolean
private final SimpleOption.TooltipFactory<T>
private T
private final CyclingButtonWidget.Values<T>
Fields inherited from class net.minecraft.client.gui.widget.ClickableWidget
active, alpha, height, hovered, visible, WIDGETS_TEXTURE, width, x, y
Fields inherited from class net.minecraft.client.gui.DrawableHelper
GUI_ICONS_TEXTURE, OPTIONS_BACKGROUND_TEXTURE, STATS_ICON_TEXTURE
Fields inherited from interface net.minecraft.client.gui.Element
MAX_DOUBLE_CLICK_INTERVAL
-
Constructor Summary
ConstructorDescriptionCyclingButtonWidget
(int x, int y, int width, int height, Text message, Text optionText, int index, T value, CyclingButtonWidget.Values<T> values, Function<T, Text> valueToText, Function<CyclingButtonWidget<T>, MutableText> narrationMessageFactory, CyclingButtonWidget.UpdateCallback<T> callback, SimpleOption.TooltipFactory<T> tooltipFactory, boolean optionTextOmitted) -
Method Summary
Modifier and TypeMethodDescriptionvoid
appendNarrations
(NarrationMessageBuilder builder) static <T> CyclingButtonWidget.Builder<T>
Creates a new builder for a cycling button widget.private MutableText
composeGenericOptionText
(T value) private Text
composeText
(T value) private void
cycle
(int amount) Returns a generic narration message for this button.protected MutableText
getValue()
private T
getValue
(int offset) private void
internalSetValue
(T value) boolean
mouseScrolled
(double mouseX, double mouseY, double amount) Callback for when a mouse button scroll event has been captured.static CyclingButtonWidget.Builder<Boolean>
Creates a builder for a cycling button widget that only has Boolean.TRUE and Boolean.FALSE values.static CyclingButtonWidget.Builder<Boolean>
onOffBuilder
(boolean initialValue) Creates a builder for a cycling button widget that only has Boolean.TRUE and Boolean.FALSE values.static CyclingButtonWidget.Builder<Boolean>
onOffBuilder
(Text on, Text off) Creates a builder for a cycling button widget that only has Boolean.TRUE and Boolean.FALSE values.void
onPress()
void
Methods inherited from class net.minecraft.client.gui.widget.PressableWidget
keyPressed, onClick
Methods inherited from class net.minecraft.client.gui.widget.ClickableWidget
appendDefaultNarrations, changeFocus, clicked, getHeight, getMessage, getNarrationMessage, getType, getWidth, getYImage, isFocused, isHovered, isMouseOver, isNarratable, isValidClickButton, mouseClicked, mouseDragged, mouseReleased, onDrag, onFocusedChanged, onRelease, playDownSound, render, renderBackground, renderButton, renderTooltip, setAlpha, setFocused, setMessage, setWidth
Methods inherited from class net.minecraft.client.gui.DrawableHelper
disableScissor, drawCenteredText, drawCenteredText, drawCenteredTextWithShadow, drawHorizontalLine, drawSprite, drawStringWithShadow, drawTexture, drawTexture, drawTexture, drawTexture, drawTextWithShadow, drawVerticalLine, drawWithOutline, drawWithShadow, enableScissor, fill, fillGradient, fillGradient, fillGradient, getZOffset, setZOffset
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.Element
charTyped, keyReleased, mouseMoved
-
Field Details
-
HAS_ALT_DOWN
- Mappings:
Namespace Name Mixin selector official a
Lehv;a:Ljava/util/function/BooleanSupplier;
intermediary field_27961
Lnet/minecraft/class_5676;field_27961:Ljava/util/function/BooleanSupplier;
named HAS_ALT_DOWN
Lnet/minecraft/client/gui/widget/CyclingButtonWidget;HAS_ALT_DOWN:Ljava/util/function/BooleanSupplier;
-
BOOLEAN_VALUES
- Mappings:
Namespace Name Mixin selector official b
Lehv;b:Ljava/util/List;
intermediary field_27962
Lnet/minecraft/class_5676;field_27962:Ljava/util/List;
named BOOLEAN_VALUES
Lnet/minecraft/client/gui/widget/CyclingButtonWidget;BOOLEAN_VALUES:Ljava/util/List;
-
optionText
- Mappings:
Namespace Name Mixin selector official c
Lehv;c:Lrq;
intermediary field_27963
Lnet/minecraft/class_5676;field_27963:Lnet/minecraft/class_2561;
named optionText
Lnet/minecraft/client/gui/widget/CyclingButtonWidget;optionText:Lnet/minecraft/text/Text;
-
index
private int index- Mappings:
Namespace Name Mixin selector official d
Lehv;d:I
intermediary field_27964
Lnet/minecraft/class_5676;field_27964:I
named index
Lnet/minecraft/client/gui/widget/CyclingButtonWidget;index:I
-
value
- Mappings:
Namespace Name Mixin selector official e
Lehv;e:Ljava/lang/Object;
intermediary field_27965
Lnet/minecraft/class_5676;field_27965:Ljava/lang/Object;
named value
Lnet/minecraft/client/gui/widget/CyclingButtonWidget;value:Ljava/lang/Object;
-
values
- Mappings:
Namespace Name Mixin selector official f
Lehv;f:Lehv$c;
intermediary field_27966
Lnet/minecraft/class_5676;field_27966:Lnet/minecraft/class_5676$class_5680;
named values
Lnet/minecraft/client/gui/widget/CyclingButtonWidget;values:Lnet/minecraft/client/gui/widget/CyclingButtonWidget$Values;
-
valueToText
- Mappings:
Namespace Name Mixin selector official s
Lehv;s:Ljava/util/function/Function;
intermediary field_27967
Lnet/minecraft/class_5676;field_27967:Ljava/util/function/Function;
named valueToText
Lnet/minecraft/client/gui/widget/CyclingButtonWidget;valueToText:Ljava/util/function/Function;
-
narrationMessageFactory
- Mappings:
Namespace Name Mixin selector official t
Lehv;t:Ljava/util/function/Function;
intermediary field_27968
Lnet/minecraft/class_5676;field_27968:Ljava/util/function/Function;
named narrationMessageFactory
Lnet/minecraft/client/gui/widget/CyclingButtonWidget;narrationMessageFactory:Ljava/util/function/Function;
-
callback
- Mappings:
Namespace Name Mixin selector official u
Lehv;u:Lehv$b;
intermediary field_27969
Lnet/minecraft/class_5676;field_27969:Lnet/minecraft/class_5676$class_5678;
named callback
Lnet/minecraft/client/gui/widget/CyclingButtonWidget;callback:Lnet/minecraft/client/gui/widget/CyclingButtonWidget$UpdateCallback;
-
tooltipFactory
- Mappings:
Namespace Name Mixin selector official v
Lehv;v:Lefx$l;
intermediary field_27970
Lnet/minecraft/class_5676;field_27970:Lnet/minecraft/class_7172$class_7277;
named tooltipFactory
Lnet/minecraft/client/gui/widget/CyclingButtonWidget;tooltipFactory:Lnet/minecraft/client/option/SimpleOption$TooltipFactory;
-
optionTextOmitted
private final boolean optionTextOmitted- Mappings:
Namespace Name Mixin selector official w
Lehv;w:Z
intermediary field_27971
Lnet/minecraft/class_5676;field_27971:Z
named optionTextOmitted
Lnet/minecraft/client/gui/widget/CyclingButtonWidget;optionTextOmitted:Z
-
-
Constructor Details
-
CyclingButtonWidget
CyclingButtonWidget(int x, int y, int width, int height, Text message, Text optionText, int index, T value, CyclingButtonWidget.Values<T> values, Function<T, Text> valueToText, Function<CyclingButtonWidget<T>, MutableText> narrationMessageFactory, CyclingButtonWidget.UpdateCallback<T> callback, SimpleOption.TooltipFactory<T> tooltipFactory, boolean optionTextOmitted) - Mappings:
Namespace Name Mixin selector official <init>
Lehv;<init>(IIIILrq;Lrq;ILjava/lang/Object;Lehv$c;Ljava/util/function/Function;Ljava/util/function/Function;Lehv$b;Lefx$l;Z)V
intermediary <init>
Lnet/minecraft/class_5676;<init>(IIIILnet/minecraft/class_2561;Lnet/minecraft/class_2561;ILjava/lang/Object;Lnet/minecraft/class_5676$class_5680;Ljava/util/function/Function;Ljava/util/function/Function;Lnet/minecraft/class_5676$class_5678;Lnet/minecraft/class_7172$class_7277;Z)V
named <init>
Lnet/minecraft/client/gui/widget/CyclingButtonWidget;<init>(IIIILnet/minecraft/text/Text;Lnet/minecraft/text/Text;ILjava/lang/Object;Lnet/minecraft/client/gui/widget/CyclingButtonWidget$Values;Ljava/util/function/Function;Ljava/util/function/Function;Lnet/minecraft/client/gui/widget/CyclingButtonWidget$UpdateCallback;Lnet/minecraft/client/option/SimpleOption$TooltipFactory;Z)V
-
-
Method Details
-
onPress
public void onPress()- Specified by:
onPress
in classPressableWidget
- Mappings:
Namespace Name Mixin selector official d
Lehi;d()V
intermediary method_25306
Lnet/minecraft/class_4264;method_25306()V
named onPress
Lnet/minecraft/client/gui/widget/PressableWidget;onPress()V
-
cycle
private void cycle(int amount) - Mappings:
Namespace Name Mixin selector official c
Lehv;c(I)V
intermediary method_32612
Lnet/minecraft/class_5676;method_32612(I)V
named cycle
Lnet/minecraft/client/gui/widget/CyclingButtonWidget;cycle(I)V
-
getValue
- Mappings:
Namespace Name Mixin selector official e
Lehv;e(I)Ljava/lang/Object;
intermediary method_37027
Lnet/minecraft/class_5676;method_37027(I)Ljava/lang/Object;
named getValue
Lnet/minecraft/client/gui/widget/CyclingButtonWidget;getValue(I)Ljava/lang/Object;
-
mouseScrolled
public boolean mouseScrolled(double mouseX, double mouseY, double amount) Callback for when a mouse button scroll event has been captured.- Specified by:
mouseScrolled
in interfaceElement
- Parameters:
mouseX
- the X coordinate of the mousemouseY
- the Y coordinate of the mouseamount
- value is< 0
if scrolled down,> 0
if scrolled up- Returns:
true
to indicate that the event handling is successful/valid- See Also:
- Mappings:
Namespace Name Mixin selector official a
Leir;a(DDD)Z
intermediary method_25401
Lnet/minecraft/class_364;method_25401(DDD)Z
named mouseScrolled
Lnet/minecraft/client/gui/Element;mouseScrolled(DDD)Z
-
setValue
- Mappings:
Namespace Name Mixin selector official a
Lehv;a(Ljava/lang/Object;)V
intermediary method_32605
Lnet/minecraft/class_5676;method_32605(Ljava/lang/Object;)V
named setValue
Lnet/minecraft/client/gui/widget/CyclingButtonWidget;setValue(Ljava/lang/Object;)V
-
internalSetValue
- Mappings:
Namespace Name Mixin selector official b
Lehv;b(Ljava/lang/Object;)V
intermediary method_32609
Lnet/minecraft/class_5676;method_32609(Ljava/lang/Object;)V
named internalSetValue
Lnet/minecraft/client/gui/widget/CyclingButtonWidget;internalSetValue(Ljava/lang/Object;)V
-
composeText
- Mappings:
Namespace Name Mixin selector official c
Lehv;c(Ljava/lang/Object;)Lrq;
intermediary method_37026
Lnet/minecraft/class_5676;method_37026(Ljava/lang/Object;)Lnet/minecraft/class_2561;
named composeText
Lnet/minecraft/client/gui/widget/CyclingButtonWidget;composeText(Ljava/lang/Object;)Lnet/minecraft/text/Text;
-
composeGenericOptionText
- Mappings:
Namespace Name Mixin selector official d
Lehv;d(Ljava/lang/Object;)Lsb;
intermediary method_32610
Lnet/minecraft/class_5676;method_32610(Ljava/lang/Object;)Lnet/minecraft/class_5250;
named composeGenericOptionText
Lnet/minecraft/client/gui/widget/CyclingButtonWidget;composeGenericOptionText(Ljava/lang/Object;)Lnet/minecraft/text/MutableText;
-
getValue
- Mappings:
Namespace Name Mixin selector official a
Lehv;a()Ljava/lang/Object;
intermediary method_32603
Lnet/minecraft/class_5676;method_32603()Ljava/lang/Object;
named getValue
Lnet/minecraft/client/gui/widget/CyclingButtonWidget;getValue()Ljava/lang/Object;
-
getNarrationMessage
- Overrides:
getNarrationMessage
in classClickableWidget
- Mappings:
Namespace Name Mixin selector official ai_
Lehn;ai_()Lsb;
intermediary method_25360
Lnet/minecraft/class_339;method_25360()Lnet/minecraft/class_5250;
named getNarrationMessage
Lnet/minecraft/client/gui/widget/ClickableWidget;getNarrationMessage()Lnet/minecraft/text/MutableText;
-
appendNarrations
- Specified by:
appendNarrations
in interfaceNarratable
- Mappings:
Namespace Name Mixin selector official a
Lejw;a(Lejv;)V
intermediary method_37020
Lnet/minecraft/class_6383;method_37020(Lnet/minecraft/class_6382;)V
named appendNarrations
Lnet/minecraft/client/gui/Narratable;appendNarrations(Lnet/minecraft/client/gui/screen/narration/NarrationMessageBuilder;)V
-
getGenericNarrationMessage
Returns a generic narration message for this button.If the button omits the option text in rendering, such as showing only "Value", this narration message will still read out the option like "Option: Value".
- Returns:
- a generic narration message for this button
- Mappings:
Namespace Name Mixin selector official b
Lehv;b()Lsb;
intermediary method_32611
Lnet/minecraft/class_5676;method_32611()Lnet/minecraft/class_5250;
named getGenericNarrationMessage
Lnet/minecraft/client/gui/widget/CyclingButtonWidget;getGenericNarrationMessage()Lnet/minecraft/text/MutableText;
-
getOrderedTooltip
- Specified by:
getOrderedTooltip
in interfaceOrderableTooltip
- Mappings:
Namespace Name Mixin selector official c
Leil;c()Ljava/util/List;
intermediary method_31047
Lnet/minecraft/class_5499;method_31047()Ljava/util/List;
named getOrderedTooltip
Lnet/minecraft/client/util/OrderableTooltip;getOrderedTooltip()Ljava/util/List;
-
builder
Creates a new builder for a cycling button widget.- Mappings:
Namespace Name Mixin selector official a
Lehv;a(Ljava/util/function/Function;)Lehv$a;
intermediary method_32606
Lnet/minecraft/class_5676;method_32606(Ljava/util/function/Function;)Lnet/minecraft/class_5676$class_5677;
named builder
Lnet/minecraft/client/gui/widget/CyclingButtonWidget;builder(Ljava/util/function/Function;)Lnet/minecraft/client/gui/widget/CyclingButtonWidget$Builder;
-
onOffBuilder
Creates a builder for a cycling button widget that only has Boolean.TRUE and Boolean.FALSE values. It displayson
fortrue
andoff
forfalse
. Its current initial value istrue
.- Mappings:
Namespace Name Mixin selector official a
Lehv;a(Lrq;Lrq;)Lehv$a;
intermediary method_32607
Lnet/minecraft/class_5676;method_32607(Lnet/minecraft/class_2561;Lnet/minecraft/class_2561;)Lnet/minecraft/class_5676$class_5677;
named onOffBuilder
Lnet/minecraft/client/gui/widget/CyclingButtonWidget;onOffBuilder(Lnet/minecraft/text/Text;Lnet/minecraft/text/Text;)Lnet/minecraft/client/gui/widget/CyclingButtonWidget$Builder;
-
onOffBuilder
Creates a builder for a cycling button widget that only has Boolean.TRUE and Boolean.FALSE values. It displaysScreenTexts.ON
fortrue
andScreenTexts.OFF
forfalse
. Its current initial value istrue
.- Mappings:
Namespace Name Mixin selector official e
Lehv;e()Lehv$a;
intermediary method_32614
Lnet/minecraft/class_5676;method_32614()Lnet/minecraft/class_5676$class_5677;
named onOffBuilder
Lnet/minecraft/client/gui/widget/CyclingButtonWidget;onOffBuilder()Lnet/minecraft/client/gui/widget/CyclingButtonWidget$Builder;
-
onOffBuilder
Creates a builder for a cycling button widget that only has Boolean.TRUE and Boolean.FALSE values. It displaysScreenTexts.ON
fortrue
andScreenTexts.OFF
forfalse
. Its current initial value is set toinitialValue
.- Mappings:
Namespace Name Mixin selector official e
Lehv;e(Z)Lehv$a;
intermediary method_32613
Lnet/minecraft/class_5676;method_32613(Z)Lnet/minecraft/class_5676$class_5677;
named onOffBuilder
Lnet/minecraft/client/gui/widget/CyclingButtonWidget;onOffBuilder(Z)Lnet/minecraft/client/gui/widget/CyclingButtonWidget$Builder;
-