I'm a doctor, not a mechanic

UE2:GUISubtitleText (UT2004)

From Unreal Wiki, The Unreal Engine Documentation Site

(Redirected from UE2:EDisplayState (UT2004))
Jump to: navigation, search
UT2004 Object >> GUI >> GUIComponent >> GUILabel >> GUISubtitleText

Contents

Package: 
XInterface

A timed label used to display subtitles

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

[edit] Properties

[edit] Property group 'GUISubtitleText'

[edit] DelayTime

Type: float

default delay time

Default value: 2.0

[edit] GuessCharTime

Type: float

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

Default value: 0.06

[edit] InitialDelay

Type: float

initial delay

[edit] SubTitles

Type: array<string>

each subtitle on a diffirent line

[edit] SubTitleTiming

Type: array<VisibleDelay>

time to show a single subtitle

[edit] VisibleTime

Type: float

default subtitle visibility, if <= 0 remain visible

[edit] Internal variables

[edit] CurLine

Type: int

Modifiers: protected


[edit] DisplayState

Type: eDisplayState

Modifiers: protected


[edit] Separator

Type: string

default seperator

Default value: "|"

[edit] Default values

Property Value
bMultiLine True
StyleName "TextLabel"
TextAlign TXTA_Center

[edit] Enums

[edit] eDisplayState

DS_Delay 
DS_Visibility 
DS_Stopped 

[edit] Structs

[edit] 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 

[edit] Delegates

[edit] OnStopped

delegate OnStopped ()


[edit] Functions

[edit] Events

[edit] Timer

event Timer ()

Overrides: GUIComponent.Timer


[edit] Other instance functions

[edit] 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

[edit] ClearSubtitles

function ClearSubtitles ()


[edit] 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

[edit] Restart

function Restart ()


[edit] 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

[edit] Stop

function Stop ()