You can use TextAnimatorPlayers to show letters dynamically (like a typewriter), choosing different pauses for any kind of characters (punctuaction, letters, […]), trigger events and more.


Showing Text

You can tell TextAnimator to use the typewriter in two ways.

Replacing “tmproText.text = textValue;” with textAnimatorPlayer.ShowText(textValue); in your code (referencing a TextAnimatorPlayer component).

B) Via the “Easy Integration”

Enabling the “Use Easy Integration” option in the TextAnimator component.
This will let the plugin automatically check for text changes in your TextMeshPro’s component.

textanimator component easy integration option

Untitled1


As typewriter, you can use the built-in one or you can create your own. (Read here how to create a custom typewriter via C#)

Built-in typewriter (TextAnimatorPlayer.cs)

The default typewriter component is called TextAnimatorPlayer.
You can hover the mouse above its fields in the Inspector to show the tooltips for each option/feature, but here’s a quick look in this page as well.

Untitled2

  • Use Type Writer: true if you want to show text dynamically, like a typewriter.

👍🏻 The typewriter timescale will match the relative TextAnimator component one.


Set different pauses

Untitled3

  • Normal chars: not puntuaction
  • Long: ‘!’, ‘?’, ‘.
  • Middle: ‘,’, ‘;’, ‘)’,’:’,’-
  • AvoidMultiplePunctuactionWait
    • If true, only the last punctuaction on a sequence waits for its category time.

      Example: “I’m bored……” → all dots will have a “normal” wait, except for the very last dot of the sequence, which will have a “long” wait.

    • If false, each punctuaction will wait regardless if it’s in a sequence or not.

      Example: “I’m bored……” → each single dot will have a “long” wait


Events

You can trigger events based on the typewriter activity (example: when it just ended showing text).

Untitled4

  • OnTextShowed: event called after the entire text has been shown (if you’ve set “Use Typewriter” to true, it will wait until all letters are shown).

The following events only work if the “Use typewriter” is set to true:

  • OnCharacterVisible(char x): event called each time a character became visible.
  • OnTypewriterStart: event called right before the typewriter starts showing its first letter. It doesn’t work if the typewriter is off, since it would coincide with the “OnTextShowed” event (in this case you can use that one instead)

Typewriter Skip

Untitled5

  • Can Skip Typewriter: true if the player can skip the typewriter. To skip a typewriter, invoke the TextAnimatorPlayer’s method called “SkipTypewriter” from your scripts.
  • Hide Appearances On Skip: true if the letters will be skipped without any appearance effect.