ActionMarkupHandler
public abstract class ActionMarkupHandler : MonoBehaviour, IActionMarkupHandlerInherits from MonoBehaviour
Implements Yarn.Unity.IActionMarkupHandler
Intended to be used in situations where you require a monobehaviour version of the interfaces. This is used by LinePresenter to have a list of handlers that can be connected up via the inspector.
#Methods
#OnCharacterWillAppear(int, MarkupParseResult, CancellationToken)
public abstract YarnTask OnCharacterWillAppear(int currentCharacterIndex, MarkupParseResult line, CancellationToken cancellationToken);Parameters
currentCharacterIndexintThe zero-based index of the character being displayed.text(unknown)ATMP_Textobject that the line is being displayed in.cancellationTokenCancellationTokenA cancellation token representing whether the
Returns YarnTask: A task that completes when the ActionMarkupHandler has completed presenting this
character. Dialogue presenters will wait until this task is complete
before displaying the remainder of the line.
#OnLineDisplayBegin(MarkupParseResult, TMP_Text)
public abstract void OnLineDisplayBegin(MarkupParseResult line, TMP_Text text);Parameters
- The line being presented.
textTMP_TextATMP_Textobject that the line is being displayed in.
#OnLineDisplayComplete()
PresentCharacter(int, TMP_Text, CancellationToken).public abstract void OnLineDisplayComplete();#OnLineWillDismiss()
public abstract void OnLineWillDismiss();#OnPrepareForLine(MarkupParseResult, TMP_Text)
public abstract void OnPrepareForLine(MarkupParseResult line, TMP_Text text);Parameters
- The line being presented.
textTMP_TextATMP_Textobject that the line is being displayed in.
Generated from Yarn Spinner for Unity 3.3.