I'm a doctor, not a mechanic

UE2:GUIScrollText (UT2003)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT2003 Object >> GUI >> GUIComponent >> GUIListBase >> GUIVertList >> GUIList >> GUIScrollText
Package: 
XInterface
This class in other games:
UE2Runtime, UT2004

null

Properties

bClickText

Type: bool

Upon clicking on this text box, fill in ClickedString field

bNewContent

Type: bool

Modifiers: protected

This is set when new text content has been set for the control

bNoTeletype

Type: bool

Dont do the teletyping effect at all

bRepeat

Type: bool

Should the sequence be repeated ?

bStopped

Type: bool

Modifiers: protected


CharDelay

Type: float

This is the delay between each char

Default value: 0.25

ClickedString

Type: string


Content

Type: string

Modifiers: protected

This is the content to display in 1 single string

EOLDelay

Type: float

This is the delay to use when reaching end of line

Default value: 0.75

InitialDelay

Type: float

Initial delay after new content was set

MaxHistory

Type: int

Maximum number of rows. Only used in conjunction with NewText. 0 indicates no limit.

NewText

Type: string

New text to add the end of

oldWidth

Type: int

Modifiers: protected

Last width of the diplay area

RepeatDelay

Type: float

This is used after all the text has been displayed and bRepeat is true

Default value: 3.0

ScrollState

Type: eScrollState

Modifiers: protected

What was the last action we did

Separator

Type: string

Separator to use

Default value: "|"

VisibleChars

Type: int

Modifiers: protected

How Many chars in the last displayed line are visible

VisibleLines

Type: int

Modifiers: protected

This is the number of visible lines

Default value: -1

Default values

Property Value
TextAlign TXTA_Left

Enums

eScrollState

STS_None 
STS_Initial 
STS_Char 
STS_EOL 
STS_Repeat 

Delegates

OnEndOfLine

delegate OnEndOfLine ()


Functions

Native functions

GetWordUnderCursor

native final function string GetWordUnderCursor ()


Events

Timer

event Timer ()

Overrides: GUIComponent.Timer


Other instance functions

EndScrolling

function EndScrolling ()


InitComponent

function InitComponent (GUIController MyController, GUIComponent MyOwner)

Overrides: GUIVertList.InitComponent


InternalOnClick

function bool InternalOnClick (GUIComponent Sender)

Overrides: GUIVertList.InternalOnClick


InternalOnKeyEvent

function bool InternalOnKeyEvent (out byte Key, out byte State, float delta)

Overrides: GUIVertList.InternalOnKeyEvent


InternalOnKeyType

function bool InternalOnKeyType (out byte Key, optional string Unicode)

Overrides: GUIVertList.InternalOnKeyType


Restart

function Restart ()


SetContent

function SetContent (string NewContent, optional string sep)


SkipChar

function bool SkipChar ()


Stop

function Stop ()