# WordTypewriter

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

Inherits from `System.Object`

## Summary

An implementation of [IAsyncTypewriter](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.iasynctypewriter) that delivers words one at a time, and invokes any [IActionMarkupHandler](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.iactionmarkuphandler) s along the way as needed.

```csharp
public class WordTypewriter : IAsyncTypewriter
```

## Methods

| Name                                                                                                                                                                              | Description                                |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ |
| [ContentDidDismiss()](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.wordtypewriter/yarn.unity.wordtypewriter.contentdiddismiss)                                   |                                            |
| [ContentWillDismiss()](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.wordtypewriter/yarn.unity.wordtypewriter.contentwilldismiss)                                 |                                            |
| [PrepareForContent(Markup.MarkupParseResult)](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.wordtypewriter/yarn.unity.wordtypewriter.prepareforcontent)           |                                            |
| [RunTypewriter(Markup.MarkupParseResult,CancellationToken)](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.wordtypewriter/yarn.unity.wordtypewriter.runtypewriter) | Displays the contents of a line over time. |

## Properties

| Name                                                                                                                                                | Description                                                                                                                                                                                                                                                                                                                                                                                                                        |
| --------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [ActionMarkupHandlers](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.wordtypewriter/yarn.unity.wordtypewriter.actionmarkuphandlers) | A collection of [IActionMarkupHandler](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.iactionmarkuphandler) objects that should be invoked as needed during the typewriter's delivery in [RunTypewriter(Markup.MarkupParseResult,CancellationToken)](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.wordtypewriter/yarn.unity.wordtypewriter.runtypewriter) , depending upon the contents of a line. |
| [TextElement](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.wordtypewriter/yarn.unity.wordtypewriter.textelement)                   | The `TMPro.TMP_Text` to display the text in.                                                                                                                                                                                                                                                                                                                                                                                       |
| [WordsPerSecond](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.wordtypewriter/yarn.unity.wordtypewriter.wordspersecond)             | The number of words per second to deliver.                                                                                                                                                                                                                                                                                                                                                                                         |