GearBlocks
The GearBlocks Lua scripting API
List of all members
SmashHammer.UI.LabelledDropdown Class Reference

A labelled dropdown UI element. More...

Inheritance diagram for SmashHammer.UI.LabelledDropdown:
SmashHammer.UI.Element SmashHammer.UI.IDropdown SmashHammer.UI.ILabel SmashHammer.UI.IElement SmashHammer.UI.ISizeable SmashHammer.UI.IRotatable

Additional Inherited Members

- Public Types inherited from SmashHammer.UI.ISizeable
enum  Align : byte {
  LeftEdge , RightEdge , TopEdge , BottomEdge ,
  HorizEdges , VertEdges , HorizCentre , VertCentre
}
 UI element alignment mode. More...
 
void SetAlignment (Align align, float paramA, float paramB)
 Set the element's alignment.
 
void SetRotation (float angle)
 Set the element's rotation.
 
void AddOption (string name)
 Add an option to the dropdown menu.
 
void AddOption (string name, bool selectable)
 Add an option to the dropdown menu.
 
void AddOptions (IList< string > names)
 Add options to the dropdown menu.
 
void AddOptions (IList<(string, bool)> options)
 Add options to the dropdown menu.
 
void ClearOptions ()
 Clear all options from the dropdown menu.
 
- Properties inherited from SmashHammer.UI.Element
virtual bool IsVisible [get, set]
 Is the element visible?
 
- Properties inherited from SmashHammer.UI.IElement
bool IsVisible [get, set]
 Is the element visible?
 
bool IsInteractable [get, set]
 Is the element interactable?
 
bool IsTargetable [get, set]
 Is the element targetable?
 
- Properties inherited from SmashHammer.UI.IDropdown
int Value [get, set]
 The dropdown value.
 
string SelectedOption [get]
 The selected dropdown option.
 
int NumOptions [get]
 The number of dropdown options.
 
- Properties inherited from SmashHammer.UI.ILabel
string Text [get, set]
 The label text.
 
Color32Proxy Colour [get, set]
 The text colour.
 
FontStyle FontStyle [get, set]
 The font style.
 
int FontSize [get, set]
 The font size.
 
float LineSpacing [get, set]
 The line spacing.
 
TextAnchor Alignment [get, set]
 The text alignment.
 
float PreferredWidth [get]
 The preferred width.
 
float PreferredHeight [get]
 The preferred height.
 
- Events inherited from SmashHammer.UI.IDropdown
ValueChangedHandler OnChanged
 Event that is raised when the dropdown value is changed.
 

Detailed Description

A labelled dropdown UI element.