YarnDialogueRunner
class_name YarnDialogueRunner
extends NodeInherits from Node
#Nested Types
- SaliencyStrategyType enum
#Constants
#MAX_CONTINUES_PER_FRAME
const MAX_CONTINUES_PER_FRAME = 100#STALL_WARNING_SECONDS
const STALL_WARNING_SECONDS = 5.0#Properties
#allow_option_fallthrough
var allow_option_fallthrough: bool = trueType bool
#auto_discover_commands
var auto_discover_commands: bool = trueType bool
#auto_start
var auto_start: bool = falseType bool
#discovery_root
var discovery_root: NodePath = NodePath("")Type NodePath
#line_provider
var line_provider: YarnLineProviderType YarnLineProvider
#option_timeout
var option_timeout: float = 0.0Type float
#presenters
var presenters: Array[YarnDialoguePresenter] = []#saliency_strategy
var saliency_strategy: int = 0Type int
#show_selected_option_as_line
var show_selected_option_as_line: bool = falseType bool
#start_node
var start_node: String = "Start"Type String
#translation_prefix
var translation_prefix: String = "YARN_"Type String
#variable_storage
var variable_storage: YarnVariableStorageType YarnVariableStorage
#verbose_logging
var verbose_logging: bool = falseType bool
#yarn_project
var yarn_project: YarnProjectResourceType YarnProjectResource
#ysls_scan_path
var ysls_scan_path: String = ""Type String
#Signals
#command_received
signal command_received(command_name: String, command_args: Array)Parameters
command_nameStringcommand_argsArray
#command_unhandled
signal command_unhandled(command_text: String)Parameters
command_textString
#dialogue_cancelled
signal dialogue_cancelled()#dialogue_completed
signal dialogue_completed()#dialogue_started
signal dialogue_started()#node_completed
signal node_completed(node_name: String)Parameters
node_nameString
#node_started
signal node_started(node_name: String)Parameters
node_nameString
#Methods
#add_command_target(String, Node)
func add_command_target(target_name: String, target: Node) -> voidParameters
target_nameStringtargetNode
#add_command(String, Callable)
func add_command(command_name: String, callable: Callable) -> voidParameters
command_nameStringcallableCallable
#add_function(String, Callable, int)
func add_function(func_name: String, callable: Callable, param_count: int = -1) -> voidParameters
func_nameStringcallableCallableparam_countint
#add_presenter(YarnDialoguePresenter)
func add_presenter(presenter: YarnDialoguePresenter) -> voidParameters
presenterYarnDialoguePresenter
#add_strings_to_translation_server(String)
func add_strings_to_translation_server(locale_code: String) -> voidParameters
locale_codeString
#are_options_active()
func are_options_active() -> boolReturns bool
#export_for_godot_translation(String)
func export_for_godot_translation(output_path: String) -> intParameters
output_pathString
Returns int
#find_runner(Node)
static func find_runner(node: Node) -> YarnDialogueRunnerParameters
nodeNode
Returns YarnDialogueRunner
#get_all_headers(String)
func get_all_headers(node_name: String) -> Array[Dictionary]Parameters
node_nameString
Returns Array[Dictionary]
#get_all_node_names()
func get_all_node_names() -> PackedStringArrayReturns PackedStringArray
#get_asset_provider()
func get_asset_provider() -> YarnAssetProviderReturns YarnAssetProvider
#get_available_locales()
func get_available_locales() -> PackedStringArrayReturns PackedStringArray
#get_cancellation_token()
func get_cancellation_token() -> YarnCancellationTokenReturns YarnCancellationToken
#get_content_frame()
func get_content_frame() -> intReturns int
#get_current_line_as_dict()
func get_current_line_as_dict() -> DictionaryReturns Dictionary
#get_current_node_name()
func get_current_node_name() -> StringReturns String
#get_current_options_as_array()
func get_current_options_as_array() -> ArrayReturns Array
#get_header_value(String, String)
func get_header_value(node_name: String, header_name: String) -> StringParameters
node_nameStringheader_nameString
Returns String
#get_headers(String)
func get_headers(node_name: String) -> DictionaryParameters
node_nameString
Returns Dictionary
#get_library()
func get_library() -> YarnLibraryReturns YarnLibrary
#get_line_provider()
func get_line_provider() -> YarnLineProviderReturns YarnLineProvider
#get_locale()
func get_locale() -> StringReturns String
#get_localisation_debug_info()
func get_localisation_debug_info() -> StringReturns String
#get_localised_audio(String)
func get_localised_audio(line_id: String) -> AudioStreamParameters
line_idString
Returns AudioStream
#get_presenters()
func get_presenters() -> Array[YarnDialoguePresenter]Returns Array[YarnDialoguePresenter]
#get_saliency_options_for_node_group(String)
func get_saliency_options_for_node_group(node_group_name: String) -> ArrayParameters
node_group_nameString
Returns Array
#get_smart_variable_evaluator()
func get_smart_variable_evaluator() -> YarnSmartVariableEvaluatorReturns YarnSmartVariableEvaluator
#get_string_id_for_node(String)
func get_string_id_for_node(node_name: String) -> StringParameters
node_nameString
Returns String
#get_variable_storage()
func get_variable_storage() -> YarnVariableStorageReturns YarnVariableStorage
#get_visit_count(String)
func get_visit_count(node_name: String) -> intParameters
node_nameString
Returns int
#has_header(String, String)
func has_header(node_name: String, header_name: String) -> boolParameters
node_nameStringheader_nameString
Returns bool
#has_line_advancer()
func has_line_advancer() -> boolReturns bool
#has_locale(String)
func has_locale(locale_code: String) -> boolParameters
locale_codeString
Returns bool
#has_localised_audio(String)
func has_localised_audio(line_id: String) -> boolParameters
line_idString
Returns bool
#has_salient_content(String)
func has_salient_content(node_group_name: String) -> boolParameters
node_group_nameString
Returns bool
#has_visited_node(String)
func has_visited_node(node_name: String) -> boolParameters
node_nameString
Returns bool
#has_yarn_node(String)
func has_yarn_node(node_name: String) -> boolParameters
node_nameString
Returns bool
#is_node_group(String)
func is_node_group(node_name: String) -> boolParameters
node_nameString
Returns bool
#is_presenting_line()
func is_presenting_line() -> boolReturns bool
#is_running()
func is_running() -> boolReturns bool
#load_state_from_persistent_storage(String)
func load_state_from_persistent_storage(save_file_name: String) -> boolParameters
save_file_nameString
Returns bool
#regenerate_ysls()
func regenerate_ysls() -> void#register_line_advancer(Node)
func register_line_advancer(advancer: Node) -> voidParameters
advancerNode
#remove_command_target(String)
func remove_command_target(target_name: String) -> voidParameters
target_nameString
#remove_command(String)
func remove_command(command_name: String) -> voidParameters
command_nameString
#remove_function(String)
func remove_function(func_name: String) -> voidParameters
func_nameString
#remove_presenter(YarnDialoguePresenter)
func remove_presenter(presenter: YarnDialoguePresenter) -> voidParameters
presenterYarnDialoguePresenter
#request_hurry_up_option()
func request_hurry_up_option() -> void#request_hurry_up()
func request_hurry_up() -> void#request_line_cancellation(YarnLine)
func request_line_cancellation(_line: YarnLine) -> voidParameters
_lineYarnLine
#request_next_content()
func request_next_content() -> void#request_next_line()
func request_next_line() -> void#reset_visit_tracking()
func reset_visit_tracking() -> void#save_state_to_persistent_storage(String)
func save_state_to_persistent_storage(save_file_name: String) -> boolParameters
save_file_nameString
Returns bool
#select_option(int)
func select_option(option_index: int) -> voidParameters
option_indexint
#set_audio_base_path(String)
func set_audio_base_path(path: String) -> voidParameters
pathString
#set_content_saliency_strategy(YarnSaliencyStrategy)
func set_content_saliency_strategy(strategy: YarnSaliencyStrategy) -> voidParameters
strategyYarnSaliencyStrategy
#set_locale(String)
func set_locale(locale_code: String) -> voidParameters
locale_codeString
#set_project(YarnProjectResource)
func set_project(project: YarnProjectResource) -> voidParameters
projectYarnProjectResource
#signal_content_complete()
func signal_content_complete() -> void#start_dialogue(String)
func start_dialogue(node_name: String = "") -> voidParameters
node_nameString
#stop_dialogue()
func stop_dialogue() -> void#unregister_line_advancer(Node)
func unregister_line_advancer(advancer: Node) -> voidParameters
advancerNode
Generated from Yarn Spinner for Godot GDScript 3.3.