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

Provides access to a UI showable's properties and methods. More...

Inheritance diagram for SmashHammer.UI.IShowable:
SmashHammer.UI.Showable SmashHammer.UI.Window SmashHammer.UI.Windows

Public Member Functions

void Show (bool show)
 Show or hide the showable.
 

Properties

bool IsShowing [get]
 Is the showable showing?
 
float ScaleFactor [get]
 The size of this showable (and it's contents) is multiplied by this factor to get the actual on screen pixel size.
 

Detailed Description

Provides access to a UI showable's properties and methods.

Member Function Documentation

◆ Show()

void SmashHammer.UI.IShowable.Show ( bool  show)

Show or hide the showable.

Parameters
showSet to true to show the showable; false to hide it.

Implemented in SmashHammer.UI.Showable.

Property Documentation

◆ IsShowing

bool SmashHammer.UI.IShowable.IsShowing
get

Is the showable showing?

true if this showable is showing; otherwise, false.

Implemented in SmashHammer.UI.Showable.

◆ ScaleFactor

float SmashHammer.UI.IShowable.ScaleFactor
get

The size of this showable (and it's contents) is multiplied by this factor to get the actual on screen pixel size.

The scaling factor applied to this showable.

Implemented in SmashHammer.UI.Showable.