Package com.pixelmonmod.pixelmon.client.gui.npc.widget

Class SliderWidget

java.lang.Object
net.minecraft.client.gui.components.AbstractWidget
net.minecraft.client.gui.components.AbstractSliderButton
net.neoforged.neoforge.client.gui.widget.ExtendedSlider
com.pixelmonmod.pixelmon.client.gui.npc.widget.SliderWidget
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, net.neoforged.neoforge.client.extensions.IAbstractWidgetExtension
public class SliderWidget extends net.neoforged.neoforge.client.gui.widget.ExtendedSlider
Slider Widget implementation allowing for Consumer actions upon setting values. A slider looks like the FOV option in the settings menu.

  • Nested Class Summary

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

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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected Consumer<Double>
    onSelected
     

    Fields inherited from class net.neoforged.neoforge.client.gui.widget.ExtendedSlider

    drawString, maxValue, minValue, prefix, stepSize, suffix

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

    TEXT_MARGIN, value

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

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

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

    DOUBLE_CLICK_THRESHOLD_MS

  • Constructor Summary

    Constructors
    Constructor
    Description
    SliderWidget(int x, int y, int width, int height, net.minecraft.network.chat.Component prefix, net.minecraft.network.chat.Component suffix, double minValue, double maxValue, double currentValue, boolean drawString)
    Overload with stepSize set to 1, useful for sliders with whole number values.
    SliderWidget(int x, int y, int width, int height, net.minecraft.network.chat.Component prefix, net.minecraft.network.chat.Component suffix, double minValue, double maxValue, double currentValue, double stepSize, int precision, boolean drawString)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    keyPressed(int keyCode, int scanCode, int modifiers)
     
    void
    onClick(double mouseX, double mouseY)
     
    protected void
    onDrag(double mouseX, double mouseY, double dragX, double dragY)
     
    SliderWidget
    setOnSelected(Consumer<Double> onSelected)
     
    void
    setSelected(Double selected)
     
    protected void
    setSliderValue(double value)
     
    void
    setValue(double value)
     
    protected void
    setValueFromMouse(double mouseX)
     
    protected double
    snapToNearest(double value)
    Snaps the value, so that the displayed value is the nearest multiple of stepSize.

    Methods inherited from class net.neoforged.neoforge.client.gui.widget.ExtendedSlider

    applyValue, getValue, getValueInt, getValueLong, getValueString, renderWidget, updateMessage

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

    createNarrationMessage, getHandleSprite, getSprite, onRelease, playDownSound, setFocused, updateWidgetNarration

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

    clearFGColor, clicked, defaultButtonNarrationText, getBottom, getFGColor, getHeight, getMessage, getRectangle, getRight, getTabOrderGroup, getTooltip, getWidth, getX, getY, isActive, isFocused, isHovered, isHoveredOrFocused, isMouseOver, isValidClickButton, mouseClicked, mouseDragged, mouseReleased, narrationPriority, nextFocusPath, render, renderScrollingString, renderScrollingString, renderScrollingString, setAlpha, setFGColor, setHeight, setMessage, setRectangle, setSize, 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.neoforged.neoforge.client.extensions.IAbstractWidgetExtension

    onClick

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

    setPosition

  • Field Details

  • Constructor Details

    • SliderWidget

      public SliderWidget(int x, int y, int width, int height, net.minecraft.network.chat.Component prefix, net.minecraft.network.chat.Component suffix, double minValue, double maxValue, double currentValue, double stepSize, int precision, boolean drawString)
      Parameters:
      x - x position of upper left corner
      y - y position of upper left corner
      width - Width of the widget
      height - Height of the widget
      prefix - Component displayed before the value string
      suffix - Component displayed after the value string
      minValue - Minimum (left) value of slider
      maxValue - Maximum (right) value of slider
      currentValue - Starting value when widget is first displayed
      stepSize - Size of step used. Precision will automatically be calculated based on this value if this value is not 0.
      precision - Only used when stepSize is 0. Limited to a maximum of 4 (inclusive).
      drawString - Should text be displayed on the widget

    • SliderWidget

      public SliderWidget(int x, int y, int width, int height, net.minecraft.network.chat.Component prefix, net.minecraft.network.chat.Component suffix, double minValue, double maxValue, double currentValue, boolean drawString)
      Overload with stepSize set to 1, useful for sliders with whole number values.

  • Method Details

    • setValue

      public void setValue(double value)
      Overrides:
      setValue in class net.neoforged.neoforge.client.gui.widget.ExtendedSlider
      Parameters:
      value - The new slider value

    • onClick

      public void onClick(double mouseX, double mouseY)
      Overrides:
      onClick in class net.neoforged.neoforge.client.gui.widget.ExtendedSlider

    • onDrag

      protected void onDrag(double mouseX, double mouseY, double dragX, double dragY)
      Overrides:
      onDrag in class net.neoforged.neoforge.client.gui.widget.ExtendedSlider

    • setValueFromMouse

      protected void setValueFromMouse(double mouseX)

    • keyPressed

      public boolean keyPressed(int keyCode, int scanCode, int modifiers)
      Specified by:
      keyPressed in interface net.minecraft.client.gui.components.events.GuiEventListener
      Overrides:
      keyPressed in class net.neoforged.neoforge.client.gui.widget.ExtendedSlider

    • setSliderValue

      protected void setSliderValue(double value)
      Parameters:
      value - Percentage of slider range

    • snapToNearest

      protected double snapToNearest(double value)
      Snaps the value, so that the displayed value is the nearest multiple of stepSize. If stepSize is 0, no snapping occurs.

    • setSelected

      public void setSelected(Double selected)

    • setOnSelected

      public SliderWidget setOnSelected(Consumer<Double> onSelected)