IActionMarkupHandler
Interface in Yarn.Unity
Summary
A IActionMarkupHandler is an object that reacts to the delivery of a line of dialogue, and can optionally control the timing of that delivery.
public interface IActionMarkupHandlerRemarks
There are a number of cases where a line's delivery needs to have its timing controlled. For example, PauseEventProcessor adds a small delay between each character, creating a 'typewriter' effect as each letter appears over time.
Another example of a IActionMarkupHandler is an in-line event or animation, such as causing a character to play an animation (and waiting for that animation to complete before displaying the rest of the line).
Methods
| Name | Description |
|---|---|
| OnCharacterWillAppear(int,MarkupParseResult,CancellationToken) | Called repeatedly for each visible character in the line. |
| OnLineDisplayBegin(MarkupParseResult,TMP_Text) | Called immediately before the first character in the line is presented. |
| OnLineDisplayComplete() | Called after the last call to PresentCharacter(int, TMP_Text, CancellationToken) . |
| OnLineWillDismiss() | Called right before the line will dismiss itself. |
| OnPrepareForLine(MarkupParseResult,TMP_Text) | Called when the line view receives the line, to prepare for showing the line. |