Applies a typewriter effect to the text of a GUI control. More...

Inheritance diagram for PixelCrushers.DialogueSystem.UnityGUI.TypewriterEffect:

Collaboration diagram for PixelCrushers.DialogueSystem.UnityGUI.TypewriterEffect:

Public Member Functions
override IEnumerator	Play ()
	Plays the typewriter effect. More...

override void	Stop ()
	Stops the effect. More...

Public Member Functions inherited from PixelCrushers.DialogueSystem.UnityGUI.GUIEffect
void	OnEnable ()

void	OnDisable ()

Public Attributes
float	charactersPerSecond = 50
	How fast to "type." More...

AudioClip	audioClip = null
	The audio clip to play with each character. More...

Public Attributes inherited from PixelCrushers.DialogueSystem.UnityGUI.GUIEffect
GUIEffectTrigger	trigger = GUIEffectTrigger.OnEnable
	The trigger that makes the effect play. More...

Properties
bool	IsPlaying `[get]`
	Indicates whether the effect is playing. More...

Detailed Description

Applies a typewriter effect to the text of a GUI control.

Characters are displayed one at a time at a rate of charactersPerSecond.

Member Function Documentation

override IEnumerator PixelCrushers.DialogueSystem.UnityGUI.TypewriterEffect.Play ( )

virtual

Plays the typewriter effect.

override void PixelCrushers.DialogueSystem.UnityGUI.TypewriterEffect.Stop ( )

virtual

Stops the effect.

AudioClip PixelCrushers.DialogueSystem.UnityGUI.TypewriterEffect.audioClip = null

The audio clip to play with each character.

float PixelCrushers.DialogueSystem.UnityGUI.TypewriterEffect.charactersPerSecond = 50

How fast to "type."

bool PixelCrushers.DialogueSystem.UnityGUI.TypewriterEffect.IsPlaying

get

Indicates whether the effect is playing.

true if this instance is playing; otherwise, false.

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

D:/Documents/Unity Projects/Dialogue System/Dev/Source/Assets/Dialogue System/Scripts/Supplemental/Unity GUI/GUI Controls/Effects/TypewriterEffect.cs