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

Class WidgetButtonExtended

java.lang.Object
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, net.minecraft.client.gui.components.events.GuiEventListener, net.minecraft.client.gui.components.Renderable, net.minecraft.client.gui.components.TabOrderedElement, net.minecraft.client.gui.layouts.LayoutElement, 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
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.Builder, net.minecraft.client.gui.components.Button.CreateNarration, net.minecraft.client.gui.components.Button.OnPress

    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

    createNarration, DEFAULT_HEIGHT, DEFAULT_NARRATION, DEFAULT_WIDTH, onPress, SMALL_WIDTH

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

    TEXT_MARGIN, TEXTURE_BORDER_X, TEXTURE_BORDER_Y, TEXTURE_HEIGHT, TEXTURE_WIDTH, TEXTURE_Y_OFFSET

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

    ACCESSIBILITY_TEXTURE, active, alpha, height, isHovered, packedFGColor, UNSET_FG_COLOR, visible, WIDGETS_LOCATION, width

    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
    String
    getTag()
    Get the data to send to the server.
    void
    onPress()
     
    void
    renderWidget(net.minecraft.client.gui.GuiGraphics graphics, 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 tip)
     
    WidgetButtonExtended
    setTooltipText(List<net.minecraft.network.chat.Component> comps)
     
    WidgetButtonExtended
    setTooltipText(net.minecraft.network.chat.Component comp)
     
    WidgetButtonExtended
    setVisible(boolean visible)
     
    WidgetButtonExtended
    withTag(String tag)
    Added a string tag to the button.
    WidgetButtonExtended
    withTag(Supplier<String> tagSupplier)
     

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

    builder, createNarrationMessage, updateWidgetNarration

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

    keyPressed, onClick, renderString

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

    clearFGColor, clicked, createTooltipPositioner, defaultButtonNarrationText, getFGColor, getHeight, getMessage, getRectangle, getTabOrderGroup, getTooltip, getWidth, getX, getY, isActive, isFocused, isHovered, isHoveredOrFocused, isMouseOver, isValidClickButton, mouseClicked, mouseDragged, mouseReleased, narrationPriority, nextFocusPath, onDrag, onRelease, playDownSound, render, renderScrollingString, renderScrollingString, renderTexture, setAlpha, setFGColor, setFocused, setHeight, setMessage, setTabOrderGroup, setTooltip, setTooltipDelay, setWidth, setX, setY, updateNarration, visitWidgets, wrapDefaultNarrationMessage

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

    Methods inherited from interface net.minecraft.client.gui.layouts.LayoutElement

    setPosition

  • 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

    • withTag

      public WidgetButtonExtended withTag(Supplier<String> tagSupplier)

    • 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)

    • setHighlightWhenInactive

      public void setHighlightWhenInactive(boolean highlight)

    • setRenderStackSize

      public void setRenderStackSize(boolean renderStackSize)

    • renderWidget

      public void renderWidget(net.minecraft.client.gui.GuiGraphics graphics, int x, int y, float partialTicks)
      Overrides:
      renderWidget in class net.minecraftforge.client.gui.widget.ExtendedButton

    • setTooltipText

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

    • setTooltipText

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

    • setTooltipKey

      public WidgetButtonExtended setTooltipKey(String tip)