UE2:GUIScrollText (UT2004)

From Unreal Wiki, The Unreal Engine Documentation Site
(Redirected from UE2:EScrollState (UT2004))
Jump to navigation Jump to search
UT2004 Object >> GUI >> GUIComponent >> GUIListBase >> GUIVertList >> GUIList >> GUIScrollText
Package: 
XInterface

null

Properties

Property group 'GUIScrollText'

bClickText

Type: bool

Upon clicking on this text box, fill in ClickedString field

bNewContent

Type: bool

Modifiers: editconst, 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: editconst, protected

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

CharDelay

Type: float

This is the delay between each char

Default value: 0.25

ClickedString

Type: string

Modifiers: editconst


Content

Type: string

Modifiers: editconst, 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

Modifiers: editconst

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

NewText

Type: string

Modifiers: editconst

New text to add the end of

oldWidth

Type: float

Modifiers: editconst, 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: editconst, protected

What was the last action we did

Separator

Type: string

Modifiers: editconst

Separator to use

Default value: "|"

StringElements

Type: array<string>

Modifiers: editconst, editconstarray


VisibleChars

Type: int

Modifiers: editconst, protected

How Many chars in the last displayed line are visible

VisibleLines

Type: int

Modifiers: editconst, protected

This is the number of visible lines

Default value: -1

Internal variables

bReceivedNewContent

Type: bool

Modifiers: const, editconst, private


Default values

Property Value
OnClick InternalOnClick
OnKeyEvent InternalOnKeyEvent
OnKeyType InternalOnKeyType
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

InitComponent

event InitComponent (GUIController MyController, GUIComponent MyOwner)

Overrides: GUIListBase.InitComponent


Timer

event Timer ()

Overrides: GUIComponent.Timer


Other instance functions

Dump

function Dump ()


EndScrolling

function EndScrolling ()


InternalOnClick

function bool InternalOnClick (GUIComponent Sender)

Overrides: GUIVertList.InternalOnClick


InternalOnKeyEvent

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

Overrides: GUIListBase.InternalOnKeyEvent


InternalOnKeyType

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

Overrides: GUIVertList.InternalOnKeyType


IsValid

function bool IsValid ()

Overrides: GUIListBase.IsValid


Restart

function Restart ()


SetContent

function SetContent (string NewContent, optional string sep)


SkipChar

function bool SkipChar ()


Stop

function Stop ()