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).

LineCancellationToken

A Line Cancellation Token stores information about whether a dialogue presenter should stop its delivery.
public struct LineCancellationToken

Inherits from System.ValueType

Main use of this is for Dialogue presenters where they receive a Line Cancellation Tokens as a parameter to RunLineAsync(LocalizedLine,LineCancellationToken). Line Cancellation Tokens indicate whether the user has requested that the line's delivery should be hurried up, and whether the dialogue presenter should stop showing the current line.

While the main use of this type is for controlling lines (which have a generally agreed upon understanding or hurrying up and skipping) this type is provided as the cancellation mechanism for many different events on the DialoguePresenterBase.

#Fields

#HurryUpToken

A System.Threading.CancellationToken that becomes cancelled when a DialogueRunner wishes all dialogue presenters to speed up their delivery of their content, if appropriate. For example, UI animations should be played faster or skipped.
public CancellationToken HurryUpToken;

Type CancellationToken

This token is linked to NextContentToken: if the next content token is cancelled, then this token will become cancelled as well.

#NextContentToken

A System.Threading.CancellationToken that becomes cancelled when a DialogueRunner wishes all dialogue presenters to stop running the current content. For example, on-screen UI should be dismissed, and any ongoing audio playback should be stopped.
public CancellationToken NextContentToken;

Type CancellationToken

#Properties

#IsHurryUpRequested

Gets a value indicating whether the user has requested that the content be hurried up.
public readonly bool IsHurryUpRequested { get }

Type Boolean

If this value is true, Dialogue presenters should speed up any ongoing delivery of the content, such as on-screen animations, but are not required to finish delivering the line entirely (that is, UI elements may remain on screen)

If IsNextContentRequested is true, then this property will also be true.

#IsNextContentRequested

Gets a value indicating whether the dialogue runner has requested that the next content be shown.
public readonly bool IsNextContentRequested { get }

Type Boolean

If this value is true, dialogue presenters should skip presenting the current content, so that the next piece of content can be shown to the user.

If this property is true, then IsHurryUpRequested will also be true.

Generated from Yarn Spinner for Unity 3.3.