SUIDropdown

Index

Functions Index

Function Name
void RefreshShownValue ()
void AddOptions (string[] options) void AddOptions (Table options) void AddOptions (SResource[] optionsSprites)
void ClearOptions ()
void Show ()
void Hide ()
void OnValueChanged (Closure callback)

Properties Index

Property Name
bool Interactable get set
SGameObject Template get set
SUIText CaptionText get set
SUIImage CaptionImage get set
SUIText ItemText get set
SUIImage ItemImage get set
string[] OptionsAsText get
SResource[] OptionsAsSprites get
int Value 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

RefreshShownValue

void RefreshShownValue ()

Refreshes the text and image (if available) of the currently selected option.If you have modified the list of options, you should call this method afterwards to ensure that the visual state of the dropdown corresponds to the updated options.

Parameter	Type	Description

Lua

Space.Host.ExecutingObject.UIDropdown.RefreshShownValue()

AddOptions

void AddOptions (string[] options) void AddOptions (Table options) void AddOptions (SResource[] optionsSprites)

Add multiple options to the options of the Dropdown.

Parameter	Type	Description

Lua

Space.Host.ExecutingObject.UIDropdown.AddOptions({"option1","option2","option3"})

ClearOptions

void ClearOptions ()

Clear the list of options in the Dropdown.

Lua

Space.Host.ExecutingObject.UIDropdown.ClearOptions()

Show

void Show ()

Show the dropdown list.

Lua

Space.Host.ExecutingObject.UIDropdown.Show()

Hide

void Hide ()

Hide the dropdown list.

Lua

Space.Host.ExecutingObject.UIDropdown.Hide()

OnValueChanged

void OnValueChanged (Closure callback)

Bind a function to handle the event that is invoked when when a user has clicked one of the options in the dropdown list.

Parameter	Type	Description

Lua

function AFunction()
--
end

Space.Host.ExecutingObject.UIDropdown.OnValueChanged(AFunction)

SetValueByText

bool SetValueByText (string text)

Attempts to set the dropdown to the first option in the dropdown list that matches the inputted text. Returns true if found, false if no matches found.

Parameter	Type	Description

Lua

Space.Host.ExecutingObject.UIDropdown.SetValueByText("Value Text")

Lua

--Populating a UIDropdown and making a selection using value's text
dropDown=Space.Host.GetReference("DropDown").UIDropdown
options = {"Room 1", "Room 2", "Room 3", "Room 4"}
dropDown.AddOptions(options)
dropDown.SetValueByText("Room 3")

Properties

Interactable

bool Interactable get set

Is this UIDropdown interactable?

Lua

Space.Host.ExecutingObject.UIDropdown.Interactable = true

Lua

--clicking this object will toggle a UIDropdown's interactable status

thisGameObject = Space.Host.ExecutingObject
dropdown = Space.Host.GetReference("dropdown").UIDropdown 
--make sure to add this reference to the Scripting Runtime component


OnClick = function()
dropdown.Interactable =  not dropdown.Interactable
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

Template

SGameObject Template get set

The Rect Transform of the template for the dropdown list.

Lua

aReferenceToAGameObject = Space.Host.GetReference("reference name")
Space.Host.ExecutingObject.UIDropdown.Template = aReferenceToAGameObject

CaptionText

SUIText CaptionText get set

The Text component to hold the text of the currently selected option.

Lua

captionText = Space.Host.ExecutingObject.UIDropdown.CaptionText
captionText.Text = "new caption"

CaptionImage

SUIImage CaptionImage get set

The Image component to hold the image of the currently selected option.

Lua

aReferenceToAGameObject = Space.Host.GetReference("reference name")
Space.Host.ExecutingObject.UIDropdown.CaptionImage = aReferenceToAGameObject.UIImage

ItemText

SUIText ItemText get set

The Text component to hold the text of the item.

Lua

aReferenceToAGameObject = Space.Host.GetReference("reference name")
Space.Host.ExecutingObject.UIDropdown.CaptionImage = aReferenceToAGameObject.UIText

ItemImage

SUIImage ItemImage get set

The Image component to hold the image of the item.

Lua

iaReferenceToAGameObject = Space.Host.GetReference("reference name")
Space.Host.ExecutingObject.UIDropdown.CaptionImage = aReferenceToAGameObject.UIImage

OptionsAsText

string[] OptionsAsText get

The list of possible options. (Text)

Lua

optionsText = Space.Host.ExecutingObject.UIDropdown.OptionsAsText

OptionsAsSprites

SResource[] OptionsAsSprites get

The list of possible options. (Sprites)

Lua

optionsSprites = Space.Host.ExecutingObject.UIDropdown.OptionsAsSprites

Value

int Value get set

The Value is the index number of the current selection in the Dropdown. 0 is the first option in the Dropdown, 1 is the second, and so on.

Lua

Space.Host.ExecutingObject.UIDropdown.Value= 2

NormalColor

SColor NormalColor get set

Property Description

Lua

Space.Host.ExecutingObject.UIDropdown.NormalColor = Color.Red

HighlightedColor

SColor HighlightedColor get set

Property Description

Lua

Space.Host.ExecutingObject.UIDropdown.HighlightedColor = Color.Red

PressedColor

SColor PressedColor get set

Property Description

Lua

Space.Host.ExecutingObject.UIDropdown.PressedColor = Color.Red

DisabledColor

SColor DisabledColor get set

Property Description

Lua

Space.Host.ExecutingObject.UIDropdown.DisabledColor = Color.Red

ColorMultiplier

float ColorMultiplier get set

Property Description

Lua

Space.Host.ExecutingObject.UIDropdown.ColorMultiplier = Color.Red

GameObject

SGameObject GameObject get

Property Description

Lua

Space.Host.ExecutingObject.UIDropdown.GameObject = Color.Red