wiki.sine.space | sinespace

Difference between revisions of "Scripting/SUISlider"

From wiki.sine.space
Jump to: navigation, search
(Added simple examples to SUISlider .WholeNumbers . Value .NormalizedValue .MinValue .MaxValue .Interactable .Enabled . Direction .OnValueChanged)
Line 10: Line 10:
  
 
==Properties==
 
==Properties==
{{ScriptFunction|float|ColorMultiplier|{ get;set; }|Multiplier applied to colors (allows brightening greater then base color).|5=<pre></pre>}}
+
{{ScriptFunction|float|ColorMultiplier|{get;set}|This multiplies the tint color for each transition by its value.|5=  
 +
local slider=Space.Host.GetReference("Slider").UISlider<br>
 +
Space.Log(slider.ColorMultiplier)
 +
}}
 
{{ScriptFunction|Slider.Direction|Direction|{ get;set; }|The direction of the slider (0 to 4).
 
{{ScriptFunction|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|5=<pre>Space.Host.ExecutingObject.UISlider.Direction = 1</pre>}}
 
0 Left To Right, 1 Right To Left, 2 Bottom To Top, 3 Top To Bottom|5=<pre>Space.Host.ExecutingObject.UISlider.Direction = 1</pre>}}

Revision as of 02:07, 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; }

Disabled Color.


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; }

Highlighted Color.


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; }

Normal Color.


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; }

Pressed Color.


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