SUISlider

Index

Functions Index

Function Name
void OnValueChanged (Closure callback)

Properties Index

Property Name
bool Enabled get set
bool Interactable get set
int Direction get set
float MinValue get set
float MaxValue get set
bool WholeNumbers get set
float Value get set
float NormalizedValue get set
SColor NormalColor get set
SColor HighlightedColor get set
SColor PressedColor get set
SColor DisabledColor get set
float ColorMultiplier get set
SGameObject GameObject get

Functions

OnValueChanged

void OnValueChanged (Closure callback)

Callback executed when the value of the slider is changed.

Parameter	Type	Description

Lua

function ValueChanged()
--
end

Space.Host.ExecutingObject.UISlider.OnValueChanged(ValueChanged)

Lua

--This script will make moving a slider control the Master Volume
--and also update a text field with the current Master Volume
--[You need to add the slider and text field as a reference]

slider = Space.Host.GetReference("Slider").UISlider
textField = Space.Host.GetReference("Text Field").UIText


OnValueChanged = function()
Space.UI.MasterVolume = slider.NormalizedValue * 100
textField.Text = Space.UI.MasterVolume
end

slider.OnValueChanged(OnValueChanged)

Properties

Enabled

bool Enabled get set

Whether this Slider component is Enabled or not

Lua

Space.Host.ExecutingObject.UISlider.Enabled = false 

Lua

--clicking this object will toggle a Sliders's Enabled status

thisGameObject = Space.Host.ExecutingObject
slider = Space.Host.GetReference("slider").UISlider 
--make sure to add this reference to the Scripting Runtime component


OnClick = function()
slider.Enabled =  not slider.Enabled
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

Interactable

bool Interactable get set

Use to enable or disable the ability to interact with the slider.

Lua

Space.Host.ExecutingObject.UISlider.Interactable = true

Lua

--clicking this object will toggle a Sliders's Interactable status

thisGameObject = Space.Host.ExecutingObject
slider = Space.Host.GetReference("slider").UISlider 
--make sure to add this reference to the Scripting Runtime component


OnClick = function()
slider.Interactable =  not slider.Interactable
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

Direction

int Direction get set

The direction of the slider (0 to 4). 0 Left To Right, 1 Right To Left, 2 Bottom To Top, 3 Top To Bottom

Lua

Space.Host.ExecutingObject.UISlider.Direction = 1

MinValue

float MinValue get set

The minimum allowed value of the slider.

Lua

Space.Host.ExecutingObject.UISlider.MinValue = 10

MaxValue

float MaxValue get set

The maximum allowed value of the slider.

Lua

Space.Host.ExecutingObject.UISlider.MaxValue = 20

WholeNumbers

bool WholeNumbers get set

Should the value only be allowed to be whole numbers?

Lua

Space.Host.ExecutingObject.UISlider.WholeNumbers = true

Lua

--clicking this object will toggle a Sliders's Whole Numbers status

thisGameObject = Space.Host.ExecutingObject
slider = Space.Host.GetReference("slider").UISlider 
--make sure to add this reference to the Scripting Runtime component


OnClick = function()
slider.WholeNumbers =  not slider.WholeNumbers
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

Value

float Value get set

The current value of the slider.

Lua

Space.Host.ExecutingObject.UISlider.Value = 20

NormalizedValue

float NormalizedValue get set

The current value of the slider normalized into a value between 0 and 1.

Lua

Space.Host.ExecutingObject.UISlider.NormalizedValue = 0.5

Lua

--This script will make moving a slider control the Master Volume
--and also update a text field with the current Master Volume
--(example: custom UI)
--[You need to add the slider and text field as a reference]

slider = Space.Host.GetReference("Slider").UISlider
textField = Space.Host.GetReference("Text Field").UIText


OnValueChanged = function()
Space.UI.MasterVolume = slider.NormalizedValue * 100
textField.Text = Space.UI.MasterVolume
end

slider.OnValueChanged(OnValueChanged)

NormalColor

SColor NormalColor get set

The normal color.

Lua

Space.Host.ExecutingObject.UISlider.NormalColor = Color.Red

HighlightedColor

SColor HighlightedColor get set

The color of the control when it is highlighted.

Lua

Space.Host.ExecutingObject.UISlider.HighlightedColor = Color.Red

PressedColor

SColor PressedColor get set

The color of the control when it is pressed.

Lua

Space.Host.ExecutingObject.UISlider.PressedColor = Color.Red

DisabledColor

SColor DisabledColor get set

The color of the control when it is disabled.

Lua

lSpace.Host.ExecutingObject.UISlider.DisabledColor = Color.Red

ColorMultiplier

float ColorMultiplier get set

This multiplies the tint color for each transition by its value.

Lua

Space.Host.ExecutingObject.UISlider.ColorMultiplier = 1.2

GameObject

SGameObject GameObject get

Property Description

Lua

theGameObject = Space.Host.ExecutingObject.UISlider.GameObject