Portraits: Improving/fixing issues with Speaker signal and Highlight methods (#2543)

- fixes several issues reported on the discord server

This code is defenitely breaking some compatibilty, because the speaker is now stored as an identifier and not as a resource_path in the current_state (breaks compat with old saves and maybe with some custom code of people). This is necessary to allow the speaker_update method to work with runtime-characters.

Could also break stuff because the order of operations in the text event has slightly been changed.

Also removed the unnecessary get_current_character method from the Portraits subsystem, as it just did the same as the Text systems method, and speaker is mostly a text concept anyways.

Fixed a dumb mistake in the dialogic_identifiable_resource

Author: Jowan-Spooner

Tests/Unit/subsystem_text_test.gd

@@ -1,6 +1,11 @@
 extends GdUnitTestSuite
 
-const VALID_SPEAKER_PATH := "res://Tests/Resources/unit_test_character.dch"
+const VALID_SPEAKER_PATH := "unit_test_character"
+
+
+func test_build_character_directory() -> void:
+	DialogicResourceUtil.update()
+
 
 ## We ensure that missing a speaker will return null.
 func test_missing_current_speaker() -> void:
@@ -24,4 +29,4 @@ func test_set_valid_current_speaker() -> void:
 	var current_speaker := DialogicUtil.autoload().Text.get_current_speaker()
 
 	assert(not current_speaker == null, "Valid speaker must be valid, but is invalid.")
-	assert(current_speaker.get_path() == VALID_SPEAKER_PATH, "Valid speaker path is not set correctly.")
+	assert(current_speaker.get_identifier() == VALID_SPEAKER_PATH, "Valid speaker path is not set correctly.")

addons/dialogic/Core/DialogicGameHandler.gd

@@ -80,12 +80,12 @@ signal dialogic_paused
 signal dialogic_resumed
 
 
-## Emitted when the timeline ends.
-## This can be a timeline ending or [method end_timeline] being called.
-signal timeline_ended
 ## Emitted when a timeline starts by calling either [method start]
 ## or [method start_timeline].
 signal timeline_started
+## Emitted when the timeline ends.
+## This can be a timeline ending or [method end_timeline] being called.
+signal timeline_ended
 ## Emitted when an event starts being executed.
 ## The event may not have finished executing yet.
 signal event_handled(resource: DialogicEvent)

addons/dialogic/Modules/Character/subsystem_portraits.gd

@@ -53,11 +53,11 @@ func load_game_state(_load_flag:=LoadFlags.FULL_LOAD) -> void:
 			push_error('[Dialogic] Failed to load character "' + str(character_path) + '".')
 
 	# Load Speaker Portrait
-	var speaker: Variant = dialogic.current_state_info.get('speaker', "")
+	var speaker: Variant = dialogic.current_state_info.get("speaker", "")
 	if speaker:
-		dialogic.current_state_info['speaker'] = ""
-		change_speaker(load(speaker))
-	dialogic.current_state_info['speaker'] = speaker
+		dialogic.current_state_info["speaker"] = ""
+		change_speaker(DialogicResourceUtil.get_character_resource(speaker))
+	dialogic.current_state_info["speaker"] = speaker
 
 
 func pause() -> void:
@@ -613,13 +613,6 @@ func remove_character(character: DialogicCharacter) -> void:
 	dialogic.current_state_info['portraits'].erase(character.resource_path)
 
 
-func get_current_character() -> DialogicCharacter:
-	if dialogic.current_state_info.get('speaker', null):
-		return load(dialogic.current_state_info.speaker)
-	return null
-
-
-
 ## Returns true if the given character is currently joined.
 func is_character_joined(character: DialogicCharacter) -> bool:
 	if character == null or not character.resource_path in dialogic.current_state_info['portraits']:
@@ -733,16 +726,13 @@ func change_speaker(speaker: DialogicCharacter = null, portrait := "") -> void:
 
 		_change_portrait_mirror(character_node)
 
-	if speaker:
-		if speaker.resource_path != dialogic.current_state_info['speaker']:
-			if dialogic.current_state_info['speaker'] and is_character_joined(load(dialogic.current_state_info['speaker'])):
-				dialogic.current_state_info['portraits'][dialogic.current_state_info['speaker']].node.get_child(-1)._unhighlight()
-
-			if speaker and is_character_joined(speaker):
-				dialogic.current_state_info['portraits'][speaker.resource_path].node.get_child(-1)._highlight()
-
-	elif dialogic.current_state_info['speaker'] and is_character_joined(load(dialogic.current_state_info['speaker'])):
-		dialogic.current_state_info['portraits'][dialogic.current_state_info['speaker']].node.get_child(-1)._unhighlight()
+	var prev_speaker: DialogicCharacter = dialogic.Text.get_current_speaker()
+	if speaker != prev_speaker:
+		if is_character_joined(prev_speaker):
+			dialogic.current_state_info["portraits"][prev_speaker.resource_path].node.get_child(-1)._unhighlight()
+		
+		if is_character_joined(speaker):
+			dialogic.current_state_info["portraits"][speaker.resource_path].node.get_child(-1)._highlight()
 
 #endregion
 
@@ -753,14 +743,15 @@ func change_speaker(speaker: DialogicCharacter = null, portrait := "") -> void:
 ## Called from the [portrait=something] text effect.
 func text_effect_portrait(_text_node:Control, _skipped:bool, argument:String) -> void:
 	if argument:
-		if dialogic.current_state_info.get('speaker', null):
-			change_character_portrait(load(dialogic.current_state_info.speaker), argument)
-			change_speaker(load(dialogic.current_state_info.speaker), argument)
+		var current_speaker := dialogic.Text.get_current_speaker()
+		if current_speaker:
+			change_character_portrait(current_speaker, argument)
+			change_speaker(current_speaker, argument)
 
 
 ## Called from the [extra_data=something] text effect.
 func text_effect_extradata(_text_node:Control, _skipped:bool, argument:String) -> void:
 	if argument:
-		if dialogic.current_state_info.get('speaker', null):
-			change_character_extradata(load(dialogic.current_state_info.speaker), argument)
+		if dialogic.Text.get_current_speaker():
+			change_character_extradata(dialogic.Text.get_current_speaker(), argument)
 #endregion

addons/dialogic/Modules/Text/event_text.gd

@@ -51,45 +51,60 @@ func _clear_state() -> void:
 	dialogic.current_state_info.erase('text_sub_idx')
 	_disconnect_signals()
 
+
 func _execute() -> void:
 	if text.is_empty():
 		finish()
 		return
-
-	if (not character or character.custom_info.get('style', '').is_empty()) and dialogic.has_subsystem('Styles'):
-		# if previous characters had a custom style change back to base style
-		if dialogic.current_state_info.get('base_style') != dialogic.current_state_info.get('style'):
-			dialogic.Styles.change_style(dialogic.current_state_info.get('base_style', 'Default'))
-			await dialogic.get_tree().process_frame
-
-	var character_name_text := dialogic.Text.get_character_name_parsed(character)
-	if character:
-		dialogic.current_state_info['speaker'] = character.resource_path
-		if dialogic.has_subsystem('Styles') and character.custom_info.get('style', null):
-			dialogic.Styles.change_style(character.custom_info.style, false)
-			await dialogic.get_tree().process_frame
-
-
-		if portrait and dialogic.has_subsystem('Portraits') and dialogic.Portraits.is_character_joined(character):
-			dialogic.Portraits.change_character_portrait(character, portrait)
-		dialogic.Portraits.change_speaker(character, portrait)
-		var check_portrait: String = portrait if !portrait.is_empty() else dialogic.current_state_info['portraits'].get(character.resource_path, {}).get('portrait', '')
-
-		if check_portrait and character.portraits.get(check_portrait, {}).get('sound_mood', '') in character.custom_info.get('sound_moods', {}):
-			dialogic.Text.update_typing_sound_mood(character.custom_info.get('sound_moods', {}).get(character.portraits[check_portrait].get('sound_mood', {}), {}))
-		elif !character.custom_info.get('sound_mood_default', '').is_empty():
-			dialogic.Text.update_typing_sound_mood(character.custom_info.get('sound_moods', {}).get(character.custom_info.get('sound_mood_default'), {}))
+	
+	
+	## Change Portrait and Active Speaker
+	if dialogic.has_subsystem("Portraits"):
+		if character:
+			
+			dialogic.Portraits.change_speaker(character, portrait)
+			
+			if portrait and dialogic.Portraits.is_character_joined(character):
+				dialogic.Portraits.change_character_portrait(character, portrait)
+			
 		else:
-			dialogic.Text.update_typing_sound_mood()
-
+			dialogic.Portraits.change_speaker(null)
+	
+	## Change and Type Sound Mood
+	if character:
 		dialogic.Text.update_name_label(character)
+		
+		var current_portrait: String = portrait
+		if portrait.is_empty():
+			portrait = dialogic.current_state_info["portraits"].get(character.resource_path, {}).get("portrait", "")
+		
+		var current_portrait_sound_mood: String = character.portraits.get(current_portrait, {}).get("sound_mood", "")
+		dialogic.Text.update_typing_sound_mood_from_character(character, current_portrait_sound_mood)
+	
 	else:
-		dialogic.Portraits.change_speaker(null)
 		dialogic.Text.update_name_label(null)
 		dialogic.Text.update_typing_sound_mood()
+		
+	
+	## Handle style changes
+	if dialogic.has_subsystem("Styles"):
+		var current_base_style: String = dialogic.current_state_info.get("base_style")
+		var current_style: String = dialogic.current_state_info.get("style", "")
+		var character_style: String = "" if not character else character.custom_info.get("style", "")
+		
+		## Change back to base style, if another characters style is currently used
+		if (not character or character_style.is_empty()) and (current_base_style != current_style):
+			dialogic.Styles.change_style(dialogic.current_state_info.get("base_style", "Default"))
+			await dialogic.get_tree().process_frame
+		
+		## Change to the characters style if this character has one
+		elif character and not character_style.is_empty():
+			dialogic.Styles.change_style(current_style, false)
+			await dialogic.get_tree().process_frame
 
 	_connect_signals()
 
+	var character_name_text := dialogic.Text.get_character_name_parsed(character)
 	var final_text: String = get_property_translated('text')
 	if ProjectSettings.get_setting('dialogic/text/split_at_new_lines', false):
 		match ProjectSettings.get_setting('dialogic/text/split_at_new_lines_as', 0):

addons/dialogic/Modules/Text/subsystem_text.gd

@@ -74,10 +74,10 @@ var _autopauses := {}
 ####################################################################################################
 
 func clear_game_state(_clear_flag:=DialogicGameHandler.ClearFlags.FULL_CLEAR) -> void:
-	update_dialog_text('', true)
+	update_dialog_text("", true)
 	update_name_label(null)
-	dialogic.current_state_info['speaker'] = ""
-	dialogic.current_state_info['text'] = ''
+	dialogic.current_state_info["speaker"] = ""
+	dialogic.current_state_info["text"] = ""
 
 	set_text_reveal_skippable(ProjectSettings.get_setting('dialogic/text/initial_text_reveal_skippable', true))
 
@@ -90,9 +90,7 @@ func clear_game_state(_clear_flag:=DialogicGameHandler.ClearFlags.FULL_CLEAR) ->
 func load_game_state(_load_flag:=LoadFlags.FULL_LOAD) -> void:
 	update_textbox(dialogic.current_state_info.get('text', ''), true)
 	update_dialog_text(dialogic.current_state_info.get('text', ''), true)
-	var character: DialogicCharacter = null
-	if dialogic.current_state_info.get('speaker', ""):
-		character = load(dialogic.current_state_info.get('speaker', ""))
+	var character: DialogicCharacter = get_current_speaker()
 
 	if character:
 		update_name_label(character)
@@ -190,18 +188,18 @@ func update_dialog_text(text: String, instant := false, additional := false) ->
 
 
 func _on_dialog_text_finished() -> void:
-	text_finished.emit({'text':dialogic.current_state_info['text'], 'character':dialogic.current_state_info['speaker']})
+	text_finished.emit({"text":dialogic.current_state_info["text"], "character":dialogic.current_state_info["speaker"]})
 
 
 ## Updates the visible name on all name labels nodes.
 ## If a name changes, the [signal speaker_updated] signal is emitted.
 func update_name_label(character:DialogicCharacter):
-	var character_path := character.resource_path if character else ""
-	var current_character_path: String = dialogic.current_state_info.get("speaker", "")
+	var character_id := character.get_identifier() if character else ""
+	var current_character_id: String = dialogic.current_state_info.get("speaker", "")
 
-	if character_path != current_character_path:
-		dialogic.current_state_info['speaker'] = character_path
+	if character_id != current_character_id:
 		speaker_updated.emit(character)
+		dialogic.current_state_info["speaker"] = character_id
 
 	var name_label_text := get_character_name_parsed(character)
 
@@ -214,8 +212,19 @@ func update_name_label(character:DialogicCharacter):
 			name_label.self_modulate = Color(1,1,1,1)
 
 
+func update_typing_sound_mood_from_character(character:DialogicCharacter, mood:String) -> void:
+	if character.custom_info.get("sound_moods", {}).is_empty():
+		update_typing_sound_mood()
+	elif mood in character.custom_info.get("sound_moods", {}):
+		update_typing_sound_mood(character.custom_info.get("sound_moods", {})[mood])
+	else:
+		var default_mood := character.custom_info.get("sound_mood_default")
+		update_typing_sound_mood(character.custom_info.get("sound_moods", {}).get(default_mood, {}))
+		
+
+
 func update_typing_sound_mood(mood:Dictionary = {}) -> void:
-	for typing_sound in get_tree().get_nodes_in_group('dialogic_type_sounds'):
+	for typing_sound in get_tree().get_nodes_in_group("dialogic_type_sounds"):
 		typing_sound.load_overwrite(mood)
 
 
@@ -447,19 +456,12 @@ func get_character_name_parsed(character:DialogicCharacter) -> String:
 ## Returns the [class DialogicCharacter] of the current speaker.
 ## If there is no current speaker or the speaker is not found, returns null.
 func get_current_speaker() -> DialogicCharacter:
-	var speaker_path: String = dialogic.current_state_info.get("speaker", "")
+	var speaker_id: String = dialogic.current_state_info.get("speaker", "")
 
-	if speaker_path.is_empty():
+	if speaker_id.is_empty():
 		return null
 
-	var speaker_resource := load(speaker_path)
-
-	if speaker_resource == null:
-		return null
-
-	var speaker_character := speaker_resource as DialogicCharacter
-
-	return speaker_character
+	return DialogicResourceUtil.get_character_resource(speaker_id)
 
 
 func _update_user_speed(_user_speed:float) -> void:
@@ -596,9 +598,9 @@ func effect_signal(_text_node:Control, _skipped:bool, argument:String) -> void:
 
 func effect_mood(_text_node:Control, _skipped:bool, argument:String) -> void:
 	if argument.is_empty(): return
-	if dialogic.current_state_info.get('speaker', ""):
+	if get_current_speaker():
 		update_typing_sound_mood(
-			load(dialogic.current_state_info.speaker).custom_info.get('sound_moods', {}).get(argument, {}))
+			get_current_speaker().custom_info.get('sound_moods', {}).get(argument, {}))
 
 
 var modifier_select_regex := RegEx.create_from_string(r"(?<!\\)\<[^\>]+(\/[^\>]*)\>")

addons/dialogic/Resources/dialogic_identifiable_resource.gd

@@ -18,7 +18,7 @@ func _to_string() -> String:
 func get_identifier() -> String:
 	if resource_path:
 		return DialogicResourceUtil.get_unique_identifier_by_path(resource_path)
-	if Engine.is_editor_hint():
+	if not Engine.is_editor_hint():
 		return DialogicResourceUtil.get_runtime_unique_identifier(self, _get_extension())
 	return ""