Calcatz.Sequine.SequineText Class Reference

Sequine Text is a TextMeshPro animation tool with stackable behaviour. Using the stackable behaviour, you can deicide whether you want to animate it per character or the whole texts, the timings, the colors, etc. More...

Inheritance diagram for Calcatz.Sequine.SequineText:

Public Member Functions
void	Restart ()
void	Play ()
void	Play (bool _restart=true)
void	Complete ()
void	Stop ()
void	SetDirty ()
void	AppendText (string _text, TextBehaviourProfile _behaviourProfile, System.Action _onComplete=null)
	Append text to the current text, and immediately play if it's currently not playing. More...
void	AppendText (string _text, TextBehaviourProfile _behaviourProfile, bool _restartAnimation, System.Action _onComplete=null)
	Append text to the current text, and immediately play if it's currently not playing. More...
void	ResetText ()

Protected Member Functions
virtual void	Update ()
virtual void	FixedUpdate ()

Properties
TMP_Text	textComponent [get]
bool	isPlaying [get]
string	text [getset]
float	normalizedTime [getset]
float	time [getset]
float	totalDuration [get]
bool	loop [getset]

Events
System.Action	onAnimationCompleted

Detailed Description

Sequine Text is a TextMeshPro animation tool with stackable behaviour. Using the stackable behaviour, you can deicide whether you want to animate it per character or the whole texts, the timings, the colors, etc.

Member Function Documentation

AppendText() [1/2]

void Calcatz.Sequine.SequineText.AppendText	(	string	_text,
		TextBehaviourProfile	_behaviourProfile,
		bool	_restartAnimation,
		System.Action	_onComplete = null
	)

Append text to the current text, and immediately play if it's currently not playing.

Parameters

_text
_behaviourProfile
_restartAnimation
_onComplete

AppendText() [2/2]

void Calcatz.Sequine.SequineText.AppendText	(	string	_text,
		TextBehaviourProfile	_behaviourProfile,
		System.Action	_onComplete = null
	)

Append text to the current text, and immediately play if it's currently not playing.

Parameters

_text
_behaviourProfile
_onComplete

Complete()

void Calcatz.Sequine.SequineText.Complete

(

)

FixedUpdate()

virtual void Calcatz.Sequine.SequineText.FixedUpdate ( )

protectedvirtual

Play() [1/2]

void Calcatz.Sequine.SequineText.Play

(

)

Play() [2/2]

void Calcatz.Sequine.SequineText.Play

(

bool

_restart = true

)

ResetText()

void Calcatz.Sequine.SequineText.ResetText

(

)

Restart()

void Calcatz.Sequine.SequineText.Restart

(

)

SetDirty()

void Calcatz.Sequine.SequineText.SetDirty

(

)

Stop()

void Calcatz.Sequine.SequineText.Stop

(

)

Update()

virtual void Calcatz.Sequine.SequineText.Update ( )

protectedvirtual

Property Documentation

isPlaying

bool Calcatz.Sequine.SequineText.isPlaying

get

loop

bool Calcatz.Sequine.SequineText.loop

getset

normalizedTime

float Calcatz.Sequine.SequineText.normalizedTime

getset

text

string Calcatz.Sequine.SequineText.text

getset

textComponent

TMP_Text Calcatz.Sequine.SequineText.textComponent

get

time

float Calcatz.Sequine.SequineText.time

getset

totalDuration

float Calcatz.Sequine.SequineText.totalDuration

get

Event Documentation

onAnimationCompleted

System.Action Calcatz.Sequine.SequineText.onAnimationCompleted