There is no spoon

UE2:GUIComponent properties (UT2004)

From Unreal Wiki, The Unreal Engine Documentation Site
Revision as of 09:11, 17 May 2008 by Wormbo (Talk | contribs) (Auto-generated page)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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

Property group 'GUIComponent'

bAnimating

Type: bool

Modifiers: editconst, noexport

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

bCaptureTabs

Type: bool

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

bDebugging

Type: bool


bDropSource

Type: bool

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

bDropTarget

Type: bool

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

bFocusOnWatch

Type: bool

If true, watching focuses

bInit

Type: bool

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

Default value: True

bMouseOverSound

Type: bool

Should component bleep when mouse goes over it

bNeverScale

Type: bool


BoundingType

Type: EParentScaleType


bPositioned

Type: bool

Modifiers: editconst, const, noexport

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

bSizing

Type: bool

Modifiers: editconst, noexport, const

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

bTimerRepeat

Type: bool


bTravelling

Type: bool

Modifiers: editconst, noexport, const


ContextMenu

Type: GUIContextMenu

Modifiers: editconst


FriendlyLabel

Type: GUILabel

Modifiers: noexport

My state is projected on this objects state.

Hint

Type: string

Modifiers: localized

The hint that gets displayed for this component

IniDefault

Type: string

The default value for a missing ini option

IniOption

Type: string

Points to the INI option to load for this component

MotionFrame

Type: array<Object.Vector>

Modifiers: editconst, noexport, const


RenderWeight

Type: float

Used to determine sorting in the controls stack

Default value: 0.5

ScalingType

Type: EParentScaleType


SizeFrame

Type: array<Object.Vector>

Modifiers: editconst, noexport, const


Tag

Type: int

Free (can be used for anything)

Default value: -1

TimerCountdown

Type: float


TimerIndex

Type: int

Modifiers: noexport, editconst, const

For easier maintenance

Default value: -1

TimerInterval

Type: float


ToolTip

Type: GUIToolTip

Modifiers: editconst


Property group 'Menu'

bBoundToParent

Type: bool

Use the Parents Bounds for all positioning

Bounds

Type: float

Array size: 4

Modifiers: editconst, const, noexport

Internal normalized positions in world space

bScaleToParent

Type: bool

Use the Parent for scaling

bStandardized

Type: bool


bTabStop

Type: bool

Does a TAB/Shift-Tab stop here

ClientBounds

Type: float

Array size: 4

Modifiers: editconst, const, noexport


MenuOwner

Type: GUIComponent

Modifiers: noexport, editconst

Callback to the Component that owns this one

PageOwner

Type: GUIPage

Modifiers: noexport, editconst

Callback to the GUIPage that contains this control

StandardHeight

Type: float


TabOrder

Type: int

Used to figure out tabbing

Default value: -1

WinHeight

Type: float

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

WinLeft

Type: float

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

WinTop

Type: float


WinWidth

Type: float


Default value: 1.0

Property group 'State'

bAcceptsInput

Type: bool

Does this control accept input

bCaptureMouse

Type: bool

Control should capture the mouse when pressed

bHasFocus

Type: bool

Modifiers: noexport

Does this component currently have input focus

bNeverFocus

Type: bool

This control should never fully receive focus

bPendingFocus

Type: bool

Modifiers: noexport

Big big hack for ComboBoxes..

bRepeatClick

Type: bool

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

bRequireReleaseClick

Type: bool

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

bVisible

Type: bool

Is this component currently visible

Default value: True

DropState

Type: GUI.eDropState

Modifiers: noexport

Used to determine the current drop state of this component

FocusInstead

Type: GUIComponent

Modifiers: noexport

Who should get the focus instead of this control if bNeverFocus

LastMenuState

Type: GUI.eMenuState

Modifiers: editconst, noexport

The previous MenuState of this component

MenuState

Type: GUI.eMenuState

Modifiers: noexport

Used to determine the current state of this component

Property group 'Style'

FontScale

Type: GUI.eFontScale


Default value: FNS_Medium

MouseCursorIndex

Type: int

The mouse cursor to use when over this control

OnClickSound

Type: EClickSound


Style

Type: GUIStyles

Modifiers: noexport

My GUI Style

StyleName

Type: string

Name of my Style

Internal variables

bRequiresStyle

Type: bool

Modifiers: const, noexport


DrawCount

Type: int

Modifiers: editconst, const, noexport


MouseOffset

Type: float

Array size: 4

Modifiers: noexport, const

Used natively for drawing outlines

OnDrawCount

Type: int

Modifiers: editconst, noexport


OnPreDrawCount

Type: int

Modifiers: editconst, noexport


OnRenderCount

Type: int

Modifiers: editconst, noexport


OnRenderedCount

Type: int

Modifiers: editconst, noexport


PreDrawCount

Type: int

Modifiers: editconst, const, noexport


WhiteColor

Type: Object.Color

Modifiers: noexport, const


Default value:

Member Value
A 255
B 244
G 237
R 253