Main   Class List   Namespace List   Online

Core Controls
[GUI]

Core parts of the Gui System. More...

Classes

class  GuiCanvas
 A canvas on which rendering occurs. More...
class  GuiConsole
 The on-screen, in-game console. Calls getLog() to get the on-screen console entries, then renders them as needed. More...
class  GuiConsoleEditCtrl
 Text entry element of a GuiConsole. More...
class  GuiControl
 Base class for all Gui control objects. More...
class  GuiControlProfile
 A collection of properties that determine control behavior and rendering. More...
class  GuiCursor
 Acts as a skin for the cursor, where each GuiCursor object can have its own look and click-zone. More...
class  GuiFadeinBitmapCtrl
 A GUI control which renders a black square over a bitmap image. The black square will fade out, then fade back in after a determined time. This control is especially useful for transitions and splash screens. More...
class  GuiIconButtonCtrl
 Draws the bitmap within a special button control. Only a single bitmap is used and the button will be drawn in a highlighted mode when the mouse hovers over it or when it has been clicked. More...
class  GuiListBoxCtrl
 A list of text items. More...
class  GuiMenuBar
 GUI Control which displays a horizontal bar with individual drop-down menu items. Each menu item may also have submenu items. More...
class  GuiMLTextCtrl
 A text control that uses the Gui Markup Language ('ML') tags to dynamically change the text. More...
class  GuiMouseEventCtrl
 Used to overlaps a 'hot region' where you want to catch inputs with and have specific events occur based on individual callbacks. More...
class  GuiTextCtrl
 GUI control object this displays a single line of text, without TorqueML. More...
class  GuiTextEditSliderBitmapCtrl
 GUI Control which displays a numerical value which can be increased or decreased using a pair of bitmap up/down buttons. More...
class  GuiTextEditSliderCtrl
 GUI Control which displays a numerical value which can be increased or decreased using a pair of arrows. More...

Enumerations

enum  GuiAlignmentType {
  Left,
  Center,
  Right,
  Top,
  Bottom
}
enum  GuiFontCharset {
  ANSI,
  SYMBOL,
  SHIFTJIS,
  HANGEUL,
  HANGUL,
  GB2312,
  CHINESEBIG5,
  OEM,
  JOHAB,
  HEBREW,
  ARABIC,
  GREEK,
  TURKISH,
  VIETNAMESE,
  THAI,
  EASTEUROPE,
  RUSSIAN,
  MAC,
  BALTIC
}
enum  GuiHorizontalSizing {
  right,
  width,
  left,
  center,
  relative,
  windowRelative
}
 

Horizontal sizing behavior of a GuiControl.

More...
enum  GuiVerticalSizing {
  bottom,
  height,
  top,
  center,
  relative,
  windowRelative
}
 

Vertical sizing behavior of a GuiControl.

More...

Functions

bool excludeOtherInstance (string appIdentifer)
 Used to exclude/prevent all other instances using the same identifier specified.
string StripMLControlChars (string inString)
 Strip TorqueML control characters from the specified string, returning a 'clean' version.

Variables

GuiControl $ThisControl
 The control for which a command is currently being evaluated. Only set during 'command' and altCommand callbacks to the control for which the command or altCommand is invoked.

Detailed Description

Core parts of the Gui System.


Enumeration Type Documentation

Enumerator:
Left 
Center 
Right 
Top 
Bottom 
Enumerator:
ANSI 
SYMBOL 
SHIFTJIS 
HANGEUL 
HANGUL 
GB2312 
CHINESEBIG5 
OEM 
JOHAB 
HEBREW 
ARABIC 
GREEK 
TURKISH 
VIETNAMESE 
THAI 
EASTEUROPE 
RUSSIAN 
MAC 
BALTIC 

Horizontal sizing behavior of a GuiControl.

Enumerator:
right 
width 
left 
center 
relative 
windowRelative 

Vertical sizing behavior of a GuiControl.

Enumerator:
bottom 
height 
top 
center 
relative 
windowRelative 

Function Documentation

bool excludeOtherInstance ( string  appIdentifer  ) 

Used to exclude/prevent all other instances using the same identifier specified.

Note:
Not used on OSX, Xbox, or in Win debug builds
Parameters:
appIdentifier Name of the app set up for exclusive use.
Returns:
False if another app is running that specified the same appIdentifier
string StripMLControlChars ( string  inString  ) 

Strip TorqueML control characters from the specified string, returning a 'clean' version.

Parameters:
inString String to strip TorqueML control characters from.
Example:
// Define the string to strip TorqueML control characters from
%string = "<font:Arial:24>How Now <color:c43c12>Brown <color:000000>Cow";

// Request the stripped version of the string
%strippedString = StripMLControlChars(%string);
Returns:
Version of the inputted string with all TorqueML characters removed.
See also:
References

Variable Documentation

GuiControl $ThisControl

The control for which a command is currently being evaluated. Only set during 'command' and altCommand callbacks to the control for which the command or altCommand is invoked.



Copyright © GarageGames, LLC. All Rights Reserved.