Mostly Harmless

UE2:GUILabel (UT2004)

From Unreal Wiki, The Unreal Engine Documentation Site
Revision as of 10: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 >> GUILabel
Package: 
XInterface
Direct subclass:
GUISubtitleText
This class in other games:
UT2003, UE2Runtime

GUILabel - A text label that get's displayed. By default, it uses the default font, however you can override it if you wish.

By default, labels will never be focused, since bAcceptsInput is false for GUILabel. This means that GUILabel will never be put into the MSAT_Focused state (thus changing the color of the text to FocusedTextColor) unless the GUILabel is associated with a component that manually sets the label's state, such as a GUIMenuOption.

The easiest way to override this default behavior, if desired, is by setting StyleName to "TextLabel".

Written by Joe Wilcox Updated by Ron Prestenback (c) 2002 - 2003, Epic Games, Inc. All Rights Reserved

Properties[edit]

Property group 'GUILabel'[edit]

BackColor[edit]

Type: Object.Color

Background color for this label

Default value:

Member Value
A 255
B 0
G 0
R 0

bMultiLine[edit]

Type: bool

Will cut content to display on multiple lines when too long

bTransparent[edit]

Type: bool

Draw a Background for this label

Default value: True

Caption[edit]

Type: string

Modifiers: localized

The text to display

FocusedTextColor[edit]

Type: Object.Color

The Color to display this in.

Default value:

Member Value
A 255
B 80
G 32
R 32

HilightColor[edit]

Type: Object.Color

Shadow Color

Default value:

Member Value
A 196
B 255
G 255
R 255

HilightOffsetX[edit]

Type: float

if > 0 draw shadow

HilightOffsetY[edit]

Type: float

if > 0 draw shadow

ShadowColor[edit]

Type: Object.Color

Shadow Color

Default value:

Member Value
A 196
B 0
G 0
R 0

ShadowOffsetX[edit]

Type: float

if > 0 draw shadow

ShadowOffsetY[edit]

Type: float

if > 0 draw shadow

TextAlign[edit]

Type: GUI.eTextAlign

How is the text aligned in it's bounding box

TextColor[edit]

Type: Object.Color

The Color to display this in.

Default value:

Member Value
A 255
B 64
G 0
R 0

TextFont[edit]

Type: string

The Font to display it in

Default value: "UT2MenuFont"

TextStyle[edit]

Type: GUI.EMenuRenderStyle

What canvas style to use

Default value: MSTY_Normal

VertAlign[edit]

Type: GUI.eTextAlign

Vertical alignment (only if bMultiLine) - Left = Top

Default values[edit]

Property Value
RenderWeight 0.4
WinHeight 0.06