wiki.sine.space | sinespace

Difference between revisions of "Scripting/SUISlider"

From wiki.sine.space
Jump to: navigation, search
Line 48: Line 48:
 
--displays the current value of the slider in the console</pre>}}
 
--displays the current value of the slider in the console</pre>}}
 
{{ScriptFunction|bool|WholeNumbers|{ get;set; }|Should the value only be allowed to be whole numbers?|5=<pre>Space.Host.ExecutingObject.UISlider.WholeNumbers = true --or false</pre>}}
 
{{ScriptFunction|bool|WholeNumbers|{ get;set; }|Should the value only be allowed to be whole numbers?|5=<pre>Space.Host.ExecutingObject.UISlider.WholeNumbers = true --or false</pre>}}
 +
 +
{{Scripting Navbox}}

Revision as of 03:47, 30 December 2020

Members

OnValueChanged

void OnValueChanged (Closure callback);

Callback executed when the value of the slider is changed.

function valueChanged()
  
  Space.Log("value changed")
  
  end

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



Properties

ColorMultiplier

float ColorMultiplier {get;set}

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

local slider=Space.Host.GetReference("Slider").UISlider
Space.Log(slider.ColorMultiplier)


Direction

Slider.Direction 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

Space.Host.ExecutingObject.UISlider.Direction = 1


DisabledColor

SColor DisabledColor {get;set}

The color of the control when it is disabled.

local slider=Space.Host.GetReference("Slider").UISlider
Space.Log(slider.DisabledColor.ToString())


Enabled

bool Enabled { get;set; }

Whether this slider is Enabled or not

Space.Host.ExecutingObject.UISlider.Enabled = false  --or false


HighlightedColor

SColor HighlightedColor {get;set}

The color of the control when it is highlighted.

local slider=Space.Host.GetReference("Slider").UISlider
Space.Log(slider.HighlightedColor.ToString())


Interactable

bool Interactable { get;set;}

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

Space.Host.ExecutingObject.UISlider.Interactable = true


MaxValue

float MaxValue { get;set; }

The maximum allowed value of the slider.

Space.Host.ExecutingObject.UISlider.MaxValue = 20


MinValue

float MinValue { get;set; }

The minimum allowed value of the slider.

Space.Host.ExecutingObject.UISlider.MinValue = 10


NormalColor

SColor NormalColor {get;set}

The normal color.

local slider=Space.Host.GetReference("Slider").UISlider
Space.Log(slider.NormalColor.ToString())


NormalizedValue

float NormalizedValue { get;set; }

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

Space.Log(Space.Host.ExecutingObject.UISlider.NormalizedValue)
--displays the current normalized value of the slider in the console


PressedColor

SColor PressedColor {get;set}

The color of the control when it is pressed.

local slider=Space.Host.GetReference("Slider").UISlider
Space.Log(slider.PressedColor.ToString())


Value

float Value { get;set; }

The current value of the slider.

Space.Log(Space.Host.ExecutingObject.UISlider.Value)
--displays the current value of the slider in the console


WholeNumbers

bool WholeNumbers { get;set; }

Should the value only be allowed to be whole numbers?

Space.Host.ExecutingObject.UISlider.WholeNumbers = true --or false