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

UE2:GUISubtitleText (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 >> GUILabel >> GUISubtitleText
Package: 
XInterface

A timed label used to display subtitles

Written by Michiel Hendriks (c) 2003, Epic Games, Inc. All Rights Reserved

Properties[edit]

Property group 'GUISubtitleText'[edit]

DelayTime[edit]

Type: float

default delay time

Default value: 2.0

GuessCharTime[edit]

Type: float

use by SetSubTitles to guess the delay, delay = guess time * no. chars

Default value: 0.06

InitialDelay[edit]

Type: float

initial delay

SubTitles[edit]

Type: array<string>

each subtitle on a diffirent line

SubTitleTiming[edit]

Type: array<VisibleDelay>

time to show a single subtitle

VisibleTime[edit]

Type: float

default subtitle visibility, if <= 0 remain visible

Internal variables[edit]

CurLine[edit]

Type: int

Modifiers: protected


DisplayState[edit]

Type: eDisplayState

Modifiers: protected


Separator[edit]

Type: string

default seperator

Default value: "|"

Default values[edit]

Property Value
bMultiLine True
StyleName "TextLabel"
TextAlign TXTA_Center

Enums[edit]

eDisplayState[edit]

DS_Delay 
DS_Visibility 
DS_Stopped 

Structs[edit]

VisibleDelay[edit]

Visible is the time this subtitle is vissible Delay is the time to wait to display the next sub title

float Visible 
float Delay 

Delegates[edit]

OnStopped[edit]

delegate OnStopped ()


Functions[edit]

Events[edit]

Timer[edit]

event Timer ()

Overrides: GUIComponent.Timer


Other instance functions[edit]

AddSubtitle[edit]

function int AddSubtitle (string NewTitle, optional float delay, optional float Visible)

Add a subtitle if delay/visible is omitted or 0 the default value is used to have an actual 0 as visible/delay use a negative value

ClearSubtitles[edit]

function ClearSubtitles ()


InsertSubtitle[edit]

function int InsertSubtitle (int position, string NewTitle, optional float delay, optional float Visible)

Insert a subtitle If the position is invalid -1 is returned

Restart[edit]

function Restart ()


SetSubtitles[edit]

function int SetSubtitles (string alldata, optional string sep, optional bool bDontGuess, optional string lengthdata)

Set the subtitles, using default timing if bDontGuess == true lengthdata will be used (uses the same seperator) Return the number of items added

Stop[edit]

function Stop ()