Package me.desht.pneumaticcraft.client.gui.widget

Class WidgetButtonExtended

java.lang.Object
net.minecraft.client.gui.GuiComponent
net.minecraft.client.gui.components.AbstractWidget
net.minecraft.client.gui.components.AbstractButton
net.minecraft.client.gui.components.Button
net.minecraftforge.client.gui.widget.ExtendedButton
me.desht.pneumaticcraft.client.gui.widget.WidgetButtonExtended
All Implemented Interfaces:
ITaggedWidget, ITooltipProvider, net.minecraft.client.gui.components.events.GuiEventListener, net.minecraft.client.gui.components.Widget, net.minecraft.client.gui.narration.NarratableEntry, net.minecraft.client.gui.narration.NarrationSupplier
Direct Known Subclasses:
KeybindingButton, WidgetColorSelector, WidgetRangeToggleButton
public class WidgetButtonExtended extends net.minecraftforge.client.gui.widget.ExtendedButton implements ITaggedWidget, ITooltipProvider
Extension of GuiButtonExt that add: 1) a string tag which is sent to the server when clicked (PacketGuiButton), 2) ability to draw itemstack or textured icons, and 3) can render its area when invisible

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    WidgetButtonExtended.IconPosition
     

    Nested classes/interfaces inherited from class net.minecraft.client.gui.components.Button

    net.minecraft.client.gui.components.Button.OnPress, net.minecraft.client.gui.components.Button.OnTooltip

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

    net.minecraft.client.gui.narration.NarratableEntry.NarrationPriority

  • Field Summary

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

    DEFAULT_HEIGHT, DEFAULT_WIDTH, NO_TOOLTIP, onPress, onTooltip, SMALL_WIDTH

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

    active, alpha, height, isHovered, packedFGColor, UNSET_FG_COLOR, visible, WIDGETS_LOCATION, width, x, y

    Fields inherited from class net.minecraft.client.gui.GuiComponent

    BACKGROUND_LOCATION, GUI_ICONS_LOCATION, STATS_ICON_LOCATION

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

    DOUBLE_CLICK_THRESHOLD_MS

  • Constructor Summary

    Constructors
    Constructor
    Description
    WidgetButtonExtended(int startX, int startY, int xSize, int ySize)
     
    WidgetButtonExtended(int startX, int startY, int xSize, int ySize, String buttonText)
     
    WidgetButtonExtended(int startX, int startY, int xSize, int ySize, String buttonText, net.minecraft.client.gui.components.Button.OnPress pressable)
     
    WidgetButtonExtended(int startX, int startY, int xSize, int ySize, net.minecraft.network.chat.Component buttonText)
     
    WidgetButtonExtended(int startX, int startY, int xSize, int ySize, net.minecraft.network.chat.Component buttonText, net.minecraft.client.gui.components.Button.OnPress pressable)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addTooltip(double mouseX, double mouseY, List<net.minecraft.network.chat.Component> curTip, boolean shift)
     
    int
    getHeight()
     
    String
    getTag()
    Get the data to send to the server.
    List<net.minecraft.network.chat.Component>
    getTooltip()
     
    int
    getWidth()
     
    boolean
    hasTooltip()
     
    void
    onPress()
     
    void
    renderButton(com.mojang.blaze3d.vertex.PoseStack matrixStack, int x, int y, float partialTicks)
     
    void
    setHighlightWhenInactive(boolean highlight)
     
    WidgetButtonExtended
    setIconPosition(WidgetButtonExtended.IconPosition iconPosition)
     
    WidgetButtonExtended
    setIconSpacing(int spacing)
     
    WidgetButtonExtended
    setInvisibleHoverColor(int color)
     
    WidgetButtonExtended
    setRenderedIcon(net.minecraft.resources.ResourceLocation resLoc)
     
    WidgetButtonExtended
    setRenderStacks(net.minecraft.world.item.ItemStack... renderedStacks)
     
    void
    setRenderStackSize(boolean renderStackSize)
     
    WidgetButtonExtended
    setTexture(Object texture)
     
    WidgetButtonExtended
    setTooltipKey(String key, Object... params)
     
    WidgetButtonExtended
    setTooltipText(List<net.minecraft.network.chat.Component> tooltip)
     
    WidgetButtonExtended
    setTooltipText(net.minecraft.network.chat.Component tooltip)
     
    WidgetButtonExtended
    setVisible(boolean visible)
     
    WidgetButtonExtended
    withTag(String tag)
    Added a string tag to the button.

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

    renderToolTip, updateNarration

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

    keyPressed, onClick

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

    changeFocus, clearFGColor, clicked, createNarrationMessage, defaultButtonNarrationText, getFGColor, getMessage, getYImage, isActive, isFocused, isHoveredOrFocused, isMouseOver, isValidClickButton, mouseClicked, mouseDragged, mouseReleased, narrationPriority, onDrag, onFocusedChanged, onRelease, playDownSound, render, renderBg, setAlpha, setFGColor, setFocused, setHeight, setMessage, setWidth, wrapDefaultNarrationMessage

    Methods inherited from class net.minecraft.client.gui.GuiComponent

    blit, blit, blit, blit, blit, blitOutlineBlack, disableScissor, drawCenteredString, drawCenteredString, drawCenteredString, drawString, drawString, drawString, enableScissor, fill, fillGradient, fillGradient, fillGradient, getBlitOffset, hLine, setBlitOffset, vLine

    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, keyReleased, mouseMoved, mouseScrolled

    Methods inherited from interface me.desht.pneumaticcraft.client.gui.widget.ITooltipProvider

    shouldProvide

  • Constructor Details

    • WidgetButtonExtended

      public WidgetButtonExtended(int startX, int startY, int xSize, int ySize, net.minecraft.network.chat.Component buttonText, net.minecraft.client.gui.components.Button.OnPress pressable)

    • WidgetButtonExtended

      public WidgetButtonExtended(int startX, int startY, int xSize, int ySize, net.minecraft.network.chat.Component buttonText)

    • WidgetButtonExtended

      public WidgetButtonExtended(int startX, int startY, int xSize, int ySize, String buttonText, net.minecraft.client.gui.components.Button.OnPress pressable)

    • WidgetButtonExtended

      public WidgetButtonExtended(int startX, int startY, int xSize, int ySize, String buttonText)

    • WidgetButtonExtended

      public WidgetButtonExtended(int startX, int startY, int xSize, int ySize)

  • Method Details

    • withTag

      public WidgetButtonExtended withTag(String tag)
      Added a string tag to the button. This will be sent to the server as the payload of a PacketGuiButton packet when the button is clicked.
      Parameters:
      tag - a string tag containing any arbitrary information
      Returns:
      the button, for fluency

    • onPress

      public void onPress()
      Overrides:
      onPress in class net.minecraft.client.gui.components.Button

    • getTag

      public String getTag()
      Description copied from interface: ITaggedWidget
      Get the data to send to the server. This is just some arbitrary string data which will be processed by the server-side container.
      Specified by:
      getTag in interface ITaggedWidget
      Returns:
      a string tag containing any arbitrary information

    • setVisible

      public WidgetButtonExtended setVisible(boolean visible)

    • setInvisibleHoverColor

      public WidgetButtonExtended setInvisibleHoverColor(int color)

    • setIconPosition

      public WidgetButtonExtended setIconPosition(WidgetButtonExtended.IconPosition iconPosition)

    • setRenderStacks

      public WidgetButtonExtended setRenderStacks(net.minecraft.world.item.ItemStack... renderedStacks)

    • setRenderedIcon

      public WidgetButtonExtended setRenderedIcon(net.minecraft.resources.ResourceLocation resLoc)

    • setIconSpacing

      public WidgetButtonExtended setIconSpacing(int spacing)

    • setTexture

      public WidgetButtonExtended setTexture(Object texture)

    • setTooltipKey

      public WidgetButtonExtended setTooltipKey(String key, Object... params)

    • setTooltipText

      public WidgetButtonExtended setTooltipText(net.minecraft.network.chat.Component tooltip)

    • setTooltipText

      public WidgetButtonExtended setTooltipText(List<net.minecraft.network.chat.Component> tooltip)

    • setHighlightWhenInactive

      public void setHighlightWhenInactive(boolean highlight)

    • addTooltip

      public void addTooltip(double mouseX, double mouseY, List<net.minecraft.network.chat.Component> curTip, boolean shift)
      Specified by:
      addTooltip in interface ITooltipProvider

    • hasTooltip

      public boolean hasTooltip()

    • getTooltip

      public List<net.minecraft.network.chat.Component> getTooltip()

    • getWidth

      public int getWidth()
      Overrides:
      getWidth in class net.minecraft.client.gui.components.AbstractWidget

    • getHeight

      public int getHeight()
      Overrides:
      getHeight in class net.minecraft.client.gui.components.AbstractWidget

    • setRenderStackSize

      public void setRenderStackSize(boolean renderStackSize)

    • renderButton

      public void renderButton(com.mojang.blaze3d.vertex.PoseStack matrixStack, int x, int y, float partialTicks)
      Overrides:
      renderButton in class net.minecraftforge.client.gui.widget.ExtendedButton