YarnDialogueView
complete dialogue view combining line and options presenters. provides a ready-to-use dialogue ui with no additional setup.
class_name YarnDialogueView
extends CanvasLayerInherits from CanvasLayer
The visuals come from ui_scene (dialogue_view_ui.tscn by default) open that scene in the editor to restyle the panel, fonts and colours, or point ui_scene at your own scene. A custom scene must contain these scene-unique-named nodes:
%Panel, %CharacterContainer, %CharacterLabel, %TextLabel, %ContinueIndicator and %OptionsContainer.#Properties
#auto_start
Starts dialogue as soon as the view is ready. Ignored when the runner's own Auto Start is enabled (the runner starts itself; enabling both would race). Prefer configuring auto start on the runner.
var auto_start: bool = falseType bool
#dialogue_runner
The runner this view presents for. Found automatically among ancestors when left unset.
var dialogue_runner: YarnDialogueRunnerType YarnDialogueRunner
#line_presenter
var line_presenter: YarnLinePresenterType YarnLinePresenter
#options_presenter
var options_presenter: YarnOptionsPresenterType YarnOptionsPresenter
#start_node
Node used when THIS VIEW starts dialogue (via start_dialogue or auto_start). Leave empty to use the runner's own Start Node set it here only to override the runner.
var start_node: String = ""Type String
#ui_scene
The scene providing this view's visuals. Swap it to reskin the dialogue.
var ui_scene: PackedScene = <Object>Type PackedScene
#Methods
#start_dialogue(String)
func start_dialogue(node_name: String = "") -> voidParameters
node_nameString
#stop_dialogue()
func stop_dialogue() -> voidGenerated from Yarn Spinner for Godot GDScript 3.3.