Package net.minecraft.client.gui.widget
Class ClickableWidget
java.lang.Object
net.minecraft.client.gui.DrawableHelper
net.minecraft.client.gui.widget.ClickableWidget
- All Implemented Interfaces:
Drawable,Element,Narratable,Selectable
- Direct Known Subclasses:
AnimatedResultButton,GameModeSelectionScreen.ButtonWidget,PressableWidget,RecipeAlternativesWidget.AlternativeButtonWidget,SliderWidget,TextFieldWidget,ToggleButtonWidget
@Environment(CLIENT)
public abstract class ClickableWidget
extends DrawableHelper
implements Drawable, Element, 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 official egqintermediary net/minecraft/class_339named net/minecraft/client/gui/widget/ClickableWidget
-
Nested Class Summary
Nested classes/interfaces inherited from interface net.minecraft.client.gui.Selectable
Selectable.SelectionType -
Field Summary
FieldsModifier and TypeFieldDescriptionbooleanprotected floatprivate booleanprotected intprotected booleanprivate Textbooleanstatic final Identifierprotected intintintFields inherited from class net.minecraft.client.gui.DrawableHelper
GUI_ICONS_TEXTURE, OPTIONS_BACKGROUND_TEXTURE, STATS_ICON_TEXTUREFields inherited from interface net.minecraft.client.gui.Element
MAX_DOUBLE_CLICK_INTERVAL -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected voidbooleanchangeFocus(boolean lookForwards) Changes the focusing element by cycling to the next/previous element.protected booleanclicked(double mouseX, double mouseY) intprotected MutableTextstatic MutableTextgetNarrationMessage(Text message) getType()intgetWidth()protected intgetYImage(boolean hovered) booleanbooleanbooleanisMouseOver(double mouseX, double mouseY) Checks if the mouse position is within the bound of the element.booleanprotected 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) protected voidonFocusedChanged(boolean newFocused) voidonRelease(double mouseX, double mouseY) voidplayDownSound(SoundManager soundManager) voidrender(MatrixStack matrices, int mouseX, int mouseY, float delta) protected voidrenderBackground(MatrixStack matrices, MinecraftClient client, int mouseX, int mouseY) voidrenderButton(MatrixStack matrices, int mouseX, int mouseY, float delta) voidrenderTooltip(MatrixStack matrices, int mouseX, int mouseY) voidsetAlpha(float alpha) protected voidsetFocused(boolean focused) voidsetMessage(Text message) voidsetWidth(int width) Methods inherited from class net.minecraft.client.gui.DrawableHelper
drawCenteredText, drawCenteredText, drawCenteredTextWithShadow, drawHorizontalLine, drawSprite, drawStringWithShadow, drawTexture, drawTexture, drawTexture, drawTexture, drawTextWithShadow, drawVerticalLine, drawWithOutline, drawWithShadow, fill, fillGradient, fillGradient, fillGradient, getZOffset, setZOffsetMethods 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, keyPressed, keyReleased, mouseMoved, mouseScrolledMethods inherited from interface net.minecraft.client.gui.Narratable
appendNarrations
-
Field Details
-
WIDGETS_TEXTURE
- Mappings:
Namespace Name Mixin selector official jLegq;j:Laaj;intermediary field_22757Lnet/minecraft/class_339;field_22757:Lnet/minecraft/class_2960;named WIDGETS_TEXTURELnet/minecraft/client/gui/widget/ClickableWidget;WIDGETS_TEXTURE:Lnet/minecraft/util/Identifier;
-
width
protected int width- Mappings:
Namespace Name Mixin selector official kLegq;k:Iintermediary field_22758Lnet/minecraft/class_339;field_22758:Inamed widthLnet/minecraft/client/gui/widget/ClickableWidget;width:I
-
height
protected int height- Mappings:
Namespace Name Mixin selector official lLegq;l:Iintermediary field_22759Lnet/minecraft/class_339;field_22759:Inamed heightLnet/minecraft/client/gui/widget/ClickableWidget;height:I
-
x
public int x- Mappings:
Namespace Name Mixin selector official mLegq;m:Iintermediary field_22760Lnet/minecraft/class_339;field_22760:Inamed xLnet/minecraft/client/gui/widget/ClickableWidget;x:I
-
y
public int y- Mappings:
Namespace Name Mixin selector official nLegq;n:Iintermediary field_22761Lnet/minecraft/class_339;field_22761:Inamed yLnet/minecraft/client/gui/widget/ClickableWidget;y:I
-
message
- Mappings:
Namespace Name Mixin selector official aLegq;a:Lrm;intermediary field_22754Lnet/minecraft/class_339;field_22754:Lnet/minecraft/class_2561;named messageLnet/minecraft/client/gui/widget/ClickableWidget;message:Lnet/minecraft/text/Text;
-
hovered
protected boolean hovered- Mappings:
Namespace Name Mixin selector official oLegq;o:Zintermediary field_22762Lnet/minecraft/class_339;field_22762:Znamed hoveredLnet/minecraft/client/gui/widget/ClickableWidget;hovered:Z
-
active
public boolean active- Mappings:
Namespace Name Mixin selector official pLegq;p:Zintermediary field_22763Lnet/minecraft/class_339;field_22763:Znamed activeLnet/minecraft/client/gui/widget/ClickableWidget;active:Z
-
visible
public boolean visible- Mappings:
Namespace Name Mixin selector official qLegq;q:Zintermediary field_22764Lnet/minecraft/class_339;field_22764:Znamed visibleLnet/minecraft/client/gui/widget/ClickableWidget;visible:Z
-
alpha
protected float alpha- Mappings:
Namespace Name Mixin selector official rLegq;r:Fintermediary field_22765Lnet/minecraft/class_339;field_22765:Fnamed alphaLnet/minecraft/client/gui/widget/ClickableWidget;alpha:F
-
focused
private boolean focused- Mappings:
Namespace Name Mixin selector official bLegq;b:Zintermediary field_22756Lnet/minecraft/class_339;field_22756:Znamed focusedLnet/minecraft/client/gui/widget/ClickableWidget;focused:Z
-
-
Constructor Details
-
ClickableWidget
- Mappings:
Namespace Name Mixin selector official <init>Legq;<init>(IIIILrm;)Vintermediary <init>Lnet/minecraft/class_339;<init>(IIIILnet/minecraft/class_2561;)Vnamed <init>Lnet/minecraft/client/gui/widget/ClickableWidget;<init>(IIIILnet/minecraft/text/Text;)V
-
-
Method Details
-
getHeight
public int getHeight()- Mappings:
Namespace Name Mixin selector official eLegq;e()Iintermediary method_25364Lnet/minecraft/class_339;method_25364()Inamed getHeightLnet/minecraft/client/gui/widget/ClickableWidget;getHeight()I
-
getYImage
protected int getYImage(boolean hovered) - Mappings:
Namespace Name Mixin selector official aLegq;a(Z)Iintermediary method_25356Lnet/minecraft/class_339;method_25356(Z)Inamed getYImageLnet/minecraft/client/gui/widget/ClickableWidget;getYImage(Z)I
-
render
- Specified by:
renderin interfaceDrawable- Mappings:
Namespace Name Mixin selector official aLehn;a(Ldzt;IIF)Vintermediary method_25394Lnet/minecraft/class_4068;method_25394(Lnet/minecraft/class_4587;IIF)Vnamed renderLnet/minecraft/client/gui/Drawable;render(Lnet/minecraft/client/util/math/MatrixStack;IIF)V
-
getNarrationMessage
- Mappings:
Namespace Name Mixin selector official ak_Legq;ak_()Lrt;intermediary method_25360Lnet/minecraft/class_339;method_25360()Lnet/minecraft/class_5250;named getNarrationMessageLnet/minecraft/client/gui/widget/ClickableWidget;getNarrationMessage()Lnet/minecraft/text/MutableText;
-
getNarrationMessage
- Mappings:
Namespace Name Mixin selector official aLegq;a(Lrm;)Lrt;intermediary method_32602Lnet/minecraft/class_339;method_32602(Lnet/minecraft/class_2561;)Lnet/minecraft/class_5250;named getNarrationMessageLnet/minecraft/client/gui/widget/ClickableWidget;getNarrationMessage(Lnet/minecraft/text/Text;)Lnet/minecraft/text/MutableText;
-
renderButton
- Mappings:
Namespace Name Mixin selector official bLegq;b(Ldzt;IIF)Vintermediary method_25359Lnet/minecraft/class_339;method_25359(Lnet/minecraft/class_4587;IIF)Vnamed renderButtonLnet/minecraft/client/gui/widget/ClickableWidget;renderButton(Lnet/minecraft/client/util/math/MatrixStack;IIF)V
-
renderBackground
protected void renderBackground(MatrixStack matrices, MinecraftClient client, int mouseX, int mouseY) - Mappings:
Namespace Name Mixin selector official aLegq;a(Ldzt;Leev;II)Vintermediary method_25353Lnet/minecraft/class_339;method_25353(Lnet/minecraft/class_4587;Lnet/minecraft/class_310;II)Vnamed renderBackgroundLnet/minecraft/client/gui/widget/ClickableWidget;renderBackground(Lnet/minecraft/client/util/math/MatrixStack;Lnet/minecraft/client/MinecraftClient;II)V
-
onClick
public void onClick(double mouseX, double mouseY) - Mappings:
Namespace Name Mixin selector official aLegq;a(DD)Vintermediary method_25348Lnet/minecraft/class_339;method_25348(DD)Vnamed onClickLnet/minecraft/client/gui/widget/ClickableWidget;onClick(DD)V
-
onRelease
public void onRelease(double mouseX, double mouseY) - Mappings:
Namespace Name Mixin selector official bLegq;b(DD)Vintermediary method_25357Lnet/minecraft/class_339;method_25357(DD)Vnamed onReleaseLnet/minecraft/client/gui/widget/ClickableWidget;onRelease(DD)V
-
onDrag
protected void onDrag(double mouseX, double mouseY, double deltaX, double deltaY) - Mappings:
Namespace Name Mixin selector official aLegq;a(DDDD)Vintermediary method_25349Lnet/minecraft/class_339;method_25349(DDDD)Vnamed onDragLnet/minecraft/client/gui/widget/ClickableWidget;onDrag(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 official aLehq;a(DDI)Zintermediary method_25402Lnet/minecraft/class_364;method_25402(DDI)Znamed mouseClickedLnet/minecraft/client/gui/Element;mouseClicked(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 official cLehq;c(DDI)Zintermediary method_25406Lnet/minecraft/class_364;method_25406(DDI)Znamed mouseReleasedLnet/minecraft/client/gui/Element;mouseReleased(DDI)Z
-
isValidClickButton
protected boolean isValidClickButton(int button) - Mappings:
Namespace Name Mixin selector official h_Legq;h_(I)Zintermediary method_25351Lnet/minecraft/class_339;method_25351(I)Znamed isValidClickButtonLnet/minecraft/client/gui/widget/ClickableWidget;isValidClickButton(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 official aLehq;a(DDIDD)Zintermediary method_25403Lnet/minecraft/class_364;method_25403(DDIDD)Znamed mouseDraggedLnet/minecraft/client/gui/Element;mouseDragged(DDIDD)Z
-
clicked
protected boolean clicked(double mouseX, double mouseY) - Mappings:
Namespace Name Mixin selector official cLegq;c(DD)Zintermediary method_25361Lnet/minecraft/class_339;method_25361(DD)Znamed clickedLnet/minecraft/client/gui/widget/ClickableWidget;clicked(DD)Z
-
isHovered
public boolean isHovered()- Mappings:
Namespace Name Mixin selector official fLegq;f()Zintermediary method_25367Lnet/minecraft/class_339;method_25367()Znamed isHoveredLnet/minecraft/client/gui/widget/ClickableWidget;isHovered()Z
-
changeFocus
public boolean changeFocus(boolean lookForwards) Changes the focusing element by cycling to the next/previous element. This action is done typically when the user has pressed the 'Tab' or 'Ctrl+Tab' key.- Specified by:
changeFocusin interfaceElement- Parameters:
lookForwards-trueto cycle forwards, otherwise cycle backwards- Returns:
trueto indicate that the event handling is successful/valid- Mappings:
Namespace Name Mixin selector official bLehq;b(Z)Zintermediary method_25407Lnet/minecraft/class_364;method_25407(Z)Znamed changeFocusLnet/minecraft/client/gui/Element;changeFocus(Z)Z
-
onFocusedChanged
protected void onFocusedChanged(boolean newFocused) - Mappings:
Namespace Name Mixin selector official cLegq;c(Z)Vintermediary method_25363Lnet/minecraft/class_339;method_25363(Z)Vnamed onFocusedChangedLnet/minecraft/client/gui/widget/ClickableWidget;onFocusedChanged(Z)V
-
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 official a_Lehq;a_(DD)Zintermediary method_25405Lnet/minecraft/class_364;method_25405(DD)Znamed isMouseOverLnet/minecraft/client/gui/Element;isMouseOver(DD)Z
-
renderTooltip
- Mappings:
Namespace Name Mixin selector official aLegq;a(Ldzt;II)Vintermediary method_25352Lnet/minecraft/class_339;method_25352(Lnet/minecraft/class_4587;II)Vnamed renderTooltipLnet/minecraft/client/gui/widget/ClickableWidget;renderTooltip(Lnet/minecraft/client/util/math/MatrixStack;II)V
-
playDownSound
- Mappings:
Namespace Name Mixin selector official aLegq;a(Lfmb;)Vintermediary method_25354Lnet/minecraft/class_339;method_25354(Lnet/minecraft/class_1144;)Vnamed playDownSoundLnet/minecraft/client/gui/widget/ClickableWidget;playDownSound(Lnet/minecraft/client/sound/SoundManager;)V
-
getWidth
public int getWidth()- Mappings:
Namespace Name Mixin selector official gLegq;g()Iintermediary method_25368Lnet/minecraft/class_339;method_25368()Inamed getWidthLnet/minecraft/client/gui/widget/ClickableWidget;getWidth()I
-
setWidth
public void setWidth(int width) - Mappings:
Namespace Name Mixin selector official bLegq;b(I)Vintermediary method_25358Lnet/minecraft/class_339;method_25358(I)Vnamed setWidthLnet/minecraft/client/gui/widget/ClickableWidget;setWidth(I)V
-
setAlpha
public void setAlpha(float alpha) - Mappings:
Namespace Name Mixin selector official aLegq;a(F)Vintermediary method_25350Lnet/minecraft/class_339;method_25350(F)Vnamed setAlphaLnet/minecraft/client/gui/widget/ClickableWidget;setAlpha(F)V
-
setMessage
- Mappings:
Namespace Name Mixin selector official bLegq;b(Lrm;)Vintermediary method_25355Lnet/minecraft/class_339;method_25355(Lnet/minecraft/class_2561;)Vnamed setMessageLnet/minecraft/client/gui/widget/ClickableWidget;setMessage(Lnet/minecraft/text/Text;)V
-
getMessage
- Mappings:
Namespace Name Mixin selector official hLegq;h()Lrm;intermediary method_25369Lnet/minecraft/class_339;method_25369()Lnet/minecraft/class_2561;named getMessageLnet/minecraft/client/gui/widget/ClickableWidget;getMessage()Lnet/minecraft/text/Text;
-
isFocused
public boolean isFocused()- Mappings:
Namespace Name Mixin selector official iLegq;i()Zintermediary method_25370Lnet/minecraft/class_339;method_25370()Znamed isFocusedLnet/minecraft/client/gui/widget/ClickableWidget;isFocused()Z
-
isNarratable
public boolean isNarratable()- Specified by:
isNarratablein interfaceSelectable- Mappings:
Namespace Name Mixin selector official al_Leis;al_()Zintermediary method_37303Lnet/minecraft/class_6379;method_37303()Znamed isNarratableLnet/minecraft/client/gui/Selectable;isNarratable()Z
-
setFocused
protected void setFocused(boolean focused) - Mappings:
Namespace Name Mixin selector official dLegq;d(Z)Vintermediary method_25365Lnet/minecraft/class_339;method_25365(Z)Vnamed setFocusedLnet/minecraft/client/gui/widget/ClickableWidget;setFocused(Z)V
-
getType
- Specified by:
getTypein interfaceSelectable- Mappings:
Namespace Name Mixin selector official sLeis;s()Leis$a;intermediary method_37018Lnet/minecraft/class_6379;method_37018()Lnet/minecraft/class_6379$class_6380;named getTypeLnet/minecraft/client/gui/Selectable;getType()Lnet/minecraft/client/gui/Selectable$SelectionType;
-
appendDefaultNarrations
- Mappings:
Namespace Name Mixin selector official bLegq;b(Leiu;)Vintermediary method_37021Lnet/minecraft/class_339;method_37021(Lnet/minecraft/class_6382;)Vnamed appendDefaultNarrationsLnet/minecraft/client/gui/widget/ClickableWidget;appendDefaultNarrations(Lnet/minecraft/client/gui/screen/narration/NarrationMessageBuilder;)V
-