UE2:GUISubtitleText (UT2004)

From Unreal Wiki, The Unreal Engine Documentation Site
(Redirected from UE2:EDisplayState (UT2004))
Jump to navigation Jump to 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

Property group 'GUISubtitleText'

DelayTime

Type: float

default delay time

Default value: 2.0

GuessCharTime

Type: float

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

Default value: 0.06

InitialDelay

Type: float

initial delay

SubTitles

Type: array<string>

each subtitle on a diffirent line

SubTitleTiming

Type: array<VisibleDelay>

time to show a single subtitle

VisibleTime

Type: float

default subtitle visibility, if <= 0 remain visible

Internal variables

CurLine

Type: int

Modifiers: protected


DisplayState

Type: eDisplayState

Modifiers: protected


Separator

Type: string

default seperator

Default value: "|"

Default values

Property Value
bMultiLine True
StyleName "TextLabel"
TextAlign TXTA_Center

Enums

eDisplayState

DS_Delay 
DS_Visibility 
DS_Stopped 

Structs

VisibleDelay

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

OnStopped

delegate OnStopped ()


Functions

Events

Timer

event Timer ()

Overrides: GUIComponent.Timer


Other instance functions

AddSubtitle

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

function ClearSubtitles ()


InsertSubtitle

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

function Restart ()


SetSubtitles

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

function Stop ()