Slider

Slider

Slider elements are interactable Gauges whose value can be increased or decreased based on input.

Note: For example, volume sliders for sound effects or music.

Properties

System

Name	Explanation	Type
Animate When Unfocused	Whether or not to animate the cursor and fill when unfocused.	Toggle
Change	The amount the slider value changes per input step.	Variable or Value
Color Mask	The color mask to apply to the element.	Color
Confirm Sound Effect	The sound to play when confirmation occurs.	Sound Effect
Current Value	The variable or value that tracks the current position of the slider.	Variable or Value
Cursor Offset	The amount in pixels to offset the cursor on the element.	Point
Disabled Effects	The visual effects applied when this element is disabled.	User Interface Element Effect
Execute Script	The script to execute when the confirm button is pressed.	Script
Fill	The sprite to use for the filled area between the start and end of the slider.	Sprite or Model
Fill Strategy	The method used to render the fill sprite between the start and end of the slider.	Fill Strategy
Focus Script	The script to execute when the item gets focus.	Script
Focused Effects	The visual effects applied when this element has focus.	User Interface Element Effect
Hide Cursor When Unfocused	Whether or not to hide the cursor when the element is unfocused.	Toggle
Invert Direction	Whether or not to invert the direction of the slider.	Toggle
Is Linked to Selected Context	Whether this element's context updates to reflect the currently selected item in the interface.	Toggle
Is Linked to UI Context	Whether this element's context is linked to the parent interface's context.	Toggle
Is Visible	Whether the element is visible when the interface first loads. Can be toggled at runtime via effects or scripts.	Toggle
Margin	The margin around the element in pixels.	Margin
Maximum Value	The variable or value that defines the upper bound of the slider range.	Variable or Value
Minimum Value	The variable or value that defines the lower bound of the slider range.	Variable or Value
Movement Sound Effect	The sound to play when a cursor moves.	Sound Effect
Name	The name of the element.	String
Orientation	The orientation of the slider.	Orientation
Pixel Height	The height in pixels of the element.	Number
Pixel Width	The width in pixels of the element.	Number
Pixel X	The x coordinate in pixels of the element.	Number
Pixel Y	The y coordinate in pixels of the element.	Number
Relative Height	The height relative to the container of the element.	Number
Relative Width	The width relative to the container of the element.	Number
Relative X	The x coordinate relative to the container of the element.	Number
Relative Y	The y coordinate relative to the container of the element.	Number
Selected Effects	The visual effects applied when this element is selected.	User Interface Element Effect
Sprite	The sprite to use for the current position of the slider.	Sprite or Model
Template Type	The data type expected when this element is used with templated data binding.	String
Unfocus Script	The script to execute when the item loses focus.	Script
Unfocused Effects	The visual effects applied when this element loses focus.	User Interface Element Effect
Use Default Sounds	Whether or not to use the default system sound effects.	Toggle
Use Floating Points	Whether or not to use floating points when evaluating the values.	Toggle
Use Integers	Whether or not to use integers when evaluating the values.	Toggle
Use Relative Positioning	Whether to use screen-relative coordinates (0.0 to 1.0) instead of pixel coordinates for positioning and sizing.	Toggle
Value Changed Script	The script to execute when the value changes.	Script

Fill Strategy

Name	Explanation
Repeat	Tiles the image repeatedly to fill the area.
Percentage	Fills a percentage of the area based on the current value.
Stretch	Stretches the image to fill the entire area.

Orientation

Name	Explanation
Horizontal	Items are arranged in a horizontal row.
Vertical	Items are arranged in a vertical column.