1️⃣ You're browsing the documentation for version 1.X. If you want to check version 2.X instead, please go here. 1️⃣
You can perform actions once the typewriter reaches a specific position in the text. (For this reason, actions work only if the typewriter is enabled)
Example: waiting for X seconds or waiting for the player input.
How to add actions in your text
You can add actions to your text by using rich text tags.
Actions’ formatting follows this formula: “
<actionID>” or “
<actionID=attribute1,attribute2,...>” for eventual parameters/attributes.
⚠️ Actions are case sensitive,
<waitFor> will produce different results.
Actions support multiple attributes, after the ‘
=’ sign and all separated by a
(As you can see, the attributes formatting is slightly different from the effects’ modifiers, since actions do not have attributesIDs).
- ⚠️ Floating point numbers must use a
period, not a
- ✔️ <speed=0.5>
- ❌ <speed=0,5>
You can use built-in actions or create your own. (Read more here (C#))
You can use the following built-in actions in your text.
- tag: waitfor
- description: Waits for X seconds before continuing to show the text.
- attributes: float (wait duration)
- usage_example: waitfor=1.5
- tag: waitinput
- description: Waits for the player input"
- usage_example: waitinput
- tag: speed
- description: Multiplies the typewriter speed
- attributes: float (speed multiplier)
- usage_example: speed=2