Add ability to generate IDs for nodes in a DS

Author: jonnydgreen

addons/parley/constants.gd

@@ -36,8 +36,11 @@ const DIALOGUE_BALLOON_PATH: StringName = &"parley/dialogue/dialogue_balloon_pat
 #region Internationalisation
 # Project settings
 const TRANSLATION_MODE: StringName = &"parley/translations/mode"
+const TRANSLATION_CSV_HEADER_KEY: StringName = &"parley/translations/csv_header_key"
 const TRANSLATION_FILES: StringName = &"internationalization/locale/translations"
 const TRANSLATIONS_POT_FILES: StringName = &"internationalization/locale/translations_pot_files"
+const TRANSLATION_LOCALE_TEST: StringName = &"internationalization/locale/test"
+const TRANSLATION_LOCALE_FALLBACK: StringName = &"internationalization/locale/fallback"
 #endregion
 
 

addons/parley/main_panel.gd

@@ -12,6 +12,7 @@ const new_file_icon: CompressedTexture2D = preload("./assets/New.svg")
 const load_file_icon: CompressedTexture2D = preload("./assets/Load.svg")
 const export_icon: CompressedTexture2D = preload("./assets/Export.svg")
 const import_icon: CompressedTexture2D = preload("./assets/Import.svg")
+const generate_icon: CompressedTexture2D = preload("./assets/Generate.svg")
 const insert_after_icon: CompressedTexture2D = preload("./assets/InsertAfter.svg")
 const dialogue_icon: CompressedTexture2D = preload("./assets/Dialogue.svg")
 const dialogue_option_icon: CompressedTexture2D = preload("./assets/DialogueOption.svg")
@@ -235,27 +236,27 @@ func _setup(on_ready: bool = false) -> void:
 func _setup_file_menu() -> void:
 	var popup: PopupMenu = file_menu.get_popup()
 	popup.clear()
-	popup.add_icon_item(new_file_icon, "New Dialogue Sequence...", 0)
-	popup.add_icon_item(load_file_icon, "Open Dialogue Sequence...", 1)
-	popup.add_separator("Export")
-	popup.add_icon_item(export_icon, "Export to CSV...", 2)
+	popup.add_icon_item(new_file_icon, &"New Dialogue Sequence...", 0)
+	popup.add_icon_item(load_file_icon, &"Open Dialogue Sequence...", 1)
+	popup.add_separator(&"Export")
+	popup.add_icon_item(export_icon, &"Export to CSV...", 2)
 	ParleyUtils.signals.safe_connect(popup.id_pressed, _on_file_id_pressed)
 
 
 ## Set up the insert menu
 func _setup_insert_menu() -> void:
 	var popup: PopupMenu = insert_menu.get_popup()
 	popup.clear()
-	popup.add_separator("Dialogue")
+	popup.add_separator(&"Dialogue")
 	popup.add_icon_item(dialogue_icon, ParleyDialogueSequenceAst.get_type_name(ParleyDialogueSequenceAst.Type.DIALOGUE), ParleyDialogueSequenceAst.Type.DIALOGUE)
 	popup.add_icon_item(dialogue_option_icon, ParleyDialogueSequenceAst.get_type_name(ParleyDialogueSequenceAst.Type.DIALOGUE_OPTION), ParleyDialogueSequenceAst.Type.DIALOGUE_OPTION)
-	popup.add_separator("Conditions")
+	popup.add_separator(&"Conditions")
 	popup.add_icon_item(condition_icon, ParleyDialogueSequenceAst.get_type_name(ParleyDialogueSequenceAst.Type.CONDITION), ParleyDialogueSequenceAst.Type.CONDITION)
 	popup.add_icon_item(condition_icon, ParleyDialogueSequenceAst.get_type_name(ParleyDialogueSequenceAst.Type.MATCH), ParleyDialogueSequenceAst.Type.MATCH)
-	popup.add_separator("Actions")
+	popup.add_separator(&"Actions")
 	popup.add_icon_item(action_icon, ParleyDialogueSequenceAst.get_type_name(ParleyDialogueSequenceAst.Type.ACTION), ParleyDialogueSequenceAst.Type.ACTION)
 	popup.add_icon_item(jump_node_icon, ParleyDialogueSequenceAst.get_type_name(ParleyDialogueSequenceAst.Type.JUMP), ParleyDialogueSequenceAst.Type.JUMP)
-	popup.add_separator("Misc")
+	popup.add_separator(&"Misc")
 	popup.add_icon_item(start_node_icon, ParleyDialogueSequenceAst.get_type_name(ParleyDialogueSequenceAst.Type.START), ParleyDialogueSequenceAst.Type.START)
 	popup.add_icon_item(end_node_icon, ParleyDialogueSequenceAst.get_type_name(ParleyDialogueSequenceAst.Type.END), ParleyDialogueSequenceAst.Type.END)
 	popup.add_icon_item(group_node_icon, ParleyDialogueSequenceAst.get_type_name(ParleyDialogueSequenceAst.Type.GROUP), ParleyDialogueSequenceAst.Type.GROUP)
@@ -266,14 +267,20 @@ func _render_translations_menu() -> void:
 	var popup: PopupMenu = translations_menu.get_popup()
 	popup.clear()
 
-	popup.add_icon_item(export_icon, "Export Dialogue to CSV...", 0)
-	popup.set_item_tooltip(0, "Export Dialogue Text Translations to CSV")
+	popup.add_separator(&"Exports")
+	popup.add_icon_item(export_icon, &"Export Dialogue to CSV...", 0)
+	popup.set_item_tooltip(0, &"Export Dialogue Text Translations to CSV")
 
-	popup.add_icon_item(export_icon, "Export Characters to CSV...", 1)
-	popup.set_item_tooltip(1, "Export Character Translations to CSV")
+	popup.add_icon_item(export_icon, &"Export Characters to CSV...", 1)
+	popup.set_item_tooltip(1, &"Export Character Translations to CSV")
 
-	popup.add_icon_item(import_icon, "Import Dialogue from CSV...", 2)
-	popup.set_item_tooltip(2, "Import Dialogue Text Translations from CSV")
+	popup.add_separator(&"Imports")
+	popup.add_icon_item(import_icon, &"Import Dialogue from CSV...", 2)
+	popup.set_item_tooltip(2, &"Import Dialogue Text Translations from CSV")
+
+	popup.add_separator(&"Generators")
+	popup.add_icon_item(generate_icon, &"Generate Text Translation keys...", 3)
+	popup.set_item_tooltip(3, &"Generate Text Translation keys for Dialogue Sequence Nodes")
 
 	ParleyUtils.signals.safe_connect(popup.id_pressed, _on_translations_menu_id_pressed)
 #endregion
@@ -351,6 +358,20 @@ func _on_translations_menu_id_pressed(id: int) -> void:
 			export_modal.render(ParleyExportModal.ExportType.CharacterNameTranslation, ParleyExportModal.FileType.Csv, dialogue_ast)
 		2:
 			import_modal.render(ParleyImportModal.ImportType.DialogueTextTranslation, ParleyImportModal.FileType.Csv, dialogue_ast)
+		3:
+			if dialogue_ast:
+				var ast_changed: bool = dialogue_ast.generate_text_translation_keys()
+				# TODO: This is currently to make sure that the currently open editor updates when the dialogue sequence updates.
+				# However, to improve future maintainability and better software patterns, we should do this
+				# generically by just noting that the Dialogue Sequence AST has changed and inferring everything from there
+				if ast_changed and selected_node_ast and selected_node_id:
+					node_selected.emit(selected_node_ast)
+				if selected_node_id:
+					var currently_selected_node_id: String = selected_node_id
+					var currently_selected_node_ast: ParleyNodeAst = dialogue_ast.find_node_by_id(currently_selected_node_id)
+					if currently_selected_node_ast:
+						node_selected.emit(currently_selected_node_ast)
+				print_rich(ParleyUtils.log.info_msg("Generated Text Translation Keys for Dialogue Sequence AST: {dialogue_ast}".format({'dialogue_ast': dialogue_ast})))
 		_:
 			print_rich(ParleyUtils.log.info_msg("Unknown option ID pressed: {id}".format({'id': id})))
 
@@ -386,6 +407,7 @@ func _save_dialogue() -> int:
 		EditorInterface.get_resource_filesystem().reimport_files([dialogue_ast.resource_path])
 	return OK
 
+
 func _on_arrange_nodes_button_pressed() -> void:
 	selected_node_id = null
 	await refresh()
@@ -404,6 +426,7 @@ func _on_test_dialogue_from_start_button_pressed() -> void:
 	if parley_manager:
 		parley_manager.run_test_dialogue_from_start(dialogue_ast)
 
+
 func _on_test_dialogue_from_selected_button_pressed() -> void:
 	# TODO: dialogue is technically async so we should ideally wait here
 	var result: int = _save_dialogue()
@@ -802,9 +825,9 @@ func _add_edge(from_node_name: StringName, from_slot: int, to_node_name: StringN
 	if added_edge:
 		graph_view.add_edge(added_edge, from_node_name, to_node_name)
 
-func _is_selected_node(id: String) -> bool:
+func _is_selected_node(id: String, should_log: bool = true) -> bool:
 	var is_selected_node: bool = selected_node_id == id
-	if not is_selected_node:
+	if not is_selected_node and should_log:
 		push_warning(ParleyUtils.log.warn_msg("Node with ID %s is not selected" % id))
 	return is_selected_node
 #endregion

addons/parley/models/dialogue_sequence_ast.gd

@@ -299,6 +299,34 @@ func remove_edges(edges_to_remove: Array[ParleyEdgeAst], emit: bool = true) -> i
 	if removed > 0 and emit:
 		_emit_dialogue_updated()
 	return removed
+
+
+## Generate text translation keys for all nodes
+## in the Dialogue Sequence AST.
+func generate_text_translation_keys() -> bool:
+	var ast_changed: bool = false
+	for node_ast: ParleyNodeAst in nodes:
+		match node_ast.type:
+			ParleyDialogueSequenceAst.Type.DIALOGUE:
+				var dialogue_node_ast: ParleyDialogueNodeAst = node_ast
+				var current_text_translation_key: String = ParleyUtils.translation.get_msg_ctx(dialogue_node_ast, &"text")
+				if not current_text_translation_key and dialogue_node_ast.text:
+					var text_translation_key: String = ParleyUtils.translation.generate_key(dialogue_node_ast.text, self, dialogue_node_ast, &"text")
+					dialogue_node_ast.update(dialogue_node_ast.character, dialogue_node_ast.text, text_translation_key)
+					ast_changed = true
+			ParleyDialogueSequenceAst.Type.DIALOGUE_OPTION:
+				var dialogue_option_node_ast: ParleyDialogueOptionNodeAst = node_ast
+				var current_text_translation_key: String = ParleyUtils.translation.get_msg_ctx(dialogue_option_node_ast, &"text")
+				if not current_text_translation_key and dialogue_option_node_ast.text:
+					var text_translation_key: String = ParleyUtils.translation.generate_key(dialogue_option_node_ast.text, self, dialogue_option_node_ast, &"text")
+					dialogue_option_node_ast.update(dialogue_option_node_ast.character, dialogue_option_node_ast.text, text_translation_key)
+					ast_changed = true
+			_:
+				pass
+	if ast_changed:
+		emit_changed()
+		dialogue_updated.emit(self)
+	return ast_changed
 #endregion
 
 

addons/parley/parley_manager.gd

@@ -248,10 +248,11 @@ func get_test_locale() -> String:
 	test_locale = ParleySettings.get_setting(ParleyConstants.TEST_DEFAULT_LOCALE, "")
 	if test_locale and is_instance_of(test_locale, TYPE_STRING):
 		return test_locale
-	# TODO: constant
-	test_locale = ProjectSettings.get_setting("internationalization/locale/test", "")
+
+	test_locale = ProjectSettings.get_setting(ParleyConstants.TRANSLATION_LOCALE_TEST, "")
 	if test_locale and is_instance_of(test_locale, TYPE_STRING):
 		return test_locale
+
 	return TranslationServer.get_tool_locale()
 
 

addons/parley/settings.gd

@@ -16,6 +16,7 @@ static var DEFAULT_SETTINGS: Dictionary = {
 	ParleyConstants.FACT_STORE_PATH: "res://facts/fact_store.tres",
 	# Internationalisation
 	ParleyConstants.TRANSLATION_MODE: ParleyContext.TranslationMode.keys()[ParleyContext.TranslationMode.PO],
+	ParleyConstants.TRANSLATION_CSV_HEADER_KEY: &"keys",
 	# Test Dialogue Sequence
 	# We can't preload this because of circular deps so let's
 	# hardcode it for now but allow people to edit it in settings
@@ -59,6 +60,11 @@ static var TYPES: Dictionary = {
 		"hint": PROPERTY_HINT_ENUM,
 		"hint_string": ",".join(ParleyContext.TranslationMode.keys())
 	},
+	ParleyConstants.TRANSLATION_CSV_HEADER_KEY: {
+		"name": ParleyConstants.TRANSLATION_CSV_HEADER_KEY,
+		"description": "Defines the translation header key for use in CSV translation files. By default, this is 'keys'.",
+		"type": TYPE_STRING_NAME,
+	},
 	# Testing
 	ParleyConstants.TEST_DIALOGUE_SEQUENCE_TEST_SCENE_PATH: {
 		"name": ParleyConstants.TEST_DIALOGUE_SEQUENCE_TEST_SCENE_PATH,
@@ -70,6 +76,7 @@ static var TYPES: Dictionary = {
 		"name": ParleyConstants.TEST_DEFAULT_LOCALE,
 		"description": "Defines the default locale that will be used when testing Dialogue Sequences.",
 		"type": TYPE_STRING,
+		"hint": PROPERTY_HINT_LOCALE_ID
 	}
 }
 

addons/parley/utils/parley_util.gd

@@ -3,6 +3,8 @@
 @tool
 class_name ParleyUtils
 
+const Constants = preload("res://addons/parley/constants.gd")
+const Settings = preload("res://addons/parley/settings.gd")
 
 class signals:
 	## Connect safely to a signal and handle any errors accordingly
@@ -160,17 +162,19 @@ class translation:
 
 
 	static func get_locale() -> StringName:
-		# TODO: get locale_key from config but for now default to project-then-system locale
-		var locale: StringName = ProjectSettings.get_setting("internationalization/locale/fallback")
+		var locale: StringName = Settings.get_setting(Constants.TEST_DEFAULT_LOCALE)
+		if locale:
+			return locale
+
+		locale = ProjectSettings.get_setting(Constants.TRANSLATION_LOCALE_FALLBACK)
 		if locale:
 			return locale
 
 		return TranslationServer.get_tool_locale()
-	
+
 
 	static func get_csv_key_name() -> StringName:
-		# TODO: get from config
-		return &"keys"
+		return ParleySettings.get_setting(Constants.TRANSLATION_CSV_HEADER_KEY)
 
 
 class string:

project.godot

@@ -50,11 +50,12 @@ enabled=PackedStringArray("res://addons/gut/plugin.cfg", "res://addons/parley/pl
 
 locale/translation_remaps={}
 locale/translations=PackedStringArray("res://addons/parley/locale/tooltip_translations.en.translation", "res://locale/fr.po", "res://locale/all.en.translation", "res://locale/all.fr.translation")
-locale/translations_pot_files=PackedStringArray("res://dialogue_sequences/all.ds", "res://dialogue_sequences/next_dialogue.ds", "res://tests/fixtures/basic_pot_translations.ds", "res://tests/fixtures/basic_ast_node_generation_input.ds", "res://tests/fixtures/basic_match_input.ds", "res://tests/fixtures/from_jump_node_input.ds", "res://tests/fixtures/to_jump_node_input.ds", "res://tests/fixtures/basic_ast_node_generation_input_with_sorting_cases.ds", "res://tests/fixtures/basic_guard_input.ds", "res://examples/create-to-jump-node-basic.ds", "res://examples/create-match-basic.ds", "res://examples/create-group-basic.ds", "res://examples/create-from-jump-node-basic.ds", "res://examples/create-dialogue-option-basic.ds", "res://examples/create-dialogue-basic.ds", "res://examples/create-condition-basic.ds", "res://examples/create-action-basic.ds", "res://examples/all.ds", "res://tests/fixtures/basic_csv_translations.ds")
+locale/translations_pot_files=PackedStringArray("res://dialogue_sequences/all.ds", "res://dialogue_sequences/next_dialogue.ds", "res://tests/fixtures/basic_pot_translations.ds", "res://tests/fixtures/basic_ast_node_generation_input.ds", "res://tests/fixtures/basic_match_input.ds", "res://tests/fixtures/from_jump_node_input.ds", "res://tests/fixtures/to_jump_node_input.ds", "res://tests/fixtures/basic_ast_node_generation_input_with_sorting_cases.ds", "res://tests/fixtures/basic_guard_input.ds", "res://examples/create-to-jump-node-basic.ds", "res://examples/create-match-basic.ds", "res://examples/create-group-basic.ds", "res://examples/create-from-jump-node-basic.ds", "res://examples/create-dialogue-option-basic.ds", "res://examples/create-dialogue-basic.ds", "res://examples/create-condition-basic.ds", "res://examples/create-action-basic.ds", "res://examples/all.ds", "res://tests/fixtures/basic_csv_translations.ds", "res://tests/fixtures/generate_text_translation_keys_translations.ds")
 locale/locale_filter_mode=0
 
 [parley]
 
 stores/action_store_path="uid://bfwohwb0ftpuq"
 stores/fact_store_path="uid://c3c7k7lljjqv3"
 stores/character_store_path="uid://ceouii84qmu0w"
+test_dialogue_sequence/default_locale="en"