NGUI: Next-Gen UI kit  3.7.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Macros
TypewriterEffect Class Reference

This script is able to fill in the label's text gradually, giving the effect of someone typing or fading in the content over time. More...

Inheritance diagram for TypewriterEffect:

Public Member Functions

void ResetToBeginning ()
 Reset the typewriter effect to the beginning of the label. More...
 
void Finish ()
 Finish the typewriter operation and show all the text right away. More...
 

Public Attributes

int charsPerSecond = 20
 How many characters will be printed per second. More...
 
float fadeInTime = 0f
 How long it takes for each character to fade in. More...
 
float delayOnPeriod = 0f
 How long to pause when a period is encountered (in seconds). More...
 
float delayOnNewLine = 0f
 How long to pause when a new line character is encountered (in seconds). More...
 
UIScrollView scrollView
 If a scroll view is specified, its UpdatePosition() function will be called every time the text is updated. More...
 
bool keepFullDimensions = false
 If set to 'true', the label's dimensions will be that of a fully faded-in content. More...
 
List< EventDelegateonFinished = new List<EventDelegate>()
 Event delegate triggered when the typewriter effect finishes. More...
 

Static Public Attributes

static TypewriterEffect current
 

Properties

bool isActive [get]
 Whether the typewriter effect is currently active or not. More...
 

Detailed Description

This script is able to fill in the label's text gradually, giving the effect of someone typing or fading in the content over time.

Member Function Documentation

void TypewriterEffect.Finish ( )

Finish the typewriter operation and show all the text right away.

void TypewriterEffect.ResetToBeginning ( )

Reset the typewriter effect to the beginning of the label.

Member Data Documentation

int TypewriterEffect.charsPerSecond = 20

How many characters will be printed per second.

TypewriterEffect TypewriterEffect.current
static
float TypewriterEffect.delayOnNewLine = 0f

How long to pause when a new line character is encountered (in seconds).

float TypewriterEffect.delayOnPeriod = 0f

How long to pause when a period is encountered (in seconds).

float TypewriterEffect.fadeInTime = 0f

How long it takes for each character to fade in.

bool TypewriterEffect.keepFullDimensions = false

If set to 'true', the label's dimensions will be that of a fully faded-in content.

List<EventDelegate> TypewriterEffect.onFinished = new List<EventDelegate>()

Event delegate triggered when the typewriter effect finishes.

UIScrollView TypewriterEffect.scrollView

If a scroll view is specified, its UpdatePosition() function will be called every time the text is updated.

Property Documentation

bool TypewriterEffect.isActive
get

Whether the typewriter effect is currently active or not.


The documentation for this class was generated from the following file: