wiki.sine.space | sinespace

Difference between revisions of "Scripting/SUIToggle"

From wiki.sine.space
Jump to: navigation, search
(Added and defined all members of SUIToggle (4))
 
Line 14: Line 14:
  
 
{{ScriptFunction|bool|IsOn|{ get;set; }|Whether the UIToggle is toggled On or Off|5= <pre>Space.Host.ExecutingObject.UIToggle.IsOn = true</pre>}}
 
{{ScriptFunction|bool|IsOn|{ get;set; }|Whether the UIToggle is toggled On or Off|5= <pre>Space.Host.ExecutingObject.UIToggle.IsOn = true</pre>}}
 +
 +
{{ScriptFunction|SColor|NormalColor|{get;set}|The normal color.|5=
 +
local toggle=Space.Host.GetReference("Toggle").UIToggle<br>
 +
Space.Log(toggle.NormalColor.ToString())
 +
}}
 +
 +
{{ScriptFunction|SColor|HighlightedColor|{get;set}|The color of the control when it is highlighted.|5=
 +
local toggle=Space.Host.GetReference("Toggle").UIToggle<br>
 +
Space.Log(toggle.HighlightedColor.ToString())
 +
}}
 +
 +
{{ScriptFunction|SColor|PressedColor|{get;set}|The color of the control when it is pressed.|5=
 +
local toggle=Space.Host.GetReference("Toggle").UIToggle<br>
 +
Space.Log(toggle.PressedColor.ToString())
 +
}}
 +
 +
{{ScriptFunction|SColor|DisabledColor|{get;set}|The color of the control when it is disabled.|5=
 +
local toggle=Space.Host.GetReference("Toggle").UIToggle<br>
 +
Space.Log(toggle.DisabledColor.ToString())
 +
}}
 +
 +
{{ScriptFunction|float|ColorMultiplier|{get;set}|This multiplies the tint color for each transition by its value.|5=
 +
local toggle=Space.Host.GetReference("Toggle").UIToggle<br>
 +
Space.Log(toggle.ColorMultiplier)
 +
}}
 +
  
  
 
{{Scripting Navbox}}
 
{{Scripting Navbox}}

Revision as of 02:03, 30 December 2020

Members

OnValueChanged

void OnValueChanged (Closure callback)

Binds a function to be triggered when value of the UIToggle changes

ovc = function()
  Space.Log("Toggled")
  end
Space.Host.ExecutingObject.UIToggle.OnValueChanged(ovc)



Properties

Enabled

bool Enabled { get;set; }

Whether the UIToggle is Enabled or not

Space.Host.ExecutingObject.UIToggle.Enabled = true


Interactable

bool Interactable { get;set; }

Whether the UIToggle is Interactable or not

Space.Host.ExecutingObject.UIToggle.Interactable = true


IsOn

bool IsOn { get;set; }

Whether the UIToggle is toggled On or Off

Space.Host.ExecutingObject.UIToggle.IsOn = true


NormalColor

SColor NormalColor {get;set}

The normal color.

local toggle=Space.Host.GetReference("Toggle").UIToggle
Space.Log(toggle.NormalColor.ToString())


HighlightedColor

SColor HighlightedColor {get;set}

The color of the control when it is highlighted.

local toggle=Space.Host.GetReference("Toggle").UIToggle
Space.Log(toggle.HighlightedColor.ToString())


PressedColor

SColor PressedColor {get;set}

The color of the control when it is pressed.

local toggle=Space.Host.GetReference("Toggle").UIToggle
Space.Log(toggle.PressedColor.ToString())


DisabledColor

SColor DisabledColor {get;set}

The color of the control when it is disabled.

local toggle=Space.Host.GetReference("Toggle").UIToggle
Space.Log(toggle.DisabledColor.ToString())


ColorMultiplier

float ColorMultiplier {get;set}

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

local toggle=Space.Host.GetReference("Toggle").UIToggle
Space.Log(toggle.ColorMultiplier)