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/ClickableWidgetintermediary net/minecraft/class_339official fkm
-
Nested Class Summary
Nested classes/interfaces inherited from interface net.minecraft.client.gui.Selectable
Selectable.SelectionType -
Field Summary
FieldsModifier and TypeFieldDescriptionbooleanprotected floatprivate static final doubleprivate static final doubleprivate booleanprotected intprotected booleanprivate Textprivate intprivate final TooltipStatebooleanprotected intprivate intprivate intFields inherited from interface net.minecraft.client.gui.Element
MAX_DOUBLE_CLICK_INTERVAL -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected abstract voidprotected voidfinal voidappendNarrations(NarrationMessageBuilder builder) protected booleanclicked(double mouseX, double mouseY) protected voiddrawScrollableText(DrawContext context, TextRenderer textRenderer, int xMargin, int color) protected static voiddrawScrollableText(DrawContext context, TextRenderer textRenderer, Text text, int startX, int startY, int endX, int endY, int color) protected static voiddrawScrollableText(DrawContext context, TextRenderer textRenderer, Text text, int centerX, int startX, int startY, int endX, int endY, int color) voidforEachChild(Consumer<ClickableWidget> consumer) intintprotected MutableTextstatic MutableTextgetNarrationMessage(Text message) intgetNavigationPath(GuiNavigation navigation) intgetRight()getType()intgetWidth()intgetX()intgetY()booleanbooleanbooleanisMouseOver(double mouseX, double mouseY) Checks if the mouse position is within the bound of the element.booleanbooleanprotected booleanisValidClickButton(int button) booleanmouseClicked(double mouseX, double mouseY, int button) Callback for when a mouse button down event has been captured.booleanmouseDragged(double mouseX, double mouseY, int button, double deltaX, double deltaY) Callback for when a mouse button drag event has been captured.booleanmouseReleased(double mouseX, double mouseY, int button) Callback for when a mouse button release event has been captured.voidonClick(double mouseX, double mouseY) protected voidonDrag(double mouseX, double mouseY, double deltaX, double deltaY) voidonRelease(double mouseX, double mouseY) static voidplayClickSound(SoundManager soundManager) voidplayDownSound(SoundManager soundManager) final voidrender(DrawContext context, int mouseX, int mouseY, float delta) protected abstract voidrenderWidget(DrawContext context, int mouseX, int mouseY, float delta) voidsetAlpha(float alpha) voidsetDimensions(int width, int height) voidsetDimensionsAndPosition(int width, int height, int x, int y) voidsetFocused(boolean focused) voidsetHeight(int height) voidsetMessage(Text message) voidsetNavigationOrder(int navigationOrder) voidsetTooltip(@Nullable Tooltip tooltip) voidsetTooltipDelay(Duration tooltipDelay) voidsetWidth(int width) voidsetX(int x) voidsetY(int y) Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface net.minecraft.client.gui.Element
charTyped, getFocusedPath, keyPressed, keyReleased, mouseMoved, mouseScrolledMethods 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_43055Lnet/minecraft/client/gui/widget/ClickableWidget;field_43055:Dintermediary field_43055Lnet/minecraft/class_339;field_43055:Dofficial aLfkm;a:D
-
field_43056
private static final double field_43056- See Also:
- Mappings:
Namespace Name Mixin selector named field_43056Lnet/minecraft/client/gui/widget/ClickableWidget;field_43056:Dintermediary field_43056Lnet/minecraft/class_339;field_43056:Dofficial bLfkm;b:D
-
width
protected int width- Mappings:
Namespace Name Mixin selector named widthLnet/minecraft/client/gui/widget/ClickableWidget;width:Iintermediary field_22758Lnet/minecraft/class_339;field_22758:Iofficial gLfkm;g:I
-
height
protected int height- Mappings:
Namespace Name Mixin selector named heightLnet/minecraft/client/gui/widget/ClickableWidget;height:Iintermediary field_22759Lnet/minecraft/class_339;field_22759:Iofficial hLfkm;h:I
-
x
private int x- Mappings:
Namespace Name Mixin selector named xLnet/minecraft/client/gui/widget/ClickableWidget;x:Iintermediary field_22760Lnet/minecraft/class_339;field_22760:Iofficial cLfkm;c:I
-
y
private int y- Mappings:
Namespace Name Mixin selector named yLnet/minecraft/client/gui/widget/ClickableWidget;y:Iintermediary field_22761Lnet/minecraft/class_339;field_22761:Iofficial dLfkm;d:I
-
message
- Mappings:
Namespace Name Mixin selector named messageLnet/minecraft/client/gui/widget/ClickableWidget;message:Lnet/minecraft/text/Text;intermediary field_22754Lnet/minecraft/class_339;field_22754:Lnet/minecraft/class_2561;official eLfkm;e:Lxe;
-
hovered
protected boolean hovered- Mappings:
Namespace Name Mixin selector named hoveredLnet/minecraft/client/gui/widget/ClickableWidget;hovered:Zintermediary field_22762Lnet/minecraft/class_339;field_22762:Zofficial iLfkm;i:Z
-
active
public boolean active- Mappings:
Namespace Name Mixin selector named activeLnet/minecraft/client/gui/widget/ClickableWidget;active:Zintermediary field_22763Lnet/minecraft/class_339;field_22763:Zofficial jLfkm;j:Z
-
visible
public boolean visible- Mappings:
Namespace Name Mixin selector named visibleLnet/minecraft/client/gui/widget/ClickableWidget;visible:Zintermediary field_22764Lnet/minecraft/class_339;field_22764:Zofficial kLfkm;k:Z
-
alpha
protected float alpha- Mappings:
Namespace Name Mixin selector named alphaLnet/minecraft/client/gui/widget/ClickableWidget;alpha:Fintermediary field_22765Lnet/minecraft/class_339;field_22765:Fofficial lLfkm;l:F
-
focused
private boolean focused- Mappings:
Namespace Name Mixin selector named focusedLnet/minecraft/client/gui/widget/ClickableWidget;focused:Zintermediary field_22756Lnet/minecraft/class_339;field_22756:Zofficial mLfkm;m:Z
-
tooltip
- Mappings:
Namespace Name Mixin selector named tooltipLnet/minecraft/client/gui/widget/ClickableWidget;tooltip:Lnet/minecraft/client/gui/tooltip/TooltipState;intermediary field_41095Lnet/minecraft/class_339;field_41095:Lnet/minecraft/class_9110;official nLfkm;n:Lfmc;
-
-
Constructor Details
-
ClickableWidget
- Mappings:
Namespace Name Mixin selector named <init>Lnet/minecraft/client/gui/widget/ClickableWidget;<init>(IIIILnet/minecraft/text/Text;)Vintermediary <init>Lnet/minecraft/class_339;<init>(IIIILnet/minecraft/class_2561;)Vofficial <init>Lfkm;<init>(IIIILxe;)V
-
-
Method Details
-
getHeight
public int getHeight() -
render
- Specified by:
renderin interfaceDrawable- Mappings:
Namespace Name Mixin selector named renderLnet/minecraft/client/gui/Drawable;render(Lnet/minecraft/client/gui/DrawContext;IIF)Vintermediary method_25394Lnet/minecraft/class_4068;method_25394(Lnet/minecraft/class_332;IIF)Vofficial aLflr;a(Lfkb;IIF)V
-
setTooltip
- Mappings:
Namespace Name Mixin selector named setTooltipLnet/minecraft/client/gui/widget/ClickableWidget;setTooltip(Lnet/minecraft/client/gui/tooltip/Tooltip;)Vintermediary method_47400Lnet/minecraft/class_339;method_47400(Lnet/minecraft/class_7919;)Vofficial aLfkm;a(Lflz;)V
-
getTooltip
- Mappings:
Namespace Name Mixin selector named getTooltipLnet/minecraft/client/gui/widget/ClickableWidget;getTooltip()Lnet/minecraft/client/gui/tooltip/Tooltip;intermediary method_51254Lnet/minecraft/class_339;method_51254()Lnet/minecraft/class_7919;official xLfkm;x()Lflz;
-
setTooltipDelay
- Mappings:
Namespace Name Mixin selector named setTooltipDelayLnet/minecraft/client/gui/widget/ClickableWidget;setTooltipDelay(Ljava/time/Duration;)Vintermediary method_47402Lnet/minecraft/class_339;method_47402(Ljava/time/Duration;)Vofficial aLfkm;a(Ljava/time/Duration;)V
-
getNarrationMessage
- Mappings:
Namespace Name Mixin selector named getNarrationMessageLnet/minecraft/client/gui/widget/ClickableWidget;getNarrationMessage()Lnet/minecraft/text/MutableText;intermediary method_25360Lnet/minecraft/class_339;method_25360()Lnet/minecraft/class_5250;official aP_Lfkm;aP_()Lxs;
-
getNarrationMessage
- Mappings:
Namespace Name Mixin selector named getNarrationMessageLnet/minecraft/client/gui/widget/ClickableWidget;getNarrationMessage(Lnet/minecraft/text/Text;)Lnet/minecraft/text/MutableText;intermediary method_32602Lnet/minecraft/class_339;method_32602(Lnet/minecraft/class_2561;)Lnet/minecraft/class_5250;official a_Lfkm;a_(Lxe;)Lxs;
-
renderWidget
- Mappings:
Namespace Name Mixin selector named renderWidgetLnet/minecraft/client/gui/widget/ClickableWidget;renderWidget(Lnet/minecraft/client/gui/DrawContext;IIF)Vintermediary method_48579Lnet/minecraft/class_339;method_48579(Lnet/minecraft/class_332;IIF)Vofficial bLfkm;b(Lfkb;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 drawScrollableTextLnet/minecraft/client/gui/widget/ClickableWidget;drawScrollableText(Lnet/minecraft/client/gui/DrawContext;Lnet/minecraft/client/font/TextRenderer;Lnet/minecraft/text/Text;IIIII)Vintermediary method_52718Lnet/minecraft/class_339;method_52718(Lnet/minecraft/class_332;Lnet/minecraft/class_327;Lnet/minecraft/class_2561;IIIII)Vofficial aLfkm;a(Lfkb;Lfjz;Lxe;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 drawScrollableTextLnet/minecraft/client/gui/widget/ClickableWidget;drawScrollableText(Lnet/minecraft/client/gui/DrawContext;Lnet/minecraft/client/font/TextRenderer;Lnet/minecraft/text/Text;IIIIII)Vintermediary method_49605Lnet/minecraft/class_339;method_49605(Lnet/minecraft/class_332;Lnet/minecraft/class_327;Lnet/minecraft/class_2561;IIIIII)Vofficial aLfkm;a(Lfkb;Lfjz;Lxe;IIIIII)V
-
drawScrollableText
protected void drawScrollableText(DrawContext context, TextRenderer textRenderer, int xMargin, int color) - Mappings:
Namespace Name Mixin selector named drawScrollableTextLnet/minecraft/client/gui/widget/ClickableWidget;drawScrollableText(Lnet/minecraft/client/gui/DrawContext;Lnet/minecraft/client/font/TextRenderer;II)Vintermediary method_49604Lnet/minecraft/class_339;method_49604(Lnet/minecraft/class_332;Lnet/minecraft/class_327;II)Vofficial aLfkm;a(Lfkb;Lfjz;II)V
-
onClick
public void onClick(double mouseX, double mouseY) - Mappings:
Namespace Name Mixin selector named onClickLnet/minecraft/client/gui/widget/ClickableWidget;onClick(DD)Vintermediary method_25348Lnet/minecraft/class_339;method_25348(DD)Vofficial aLfkm;a(DD)V
-
onRelease
public void onRelease(double mouseX, double mouseY) - Mappings:
Namespace Name Mixin selector named onReleaseLnet/minecraft/client/gui/widget/ClickableWidget;onRelease(DD)Vintermediary method_25357Lnet/minecraft/class_339;method_25357(DD)Vofficial a_Lfkm;a_(DD)V
-
onDrag
protected void onDrag(double mouseX, double mouseY, double deltaX, double deltaY) - Mappings:
Namespace Name Mixin selector named onDragLnet/minecraft/client/gui/widget/ClickableWidget;onDrag(DDDD)Vintermediary method_25349Lnet/minecraft/class_339;method_25349(DDDD)Vofficial bLfkm;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 inGLFWclass.- Specified by:
mouseClickedin interfaceElement- Parameters:
mouseX- the X coordinate of the mousemouseY- the Y coordinate of the mousebutton- the mouse button number- Returns:
trueto indicate that the event handling is successful/valid- See Also:
- Mappings:
Namespace Name Mixin selector named mouseClickedLnet/minecraft/client/gui/Element;mouseClicked(DDI)Zintermediary method_25402Lnet/minecraft/class_364;method_25402(DDI)Zofficial aLfml;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 inGLFWclass.- Specified by:
mouseReleasedin interfaceElement- Parameters:
mouseX- the X coordinate of the mousemouseY- the Y coordinate of the mousebutton- the mouse button number- Returns:
trueto indicate that the event handling is successful/valid- See Also:
- Mappings:
Namespace Name Mixin selector named mouseReleasedLnet/minecraft/client/gui/Element;mouseReleased(DDI)Zintermediary method_25406Lnet/minecraft/class_364;method_25406(DDI)Zofficial bLfml;b(DDI)Z
-
isValidClickButton
protected boolean isValidClickButton(int button) - Mappings:
Namespace Name Mixin selector named isValidClickButtonLnet/minecraft/client/gui/widget/ClickableWidget;isValidClickButton(I)Zintermediary method_25351Lnet/minecraft/class_339;method_25351(I)Zofficial jLfkm;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 inGLFWclass.- Specified by:
mouseDraggedin 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:
trueto indicate that the event handling is successful/valid- See Also:
- Mappings:
Namespace Name Mixin selector named mouseDraggedLnet/minecraft/client/gui/Element;mouseDragged(DDIDD)Zintermediary method_25403Lnet/minecraft/class_364;method_25403(DDIDD)Zofficial aLfml;a(DDIDD)Z
-
clicked
protected boolean clicked(double mouseX, double mouseY) - Mappings:
Namespace Name Mixin selector named clickedLnet/minecraft/client/gui/widget/ClickableWidget;clicked(DD)Zintermediary method_25361Lnet/minecraft/class_339;method_25361(DD)Zofficial dLfkm;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:
isMouseOverin interfaceElement- Parameters:
mouseX- the X coordinate of the mousemouseY- the Y coordinate of the mouse- Returns:
trueif the mouse is within the bound of the element, otherwisefalse- Mappings:
Namespace Name Mixin selector named isMouseOverLnet/minecraft/client/gui/Element;isMouseOver(DD)Zintermediary method_25405Lnet/minecraft/class_364;method_25405(DD)Zofficial cLfml;c(DD)Z
-
playDownSound
- Mappings:
Namespace Name Mixin selector named playDownSoundLnet/minecraft/client/gui/widget/ClickableWidget;playDownSound(Lnet/minecraft/client/sound/SoundManager;)Vintermediary method_25354Lnet/minecraft/class_339;method_25354(Lnet/minecraft/class_1144;)Vofficial aLfkm;a(Lhcf;)V
-
playClickSound
- Mappings:
Namespace Name Mixin selector named playClickSoundLnet/minecraft/client/gui/widget/ClickableWidget;playClickSound(Lnet/minecraft/client/sound/SoundManager;)Vintermediary method_62888Lnet/minecraft/class_339;method_62888(Lnet/minecraft/class_1144;)Vofficial bLfkm;b(Lhcf;)V
-
getWidth
public int getWidth() -
setWidth
public void setWidth(int width) - Mappings:
Namespace Name Mixin selector named setWidthLnet/minecraft/client/gui/widget/ClickableWidget;setWidth(I)Vintermediary method_25358Lnet/minecraft/class_339;method_25358(I)Vofficial kLfkm;k(I)V
-
setHeight
public void setHeight(int height) - Mappings:
Namespace Name Mixin selector named setHeightLnet/minecraft/client/gui/widget/ClickableWidget;setHeight(I)Vintermediary method_53533Lnet/minecraft/class_339;method_53533(I)Vofficial lLfkm;l(I)V
-
setAlpha
public void setAlpha(float alpha) - Mappings:
Namespace Name Mixin selector named setAlphaLnet/minecraft/client/gui/widget/ClickableWidget;setAlpha(F)Vintermediary method_25350Lnet/minecraft/class_339;method_25350(F)Vofficial aLfkm;a(F)V
-
setMessage
- Mappings:
Namespace Name Mixin selector named setMessageLnet/minecraft/client/gui/widget/ClickableWidget;setMessage(Lnet/minecraft/text/Text;)Vintermediary method_25355Lnet/minecraft/class_339;method_25355(Lnet/minecraft/class_2561;)Vofficial bLfkm;b(Lxe;)V
-
getMessage
- Mappings:
Namespace Name Mixin selector named getMessageLnet/minecraft/client/gui/widget/ClickableWidget;getMessage()Lnet/minecraft/text/Text;intermediary method_25369Lnet/minecraft/class_339;method_25369()Lnet/minecraft/class_2561;official zLfkm;z()Lxe;
-
isFocused
public boolean isFocused() -
isHovered
public boolean isHovered()- Mappings:
Namespace Name Mixin selector named isHoveredLnet/minecraft/client/gui/widget/ClickableWidget;isHovered()Zintermediary method_49606Lnet/minecraft/class_339;method_49606()Zofficial ALfkm;A()Z
-
isSelected
public boolean isSelected()- Mappings:
Namespace Name Mixin selector named isSelectedLnet/minecraft/client/gui/widget/ClickableWidget;isSelected()Zintermediary method_25367Lnet/minecraft/class_339;method_25367()Zofficial BLfkm;B()Z
-
isNarratable
public boolean isNarratable()- Specified by:
isNarratablein interfaceSelectable- Mappings:
Namespace Name Mixin selector named isNarratableLnet/minecraft/client/gui/Selectable;isNarratable()Zintermediary method_37303Lnet/minecraft/class_6379;method_37303()Zofficial CLfoj;C()Z
-
setFocused
public void setFocused(boolean focused) - Specified by:
setFocusedin interfaceElement- Mappings:
Namespace Name Mixin selector named setFocusedLnet/minecraft/client/gui/Element;setFocused(Z)Vintermediary method_25365Lnet/minecraft/class_364;method_25365(Z)Vofficial aLfml;a(Z)V
-
getType
- Specified by:
getTypein interfaceSelectable- Mappings:
Namespace Name Mixin selector named getTypeLnet/minecraft/client/gui/Selectable;getType()Lnet/minecraft/client/gui/Selectable$SelectionType;intermediary method_37018Lnet/minecraft/class_6379;method_37018()Lnet/minecraft/class_6379$class_6380;official uLfoj;u()Lfoj$a;
-
appendNarrations
- Specified by:
appendNarrationsin interfaceNarratable- Mappings:
Namespace Name Mixin selector named appendNarrationsLnet/minecraft/client/gui/Narratable;appendNarrations(Lnet/minecraft/client/gui/screen/narration/NarrationMessageBuilder;)Vintermediary method_37020Lnet/minecraft/class_6383;method_37020(Lnet/minecraft/class_6382;)Vofficial bLfom;b(Lfol;)V
-
appendClickableNarrations
- Mappings:
Namespace Name Mixin selector named appendClickableNarrationsLnet/minecraft/client/gui/widget/ClickableWidget;appendClickableNarrations(Lnet/minecraft/client/gui/screen/narration/NarrationMessageBuilder;)Vintermediary method_47399Lnet/minecraft/class_339;method_47399(Lnet/minecraft/class_6382;)Vofficial aLfkm;a(Lfol;)V
-
appendDefaultNarrations
- Mappings:
Namespace Name Mixin selector named appendDefaultNarrationsLnet/minecraft/client/gui/widget/ClickableWidget;appendDefaultNarrations(Lnet/minecraft/client/gui/screen/narration/NarrationMessageBuilder;)Vintermediary method_37021Lnet/minecraft/class_339;method_37021(Lnet/minecraft/class_6382;)Vofficial cLfkm;c(Lfol;)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 getRightLnet/minecraft/client/gui/widget/ClickableWidget;getRight()Iintermediary method_55442Lnet/minecraft/class_339;method_55442()Iofficial FLfkm;F()I
-
getBottom
public int getBottom()- Mappings:
Namespace Name Mixin selector named getBottomLnet/minecraft/client/gui/widget/ClickableWidget;getBottom()Iintermediary method_55443Lnet/minecraft/class_339;method_55443()Iofficial GLfkm;G()I
-
forEachChild
- Specified by:
forEachChildin interfaceWidget- Mappings:
Namespace Name Mixin selector named forEachChildLnet/minecraft/client/gui/widget/Widget;forEachChild(Ljava/util/function/Consumer;)Vintermediary method_48206Lnet/minecraft/class_8021;method_48206(Ljava/util/function/Consumer;)Vofficial aLfoe;a(Ljava/util/function/Consumer;)V
-
setDimensions
public void setDimensions(int width, int height) - Mappings:
Namespace Name Mixin selector named setDimensionsLnet/minecraft/client/gui/widget/ClickableWidget;setDimensions(II)Vintermediary method_55445Lnet/minecraft/class_339;method_55445(II)Vofficial bLfkm;b(II)V
-
setDimensionsAndPosition
public void setDimensionsAndPosition(int width, int height, int x, int y) - Mappings:
Namespace Name Mixin selector named setDimensionsAndPositionLnet/minecraft/client/gui/widget/ClickableWidget;setDimensionsAndPosition(IIII)Vintermediary method_55444Lnet/minecraft/class_339;method_55444(IIII)Vofficial aLfkm;a(IIII)V
-