Sinespace Client  2023.2.17543
Client-side scripting for Sinespace
SineSpace.Scripting.Components.SUIScrollbar Class Reference
Inheritance diagram for SineSpace.Scripting.Components.SUIScrollbar:
ScriptClassComponent< Scrollbar >

Public Member Functions

void SetValueWithoutNotify (float value)
 Set the current value of the scrollbar, but do NOT call OnValueChanged. More...
 
void OnValueChanged (Closure callback)
 Handling for when the scrollbar value is changed. More...
 

Properties

float Size [get, set]
 The size of the scrollbar handle where 1 means it fills the entire scrollbar. More...
 
float Value [get, set]
 The current value of the scrollbar, between 0 and 1. More...
 
int NumberOfSteps [get, set]
 The number of steps to use for the value. A value of 0 disables use of steps. More...
 
SColor NormalColor [get, set]
 The normal color of the control More...
 
SColor HighlightedColor [get, set]
 The color of the control when it is highlighted More...
 
SColor PressedColor [get, set]
 The color of the control when it is pressed More...
 
SColor DisabledColor [get, set]
 The color of the control when it is disabled More...
 
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 (or less then full alpha). More...
 
- Properties inherited from ScriptClassComponent< Scrollbar >
SGameObject GameObject [get]
 Return the GameObject which component added. More...
 

Member Function Documentation

◆ OnValueChanged()

void SineSpace.Scripting.Components.SUIScrollbar.OnValueChanged ( Closure  callback)

Handling for when the scrollbar value is changed.

local scrollbar=Space.Host.GetReference("Scrollbar").UIScrollbar
scrollbar.OnValueChanged(function ()
Space.Log("ValueChanged!")
end)
Parameters
callbackthe script function named "callback"

◆ SetValueWithoutNotify()

void SineSpace.Scripting.Components.SUIScrollbar.SetValueWithoutNotify ( float  value)

Set the current value of the scrollbar, but do NOT call OnValueChanged.

local scrollbar=Space.Host.GetReference("Scrollbar").UIScrollbar
scrollbar.SetValueWithoutNotify(1.0)

Property Documentation

◆ ColorMultiplier

float SineSpace.Scripting.Components.SUIScrollbar.ColorMultiplier
getset

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 (or less then full alpha).

local scrollbar=Space.Host.GetReference("Scrollbar").UIScrollbar
Space.Log(scrollbar.ColorMultiplier)

◆ DisabledColor

SColor SineSpace.Scripting.Components.SUIScrollbar.DisabledColor
getset

The color of the control when it is disabled

local scrollbar=Space.Host.GetReference("Scrollbar").UIScrollbar
Space.Log(scrollbar.DisabledColor.ToString())

◆ HighlightedColor

SColor SineSpace.Scripting.Components.SUIScrollbar.HighlightedColor
getset

The color of the control when it is highlighted

local scrollbar=Space.Host.GetReference("Scrollbar").UIScrollbar
Space.Log(scrollbar.HighlightedColor.ToString())

◆ NormalColor

SColor SineSpace.Scripting.Components.SUIScrollbar.NormalColor
getset

The normal color of the control

local scrollbar=Space.Host.GetReference("Scrollbar").UIScrollbar
Space.Log(scrollbar.NormalColor.ToString())

◆ NumberOfSteps

int SineSpace.Scripting.Components.SUIScrollbar.NumberOfSteps
getset

The number of steps to use for the value. A value of 0 disables use of steps.

local scrollbar=Space.Host.GetReference("Scrollbar").UIScrollbar
Space.Log(scrollbar.NumberOfSteps)

◆ PressedColor

SColor SineSpace.Scripting.Components.SUIScrollbar.PressedColor
getset

The color of the control when it is pressed

local scrollbar=Space.Host.GetReference("Scrollbar").UIScrollbar
Space.Log(scrollbar.PressedColor.ToString())

◆ Size

float SineSpace.Scripting.Components.SUIScrollbar.Size
getset

The size of the scrollbar handle where 1 means it fills the entire scrollbar.

local scrollbar=Space.Host.GetReference("Scrollbar").UIScrollbar
Space.Log(scrollbar.Size)

◆ Value

float SineSpace.Scripting.Components.SUIScrollbar.Value
getset

The current value of the scrollbar, between 0 and 1.

local scrollbar=Space.Host.GetReference("Scrollbar").UIScrollbar
Space.Log(scrollbar.Value)