Advanced Typewriter System Documentation
This documentation provides a technical overview and integration guide for the Advanced Typewriter System plugin, featuring custom Blueprint nodes for dynamic text display.
I. Overview of Custom Nodes
The plugin exposes two primary custom Blueprint nodes for handling typewriter effects. These nodes are designed to provide granular control over the text animation speed, timing, and synchronization.
A. Node: Type Char (Advanced Type Text)
This node processes text by animating the display character by character. It offers high precision over the typing speed and punctuation timing.
| Parameter | Type | Control | Description |
|---|---|---|---|
| Text | String | Input | The source text content to be animated. |
| Text Block | Object Reference | Input | Reference to the UMG Text Block widget where the output text will be displayed. |
| Chars Per Sec | Integer | Input | Defines the speed of the effect in characters per second. |
| Enable Punctuation Delay | Boolean | Input | If checked, the system will apply extra delay when encountering punctuation marks. |
| Puntuations | Enumeration (Array) | Input | Customizable list of punctuation marks and their associated delay times. |
| Type Sound | Audio Asset | Input | The sound played for each typed character (if enabled). |
| Should Pause with Game | Boolean | Input | Determines if the typing animation pauses when the game is paused. |
Execution Outputs (Flow):
| Output Pin | Purpose |
|---|---|
| Type in Progress | Executed every time a character is typed, useful for UI feedback. |
| Type Completed | Executed once the entire text string has been fully displayed. |
B. Node: Type Word (Advanced Type Word)
This node processes text by animating the display word by word. This is suitable for faster, less granular text reveal effects.
| Parameter | Type | Control | Description |
|---|---|---|---|
| Text | String | Input | The source text content to be animated. |
| Text Block | Object Reference | Input | Reference to the UMG Text Block widget where the output text will be displayed. |
| Words Per Sec | Integer | Input | Defines the speed of the effect in words per second. |
| Enable Punctuation Delay | Boolean | Input | If checked, extra delay is applied after punctuation marks. |
| Puntuations | Enumeration (Array) | Input | Customizable list of punctuation marks and their associated delay times. |
| Type Sound | Audio Asset | Input | The sound played for each typed word (if enabled). |
C. Flow Control and Status Outputs
Both nodes share common execution input pins for dynamic control during the typing process:
| Input Pin | Purpose |
|---|---|
| Pause | Stops the animation at the current position. |
| Continue | Resumes the animation from the paused position. |
| Restart | Resets the animation and begins typing the text from the start. |
| Skip | Immediately completes the typing animation, displaying the full text. |
| Stop | Halts the animation and resets all internal state. |