‪TechbloxModdingAPI  ‪v2.2.0
‪The unofficial Techblox modding API
TechbloxModdingAPI.Interface.IMGUI.Label Class Reference

‪A simple text label. This wraps Unity IMGUI's Label. More...

Inheritance diagram for TechbloxModdingAPI.Interface.IMGUI.Label:
TechbloxModdingAPI.Interface.IMGUI.UIElement

Public Member Functions

 Label (Rect box, string initialText=null, string name=null)
 ‪Initializes a new instance of the T:TechbloxModdingAPI.Interface.IMGUI.Label. More...
 
 Label (string initialText=null, string name=null)
 ‪Initializes a new instance of the T:TechbloxModdingAPI.Interface.IMGUI.Label class with automatic layout. More...
 
override void OnGUI ()
 ‪GUI operations to perform in the OnGUI scope. This is basically equivalent to a MonoBehaviour's OnGUI method. More...
 

Properties

Rect Box = Rect.zero [get, set]
 ‪The rectangular area that the label can use. More...
 
bool Enabled = true [get, set]
 ‪Whether to display the UI element or not. More...
 
string Name [get]
 ‪The element's name. This should be unique for every instance of the class. More...
 
string Text [get, set]
 ‪String to display on the label. More...
 

Detailed Description

A simple text label. This wraps Unity IMGUI's Label.

Constructor & Destructor Documentation

◆ Label() [1/2]

TechbloxModdingAPI.Interface.IMGUI.Label.Label ( string  initialText = null,
string  name = null 
)
inline

‪Initializes a new instance of the T:TechbloxModdingAPI.Interface.IMGUI.Label class with automatic layout.

Parameters
initialText‪Initial string to display on the label.
name‪The element's name.

◆ Label() [2/2]

TechbloxModdingAPI.Interface.IMGUI.Label.Label ( Rect  box,
string  initialText = null,
string  name = null 
)
inline

‪Initializes a new instance of the T:TechbloxModdingAPI.Interface.IMGUI.Label.

Parameters
box‪Rectangular area for the label.
initialText‪Initial string to display on the label.
name‪The element's name.

Member Function Documentation

◆ OnGUI()

override void TechbloxModdingAPI.Interface.IMGUI.Label.OnGUI ( )
inlinevirtual

‪GUI operations to perform in the OnGUI scope. This is basically equivalent to a MonoBehaviour's OnGUI method.

Implements TechbloxModdingAPI.Interface.IMGUI.UIElement.

Property Documentation

◆ Box

Rect TechbloxModdingAPI.Interface.IMGUI.Label.Box = Rect.zero
getset

‪The rectangular area that the label can use.

◆ Enabled

bool TechbloxModdingAPI.Interface.IMGUI.UIElement.Enabled = true
getsetinherited

‪Whether to display the UI element or not.

◆ Name

string TechbloxModdingAPI.Interface.IMGUI.UIElement.Name
getinherited

‪The element's name. This should be unique for every instance of the class.

◆ Text

string TechbloxModdingAPI.Interface.IMGUI.Label.Text
getset

‪String to display on the label.


The documentation for this class was generated from the following file: