GearBlocks
The GearBlocks Lua scripting API
Properties | List of all members
SmashHammer.UI.Toggle Class Reference

A toggle UI element. More...

Inheritance diagram for SmashHammer.UI.Toggle:
SmashHammer.UI.Element SmashHammer.UI.IToggle SmashHammer.UI.IElement SmashHammer.UI.ISizeable SmashHammer.UI.IRotatable

Properties

bool Value [get, set]
 The toggle value.
 
- 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.IToggle
bool Value [get, set]
 The toggle value.
 

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.
 
- Events inherited from SmashHammer.UI.IToggle
ValueChangedHandler OnChanged
 Event that is raised when the toggle value is changed.
 

Detailed Description

A toggle UI element.

Property Documentation

◆ Value

bool SmashHammer.UI.Toggle.Value
getset

The toggle value.

true if this toggle is checked; otherwise, false.

Implements SmashHammer.UI.IToggle.