Show / Hide Table of Contents

Class TextAnimator_TMP

Animates a TMP text component, both UI or World. See TAnimCore for the base class information.

Inheritance
Object
TAnimCore
TextAnimator_TMP
Inherited Members
TAnimCore.typewriterStartsAutomatically
TAnimCore.animationLoop
TAnimCore.timeScale
TAnimCore.textFull
TAnimCore.textWithoutTextAnimTags
TAnimCore.textWithoutAnyTag
TAnimCore.latestCharacterShown
TAnimCore.allLettersShown
TAnimCore.anyLetterVisible
TAnimCore.CharactersCount
TAnimCore.Characters
TAnimCore.WordsCount
TAnimCore.Words
TAnimCore.useDynamicScaling
TAnimCore.referenceFontSize
TAnimCore.isResettingTimeOnNewText
TAnimCore.useDefaultDatabases
TAnimCore.DatabaseBehaviors
TAnimCore.DatabaseAppearances
TAnimCore.Behaviors
TAnimCore.Appearances
TAnimCore.Disappearances
TAnimCore.Actions
TAnimCore.DatabaseActions
TAnimCore.Events
TAnimCore.DefaultAppearancesTags
TAnimCore.DefaultDisappearancesTags
TAnimCore.DefaultBehaviorsTags
TAnimCore.time
TAnimCore.defaultTagsMode
TAnimCore.SetText(String)
TAnimCore.SetText(String, Boolean)
TAnimCore.AppendText(String, Boolean)
TAnimCore.SetVisibilityChar(Int32, Boolean)
TAnimCore.SetVisibilityWord(Int32, Boolean)
TAnimCore.SetVisibilityEntireText(Boolean, Boolean)
TAnimCore.firstVisibleCharacter
TAnimCore.maxVisibleCharacters
TAnimCore.Animate(Single)
TAnimCore.ScheduleMeshRefresh()
TAnimCore.ForceDatabaseRefresh()
TAnimCore.SetBehaviorsActive(Boolean)
TAnimCore.SetAppearancesActive(Boolean)
TAnimCore.ResetState()
TAnimCore.EnableAllEffects(Boolean)
TAnimCore.EnableAppearances(Boolean)
TAnimCore.EnableBehaviors(Boolean)
TAnimCore.EnableAppearancesLocally(Boolean)
TAnimCore.EnableBehaviorsLocally(Boolean)
TAnimCore.ShowAllCharacters(Boolean)
TAnimCore.UpdateEffects()
TAnimCore.TriggerRemainingEvents()
TAnimCore.TriggerVisibleEvents()
TAnimCore.ForceMeshRefresh()
TAnimCore.ResetEffectsTime(Boolean)
TAnimCore.isResettingEffectsOnNewText
TAnimCore.updateMode
TAnimCore.onEvent
TAnimCore.effectsAppearancesEnabled
TAnimCore.effectsBehaviorsEnabled
TAnimCore.text
TAnimCore.effectIntensityMultiplier
Namespace: Febucci.UI
Assembly: Febucci.TextAnimator.TMP.Runtime.dll
Syntax
public sealed class TextAnimator_TMP : TAnimCore

Properties

TMProComponent

The TextMeshPro text component linked to this Text Animator

Declaration
public TMP_Text TMProComponent { get; }
Property Value
Type Description
TMPro.TMP_Text

tmproText

Declaration
public TMP_Text tmproText { get; }
Property Value
Type Description
TMPro.TMP_Text

Methods

CopyMeshFromSource(ref CharacterData[])

Declaration
protected override void CopyMeshFromSource(ref CharacterData[] characters)
Parameters
Type Name Description
CharacterData[] characters
Overrides
TAnimCore.CopyMeshFromSource(ref CharacterData[])

GetCharactersCount()

Declaration
protected override int GetCharactersCount()
Returns
Type Description
Int32
Overrides
TAnimCore.GetCharactersCount()

GetExtraParsers()

Declaration
protected override TagParserBase[] GetExtraParsers()
Returns
Type Description
TagParserBase[]
Overrides
TAnimCore.GetExtraParsers()

GetOriginalTextFromSource()

Declaration
public override string GetOriginalTextFromSource()
Returns
Type Description
String
Overrides
TAnimCore.GetOriginalTextFromSource()

GetStrippedTextFromSource()

Declaration
public override string GetStrippedTextFromSource()
Returns
Type Description
String
Overrides
TAnimCore.GetStrippedTextFromSource()

HasChangedRenderingSettings()

Declaration
protected override bool HasChangedRenderingSettings()
Returns
Type Description
Boolean
Overrides
TAnimCore.HasChangedRenderingSettings()

HasChangedText(String)

Declaration
protected override bool HasChangedText(string strippedText)
Parameters
Type Name Description
String strippedText
Returns
Type Description
Boolean
Overrides
TAnimCore.HasChangedText(String)

IsReady()

Declaration
protected override bool IsReady()
Returns
Type Description
Boolean
Overrides
TAnimCore.IsReady()

OnEnable()

Declaration
protected override void OnEnable()
Overrides
TAnimCore.OnEnable()

OnForceMeshUpdate()

Declaration
protected override void OnForceMeshUpdate()
Overrides
TAnimCore.OnForceMeshUpdate()

OnInitialized()

Declaration
protected override void OnInitialized()
Overrides
TAnimCore.OnInitialized()

PasteMeshToSource(CharacterData[])

Declaration
protected override void PasteMeshToSource(CharacterData[] characters)
Parameters
Type Name Description
CharacterData[] characters
Overrides
TAnimCore.PasteMeshToSource(CharacterData[])

SetTextToSource(String)

Equivalent to setting the text to the TMP component, without parsing it. Please use SetText(String) or SetText(String, Boolean) instead.

Declaration
public override void SetTextToSource(string text)
Parameters
Type Name Description
String text
Overrides
TAnimCore.SetTextToSource(String)

TryGetNextCharacter(out TMP_CharacterInfo)

Declaration
public bool TryGetNextCharacter(out TMP_CharacterInfo result)
Parameters
Type Name Description
TMPro.TMP_CharacterInfo result
Returns
Type Description
Boolean
Back to top Text Animator for Unity - Documentation