Mostly Harmless

UE2:GUIScrollText (UT2004)

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

null

Properties[edit]

Property group 'GUIScrollText'[edit]

bClickText[edit]

Type: bool

Upon clicking on this text box, fill in ClickedString field

bNewContent[edit]

Type: bool

Modifiers: editconst, protected

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

bNoTeletype[edit]

Type: bool

Dont do the teletyping effect at all

bRepeat[edit]

Type: bool

Should the sequence be repeated ?

bStopped[edit]

Type: bool

Modifiers: editconst, protected

Tells when the sequence has stopped animating (can be rushed by clicking ?)

CharDelay[edit]

Type: float

This is the delay between each char

Default value: 0.25

ClickedString[edit]

Type: string

Modifiers: editconst


Content[edit]

Type: string

Modifiers: editconst, protected

This is the content to display in 1 single string

EOLDelay[edit]

Type: float

This is the delay to use when reaching end of line

Default value: 0.75

InitialDelay[edit]

Type: float

Initial delay after new content was set

MaxHistory[edit]

Type: int

Modifiers: editconst

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

NewText[edit]

Type: string

Modifiers: editconst

New text to add the end of

oldWidth[edit]

Type: float

Modifiers: editconst, protected

Last width of the diplay area

RepeatDelay[edit]

Type: float

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

Default value: 3.0

ScrollState[edit]

Type: eScrollState

Modifiers: editconst, protected

What was the last action we did

Separator[edit]

Type: string

Modifiers: editconst

Separator to use

Default value: "|"

StringElements[edit]

Type: array<string>

Modifiers: editconst, editconstarray


VisibleChars[edit]

Type: int

Modifiers: editconst, protected

How Many chars in the last displayed line are visible

VisibleLines[edit]

Type: int

Modifiers: editconst, protected

This is the number of visible lines

Default value: -1

Internal variables[edit]

bReceivedNewContent[edit]

Type: bool

Modifiers: const, editconst, private


Default values[edit]

Property Value
OnClick InternalOnClick
OnKeyEvent InternalOnKeyEvent
OnKeyType InternalOnKeyType
TextAlign TXTA_Left

Enums[edit]

eScrollState[edit]

STS_None 
STS_Initial 
STS_Char 
STS_EOL 
STS_Repeat 

Delegates[edit]

OnEndOfLine[edit]

delegate OnEndOfLine ()


Functions[edit]

Native functions[edit]

GetWordUnderCursor[edit]

native final function string GetWordUnderCursor ()


Events[edit]

InitComponent[edit]

event InitComponent (GUIController MyController, GUIComponent MyOwner)

Overrides: GUIListBase.InitComponent


Timer[edit]

event Timer ()

Overrides: GUIComponent.Timer


Other instance functions[edit]

Dump[edit]

function Dump ()


EndScrolling[edit]

function EndScrolling ()


InternalOnClick[edit]

function bool InternalOnClick (GUIComponent Sender)

Overrides: GUIVertList.InternalOnClick


InternalOnKeyEvent[edit]

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

Overrides: GUIListBase.InternalOnKeyEvent


InternalOnKeyType[edit]

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

Overrides: GUIVertList.InternalOnKeyType


IsValid[edit]

function bool IsValid ()

Overrides: GUIListBase.IsValid


Restart[edit]

function Restart ()


SetContent[edit]

function SetContent (string NewContent, optional string sep)


SkipChar[edit]

function bool SkipChar ()


Stop[edit]

function Stop ()