All pages
Powered by GitBook
1 of 1

Loading...

SUISlider

Index

Functions Index

Function Name

Properties Index

Property Name

Functions

OnValueChanged

void OnValueChanged (Closure callback)

Callback executed when the value of the slider is changed.

Parameter
Type
Description

Properties

Enabled

bool Enabled get set

Whether this Slider component is Enabled or not

Interactable

bool Interactable get set

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

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

MinValue

float MinValue get set

The minimum allowed value of the slider.

MaxValue

float MaxValue get set

The maximum allowed value of the slider.

WholeNumbers

bool WholeNumbers get set

Should the value only be allowed to be whole numbers?

Value

float Value get set

The current value of the slider.

NormalizedValue

float NormalizedValue get set

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

NormalColor

NormalColor get set

The normal color.

HighlightedColor

HighlightedColor get set

The color of the control when it is highlighted.

PressedColor

PressedColor get set

The color of the control when it is pressed.

DisabledColor

DisabledColor get set

The color of the control when it is disabled.

ColorMultiplier

float ColorMultiplier get set

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

GameObject

GameObject get

Property Description

SColor get set

SColor get set

float get set

SGameObject get

void OnValueChanged (Closure callback)

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
SColor
SColor
SColor
SGameObject

SColor get set

function ValueChanged()
--
end

Space.Host.ExecutingObject.UISlider.OnValueChanged(ValueChanged)
--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)
Space.Host.ExecutingObject.UISlider.Enabled = false 
--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)
Space.Host.ExecutingObject.UISlider.Interactable = true
--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)
Space.Host.ExecutingObject.UISlider.Direction = 1
Space.Host.ExecutingObject.UISlider.MinValue = 10
Space.Host.ExecutingObject.UISlider.MaxValue = 20
Space.Host.ExecutingObject.UISlider.WholeNumbers = true
--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)
Space.Host.ExecutingObject.UISlider.Value = 20
Space.Host.ExecutingObject.UISlider.NormalizedValue = 0.5
--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)
Space.Host.ExecutingObject.UISlider.NormalColor = Color.Red
Space.Host.ExecutingObject.UISlider.HighlightedColor = Color.Red
Space.Host.ExecutingObject.UISlider.PressedColor = Color.Red
lSpace.Host.ExecutingObject.UISlider.DisabledColor = Color.Red
Space.Host.ExecutingObject.UISlider.ColorMultiplier = 1.2
theGameObject = Space.Host.ExecutingObject.UISlider.GameObject
HighlightedColor
PressedColor
DisabledColor
ColorMultiplier
GameObject