Cogito, ergo sum

UE2:GUILabel (UT2004)

From Unreal Wiki, The Unreal Engine Documentation Site

Jump to: navigation, search
UT2004 Object >> GUI >> GUIComponent >> GUILabel

Contents

Package: 
XInterface
Direct subclass:
GUISubtitleText
This class in other games:
UE2Runtime, UT2003

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

[edit] Properties

[edit] Property group 'GUILabel'

[edit] BackColor

Type: Object.Color

Background color for this label

Default value:

Member Value
A 255
B 0
G 0
R 0

[edit] bMultiLine

Type: bool

Will cut content to display on multiple lines when too long

[edit] bTransparent

Type: bool

Draw a Background for this label

Default value: True

[edit] Caption

Type: string

Modifiers: localized

The text to display

[edit] FocusedTextColor

Type: Object.Color

The Color to display this in.

Default value:

Member Value
A 255
B 80
G 32
R 32

[edit] HilightColor

Type: Object.Color

Shadow Color

Default value:

Member Value
A 196
B 255
G 255
R 255

[edit] HilightOffsetX

Type: float

if > 0 draw shadow

[edit] HilightOffsetY

Type: float

if > 0 draw shadow

[edit] ShadowColor

Type: Object.Color

Shadow Color

Default value:

Member Value
A 196
B 0
G 0
R 0

[edit] ShadowOffsetX

Type: float

if > 0 draw shadow

[edit] ShadowOffsetY

Type: float

if > 0 draw shadow

[edit] TextAlign

Type: GUI.eTextAlign

How is the text aligned in it's bounding box

[edit] TextColor

Type: Object.Color

The Color to display this in.

Default value:

Member Value
A 255
B 64
G 0
R 0

[edit] TextFont

Type: string

The Font to display it in

Default value: "UT2MenuFont"

[edit] TextStyle

Type: GUI.EMenuRenderStyle

What canvas style to use

Default value: MSTY_Normal

[edit] VertAlign

Type: GUI.eTextAlign

Vertical alignment (only if bMultiLine) - Left = Top

[edit] Default values

Property Value
RenderWeight 0.4
WinHeight 0.06