Mostly Harmless

UE2:GUIComponent properties (UT2004)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT2004 Object >> GUI >> GUIComponent (properties)
GUIComponent properties in other games:
UE2Runtime, UT2003
Other member categories for this class:
delegates, functions

Properties[edit]

Property group 'GUIComponent'[edit]

bAnimating[edit]

Type: bool

Modifiers: editconst, noexport

If true, all input/focus/etc will be ignored

bCaptureTabs[edit]

Type: bool

If true, OnKeyEvent() is called for tab presses, overriding default behavior (NextControl()/PrevControl())

bDebugging[edit]

Type: bool


bDropSource[edit]

Type: bool

Can this component act as a drag-n-drop source

bDropTarget[edit]

Type: bool

Can this component act as a drag-n-drop target

bFocusOnWatch[edit]

Type: bool

If true, watching focuses

bInit[edit]

Type: bool

Can be used by any component as an "initialization" hook

Default value: True

bMouseOverSound[edit]

Type: bool

Should component bleep when mouse goes over it

bNeverScale[edit]

Type: bool


BoundingType[edit]

Type: EParentScaleType


bPositioned[edit]

Type: bool

Modifiers: editconst, const, noexport

Whether this component has been positioned yet (first Pre-Render)

bSizing[edit]

Type: bool

Modifiers: editconst, noexport, const

Travelling is true when animating position, Sizing is true when animating dimensions

bTimerRepeat[edit]

Type: bool


bTravelling[edit]

Type: bool

Modifiers: editconst, noexport, const


ContextMenu[edit]

Type: GUIContextMenu

Modifiers: editconst


FriendlyLabel[edit]

Type: GUILabel

Modifiers: noexport

My state is projected on this objects state.

Hint[edit]

Type: string

Modifiers: localized

The hint that gets displayed for this component

IniDefault[edit]

Type: string

The default value for a missing ini option

IniOption[edit]

Type: string

Points to the INI option to load for this component

MotionFrame[edit]

Type: array<Object.Vector>

Modifiers: editconst, noexport, const


RenderWeight[edit]

Type: float

Used to determine sorting in the controls stack

Default value: 0.5

ScalingType[edit]

Type: EParentScaleType


SizeFrame[edit]

Type: array<Object.Vector>

Modifiers: editconst, noexport, const


Tag[edit]

Type: int

Free (can be used for anything)

Default value: -1

TimerCountdown[edit]

Type: float


TimerIndex[edit]

Type: int

Modifiers: noexport, editconst, const

For easier maintenance

Default value: -1

TimerInterval[edit]

Type: float


ToolTip[edit]

Type: GUIToolTip

Modifiers: editconst


Property group 'Menu'[edit]

bBoundToParent[edit]

Type: bool

Use the Parents Bounds for all positioning

Bounds[edit]

Type: float

Array size: 4

Modifiers: editconst, const, noexport

Internal normalized positions in world space

bScaleToParent[edit]

Type: bool

Use the Parent for scaling

bStandardized[edit]

Type: bool


bTabStop[edit]

Type: bool

Does a TAB/Shift-Tab stop here

ClientBounds[edit]

Type: float

Array size: 4

Modifiers: editconst, const, noexport


MenuOwner[edit]

Type: GUIComponent

Modifiers: noexport, editconst

Callback to the Component that owns this one

PageOwner[edit]

Type: GUIPage

Modifiers: noexport, editconst

Callback to the GUIPage that contains this control

StandardHeight[edit]

Type: float


TabOrder[edit]

Type: int

Used to figure out tabbing

Default value: -1

WinHeight[edit]

Type: float

Where does this component exist (in world space) - Grr.. damn Left()

WinLeft[edit]

Type: float

Where does this component exist (in world space) - Grr.. damn Left()

WinTop[edit]

Type: float


WinWidth[edit]

Type: float


Default value: 1.0

Property group 'State'[edit]

bAcceptsInput[edit]

Type: bool

Does this control accept input

bCaptureMouse[edit]

Type: bool

Control should capture the mouse when pressed

bHasFocus[edit]

Type: bool

Modifiers: noexport

Does this component currently have input focus

bNeverFocus[edit]

Type: bool

This control should never fully receive focus

bPendingFocus[edit]

Type: bool

Modifiers: noexport

Big big hack for ComboBoxes..

bRepeatClick[edit]

Type: bool

Whether this component should receive OnClick() events when the mouse button is held down

bRequireReleaseClick[edit]

Type: bool

If True, this component wants the click on release even if it's not active

bVisible[edit]

Type: bool

Is this component currently visible

Default value: True

DropState[edit]

Type: GUI.eDropState

Modifiers: noexport

Used to determine the current drop state of this component

FocusInstead[edit]

Type: GUIComponent

Modifiers: noexport

Who should get the focus instead of this control if bNeverFocus

LastMenuState[edit]

Type: GUI.eMenuState

Modifiers: editconst, noexport

The previous MenuState of this component

MenuState[edit]

Type: GUI.eMenuState

Modifiers: noexport

Used to determine the current state of this component

Property group 'Style'[edit]

FontScale[edit]

Type: GUI.eFontScale


Default value: FNS_Medium

MouseCursorIndex[edit]

Type: int

The mouse cursor to use when over this control

OnClickSound[edit]

Type: EClickSound


Style[edit]

Type: GUIStyles

Modifiers: noexport

My GUI Style

StyleName[edit]

Type: string

Name of my Style

Internal variables[edit]

bRequiresStyle[edit]

Type: bool

Modifiers: const, noexport


DrawCount[edit]

Type: int

Modifiers: editconst, const, noexport


MouseOffset[edit]

Type: float

Array size: 4

Modifiers: noexport, const

Used natively for drawing outlines

OnDrawCount[edit]

Type: int

Modifiers: editconst, noexport


OnPreDrawCount[edit]

Type: int

Modifiers: editconst, noexport


OnRenderCount[edit]

Type: int

Modifiers: editconst, noexport


OnRenderedCount[edit]

Type: int

Modifiers: editconst, noexport


PreDrawCount[edit]

Type: int

Modifiers: editconst, const, noexport


WhiteColor[edit]

Type: Object.Color

Modifiers: noexport, const


Default value:

Member Value
A 255
B 244
G 237
R 253