Pardon our dust! Docs for Yarn Spinner for Unity 3.2 and Yarn Spinner for Godot C# are on docs.yarnspinner.dev (the old docs site). Docs for Yarn Spinner for Unity 3.3 (pre-release, out ASAP), Yarn Spinner for Godot GDScript and Yarn Spinner for Unreal Engine (work in progress) are on /docs/ (the new docs site).

PauseEventProcessor

Allows pausing the current typewriter through [pause/] markers.
public sealed class PauseEventProcessor : IActionMarkupHandler

Inherits from System.Object

Implements Yarn.Unity.IActionMarkupHandler

#Methods

#OnCharacterWillAppear(int, MarkupParseResult, CancellationToken)

public async YarnTask OnCharacterWillAppear(int currentCharacterIndex, MarkupParseResult line, CancellationToken cancellationToken)

Parameters

Returns YarnTask

#OnLineDisplayBegin(MarkupParseResult, TMP_Text)

public void OnLineDisplayBegin(MarkupParseResult line, TMP_Text text)

Parameters

#OnLineDisplayComplete()

public void OnLineDisplayComplete()

#OnLineWillDismiss()

Called right before the line will dismiss itself.
public void OnLineWillDismiss()
This does not mean that the entirety of the view itself will have been removed, just the DialoguePresenterBase has completed displaying everything and is returning control back to the DialogueRunner to let more content flow.

#OnPrepareForLine(MarkupParseResult, TMP_Text)

Called when the line view receives the line, to prepare for showing the line.
public void OnPrepareForLine(MarkupParseResult line, TMP_Text text)

Parameters

  • The line being presented.
  • textTMP_Text
    A TMP_Text object that the line is being displayed in.
This method is called before any part of the line is visible, and is an opportunity to set up any part of the ActionMarkupHandler's display before the user can see it.

Generated from Yarn Spinner for Unity 3.3.