Text Animator for Unity

Table of Contents

• Basic Setup
• Additional Setup
  • Text Animator Subtitle Panel (Accumulate Text, "Typed" Message)
  • Text Animator End Keyword (Sequencer {{end}} Keyword)
  • Continue Buttons
• Sequencer Commands
  • TextAnimatorDisappear()

This page describes how to set up the Dialogue System with Text Animator for Unity. (Text Animator 2.x is required.)

Text Animator copyright © Febucci Creations.

Basic Setup

To use Text Animator with the Dialogue System, see Text Animator's documentation:

https://www.textanimator.febucci.com/

The current direct link to the basic setup steps for the Dialogue System are here:

https://www.febucci.com/text-animator-unity/docs/integrated-plugins-and-dialogue-systems/

Additional Setup

The Text Animator Support package found in the Dialogue System's Third Party Support folder contains additional integration scripts.

Note: If you're using Text Animator 1.x, the old integration package is available on the Dialogue System Extras page.

Text Animator Subtitle Panel (Accumulate Text, "Typed" Message)

Switch your subtitle panel from StandardUISubtitlePanel to the TextAnimatorSubtitlePanel script if you want to enable any of these features:

• Subtitle panel Accumulate Text feature.
• You want to the sequencer to receive "Typed" messages when Text Animator finishes typing.

Text Animator End Keyword (Sequencer {{end}} Keyword)

Add the TextAnimatorEndKeyword script to your dialogue UI (not the subtitle panel) if:

• You want the sequencer {{end}} keyword to account for Text Animator typing duration.

Continue Buttons

Since Text Animator does not use the Dialogue System's built-in typewriter effect, the StandardUIContinueButtonFastForward component will not work with it. If you want the continue button to fast-forward Text Animator's typewriter if it's still typing, import the Text Animator Support package from the Dialogue System's Third Party Support folder. Replace the StandardUIContinueButtonFastForward component with TextAnimatorContinueButtonFastForward, and configure the button's OnClick() event to call its OnFastForward() method.

Sequencer Commands

The integration adds these sequencer commands:

Continue Buttons

• Syntax:
  • TextAnimatorContinue(): Immediately show the entire text and continue the current conversation.
  • TextAnimatorContinue(all): Immediately show the entire text and continue all active conversations.

TextAnimatorDisappear()

• Syntax:
  • TextAnimatorDisappear(): Hides the current subtitle panel's subtitle text using Text Animator's disappear functionality.

---

<< Third Party Integration