Torque3D Documentation / _generateds / GuiGameListMenuCtrl::Row

GuiGameListMenuCtrl::Row

Engine/source/gui/controls/guiGameListMenuCtrl.h

Internal data representation of a single row in the control.

More...

Public Types

enum
Mode {
  Default = 0
  OptionList 
  Slider 
  Keybind 
}

Public Attributes

bool

If this row is enabled or not (grayed out)

Extra amount to pad above this row.

Index of the icon to display on the row (-1 = no icon)

Text to display in the row as a label.

Collection of options available to display.

When working as a slider, this sets our min/max range.

Script callback when row is activated.

Index into mOptions pointing at the selected option.

When working as a slider, this is the increment levels in the range.

A descriptive tooltip message for what the row is.

bool

Toggle the use of the highlight icon.

When working as a slider, this contains the value.

bool

Determines if options should "wrap around" at the ends.

Public Functions

Row()
~Row()

Detailed Description

Internal data representation of a single row in the control.

Public Types

Mode

Enumerator

Default = 0
OptionList
Slider
Keybind

Public Attributes

StringTableEntry mBitmap 
GFXTexHandle mBitmapTex 
bool mEnabled 

If this row is enabled or not (grayed out)

S32 mHeightPad 

Extra amount to pad above this row.

S32 mIconIndex 

Index of the icon to display on the row (-1 = no icon)

StringTableEntry mLabel 

Text to display in the row as a label.

Mode mMode 
Vector< StringTableEntry > mOptions 

Collection of options available to display.

Point2F mRange 

When working as a slider, this sets our min/max range.

StringTableEntry mScriptCallback 

Script callback when row is activated.

S32 mSelectedOption 

Index into mOptions pointing at the selected option.

F32 mStepSize 

When working as a slider, this is the increment levels in the range.

StringTableEntry mTooltip 

A descriptive tooltip message for what the row is.

bool mUseHighlightIcon 

Toggle the use of the highlight icon.

F32 mValue 

When working as a slider, this contains the value.

bool mWrapOptions 

Determines if options should "wrap around" at the ends.

Public Functions

Row()

~Row()