Package net.neoforged.neoforge.client.gui.widget

Class ExtendedSlider

java.lang.Object

net.minecraft.client.gui.components.AbstractWidget

net.minecraft.client.gui.components.AbstractSliderButton

net.neoforged.neoforge.client.gui.widget.ExtendedSlider

All Implemented Interfaces:

GuiEventListener, Renderable, TabOrderedElement, LayoutElement, NarratableEntry, NarrationSupplier, IAbstractWidgetExtension

public class ExtendedSlider
extends AbstractSliderButton

Slider widget implementation which allows inputting values in a certain range with optional step size.

Nested Class Summary

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

NarratableEntry.NarrationPriority

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	drawString
private final DecimalFormat	format
protected double	maxValue
protected double	minValue
protected Component	prefix
protected double	stepSize	Allows input of discontinuous values with a certain step
protected Component	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

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

DOUBLE_CLICK_THRESHOLD_MS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected void	applyValue()
double	getValue()
int	getValueInt()
long	getValueLong()
String	getValueString()
boolean	keyPressed(int keyCode, int scanCode, int modifiers)	Called when a keyboard key is pressed within the GUI element.
void	onClick(double mouseX, double mouseY)
protected void	onDrag(double mouseX, double mouseY, double dragX, double dragY)
void	renderWidget(GuiGraphics guiGraphics, int mouseX, int mouseY, float partialTick)
private void	setFractionalValue(double fractionalValue)
void	setValue(double value)
private void	setValueFromMouse(double mouseX)
private double	snapToNearest(double value)	Snaps the value, so that the displayed value is the nearest multiple of stepSize.
protected void	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, defaultButtonNarrationText, getBottom, getFGColor, getHeight, getMessage, getRectangle, getRight, getTabOrderGroup, getTooltip, getWidth, getX, getY, isActive, isFocused, isHovered, isHoveredOrFocused, isMouseOver, isValidClickButton, mouseClicked, mouseDragged, mouseReleased, narrationPriority, nextFocusPath, playButtonClickSound, 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, getBorderForArrowNavigation, 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

Methods inherited from interface net.minecraft.client.gui.narration.NarratableEntry

getNarratables

Field Details

prefix

protected Component prefix

suffix

protected Component suffix

minValue

protected double minValue

maxValue

protected double maxValue

stepSize

protected double stepSize

Allows input of discontinuous values with a certain step

drawString

protected boolean drawString

format

private final DecimalFormat format

Constructor Details

ExtendedSlider

public ExtendedSlider(int x,
 int y,
 int width,
 int height,
 Component prefix,
 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

ExtendedSlider

public ExtendedSlider(int x,
 int y,
 int width,
 int height,
 Component prefix,
 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

getValue

public double getValue()

Returns:

Current slider value as a double

getValueLong

public long getValueLong()

Returns:

Current slider value as an long

getValueInt

public int getValueInt()

Returns:

Current slider value as an int

setValue

public void setValue(double value)

Parameters:

value - The new slider value

getValueString

public String getValueString()

onClick

public void onClick(double mouseX,
 double mouseY)

Overrides:

onClick in class AbstractSliderButton

onDrag

protected void onDrag(double mouseX,
 double mouseY,
 double dragX,
 double dragY)

Overrides:

onDrag in class AbstractSliderButton

keyPressed

public boolean keyPressed(int keyCode,
 int scanCode,
 int modifiers)

Description copied from interface: GuiEventListener

Called when a keyboard key is pressed within the GUI element.

Specified by:

keyPressed in interface GuiEventListener

Overrides:

keyPressed in class AbstractSliderButton

Parameters:

keyCode - the key code of the pressed key.

scanCode - the scan code of the pressed key.

modifiers - the keyboard modifiers.

Returns:

true if the event is consumed, false otherwise.

setValueFromMouse

private void setValueFromMouse(double mouseX)

setFractionalValue

private void setFractionalValue(double fractionalValue)

Parameters:

fractionalValue - fractional progress between 0 and 1

snapToNearest

private 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.

Parameters:

value - fractional progress between 0 and 1

Returns:

fractional progress between 0 and 1, snapped to the nearest allowed value

updateMessage

protected void updateMessage()

Specified by:

updateMessage in class AbstractSliderButton

applyValue

protected void applyValue()

Specified by:

applyValue in class AbstractSliderButton

renderWidget

public void renderWidget(GuiGraphics guiGraphics,
 int mouseX,
 int mouseY,
 float partialTick)

Overrides:

renderWidget in class AbstractSliderButton