Field in LineCancellationToken
A System.Threading.CancellationToken that becomes cancelled when a DialogueRunner wishes all dialogue views to stop running the current line. For example, on-screen UI should be dismissed, and any ongoing audio playback should be stopped.
Property in LineCancellationToken
Gets a value indicating whether the user has requested that the line be hurried up.
If this value is true, dialogue views should speed up any ongoing delivery of the line, such as on-screen animations, but are not required to finish delivering the line entirely (that is, UI elements may remain on screen).
If IsNextLineRequested is true, then this property will also be true.
Field in LineCancellationToken
A System.Threading.CancellationToken that becomes cancelled when a DialogueRunner wishes all dialogue views to speed up their delivery of their line, if appropriate. For example, UI animations should be played faster or skipped.
This token is linked to NextLineToken : if the next line token is cancelled, then this token will become cancelled as well.
Struct in Yarn.Unity
Inherits from System.ValueType
A Line Cancellation Token stores information about whether a dialogue view should stop its delivery.
Dialogue views receive 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 view should stop showing the current line.
A System.Threading.CancellationToken that becomes cancelled when a wishes all dialogue views to speed up their delivery of their line, if appropriate. For example, UI animations should be played faster or skipped.
A System.Threading.CancellationToken that becomes cancelled when a wishes all dialogue views to stop running the current line. For example, on-screen UI should be dismissed, and any ongoing audio playback should be stopped.
Gets a value indicating whether the user has requested that the line be hurried up.
Gets a value indicating whether the dialogue runner has requested that the next line be shown.
Property in
Gets a value indicating whether the dialogue runner has requested that the next line be shown.
If this value is true, dialogue views should presenting the current line, so that the next piece of content can be shown to the user.
If this property is true, then will also be true.