Package com.pixelmonmod.pixelmon.client.gui.widgets

Class OnOffButton

java.lang.Object
net.minecraft.client.gui.components.AbstractWidget
net.minecraft.client.gui.components.AbstractButton
net.minecraft.client.gui.components.Button
com.pixelmonmod.pixelmon.client.gui.widgets.IndexedButton
com.pixelmonmod.pixelmon.client.gui.widgets.OnOffButton
All Implemented Interfaces:
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
public class OnOffButton extends IndexedButton
A button that can be on or off.

  • Nested Class Summary

    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 com.pixelmonmod.pixelmon.client.gui.widgets.IndexedButton

    id

    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

    SPRITES, TEXT_MARGIN

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

    active, alpha, focused, height, hoverOrFocusedStartTime, isHovered, message, MIN_SCROLL_PERIOD, packedFGColor, PERIOD_PER_SCROLLED_PIXEL, tabOrderGroup, tooltip, tooltipMsDelay, UNSET_FG_COLOR, visible, wasHoveredOrFocused, width, x, y

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

    DOUBLE_CLICK_THRESHOLD_MS

  • Constructor Summary

    Constructors
    Constructor
    Description
    OnOffButton(int id, int x, int y, int width, int height, boolean on, net.minecraft.client.gui.components.Button.OnPress pressedAction)
    Initializes an on/off button.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isOn()
    Checks if the button is on.
    void
    setOn(boolean on)
    Sets whether the button is on.
    boolean
    toggle()
    Toggles the button on or off.

    Methods inherited from class com.pixelmonmod.pixelmon.client.gui.widgets.IndexedButton

    getID, setMessage

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

    builder, createNarrationMessage, onPress, updateWidgetNarration

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

    keyPressed, onClick, renderString, renderWidget

    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, renderScrollingString, 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

    • OnOffButton

      public OnOffButton(int id, int x, int y, int width, int height, boolean on, net.minecraft.client.gui.components.Button.OnPress pressedAction)
      Initializes an on/off button.
      Parameters:
      x - The x coordinate of the left side of the button.
      y - The y coordinate of the top of the button.
      width - The width of the button.
      height - The height of the button.
      on - Whether the button is initially on.

  • Method Details

    • toggle

      public boolean toggle()
      Toggles the button on or off.
      Returns:
      The new state of the button.

    • isOn

      public boolean isOn()
      Checks if the button is on.
      Returns:
      Whether the button is on.

    • setOn

      public void setOn(boolean on)
      Sets whether the button is on.
      Parameters:
      on - Whether the button will be on.