All pages
Powered by GitBook
1 of 7

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Reset()

Method in

public void Reset()

Summary

OptionsListView

RunLine(LocalizedLine,Action)

Method in OptionsListView

Summary

public override void RunLine(LocalizedLine dialogueLine, Action onDialogueLineFinished)

Parameters

Name
Description

dialogueLine

System.Action onDialogueLineFinished

Yarn.Unity.LocalizedLine

DialogueComplete()

Method in

Called by the to signal that the dialogue has ended, and no more lines will be delivered.

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

If is called, this method is how your custom views are informed of this. This allows you to skip over the normal flow of dialogue, so please use this method to clean up your views.

public override void DialogueComplete()

Summary

Remarks

The default implementation of this method does nothing.

OptionsListView
DialogueRunner
Stop()

OptionsListView

Class in Yarn.Unity

Inherits from DialogueViewBase

Summary

public class OptionsListView : DialogueViewBase

Methods

Name
Description

Called by the to signal that the dialogue has ended, and no more lines will be delivered.

DialogueComplete()
DialogueRunner
OnEnable()
Reset()
RunLine(LocalizedLine,Action)
RunOptions(DialogueOption[],Action)
Start()

RunOptions(DialogueOption[],Action<int>)

Method in OptionsListView

Summary

public override void RunOptions(DialogueOption[] dialogueOptions, Action<int> onOptionSelected)

Parameters

Name
Description

dialogueOptions

System.Action<int> onOptionSelected

Yarn.Unity.DialogueOption[]

OnEnable()

Method in

public void OnEnable()

Summary

OptionsListView

Start()

Method in

public void Start()

Summary

OptionsListView