SUIButton
Index
Functions Index
void OnClick (Closure callback)
Properties Index
bool Enabled get
set
bool Interactable get
set
SColor NormalColor get
set
SColor HighlightedColor get
set
SColor PressedColor get
set
SColor DisabledColor get
set
float ColorMultiplier get
set
SGameObject GameObject get
Functions
OnClick
void OnClick (Closure callback)
Invoke when a user clicks the button and releases it.
function OnClickFunction()
--
end
Space.Host.ExecutingObject.UIButton.OnClick(OnClickFunction)
Properties
Enabled
bool Enabled get
set
Whether the button component is Enabled.
Space.Host.ExecutingObject.UIButton.Enabled = true
--clicking this object will toggle Enable/Disable an object's Button component
thisGameObject = Space.Host.ExecutingObject
button = Space.Host.GetReference("button").UIButton
--make sure to add this reference to the Scripting Runtime component
OnClick = function()
button.Enabled = not button.Enabled
end
thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)
Interactable
bool Interactable get
set
Enable Interactable if you want this button to accept input.
Space.Host.ExecutingObject.UIButton.Interactable = true
--clicking this object will toggle Interactable status on an object's Button component
thisGameObject = Space.Host.ExecutingObject
button = Space.Host.GetReference("button").UIButton
--make sure to add this reference to the Scripting Runtime component
OnClick = function()
button.Interactable= not button.Interactable
end
thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)
NormalColor
SColor NormalColor get
set
The normal color of the control.
Space.Host.ExecutingObject.UIButton.NormalColor = Color.Red
HighlightedColor
SColor HighlightedColor get
set
The color of the control when it is highlighted.
Space.Host.ExecutingObject.UIButton.NormalColor = Color.Red
PressedColor
SColor PressedColor get
set
The color of the control when it is pressed.
Space.Host.ExecutingObject.UIButton.PressedColor = Color.Red
DisabledColor
SColor DisabledColor get
set
The color of the control when it is disabled.
Space.Host.ExecutingObject.UIButton.PressedColor = Color.Red
ColorMultiplier
float ColorMultiplier get
set
This multiplies the tint color for each transition by its value. With this you can create colors greater than 1 to brighten the colors on graphic elements whose base color is less than white.
Space.Host.ExecutingObject.UIButton.ColorMultiplier = Color.Red
GameObject
SGameObject GameObject get
Property Description
Space.Host.ExecutingObject.UIButton.GameObject = Color.Red