Package net.minecraft.client.gui.widget
Class ClickableWidget
java.lang.Object
net.minecraft.client.gui.widget.ClickableWidget
- All Implemented Interfaces:
Drawable
,Element
,Narratable
,Navigable
,Selectable
,Widget
- Direct Known Subclasses:
AbstractTextWidget
,AnimatedResultButton
,ContainerWidget
,GameModeSelectionScreen.ButtonWidget
,IconWidget
,PlayerSkinWidget
,PressableWidget
,RealmsLoadingWidget
,RecipeAlternativesWidget.AlternativeButtonWidget
,ScrollableWidget
,SliderWidget
,TabButtonWidget
,TextFieldWidget
,ToggleButtonWidget
@Environment(CLIENT)
public abstract class ClickableWidget
extends Object
implements Drawable, Element, Widget, Selectable
A clickable widget is a GUI element that has many methods to handle different
mouse actions. In addition, it allows a message to be rendered on the widget
and narrated when the widget is selected.
- Mappings:
Namespace Name named net/minecraft/client/gui/widget/ClickableWidget
intermediary net/minecraft/class_339
official fie
-
Nested Class Summary
Nested classes/interfaces inherited from interface net.minecraft.client.gui.Selectable
Selectable.SelectionType
-
Field Summary
Modifier and TypeFieldDescriptionboolean
protected float
private static final double
private static final double
private boolean
protected int
protected boolean
private Text
private int
private final TooltipState
boolean
protected int
private int
private int
Fields inherited from interface net.minecraft.client.gui.Element
MAX_DOUBLE_CLICK_INTERVAL
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected abstract void
protected void
final void
appendNarrations
(NarrationMessageBuilder builder) protected boolean
clicked
(double mouseX, double mouseY) protected void
drawScrollableText
(DrawContext context, TextRenderer textRenderer, int xMargin, int color) protected static void
drawScrollableText
(DrawContext context, TextRenderer textRenderer, Text text, int startX, int startY, int endX, int endY, int color) protected static void
drawScrollableText
(DrawContext context, TextRenderer textRenderer, Text text, int centerX, int startX, int startY, int endX, int endY, int color) void
forEachChild
(Consumer<ClickableWidget> consumer) int
int
protected MutableText
static MutableText
getNarrationMessage
(Text message) int
getNavigationPath
(GuiNavigation navigation) int
getRight()
getType()
int
getWidth()
int
getX()
int
getY()
boolean
boolean
boolean
isMouseOver
(double mouseX, double mouseY) Checks if the mouse position is within the bound of the element.boolean
boolean
protected boolean
isValidClickButton
(int button) boolean
mouseClicked
(double mouseX, double mouseY, int button) Callback for when a mouse button down event has been captured.boolean
mouseDragged
(double mouseX, double mouseY, int button, double deltaX, double deltaY) Callback for when a mouse button drag event has been captured.boolean
mouseReleased
(double mouseX, double mouseY, int button) Callback for when a mouse button release event has been captured.void
onClick
(double mouseX, double mouseY) protected void
onDrag
(double mouseX, double mouseY, double deltaX, double deltaY) void
onRelease
(double mouseX, double mouseY) void
playDownSound
(SoundManager soundManager) final void
render
(DrawContext context, int mouseX, int mouseY, float delta) protected abstract void
renderWidget
(DrawContext context, int mouseX, int mouseY, float delta) void
setAlpha
(float alpha) void
setDimensions
(int width, int height) void
setDimensionsAndPosition
(int width, int height, int x, int y) void
setFocused
(boolean focused) void
setHeight
(int height) void
setMessage
(Text message) void
setNavigationOrder
(int navigationOrder) void
setTooltip
(@Nullable Tooltip tooltip) void
setTooltipDelay
(Duration tooltipDelay) void
setWidth
(int width) void
setX
(int x) void
setY
(int y) 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, getFocusedPath, keyPressed, keyReleased, mouseMoved, mouseScrolled
Methods inherited from interface net.minecraft.client.gui.widget.Widget
setPosition
-
Field Details
-
field_43055
private static final double field_43055- See Also:
- Mappings:
Namespace Name Mixin selector named field_43055
Lnet/minecraft/client/gui/widget/ClickableWidget;field_43055:D
intermediary field_43055
Lnet/minecraft/class_339;field_43055:D
official a
Lfie;a:D
-
field_43056
private static final double field_43056- See Also:
- Mappings:
Namespace Name Mixin selector named field_43056
Lnet/minecraft/client/gui/widget/ClickableWidget;field_43056:D
intermediary field_43056
Lnet/minecraft/class_339;field_43056:D
official b
Lfie;b:D
-
width
protected int width- Mappings:
Namespace Name Mixin selector named width
Lnet/minecraft/client/gui/widget/ClickableWidget;width:I
intermediary field_22758
Lnet/minecraft/class_339;field_22758:I
official g
Lfie;g:I
-
height
protected int height- Mappings:
Namespace Name Mixin selector named height
Lnet/minecraft/client/gui/widget/ClickableWidget;height:I
intermediary field_22759
Lnet/minecraft/class_339;field_22759:I
official h
Lfie;h:I
-
x
private int x- Mappings:
Namespace Name Mixin selector named x
Lnet/minecraft/client/gui/widget/ClickableWidget;x:I
intermediary field_22760
Lnet/minecraft/class_339;field_22760:I
official c
Lfie;c:I
-
y
private int y- Mappings:
Namespace Name Mixin selector named y
Lnet/minecraft/client/gui/widget/ClickableWidget;y:I
intermediary field_22761
Lnet/minecraft/class_339;field_22761:I
official d
Lfie;d:I
-
message
- Mappings:
Namespace Name Mixin selector named message
Lnet/minecraft/client/gui/widget/ClickableWidget;message:Lnet/minecraft/text/Text;
intermediary field_22754
Lnet/minecraft/class_339;field_22754:Lnet/minecraft/class_2561;
official e
Lfie;e:Lwy;
-
hovered
protected boolean hovered- Mappings:
Namespace Name Mixin selector named hovered
Lnet/minecraft/client/gui/widget/ClickableWidget;hovered:Z
intermediary field_22762
Lnet/minecraft/class_339;field_22762:Z
official i
Lfie;i:Z
-
active
public boolean active- Mappings:
Namespace Name Mixin selector named active
Lnet/minecraft/client/gui/widget/ClickableWidget;active:Z
intermediary field_22763
Lnet/minecraft/class_339;field_22763:Z
official j
Lfie;j:Z
-
visible
public boolean visible- Mappings:
Namespace Name Mixin selector named visible
Lnet/minecraft/client/gui/widget/ClickableWidget;visible:Z
intermediary field_22764
Lnet/minecraft/class_339;field_22764:Z
official k
Lfie;k:Z
-
alpha
protected float alpha- Mappings:
Namespace Name Mixin selector named alpha
Lnet/minecraft/client/gui/widget/ClickableWidget;alpha:F
intermediary field_22765
Lnet/minecraft/class_339;field_22765:F
official l
Lfie;l:F
-
focused
private boolean focused- Mappings:
Namespace Name Mixin selector named focused
Lnet/minecraft/client/gui/widget/ClickableWidget;focused:Z
intermediary field_22756
Lnet/minecraft/class_339;field_22756:Z
official m
Lfie;m:Z
-
tooltip
- Mappings:
Namespace Name Mixin selector named tooltip
Lnet/minecraft/client/gui/widget/ClickableWidget;tooltip:Lnet/minecraft/client/gui/tooltip/TooltipState;
intermediary field_41095
Lnet/minecraft/class_339;field_41095:Lnet/minecraft/class_9110;
official n
Lfie;n:Lfju;
-
-
Constructor Details
-
ClickableWidget
- Mappings:
Namespace Name Mixin selector named <init>
Lnet/minecraft/client/gui/widget/ClickableWidget;<init>(IIIILnet/minecraft/text/Text;)V
intermediary <init>
Lnet/minecraft/class_339;<init>(IIIILnet/minecraft/class_2561;)V
official <init>
Lfie;<init>(IIIILwy;)V
-
-
Method Details
-
getHeight
public int getHeight() -
render
- Specified by:
render
in interfaceDrawable
- Mappings:
Namespace Name Mixin selector named render
Lnet/minecraft/client/gui/Drawable;render(Lnet/minecraft/client/gui/DrawContext;IIF)V
intermediary method_25394
Lnet/minecraft/class_4068;method_25394(Lnet/minecraft/class_332;IIF)V
official a
Lfjj;a(Lfht;IIF)V
-
setTooltip
- Mappings:
Namespace Name Mixin selector named setTooltip
Lnet/minecraft/client/gui/widget/ClickableWidget;setTooltip(Lnet/minecraft/client/gui/tooltip/Tooltip;)V
intermediary method_47400
Lnet/minecraft/class_339;method_47400(Lnet/minecraft/class_7919;)V
official a
Lfie;a(Lfjr;)V
-
getTooltip
- Mappings:
Namespace Name Mixin selector named getTooltip
Lnet/minecraft/client/gui/widget/ClickableWidget;getTooltip()Lnet/minecraft/client/gui/tooltip/Tooltip;
intermediary method_51254
Lnet/minecraft/class_339;method_51254()Lnet/minecraft/class_7919;
official x
Lfie;x()Lfjr;
-
setTooltipDelay
- Mappings:
Namespace Name Mixin selector named setTooltipDelay
Lnet/minecraft/client/gui/widget/ClickableWidget;setTooltipDelay(Ljava/time/Duration;)V
intermediary method_47402
Lnet/minecraft/class_339;method_47402(Ljava/time/Duration;)V
official a
Lfie;a(Ljava/time/Duration;)V
-
getNarrationMessage
- Mappings:
Namespace Name Mixin selector named getNarrationMessage
Lnet/minecraft/client/gui/widget/ClickableWidget;getNarrationMessage()Lnet/minecraft/text/MutableText;
intermediary method_25360
Lnet/minecraft/class_339;method_25360()Lnet/minecraft/class_5250;
official aM_
Lfie;aM_()Lxm;
-
getNarrationMessage
- Mappings:
Namespace Name Mixin selector named getNarrationMessage
Lnet/minecraft/client/gui/widget/ClickableWidget;getNarrationMessage(Lnet/minecraft/text/Text;)Lnet/minecraft/text/MutableText;
intermediary method_32602
Lnet/minecraft/class_339;method_32602(Lnet/minecraft/class_2561;)Lnet/minecraft/class_5250;
official a_
Lfie;a_(Lwy;)Lxm;
-
renderWidget
- Mappings:
Namespace Name Mixin selector named renderWidget
Lnet/minecraft/client/gui/widget/ClickableWidget;renderWidget(Lnet/minecraft/client/gui/DrawContext;IIF)V
intermediary method_48579
Lnet/minecraft/class_339;method_48579(Lnet/minecraft/class_332;IIF)V
official b
Lfie;b(Lfht;IIF)V
-
drawScrollableText
protected static void drawScrollableText(DrawContext context, TextRenderer textRenderer, Text text, int startX, int startY, int endX, int endY, int color) - Mappings:
Namespace Name Mixin selector named drawScrollableText
Lnet/minecraft/client/gui/widget/ClickableWidget;drawScrollableText(Lnet/minecraft/client/gui/DrawContext;Lnet/minecraft/client/font/TextRenderer;Lnet/minecraft/text/Text;IIIII)V
intermediary method_52718
Lnet/minecraft/class_339;method_52718(Lnet/minecraft/class_332;Lnet/minecraft/class_327;Lnet/minecraft/class_2561;IIIII)V
official a
Lfie;a(Lfht;Lfhr;Lwy;IIIII)V
-
drawScrollableText
protected static void drawScrollableText(DrawContext context, TextRenderer textRenderer, Text text, int centerX, int startX, int startY, int endX, int endY, int color) - Mappings:
Namespace Name Mixin selector named drawScrollableText
Lnet/minecraft/client/gui/widget/ClickableWidget;drawScrollableText(Lnet/minecraft/client/gui/DrawContext;Lnet/minecraft/client/font/TextRenderer;Lnet/minecraft/text/Text;IIIIII)V
intermediary method_49605
Lnet/minecraft/class_339;method_49605(Lnet/minecraft/class_332;Lnet/minecraft/class_327;Lnet/minecraft/class_2561;IIIIII)V
official a
Lfie;a(Lfht;Lfhr;Lwy;IIIIII)V
-
drawScrollableText
protected void drawScrollableText(DrawContext context, TextRenderer textRenderer, int xMargin, int color) - Mappings:
Namespace Name Mixin selector named drawScrollableText
Lnet/minecraft/client/gui/widget/ClickableWidget;drawScrollableText(Lnet/minecraft/client/gui/DrawContext;Lnet/minecraft/client/font/TextRenderer;II)V
intermediary method_49604
Lnet/minecraft/class_339;method_49604(Lnet/minecraft/class_332;Lnet/minecraft/class_327;II)V
official a
Lfie;a(Lfht;Lfhr;II)V
-
onClick
public void onClick(double mouseX, double mouseY) - Mappings:
Namespace Name Mixin selector named onClick
Lnet/minecraft/client/gui/widget/ClickableWidget;onClick(DD)V
intermediary method_25348
Lnet/minecraft/class_339;method_25348(DD)V
official a
Lfie;a(DD)V
-
onRelease
public void onRelease(double mouseX, double mouseY) - Mappings:
Namespace Name Mixin selector named onRelease
Lnet/minecraft/client/gui/widget/ClickableWidget;onRelease(DD)V
intermediary method_25357
Lnet/minecraft/class_339;method_25357(DD)V
official a_
Lfie;a_(DD)V
-
onDrag
protected void onDrag(double mouseX, double mouseY, double deltaX, double deltaY) - Mappings:
Namespace Name Mixin selector named onDrag
Lnet/minecraft/client/gui/widget/ClickableWidget;onDrag(DDDD)V
intermediary method_25349
Lnet/minecraft/class_339;method_25349(DDDD)V
official b
Lfie;b(DDDD)V
-
mouseClicked
public boolean mouseClicked(double mouseX, double mouseY, int button) Callback for when a mouse button down event has been captured. The button number is identified by the constants inGLFW
class.- Specified by:
mouseClicked
in interfaceElement
- Parameters:
mouseX
- the X coordinate of the mousemouseY
- the Y coordinate of the mousebutton
- the mouse button number- Returns:
true
to indicate that the event handling is successful/valid- See Also:
- Mappings:
Namespace Name Mixin selector named mouseClicked
Lnet/minecraft/client/gui/Element;mouseClicked(DDI)Z
intermediary method_25402
Lnet/minecraft/class_364;method_25402(DDI)Z
official a
Lfkc;a(DDI)Z
-
mouseReleased
public boolean mouseReleased(double mouseX, double mouseY, int button) Callback for when a mouse button release event has been captured. The button number is identified by the constants inGLFW
class.- Specified by:
mouseReleased
in interfaceElement
- Parameters:
mouseX
- the X coordinate of the mousemouseY
- the Y coordinate of the mousebutton
- the mouse button number- Returns:
true
to indicate that the event handling is successful/valid- See Also:
- Mappings:
Namespace Name Mixin selector named mouseReleased
Lnet/minecraft/client/gui/Element;mouseReleased(DDI)Z
intermediary method_25406
Lnet/minecraft/class_364;method_25406(DDI)Z
official b
Lfkc;b(DDI)Z
-
isValidClickButton
protected boolean isValidClickButton(int button) - Mappings:
Namespace Name Mixin selector named isValidClickButton
Lnet/minecraft/client/gui/widget/ClickableWidget;isValidClickButton(I)Z
intermediary method_25351
Lnet/minecraft/class_339;method_25351(I)Z
official j
Lfie;j(I)Z
-
mouseDragged
public boolean mouseDragged(double mouseX, double mouseY, int button, double deltaX, double deltaY) Callback for when a mouse button drag event has been captured. The button number is identified by the constants inGLFW
class.- Specified by:
mouseDragged
in interfaceElement
- Parameters:
mouseX
- the current X coordinate of the mousemouseY
- the current Y coordinate of the mousebutton
- the mouse button numberdeltaX
- the difference of the current X with the previous X coordinatedeltaY
- the difference of the current Y with the previous Y coordinate- Returns:
true
to indicate that the event handling is successful/valid- See Also:
- Mappings:
Namespace Name Mixin selector named mouseDragged
Lnet/minecraft/client/gui/Element;mouseDragged(DDIDD)Z
intermediary method_25403
Lnet/minecraft/class_364;method_25403(DDIDD)Z
official a
Lfkc;a(DDIDD)Z
-
clicked
protected boolean clicked(double mouseX, double mouseY) - Mappings:
Namespace Name Mixin selector named clicked
Lnet/minecraft/client/gui/widget/ClickableWidget;clicked(DD)Z
intermediary method_25361
Lnet/minecraft/class_339;method_25361(DD)Z
official d
Lfie;d(DD)Z
-
isMouseOver
public boolean isMouseOver(double mouseX, double mouseY) Checks if the mouse position is within the bound of the element.- Specified by:
isMouseOver
in interfaceElement
- Parameters:
mouseX
- the X coordinate of the mousemouseY
- the Y coordinate of the mouse- Returns:
true
if the mouse is within the bound of the element, otherwisefalse
- Mappings:
Namespace Name Mixin selector named isMouseOver
Lnet/minecraft/client/gui/Element;isMouseOver(DD)Z
intermediary method_25405
Lnet/minecraft/class_364;method_25405(DD)Z
official c
Lfkc;c(DD)Z
-
playDownSound
- Mappings:
Namespace Name Mixin selector named playDownSound
Lnet/minecraft/client/gui/widget/ClickableWidget;playDownSound(Lnet/minecraft/client/sound/SoundManager;)V
intermediary method_25354
Lnet/minecraft/class_339;method_25354(Lnet/minecraft/class_1144;)V
official a
Lfie;a(Lguy;)V
-
getWidth
public int getWidth() -
setWidth
public void setWidth(int width) - Mappings:
Namespace Name Mixin selector named setWidth
Lnet/minecraft/client/gui/widget/ClickableWidget;setWidth(I)V
intermediary method_25358
Lnet/minecraft/class_339;method_25358(I)V
official k
Lfie;k(I)V
-
setHeight
public void setHeight(int height) - Mappings:
Namespace Name Mixin selector named setHeight
Lnet/minecraft/client/gui/widget/ClickableWidget;setHeight(I)V
intermediary method_53533
Lnet/minecraft/class_339;method_53533(I)V
official l
Lfie;l(I)V
-
setAlpha
public void setAlpha(float alpha) - Mappings:
Namespace Name Mixin selector named setAlpha
Lnet/minecraft/client/gui/widget/ClickableWidget;setAlpha(F)V
intermediary method_25350
Lnet/minecraft/class_339;method_25350(F)V
official a
Lfie;a(F)V
-
setMessage
- Mappings:
Namespace Name Mixin selector named setMessage
Lnet/minecraft/client/gui/widget/ClickableWidget;setMessage(Lnet/minecraft/text/Text;)V
intermediary method_25355
Lnet/minecraft/class_339;method_25355(Lnet/minecraft/class_2561;)V
official b
Lfie;b(Lwy;)V
-
getMessage
- Mappings:
Namespace Name Mixin selector named getMessage
Lnet/minecraft/client/gui/widget/ClickableWidget;getMessage()Lnet/minecraft/text/Text;
intermediary method_25369
Lnet/minecraft/class_339;method_25369()Lnet/minecraft/class_2561;
official z
Lfie;z()Lwy;
-
isFocused
public boolean isFocused() -
isHovered
public boolean isHovered()- Mappings:
Namespace Name Mixin selector named isHovered
Lnet/minecraft/client/gui/widget/ClickableWidget;isHovered()Z
intermediary method_49606
Lnet/minecraft/class_339;method_49606()Z
official A
Lfie;A()Z
-
isSelected
public boolean isSelected()- Mappings:
Namespace Name Mixin selector named isSelected
Lnet/minecraft/client/gui/widget/ClickableWidget;isSelected()Z
intermediary method_25367
Lnet/minecraft/class_339;method_25367()Z
official B
Lfie;B()Z
-
isNarratable
public boolean isNarratable()- Specified by:
isNarratable
in interfaceSelectable
- Mappings:
Namespace Name Mixin selector named isNarratable
Lnet/minecraft/client/gui/Selectable;isNarratable()Z
intermediary method_37303
Lnet/minecraft/class_6379;method_37303()Z
official C
Lfma;C()Z
-
setFocused
public void setFocused(boolean focused) - Specified by:
setFocused
in interfaceElement
- Mappings:
Namespace Name Mixin selector named setFocused
Lnet/minecraft/client/gui/Element;setFocused(Z)V
intermediary method_25365
Lnet/minecraft/class_364;method_25365(Z)V
official a
Lfkc;a(Z)V
-
getType
- Specified by:
getType
in interfaceSelectable
- Mappings:
Namespace Name Mixin selector named getType
Lnet/minecraft/client/gui/Selectable;getType()Lnet/minecraft/client/gui/Selectable$SelectionType;
intermediary method_37018
Lnet/minecraft/class_6379;method_37018()Lnet/minecraft/class_6379$class_6380;
official u
Lfma;u()Lfma$a;
-
appendNarrations
- Specified by:
appendNarrations
in interfaceNarratable
- Mappings:
Namespace Name Mixin selector named appendNarrations
Lnet/minecraft/client/gui/Narratable;appendNarrations(Lnet/minecraft/client/gui/screen/narration/NarrationMessageBuilder;)V
intermediary method_37020
Lnet/minecraft/class_6383;method_37020(Lnet/minecraft/class_6382;)V
official b
Lfmd;b(Lfmc;)V
-
appendClickableNarrations
- Mappings:
Namespace Name Mixin selector named appendClickableNarrations
Lnet/minecraft/client/gui/widget/ClickableWidget;appendClickableNarrations(Lnet/minecraft/client/gui/screen/narration/NarrationMessageBuilder;)V
intermediary method_47399
Lnet/minecraft/class_339;method_47399(Lnet/minecraft/class_6382;)V
official a
Lfie;a(Lfmc;)V
-
appendDefaultNarrations
- Mappings:
Namespace Name Mixin selector named appendDefaultNarrations
Lnet/minecraft/client/gui/widget/ClickableWidget;appendDefaultNarrations(Lnet/minecraft/client/gui/screen/narration/NarrationMessageBuilder;)V
intermediary method_37021
Lnet/minecraft/class_339;method_37021(Lnet/minecraft/class_6382;)V
official c
Lfie;c(Lfmc;)V
-
getX
public int getX() -
setX
public void setX(int x) -
getY
public int getY() -
setY
public void setY(int y) -
getRight
public int getRight()- Mappings:
Namespace Name Mixin selector named getRight
Lnet/minecraft/client/gui/widget/ClickableWidget;getRight()I
intermediary method_55442
Lnet/minecraft/class_339;method_55442()I
official F
Lfie;F()I
-
getBottom
public int getBottom()- Mappings:
Namespace Name Mixin selector named getBottom
Lnet/minecraft/client/gui/widget/ClickableWidget;getBottom()I
intermediary method_55443
Lnet/minecraft/class_339;method_55443()I
official G
Lfie;G()I
-
forEachChild
- Specified by:
forEachChild
in interfaceWidget
- Mappings:
Namespace Name Mixin selector named forEachChild
Lnet/minecraft/client/gui/widget/Widget;forEachChild(Ljava/util/function/Consumer;)V
intermediary method_48206
Lnet/minecraft/class_8021;method_48206(Ljava/util/function/Consumer;)V
official a
Lflv;a(Ljava/util/function/Consumer;)V
-
setDimensions
public void setDimensions(int width, int height) - Mappings:
Namespace Name Mixin selector named setDimensions
Lnet/minecraft/client/gui/widget/ClickableWidget;setDimensions(II)V
intermediary method_55445
Lnet/minecraft/class_339;method_55445(II)V
official b
Lfie;b(II)V
-
setDimensionsAndPosition
public void setDimensionsAndPosition(int width, int height, int x, int y) - Mappings:
Namespace Name Mixin selector named setDimensionsAndPosition
Lnet/minecraft/client/gui/widget/ClickableWidget;setDimensionsAndPosition(IIII)V
intermediary method_55444
Lnet/minecraft/class_339;method_55444(IIII)V
official a
Lfie;a(IIII)V
-