Various Fixes (#2564)

Through some extensive testing, all of these issues were found and removed:
- Background Transitions being broken in export
- Backgrounds broken when quickly skipping
- Remove warning on container sizes
- Suggest fade and fade_length in character update event (text editor)
- Improve/Fix fading on portraits and mirrored portraits
- Fix warning about character suffix/prefix
- Fix weird headings in portrait settings
- Slightly improve character suggestions (text editor)
- Avoid a bunch of unnecessary warnings
- Fix character styles not loading
- Performance improvements (hopefully) and introduction of DialogicStylesUtil
- Enabled folding gutter in text editor
- Improve auto-indentation in text editor
- Update unit tests to be using godot 4.3 and work again

Author: Jowan-Spooner

.github/workflows/unit_test.yml

@@ -22,7 +22,7 @@ jobs:
       fail-fast: false
       matrix:
         # Insert here the Godot version you want to run your tests with.
-        godot-version: ['4.2.1']
+        godot-version: ['4.3']
 
     name: "CI Unit Test v${{ matrix.godot-version }}"
     runs-on: 'ubuntu-22.04'

Tests/Unit/glossary_resource_test.gd

@@ -6,7 +6,7 @@ const NAME_ENTRY := "Example Name"
 const EXAMPLE_TITLE := "Example Title"
 const ALTERNATIVE_ENTRIES := ["A", "BE", "VERY LONG ENTRY"]
 
-const SAMPLE_ENTRY := {
+var SAMPLE_ENTRY := {
 	DialogicGlossary.TITLE_PROPERTY: EXAMPLE_TITLE,
 	DialogicGlossary.NAME_PROPERTY: NAME_ENTRY,
 	DialogicGlossary.ALTERNATIVE_PROPERTY: ALTERNATIVE_ENTRIES
@@ -18,7 +18,7 @@ const SAMPLE_ENTRY := {
 func test_add_entry() -> void:
 	var glossary: DialogicGlossary = DialogicGlossary.new()
 
-	assert(glossary.try_add_entry(SAMPLE_ENTRY), "Unable to add entry.")
+	assert(glossary.try_add_entry(SAMPLE_ENTRY.duplicate()), "Unable to add entry.")
 
 	const NAME_COUNTER := 1
 	var total_entry_count := ALTERNATIVE_ENTRIES.size() + NAME_COUNTER
@@ -36,7 +36,7 @@ func test_add_entry() -> void:
 func test_replace_entries() -> void:
 	var glossary: DialogicGlossary = DialogicGlossary.new()
 
-	assert(glossary.try_add_entry(SAMPLE_ENTRY), "Unable to add entry.")
+	assert(glossary.try_add_entry(SAMPLE_ENTRY.duplicate()), "Unable to add entry.")
 
 	const NEW_NAME := "NEW NAME"
 
@@ -55,7 +55,7 @@ func test_replace_entries() -> void:
 func test_remove_entry() -> void:
 	var glossary: DialogicGlossary = DialogicGlossary.new()
 
-	assert(glossary.try_add_entry(SAMPLE_ENTRY), "Unable to add entry.")
+	assert(glossary.try_add_entry(SAMPLE_ENTRY.duplicate()), "Unable to add entry.")
 
 	const NAME_COUNTER := 1
 	var total_entry_count := ALTERNATIVE_ENTRIES.size() + NAME_COUNTER
@@ -72,5 +72,5 @@ func test_remove_entry() -> void:
 func test_add_duplicates() -> void:
 	var glossary: DialogicGlossary = DialogicGlossary.new()
 
-	assert(glossary.try_add_entry(SAMPLE_ENTRY), "Unable to add entry.")
-	assert(not glossary.try_add_entry(SAMPLE_ENTRY), "Entry should not have been added.")
+	assert(glossary.try_add_entry(SAMPLE_ENTRY.duplicate()), "Unable to add entry.")
+	assert(not glossary.try_add_entry(SAMPLE_ENTRY.duplicate()), "Entry should not have been added.")

addons/dialogic/Core/DialogicGameHandler.gd

@@ -91,8 +91,11 @@ signal timeline_ended
 signal event_handled(resource: DialogicEvent)
 
 ## Emitted when a [class SignalEvent] event was reached.
+@warning_ignore("unused_signal") # This is emitted by the signal event.
 signal signal_event(argument: Variant)
+
 ## Emitted when a signal event gets fired from a [class TextEvent] event.
+@warning_ignore("unused_signal") # This is emitted by the text subsystem.
 signal text_signal(argument: String)
 
 
@@ -162,6 +165,8 @@ func _ready() -> void:
 
 	clear()
 
+	DialogicResourceUtil.update_event_cache()
+
 	dialog_ending_timeline = DialogicTimeline.new()
 	dialog_ending_timeline.from_text("[clear]")
 
@@ -204,10 +209,10 @@ func start_timeline(timeline:Variant, label_or_idx:Variant = "") -> void:
 	# load the resource if only the path is given
 	if typeof(timeline) == TYPE_STRING:
 		#check the lookup table if it's not a full file name
-		if (timeline as String).contains("res://") or (timeline as String).contains("uid://"):
-			timeline = load((timeline as String))
+		if "://" in timeline:
+			timeline = load(timeline)
 		else:
-			timeline = DialogicResourceUtil.get_timeline_resource((timeline as String))
+			timeline = DialogicResourceUtil.get_timeline_resource(timeline)
 
 	if timeline == null:
 		printerr("[Dialogic] There was an error loading this timeline. Check the filename, and the timeline for errors")
@@ -228,10 +233,10 @@ func start_timeline(timeline:Variant, label_or_idx:Variant = "") -> void:
 	elif typeof(label_or_idx) == TYPE_INT:
 		if label_or_idx >-1:
 			current_event_idx = label_or_idx -1
-	
+
 	if not current_timeline == dialog_ending_timeline:
 		timeline_started.emit()
-	
+
 	handle_next_event()
 
 
@@ -240,7 +245,11 @@ func start_timeline(timeline:Variant, label_or_idx:Variant = "") -> void:
 func preload_timeline(timeline_resource:Variant) -> Variant:
 	# I think ideally this should be on a new thread, will test
 	if typeof(timeline_resource) == TYPE_STRING:
-		timeline_resource = load((timeline_resource as String))
+		if "://" in timeline_resource:
+			timeline_resource = load(timeline_resource)
+		else:
+			timeline_resource = DialogicResourceUtil.get_timeline_resource(timeline_resource)
+
 		if timeline_resource == null:
 			printerr("[Dialogic] There was an error preloading this timeline. Check the filename, and the timeline for errors")
 			return null

addons/dialogic/Core/DialogicResourceUtil.gd

@@ -13,6 +13,7 @@ static func update() -> void:
 	update_directory('.dtl')
 	update_label_cache()
 	update_audio_channel_cache()
+	DialogicStylesUtil.update_style_directory()
 
 
 #region RESOURCE DIRECTORIES

addons/dialogic/Core/DialogicUtil.gd

@@ -100,11 +100,10 @@ static func _update_autoload_subsystem_access() -> void:
 
 
 static func get_indexers(include_custom := true, force_reload := false) -> Array[DialogicIndexer]:
-	if Engine.get_main_loop().has_meta('dialogic_indexers') and !force_reload:
+	if Engine.get_main_loop().has_meta('dialogic_indexers') and not force_reload:
 		return Engine.get_main_loop().get_meta('dialogic_indexers')
 
 	var indexers: Array[DialogicIndexer] = []
-
 	for file in listdir(DialogicUtil.get_module_path(''), false):
 		var possible_script: String = DialogicUtil.get_module_path(file).path_join("index.gd")
 		if ResourceLoader.exists(possible_script):
@@ -297,40 +296,6 @@ static func _get_value_in_dictionary(path:String, dictionary:Dictionary, default
 #endregion
 
 
-
-#region STYLES
-################################################################################
-
-static func get_default_layout_base() -> PackedScene:
-	return load(DialogicUtil.get_module_path('DefaultLayoutParts').path_join("Base_Default/default_layout_base.tscn"))
-
-
-static func get_fallback_style() -> DialogicStyle:
-	return load(DialogicUtil.get_module_path('DefaultLayoutParts').path_join("Style_VN_Default/default_vn_style.tres"))
-
-
-static func get_default_style() -> DialogicStyle:
-	var default: String = ProjectSettings.get_setting('dialogic/layout/default_style', '')
-	if !ResourceLoader.exists(default):
-		return get_fallback_style()
-	return load(default)
-
-
-static func get_style_by_name(name:String) -> DialogicStyle:
-	if name.is_empty():
-		return get_default_style()
-
-	var styles: Array = ProjectSettings.get_setting('dialogic/layout/style_list', [])
-	for style in styles:
-		if not ResourceLoader.exists(style):
-			continue
-		if load(style).name == name:
-			return load(style)
-
-	return get_default_style()
-#endregion
-
-
 #region SCENE EXPORT OVERRIDES
 ################################################################################
 
@@ -692,9 +657,9 @@ static func get_autoload_suggestions(filter:String="") -> Dictionary:
 
 	for prop in ProjectSettings.get_property_list():
 		if prop.name.begins_with('autoload/'):
-			var autoload: String = prop.name.trim_prefix('autoload/')
-			suggestions[autoload] = {'value': autoload, 'tooltip':autoload, 'editor_icon': ["Node", "EditorIcons"]}
-			if filter.begins_with(autoload):
+			var some_autoload: String = prop.name.trim_prefix('autoload/')
+			suggestions[some_autoload] = {'value': some_autoload, 'tooltip':some_autoload, 'editor_icon': ["Node", "EditorIcons"]}
+			if filter.begins_with(some_autoload):
 				suggestions[filter] = {'value': filter, 'editor_icon':["GuiScrollArrowRight", "EditorIcons"]}
 	return suggestions
 
@@ -729,7 +694,7 @@ static func get_autoload_method_suggestions(filter:String, autoload_name:String)
 	return suggestions
 
 
-static func get_autoload_property_suggestions(filter:String, autoload_name:String) -> Dictionary:
+static func get_autoload_property_suggestions(_filter:String, autoload_name:String) -> Dictionary:
 	var suggestions := {}
 	var script := get_autoload_script_resource(autoload_name)
 	if script:
@@ -741,7 +706,7 @@ static func get_autoload_property_suggestions(filter:String, autoload_name:Strin
 	return suggestions
 
 
-static func get_audio_bus_suggestions(filter:= "") -> Dictionary:
+static func get_audio_bus_suggestions(_filter:= "") -> Dictionary:
 	var bus_name_list := {}
 	for i in range(AudioServer.bus_count):
 		if i == 0:
@@ -751,9 +716,7 @@ static func get_audio_bus_suggestions(filter:= "") -> Dictionary:
 	return bus_name_list
 
 
-static func get_audio_channel_suggestions(search_text:String) -> Dictionary:
-
-
+static func get_audio_channel_suggestions(_search_text:String) -> Dictionary:
 	var suggestions := {}
 	var channel_defaults := DialogicUtil.get_audio_channel_defaults()
 	var cached_names := DialogicResourceUtil.get_channel_list()

addons/dialogic/Core/index_class.gd

@@ -78,7 +78,7 @@ func list_dir(subdir:='') -> Array:
 func list_special_resources(subdir:='', extension:="") -> Dictionary:
 	var dict := {}
 	for i in list_dir(subdir):
-		if extension.is_empty() or i.ends_with(extension):
+		if extension.is_empty() or i.ends_with(extension) or (extension == ".gd" and i.ends_with(".gdc")):
 			dict[DialogicUtil.pretty_name(i).to_lower()] = {"path":i}
 	return dict
 

addons/dialogic/Editor/CharacterEditor/character_editor_main_settings_section.gd

@@ -5,6 +5,7 @@ extends Control
 ## Base class for all character editor main sections. Methods should be overriden.
 
 ## Emit this, if something changed
+@warning_ignore("unused_signal") # this is used by extending scripts
 signal changed
 
 ## Reference to the character editor, set when instantiated
@@ -30,7 +31,7 @@ func _start_opened() -> bool:
 
 
 ## Overwrite to load all the information from the character into this section.
-func _load_character(resource:DialogicCharacter) -> void:
+func _load_character(_resource:DialogicCharacter) -> void:
 	pass
 
 

addons/dialogic/Editor/CharacterEditor/character_prefix_suffix.gd

@@ -69,7 +69,7 @@ func _load_prefix_data(data: Dictionary) -> void:
 
 ## Whenever the user makes a save to the character, we save the prefix and suffix.
 func _save_changes(character: DialogicCharacter) -> DialogicCharacter:
-	if not character.custom_info:
+	if not character:
 		printerr("[Dialogic] Unable to save Prefix and Suffix, the character is missing.")
 		return character
 

addons/dialogic/Editor/Events/Fields/dictionary_part.gd

@@ -41,4 +41,3 @@ func _on_flex_value_value_changed() -> void:
 func _on_delete_pressed() -> void:
 	queue_free()
 	value_changed.emit()
-

addons/dialogic/Editor/Events/Fields/field_options_dynamic.gd

@@ -127,7 +127,7 @@ func change_to_empty() -> void:
 
 func validate() -> void:
 	if mode == Modes.ANY_VALID_STRING and validation_func:
-		var validation_result := validation_func.call(current_value)
+		var validation_result: Dictionary = validation_func.call(current_value)
 		current_value = validation_result.get('valid_text', current_value)
 		update_error_tooltip(validation_result.get('error_tooltip', ''))
 
@@ -152,7 +152,7 @@ func update_error_tooltip(text: String) -> void:
 func _on_Search_text_entered(new_text:String) -> void:
 	if mode == Modes.ANY_VALID_STRING:
 		if validation_func:
-			var validation_result := validation_func.call(new_text)
+			var validation_result: Dictionary = validation_func.call(new_text)
 			new_text = validation_result.get('valid_text', new_text)
 			update_error_tooltip(validation_result.get('error_tooltip', ''))
 
@@ -182,7 +182,7 @@ func _on_Search_text_changed(new_text:String, just_update:bool = false) -> void:
 
 	if mode == Modes.ANY_VALID_STRING and !just_update:
 		if validation_func:
-			var validation_result := validation_func.call(new_text)
+			var validation_result: Dictionary = validation_func.call(new_text)
 			new_text = validation_result.get('valid_text', new_text)
 			update_error_tooltip(validation_result.get('error_tooltip', ''))
 
@@ -207,9 +207,9 @@ func _on_Search_text_changed(new_text:String, just_update:bool = false) -> void:
 	for element in suggestions:
 		if new_text.is_empty() or new_text.to_lower() in element.to_lower() or new_text.to_lower() in str(suggestions[element].value).to_lower() or new_text.to_lower() in suggestions[element].get('tooltip', '').to_lower():
 			var curr_line_length: int = 0
-			curr_line_length = get_theme_font('font', 'Label').get_string_size(
+			curr_line_length = int(get_theme_font('font', 'Label').get_string_size(
 				element, HORIZONTAL_ALIGNMENT_LEFT, -1, get_theme_font_size("font_size", 'Label')
-			).x
+			).x)
 
 			%Suggestions.add_item(element)
 			if suggestions[element].has('icon'):
@@ -238,7 +238,7 @@ func _on_Search_text_changed(new_text:String, just_update:bool = false) -> void:
 
 	var total_height: int = 0
 	for item in %Suggestions.item_count:
-		total_height += _line_height * DialogicUtil.get_editor_scale() + _v_separation
+		total_height += int(_line_height * DialogicUtil.get_editor_scale() + _v_separation)
 	total_height += _v_separation * 2
 	if total_height > _max_height:
 		line_length += %Suggestions.get_v_scroll_bar().get_minimum_size().x
@@ -254,7 +254,7 @@ func _on_Search_text_changed(new_text:String, just_update:bool = false) -> void:
 	%Suggestions.size.x = max(%PanelContainer.size.x, line_length)
 
 
-func suggestion_selected(index: int, position := Vector2(), button_index := MOUSE_BUTTON_LEFT) -> void:
+func suggestion_selected(index: int, _position := Vector2(), button_index := MOUSE_BUTTON_LEFT) -> void:
 	if button_index != MOUSE_BUTTON_LEFT:
 		return
 	if %Suggestions.is_item_disabled(index):
@@ -348,7 +348,7 @@ func _on_search_focus_exited() -> void:
 #region DRAG AND DROP
 ################################################################################
 
-func _can_drop_data(position:Vector2, data:Variant) -> bool:
+func _can_drop_data(_position:Vector2, data:Variant) -> bool:
 	if typeof(data) == TYPE_DICTIONARY and data.has('files') and len(data.files) == 1:
 		if valid_file_drop_extension:
 			if data.files[0].ends_with(valid_file_drop_extension):
@@ -358,7 +358,7 @@ func _can_drop_data(position:Vector2, data:Variant) -> bool:
 	return false
 
 
-func _drop_data(position:Vector2, data:Variant) -> void:
+func _drop_data(_position:Vector2, data:Variant) -> void:
 	var path := str(data.files[0])
 	if mode == Modes.IDENTIFIER:
 		path = DialogicResourceUtil.get_unique_identifier_by_path(path)