The three virtues of a programmer: Laziness, Impatience, and Hubris. – Larry Wall

UE2:GUIComponent properties (UT2004)

From Unreal Wiki, The Unreal Engine Documentation Site

Jump to: navigation, search
UT2004 Object >> GUI >> GUIComponent (properties)

Contents

GUIComponent properties in other games:
UE2Runtime, UT2003
Other member categories for this class:
delegates, functions

[edit] Properties

[edit] Property group 'GUIComponent'

[edit] bAnimating

Type: bool

Modifiers: editconst, noexport

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

[edit] bCaptureTabs

Type: bool

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

[edit] bDebugging

Type: bool


[edit] bDropSource

Type: bool

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

[edit] bDropTarget

Type: bool

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

[edit] bFocusOnWatch

Type: bool

If true, watching focuses

[edit] bInit

Type: bool

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

Default value: True

[edit] bMouseOverSound

Type: bool

Should component bleep when mouse goes over it

[edit] bNeverScale

Type: bool


[edit] BoundingType

Type: EParentScaleType


[edit] bPositioned

Type: bool

Modifiers: editconst, const, noexport

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

[edit] bSizing

Type: bool

Modifiers: editconst, noexport, const

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

[edit] bTimerRepeat

Type: bool


[edit] bTravelling

Type: bool

Modifiers: editconst, noexport, const


[edit] ContextMenu

Type: GUIContextMenu

Modifiers: editconst


[edit] FriendlyLabel

Type: GUILabel

Modifiers: noexport

My state is projected on this objects state.

[edit] Hint

Type: string

Modifiers: localized

The hint that gets displayed for this component

[edit] IniDefault

Type: string

The default value for a missing ini option

[edit] IniOption

Type: string

Points to the INI option to load for this component

[edit] MotionFrame

Type: array<Object.Vector>

Modifiers: editconst, noexport, const


[edit] RenderWeight

Type: float

Used to determine sorting in the controls stack

Default value: 0.5

[edit] ScalingType

Type: EParentScaleType


[edit] SizeFrame

Type: array<Object.Vector>

Modifiers: editconst, noexport, const


[edit] Tag

Type: int

Free (can be used for anything)

Default value: -1

[edit] TimerCountdown

Type: float


[edit] TimerIndex

Type: int

Modifiers: noexport, editconst, const

For easier maintenance

Default value: -1

[edit] TimerInterval

Type: float


[edit] ToolTip

Type: GUIToolTip

Modifiers: editconst


[edit] Property group 'Menu'

[edit] bBoundToParent

Type: bool

Use the Parents Bounds for all positioning

[edit] Bounds

Type: float

Array size: 4

Modifiers: editconst, const, noexport

Internal normalized positions in world space

[edit] bScaleToParent

Type: bool

Use the Parent for scaling

[edit] bStandardized

Type: bool


[edit] bTabStop

Type: bool

Does a TAB/Shift-Tab stop here

[edit] ClientBounds

Type: float

Array size: 4

Modifiers: editconst, const, noexport


[edit] MenuOwner

Type: GUIComponent

Modifiers: noexport, editconst

Callback to the Component that owns this one

[edit] PageOwner

Type: GUIPage

Modifiers: noexport, editconst

Callback to the GUIPage that contains this control

[edit] StandardHeight

Type: float


[edit] TabOrder

Type: int

Used to figure out tabbing

Default value: -1

[edit] WinHeight

Type: float

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

[edit] WinLeft

Type: float

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

[edit] WinTop

Type: float


[edit] WinWidth

Type: float


Default value: 1.0

[edit] Property group 'State'

[edit] bAcceptsInput

Type: bool

Does this control accept input

[edit] bCaptureMouse

Type: bool

Control should capture the mouse when pressed

[edit] bHasFocus

Type: bool

Modifiers: noexport

Does this component currently have input focus

[edit] bNeverFocus

Type: bool

This control should never fully receive focus

[edit] bPendingFocus

Type: bool

Modifiers: noexport

Big big hack for ComboBoxes..

[edit] bRepeatClick

Type: bool

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

[edit] bRequireReleaseClick

Type: bool

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

[edit] bVisible

Type: bool

Is this component currently visible

Default value: True

[edit] DropState

Type: GUI.eDropState

Modifiers: noexport

Used to determine the current drop state of this component

[edit] FocusInstead

Type: GUIComponent

Modifiers: noexport

Who should get the focus instead of this control if bNeverFocus

[edit] LastMenuState

Type: GUI.eMenuState

Modifiers: editconst, noexport

The previous MenuState of this component

[edit] MenuState

Type: GUI.eMenuState

Modifiers: noexport

Used to determine the current state of this component

[edit] Property group 'Style'

[edit] FontScale

Type: GUI.eFontScale


Default value: FNS_Medium

[edit] MouseCursorIndex

Type: int

The mouse cursor to use when over this control

[edit] OnClickSound

Type: EClickSound


[edit] Style

Type: GUIStyles

Modifiers: noexport

My GUI Style

[edit] StyleName

Type: string

Name of my Style

[edit] Internal variables

[edit] bRequiresStyle

Type: bool

Modifiers: const, noexport


[edit] DrawCount

Type: int

Modifiers: editconst, const, noexport


[edit] MouseOffset

Type: float

Array size: 4

Modifiers: noexport, const

Used natively for drawing outlines

[edit] OnDrawCount

Type: int

Modifiers: editconst, noexport


[edit] OnPreDrawCount

Type: int

Modifiers: editconst, noexport


[edit] OnRenderCount

Type: int

Modifiers: editconst, noexport


[edit] OnRenderedCount

Type: int

Modifiers: editconst, noexport


[edit] PreDrawCount

Type: int

Modifiers: editconst, const, noexport


[edit] WhiteColor

Type: Object.Color

Modifiers: noexport, const


Default value:

Member Value
A 255
B 244
G 237
R 253
Personal tools