GearBlocks
The GearBlocks Lua scripting API
Public Types | Public Member Functions | List of all members
SmashHammer.UI.ISizeable Interface Reference

A sizable UI element. More...

Inheritance diagram for SmashHammer.UI.ISizeable:
SmashHammer.UI.Element SmashHammer.UI.Window SmashHammer.UI.ButtonImage SmashHammer.UI.ButtonText SmashHammer.UI.Dropdown SmashHammer.UI.Image SmashHammer.UI.InputField SmashHammer.UI.Label SmashHammer.UI.LabelledDropdown SmashHammer.UI.LabelledInputField SmashHammer.UI.LabelledNumberField SmashHammer.UI.LabelledSlider SmashHammer.UI.LabelledToggle SmashHammer.UI.NumberField SmashHammer.UI.ScrollView SmashHammer.UI.Shapes SmashHammer.UI.Slider SmashHammer.UI.TimeSeriesGraph SmashHammer.UI.Toggle

Public Types

enum  Align : byte {
  LeftEdge , RightEdge , TopEdge , BottomEdge ,
  HorizEdges , VertEdges , HorizCentre , VertCentre
}
 UI element alignment mode. More...
 

Public Member Functions

void SetAlignment (Align align, float paramA, float paramB)
 Set the element's alignment.
 

Detailed Description

A sizable UI element.

Member Enumeration Documentation

◆ Align

UI element alignment mode.

Enumerator
LeftEdge 

Offset from the left edge with a width. Available in Lua as align_LeftEdge.

RightEdge 

Offset from the right edge with a width. Available in Lua as align_RightEdge.

TopEdge 

Offset from the top edge with a height. Available in Lua as align_TopEdge.

BottomEdge 

Offset from the bottom edge with a height. Available in Lua as align_BottomEdge.

HorizEdges 

Offset from the horizontal edges. Available in Lua as align_HorizEdges.

VertEdges 

Offset from the vertical edges. Available in Lua as align_VertEdges.

HorizCentre 

Offset from the horizontal centre with a width. Available in Lua as align_HorizCentre.

VertCentre 

Offset from the vertical centre with a height. Available in Lua as align_VertCentre.

Member Function Documentation

◆ SetAlignment()

void SmashHammer.UI.ISizeable.SetAlignment ( Align  align,
float  paramA,
float  paramB 
)

Set the element's alignment.

Parameters
alignThe alignment mode.
paramAParameter A.
paramBParameter B.