Class TextAnimator

Animator for animating text in a type writer stlye

Inheritance

System.Object

TextAnimator

Implements

IDisposable

Namespace: AnimationHelpers

Assembly: cs.temp.dll.dll

Syntax

public class TextAnimator : MonoBehaviour, IDisposable

Constructors

TextAnimator()

Declaration

public TextAnimator()

Properties

CurrentCoroutine

Declaration

public Coroutine CurrentCoroutine { get; }

Property Value

Type	Description
Coroutine

Methods

AddAction(TextAnimator.TextAnimationAction)

Add actions between each animation step.

Declaration

public void AddAction(TextAnimator.TextAnimationAction action)

Parameters

Type	Name	Description
TextAnimator.TextAnimationAction	action	The action TextAnimator.TextAnimationAction

Create(TMP_Text, Single, Single, Boolean)

Create a new instance of TextAnimator

Declaration

public static TextAnimator Create(TMP_Text text, float speed, float waitTimeSenteceEnd, bool animateWords)

Parameters

Type	Name	Description
TMP_Text	text	The Text Mesh Pro text to animate
System.Single	speed	The pause between each character/word
System.Single	waitTimeSenteceEnd	The pause when sentence is finished (only recognizes . as an end of a sentence)
System.Boolean	animateWords	When true while words will appear else single characters will appear

Returns

Type	Description
TextAnimator

Dispose()

Same as Stop Stop()

Declaration

public void Dispose()

Execute()

Execute the animation.

Declaration

public TextAnimator Execute()

Returns

Type	Description
TextAnimator	It self

Stop()

Stop the animation

Declaration

public void Stop()

Implements

IDisposable