|
|
| Line 1: |
Line 1: |
| − | =Members=
| + | This page has moved to: https://docs.sine.space/v/scripting/client-scripting/components/suitoggle |
| − | {{ScriptFunction|void|OnValueChanged|(Closure callback)|Binds a function to be triggered when value of the UIToggle changes|5=<pre>ovc = function()
| + | |
| − | Space.Log("Toggled")
| + | |
| − | end
| + | |
| − | Space.Host.ExecutingObject.UIToggle.OnValueChanged(ovc)</pre>|6=<pre>--This script will make a UI Toggle show/hide the Notification Button
| + | |
| − | --(example: tools for user to customize UI)
| + | |
| − | --[You need to add an object with UI Toggle as a reference (scripting runtime)]
| + | |
| − | | + | |
| − | toggle = Space.Host.GetReference("Toggle").UIToggle
| + | |
| − | | + | |
| − | | + | |
| − | OnValueChanged = function()
| + | |
| − | if toggle.IsOn then
| + | |
| − | Space.UI.ShowNotificationButton= true
| + | |
| − | else
| + | |
| − | Space.UI.ShowNotificationButton= false
| + | |
| − | end
| + | |
| − | end
| + | |
| − | | + | |
| − | toggle.OnValueChanged(OnValueChanged)</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | | + | |
| − | =Properties=
| + | |
| − | | + | |
| − | {{ScriptFunction|bool|Enabled|{ get;set; }|Whether the UIToggle is Enabled or not|5= <pre>Space.Host.ExecutingObject.UIToggle.Enabled = true</pre>|6=<pre>--clicking this object will toggle a Toggles's Enabled status
| + | |
| − | | + | |
| − | thisGameObject = Space.Host.ExecutingObject
| + | |
| − | toggle = Space.Host.GetReference("toggle").UIToggle
| + | |
| − | --make sure to add this reference to the Scripting Runtime component
| + | |
| − | | + | |
| − | | + | |
| − | OnClick = function()
| + | |
| − | toggle.Enabled = not toggle.Enabled
| + | |
| − | end
| + | |
| − | | + | |
| − | | + | |
| − | thisGameObject.AddClickable()
| + | |
| − | thisGameObject.Clickable.OnClick(OnClick)</pre>}}
| + | |
| − | | + | |
| − | {{ScriptFunction|bool|Interactable|{ get;set; }|Whether the UIToggle is Interactable or not|5= <pre>Space.Host.ExecutingObject.UIToggle.Interactable = true</pre>|6=<pre>--clicking this object will toggle a Toggles's Interactable status
| + | |
| − | | + | |
| − | thisGameObject = Space.Host.ExecutingObject
| + | |
| − | toggle = Space.Host.GetReference("toggle").UIToggle
| + | |
| − | --make sure to add this reference to the Scripting Runtime component
| + | |
| − | | + | |
| − | | + | |
| − | OnClick = function()
| + | |
| − | toggle.Interactable= not toggle.Interactable
| + | |
| − | end
| + | |
| − | | + | |
| − | | + | |
| − | thisGameObject.AddClickable()
| + | |
| − | thisGameObject.Clickable.OnClick(OnClick)</pre>}}
| + | |
| − | | + | |
| − | {{ScriptFunction|bool|IsOn|{ get;set; }|Whether the UIToggle is toggled On or Off|5= <pre>Space.Host.ExecutingObject.UIToggle.IsOn = true</pre>|6=<pre>--This script will make a UI Toggle show/hide the Notification Button
| + | |
| − | --(example: tools for user to customize UI)
| + | |
| − | --[You need to add an object with UI Toggle as a reference (scripting runtime)]
| + | |
| − | | + | |
| − | toggle = Space.Host.GetReference("Toggle").UIToggle
| + | |
| − | | + | |
| − | | + | |
| − | OnValueChanged = function()
| + | |
| − | if toggle.IsOn then
| + | |
| − | Space.UI.ShowNotificationButton= true
| + | |
| − | else
| + | |
| − | Space.UI.ShowNotificationButton= false
| + | |
| − | end
| + | |
| − | end
| + | |
| − | | + | |
| − | toggle.OnValueChanged(OnValueChanged)</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}}
| + | |
