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

A showable UI container. More...

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

Public Member Functions

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

Properties

virtual 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.
 
- Properties inherited from SmashHammer.UI.IShowable
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

A showable UI container.

Member Function Documentation

◆ Show()

virtual void SmashHammer.UI.Showable.Show ( bool  show)
virtual

Show or hide the showable.

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

Implements SmashHammer.UI.IShowable.

Property Documentation

◆ IsShowing

virtual bool SmashHammer.UI.Showable.IsShowing
get

Is the showable showing?

true if this showable is showing; otherwise, false.

Implements SmashHammer.UI.IShowable.

◆ ScaleFactor

float SmashHammer.UI.Showable.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.

Implements SmashHammer.UI.IShowable.