LinePresenter
public sealed class LinePresenter : DialoguePresenterBaseInherits from Yarn.Unity.DialoguePresenterBase
#Fields
#autoAdvance
public bool autoAdvance = false;Type Boolean
If this value is true, the Line View will
The DialogueRunner will not proceed to the next piece of content (e.g. the next line, or the next options) until all Dialogue Presenters have reported that they have finished presenting their lines. If a LinePresenter doesn't report that it's finished until it receives input, the DialogueRunner will end up pausing.
This is useful for games in which you want the player to be able to read lines of dialogue at their own pace, and give them control over when to advance to the next line.
#autoAdvanceDelay
public float autoAdvanceDelay = 1f;Type Single
true.#canvasGroup
public CanvasGroup? canvasGroup;Type Nullable
CanvasGroup will be animated during line presentation
and dismissal.See also
#characterNameContainer
public GameObject? characterNameContainer = null;Type Nullable
#characterNameText
TMP_Text object that displays the character
names found in dialogue lines.public TMP_Text? characterNameText = null;Type Nullable
#customTypewriter
public InterfaceContainer<IAsyncTypewriter>? customTypewriter;Type InterfaceContainer
InterfaceContainer class to provide a wrapper around an interface, otherwise all typewriters would need to be monobehaviours#fadeDownDuration
public float fadeDownDuration = 0.1f;Type Single
true.See also
#fadeUpDuration
public float fadeUpDuration = 0.25f;Type Single
true.See also
#lettersPerSecond
public int lettersPerSecond = 60;Type Int32
#lineText
TMP_Text object that displays the text of
dialogue lines.public TMP_Text? lineText;Type Nullable
#showCharacterNameInLine
public bool showCharacterNameInLine = true;Type Boolean
This value is only used if characterNameText is null.
If this value is true, any character names
present in a line will be shown in the lineText
object.
If this value is false, character names will
not be shown in the lineText object.
#useFadeEffect
public bool useFadeEffect = true;Type Boolean
If this value is true, the canvasGroup object's alpha property will animate from 0 to
1 over the course of fadeUpDuration seconds when lines
appear, and animate from 1 to zero over the course of fadeDownDuration seconds when lines disappear.
If this value is false, the canvasGroup object will appear instantaneously.
See also
#wordsPerSecond
public int wordsPerSecond = 10;Type Int32
#Methods
#OnDialogueCompleteAsync(CancellationToken)
public override YarnTask OnDialogueCompleteAsync(CancellationToken token)Parameters
tokenCancellationTokenThe cancellation token for this task, if cancelled this method should finish as soon as possible.
Returns YarnTask: A task that represents any work done by this dialogue presenter in order to clean up after running dialogue.
This method is called after the last piece of content (that is, lines, options or commands) finished running.
This method is a good place to perform tasks like dismissing on-screen dialogue UI (for example, turning off a letterboxing effect, or hiding dialogue UI elements.)
The default implementation of this method does nothing.
#OnDialogueStartedAsync(CancellationToken)
public override YarnTask OnDialogueStartedAsync(CancellationToken token)Parameters
tokenCancellationTokenThe cancellation token for this task, if cancelled this method should finish as soon as possible.
Returns YarnTask: A task that represents any work done by this dialogue presenter in order to get ready for dialogue to run.
This method is called before any content (that is, lines, options or commands) are delivered.
This method is a good place to perform tasks like preparing on-screen dialogue UI (for example, turning on a letterboxing effect, or making dialogue UI elements visible.)
The default implementation of this method does nothing.
#RunLineAsync(LocalizedLine, LineCancellationToken)
public override async YarnTask RunLineAsync(LocalizedLine line, LineCancellationToken token)Parameters
- The line to present.
- A LineCancellationToken that represents whether the dialogue presenter should hurry it its presentation of the line, or stop showing the current line.
Returns YarnTask: A task that completes when the dialogue presenter has finished showing the line to the user.
Generated from Yarn Spinner for Unity 3.3.