# LineCancellationToken

Struct in [Yarn.Unity](https://docs.yarnspinner.dev/api/csharp/yarn.unity)

Inherits from `System.ValueType`

## Summary

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

```csharp
public struct LineCancellationToken
```

## Remarks

Dialogue presenters receive Line Cancellation Tokens as a parameter to [RunLineAsync(LocalizedLine,LineCancellationToken)](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.dialoguepresenterbase/yarn.unity.dialoguepresenterbase.runlineasync). 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.

## Fields

| Name                                                                                                                                                      | Description                                                                                                                                                                                                                                                                                                                 |
| --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [HurryUpToken](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.linecancellationtoken/yarn.unity.linecancellationtoken.hurryuptoken)         | A `System.Threading.CancellationToken` that becomes cancelled when a [DialogueRunner](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.dialoguerunner) wishes all dialogue presenters to speed up their delivery of their line, if appropriate. For example, UI animations should be played faster or skipped. |
| [NextContentToken](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.linecancellationtoken/yarn.unity.linecancellationtoken.nextcontenttoken) |                                                                                                                                                                                                                                                                                                                             |

## Properties

| Name                                                                                                                                                                  | Description                                                                                                                                                                                                                                                                                                                           |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [IsHurryUpRequested](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.linecancellationtoken/yarn.unity.linecancellationtoken.ishurryuprequested)         | Gets a value indicating whether the user has requested that the line be hurried up.                                                                                                                                                                                                                                                   |
| [IsNextContentRequested](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.linecancellationtoken/yarn.unity.linecancellationtoken.isnextcontentrequested) |                                                                                                                                                                                                                                                                                                                                       |
| [IsNextLineRequested](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.linecancellationtoken/yarn.unity.linecancellationtoken.isnextlinerequested)       | Gets a value indicating whether the dialogue runner has requested that the next line be shown.                                                                                                                                                                                                                                        |
| [NextLineToken](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.linecancellationtoken/yarn.unity.linecancellationtoken.nextlinetoken)                   | A `System.Threading.CancellationToken` that becomes cancelled when a [DialogueRunner](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.dialoguerunner) wishes all dialogue presenters to stop running the current line. For example, on-screen UI should be dismissed, and any ongoing audio playback should be stopped. |