Split up main processing and get main translation support working

Author: jonnydgreen

addons/parley/components/default_balloon.gd

@@ -40,18 +40,12 @@ func start(p_ctx: ParleyContext, p_dialogue_sequence_ast: ParleyDialogueSequence
 	is_waiting_for_input = false
 	ctx = p_ctx
 	dialogue_sequence_ast = p_dialogue_sequence_ast
-	if p_start_node is ParleyDialogueNodeAst or p_start_node is ParleyDialogueOptionNodeAst:
-		current_node_asts = [p_start_node]
-	elif p_start_node:
-		var run_result: ParleyRunResult = await ParleyDialogueSequenceAst.run(ctx, dialogue_sequence_ast, p_start_node)
-		current_node_asts = run_result.node_asts
-		dialogue_sequence_ast = run_result.dialogue_sequence
-		run_result.free() # Needed to ensure that everything is correctly freed up at exit
-	else:
-		var run_result: ParleyRunResult = await ParleyDialogueSequenceAst.run(ctx, dialogue_sequence_ast)
-		current_node_asts = run_result.node_asts
-		dialogue_sequence_ast = run_result.dialogue_sequence
-		run_result.free() # Needed to ensure that everything is correctly freed up at exit
+	# TODO: remove
+	ctx.start_of_run = true
+	var run_result: ParleyRunResult = await ParleyDialogueSequenceAst.run(ctx, dialogue_sequence_ast, p_start_node if p_start_node else null)
+	current_node_asts = run_result.node_asts
+	dialogue_sequence_ast = run_result.dialogue_sequence
+	run_result.free() # Needed to ensure that everything is correctly freed up at exit
 
 
 ## Process the next Nodes
@@ -83,31 +77,6 @@ func _set_current_node_asts(p_current_node_asts: Array[ParleyNodeAst]) -> void:
 		await ready
 
 	balloon.show()
-	# TODO: remove
-	# current_node_asts = []
-	# for node_ast: ParleyNodeAst in p_current_node_asts:
-	# 	# TODO: add a resolve method to each node
-	# 	var resolved_node_ast: ParleyNodeAst
-	# 	if node_ast is ParleyDialogueNodeAst:
-	# 		var dialogue_node_ast: ParleyDialogueNodeAst = node_ast
-	# 		var resolved_text: String = dialogue_sequence_ast.resolve_value(ctx, dialogue_node_ast.text, true, dialogue_node_ast, 'text')
-	# 		resolved_node_ast = ParleyDialogueNodeAst.new(
-	# 			dialogue_node_ast.id,
-	# 			dialogue_node_ast.position,
-	# 			dialogue_node_ast.character,
-	# 			resolved_text,
-	# 		)
-	# 	elif node_ast is ParleyDialogueOptionNodeAst:
-	# 		var dialogue_option_node_ast: ParleyDialogueOptionNodeAst = node_ast
-	# 		var resolved_text: String = dialogue_sequence_ast.resolve_value(ctx, dialogue_option_node_ast.text, true, dialogue_option_node_ast, 'text')
-	# 		resolved_node_ast = ParleyDialogueOptionNodeAst.new(
-	# 			dialogue_option_node_ast.id,
-	# 			dialogue_option_node_ast.position,
-	# 			dialogue_option_node_ast.character,
-	# 			resolved_text,
-	# 		)
-	# 	if resolved_node_ast:
-	# 		current_node_asts.append(resolved_node_ast)
 	current_node_asts = p_current_node_asts
 	var current_children: Array[Node] = balloon_container.get_children()
 	var first_node: ParleyNodeAst = current_node_asts.front()

addons/parley/constants.gd

@@ -2,50 +2,58 @@
 
 @tool
 
+
 #region General
 # TODO: figure out better way of getting this version as it is duplicated
-const VERSION: String = "2.1.0"
-const AST_VERSION: String = "1.1.0"
-const USER_CONFIG_PATH: String = "user://parley_user_config.json"
+const VERSION: StringName = &"2.1.0"
+const AST_VERSION: StringName = &"1.1.0"
+const USER_CONFIG_PATH: StringName = &"user://parley_user_config.json"
 #endregion
 
+
 #region Parley Plugin
-const PLUGIN_NAME: String = "Parley"
-const PARLEY_PLUGIN_METADATA: String = "ParleyPlugin"
-const PARLEY_RUNTIME_AUTOLOAD: String = "Parley"
-const PARLEY_MANAGER_SINGLETON: String = "ParleyManager"
-const PARLEY_RUNTIME_SINGLETON: String = "ParleyRuntime"
+const PLUGIN_NAME: StringName = &"Parley"
+const PARLEY_PLUGIN_METADATA: StringName = &"ParleyPlugin"
+const PARLEY_RUNTIME_AUTOLOAD: StringName = &"Parley"
+const PARLEY_MANAGER_SINGLETON: StringName = &"ParleyManager"
+const PARLEY_RUNTIME_SINGLETON: StringName = &"ParleyRuntime"
 #endregion
 
+
 #region Editor
 # User settings
-const EDITOR_CURRENT_DIALOGUE_SEQUENCE_PATH: String = "parley/editor/current_dialogue_sequence_path"
+const EDITOR_CURRENT_DIALOGUE_SEQUENCE_PATH: StringName = &"parley/editor/current_dialogue_sequence_path"
 #endregion
 
+
 #region Dialogue
 # Project settings
-const DIALOGUE_BALLOON_PATH: String = "parley/dialogue/dialogue_balloon_path"
+const DIALOGUE_BALLOON_PATH: StringName = &"parley/dialogue/dialogue_balloon_path"
 #endregion
 
+
 #region Internationalisation
 # Project settings
-const TRANSLATION_MODE: String = "parley/translations/mode"
-const TRANSLATIONS_POT_FILES: String = "internationalization/locale/translations_pot_files"
+const TRANSLATION_MODE: StringName = &"parley/translations/mode"
+const TRANSLATION_FILES: StringName = &"internationalization/locale/translations"
+const TRANSLATIONS_POT_FILES: StringName = &"internationalization/locale/translations_pot_files"
 #endregion
 
+
 #region Stores
 # Project settings
-const ACTION_STORE_PATH: String = "parley/stores/action_store_path"
-const CHARACTER_STORE_PATH: String = "parley/stores/character_store_path"
-const FACT_STORE_PATH: String = "parley/stores/fact_store_path"
+const ACTION_STORE_PATH: StringName = &"parley/stores/action_store_path"
+const CHARACTER_STORE_PATH: StringName = &"parley/stores/character_store_path"
+const FACT_STORE_PATH: StringName = &"parley/stores/fact_store_path"
 #endregion
 
+
 #region Test Dialogue Sequence
 # Project settings
-const TEST_DIALOGUE_SEQUENCE_TEST_SCENE_PATH: String = "parley/test_dialogue_sequence/test_scene_path"
+const TEST_DIALOGUE_SEQUENCE_TEST_SCENE_PATH: StringName = &"parley/test_dialogue_sequence/test_scene_path"
 # User settings
-const TEST_DIALOGUE_SEQUENCE_IS_RUNNING_DIALOGUE_TEST: String = "parley/test_dialogue_sequence/is_running_test_scene"
-const TEST_DIALOGUE_SEQUENCE_DIALOGUE_AST_RESOURCE_PATH: String = "parley/test_dialogue_sequence/dialogue_ast_resource_path"
-const TEST_DIALOGUE_SEQUENCE_FROM_START: String = "parley/test_dialogue_sequence/from_start"
-const TEST_DIALOGUE_SEQUENCE_START_NODE_ID: String = "parley/test_dialogue_sequence/start_node_id"
+const TEST_DIALOGUE_SEQUENCE_IS_RUNNING_DIALOGUE_TEST: StringName = &"parley/test_dialogue_sequence/is_running_test_scene"
+const TEST_DIALOGUE_SEQUENCE_DIALOGUE_AST_RESOURCE_PATH: StringName = &"parley/test_dialogue_sequence/dialogue_ast_resource_path"
+const TEST_DIALOGUE_SEQUENCE_FROM_START: StringName = &"parley/test_dialogue_sequence/from_start"
+const TEST_DIALOGUE_SEQUENCE_START_NODE_ID: StringName = &"parley/test_dialogue_sequence/start_node_id"
 #endregion

addons/parley/translations/tooltip_translations.csv renamed to addons/parley/locale/tooltip_translations.csv

@@ -0,0 +1,17 @@
+[remap]
+
+importer="csv_translation"
+type="Translation"
+uid="uid://wc2udkydnpmq"
+
+[deps]
+
+files=["res://addons/parley/locale/tooltip_translations.en.translation"]
+
+source_file="res://addons/parley/locale/tooltip_translations.csv"
+dest_files=["res://addons/parley/locale/tooltip_translations.en.translation"]
+
+[params]
+
+compress=true
+delimiter=0

addons/parley/locale/tooltip_translations.csv.import

@@ -278,7 +278,7 @@ func _on_graph_view_node_deselected(_node: Node) -> void:
 
 #region BUTTONS
 func _on_open_dialog_file_selected(path: String) -> void:
-	dialogue_ast = load(path)
+	dialogue_ast = ResourceLoader.load(path, 'ParleyDialogueSequenceAst')
 	# TODO: emit as a signal and handle in the plugin
 	if parley_manager:
 		parley_manager.set_current_dialogue_sequence(path)
@@ -549,7 +549,7 @@ func _on_jump_node_editor_action_node_changed(id: String, dialogue_sequence_ast_
 	# Graph View
 	# TODO: move into Graph View
 	var jump_node: ParleyJumpNode = parley_graph_node_variant
-	jump_node.dialogue_sequence_ast = load(jump_node_ast.dialogue_sequence_ast_ref) if ResourceLoader.exists(jump_node_ast.dialogue_sequence_ast_ref) else ParleyDialogueSequenceAst.new()
+	jump_node.dialogue_sequence_ast = ResourceLoader.load(jump_node_ast.dialogue_sequence_ast_ref, 'ParleyDialogueSequenceAst') if ResourceLoader.exists(jump_node_ast.dialogue_sequence_ast_ref) else ParleyDialogueSequenceAst.new()
 
 
 func _on_group_node_editor_group_node_changed(id: String, group_name: String, colour: Color) -> void:

addons/parley/main_panel.gd

@@ -14,6 +14,11 @@ class_name ParleyDialogueNodeAst extends ParleyNodeAst
 @export_multiline var text: String
 
 
+## The translation id for the text field of the Dialogue Node AST.
+## Example: "world_dialect__I_need_some_coffee"
+@export var text_translation_key: String
+
+
 ## Create a new instance of a Dialogue Node AST.
 ## Example: ParleyDialogueNodeAst.new("1", Vector2.ZERO, "Alice", "I need some coffee.")
 func _init(

addons/parley/models/dialogue_node_ast.gd

@@ -14,6 +14,11 @@ class_name ParleyDialogueOptionNodeAst extends ParleyNodeAst
 @export var text: String
 
 
+## The translation id for the text field of the Dialogue Node AST.
+## Example: "world_dialect__I_need_some_coffee"
+@export var text_translation_key: String
+
+
 ## Create a new instance of a Dialogue Option Node AST.
 ## Example: ParleyDialogueOptionNodeAst.new("1", Vector2.ZERO, "Alice", "Slurp some coffee.")
 func _init(