Slider#

public class Slider#

A control for choosing a number by dragging a handle along a track. Added to a Canvas or a Panel.

RectTransform getRectTransform()#

The rect transform for the UI object.

LayoutElement getLayoutElement()#

How much space the UI object asks a layout for.

Note

Only has an effect when the object is in a panel that has a layout. A canvas is not inside a layout and does not have one.

boolean getVisible()#
void setVisible(boolean value)#

Whether the UI object is visible.

Note

This is the object’s own setting, which is what it was last set to. An object is only drawn when everything it is inside is visible as well, so an interface can be built with its parts visible, inside a panel that is not, and shown all at once by making that panel visible.

float getValue()#
void setValue(float value)#

The value of the slider, between Slider.getMin() and Slider.getMax(). Setting a value outside the range is refused.

float getMin()#
void setMin(float value)#

The value at the low end of the slider, which is its left hand end, or the bottom of a vertical slider. Must not be greater than Slider.getMax().

float getMax()#
void setMax(float value)#

The value at the high end of the slider, which is its right hand end, or the top of a vertical slider. Must not be less than Slider.getMin().

boolean getChanged()#
void setChanged(boolean value)#

Whether the slider has been changed.

Note

This property is set to true when the user moves the slider, and not when a client sets its value. A client script should reset the property to false in order to detect subsequent changes.

boolean getInteractable()#
void setInteractable(boolean value)#

Whether the control responds to the user.

Note

A control that is not interactable is drawn grayed out and ignores the user, but is still visible. Set its visibility to false to hide it instead.

StdLib.ColorRGBA getColor()#
void setColor(StdLib.ColorRGBA value)#

The color the control is tinted with. White, the default, leaves the control drawn as the skin has it.

Note

The tint multiplies the sprite the control is drawn with, in every state, so a control can show a state of its own, an engaged autopilot for instance, by color. It is applied to the part of the control that responds to the user: the body of a button, dropdown or input field, the box of a toggle, and the handle of a slider. A control’s label is tinted through the color of its text.

String getTooltip()#
void setTooltip(String value)#

A short piece of text shown beside the pointer while it rests on the control. Empty, the default, shows nothing.

void remove()#

Remove the UI object.