Add DialogicStylesUtil and other performance fixes

The new best way to preload a style is with Dialogic.Styles.preload_style("name_or_path")

Author: Jowan-Spooner

addons/dialogic/Core/DialogicGameHandler.gd

@@ -165,6 +165,8 @@ func _ready() -> void:
 
 	clear()
 
+	DialogicResourceUtil.update_event_cache()
+
 	dialog_ending_timeline = DialogicTimeline.new()
 	dialog_ending_timeline.from_text("[clear]")
 
@@ -207,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")
@@ -243,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
 ################################################################################
 

addons/dialogic/Modules/Style/DialogicStylesUtil.gd

@@ -0,0 +1,78 @@
+@tool
+class_name DialogicStylesUtil
+extends Node
+
+static var style_directory := {}
+
+#region STYLES
+################################################################################
+
+static func update_style_directory() -> void:
+	return ProjectSettings.get_setting('dialogic/layout/style_directory', {})
+
+
+static func build_style_directory() -> void:
+	style_directory.clear()
+
+	var default := get_default_style_path()
+	if ResourceLoader.exists(default):
+		style_directory[""] = default
+
+	var styles: Array = ProjectSettings.get_setting('dialogic/layout/style_list', [])
+	for style_path in styles:
+		if not ResourceLoader.exists(style_path):
+			continue
+		# TODO this is bad
+		var resource: DialogicStyle = load(style_path)
+		style_directory[resource.name] = resource
+	ProjectSettings.set_setting('dialogic/layout/style_directory', style_directory)
+	ProjectSettings.save()
+
+
+static func get_default_style_path() -> String:
+	return ProjectSettings.get_setting('dialogic/layout/default_style', '')
+
+
+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_path() -> String:
+	return DialogicUtil.get_module_path('DefaultLayoutParts').path_join("Style_VN_Default/default_vn_style.tres")
+
+
+static func get_fallback_style() -> DialogicStyle:
+	return load(get_fallback_style_path())
+
+
+static func get_style_path(name_or_path:String) -> String:
+	var path := ""
+	if name_or_path.begins_with("res://"):
+		if not ResourceLoader.exists(name_or_path):
+			name_or_path = ""
+
+	if name_or_path in style_directory:
+		path = style_directory[name_or_path]
+
+	if not name_or_path:
+		path = get_default_style_path()
+
+	if not name_or_path or not ResourceLoader.exists(name_or_path):
+		return get_fallback_style_path()
+
+	return name_or_path
+
+
+static func start_style_preload(name_or_path:String) -> void:
+	ResourceLoader.load_threaded_request(get_style_path(name_or_path))
+
+
+static func get_style(style_name:String) -> DialogicStyle:
+	var path := get_style_path(style_name)
+	if ResourceLoader.load_threaded_get_status(path) == ResourceLoader.THREAD_LOAD_LOADED:
+		return ResourceLoader.load_threaded_get(path)
+
+	return load(path)
+
+
+#endregion

addons/dialogic/Modules/Style/DialogicStylesUtil.gd.uid

@@ -0,0 +1 @@
+uid://df671mnqushqc

addons/dialogic/Modules/Style/subsystem_styles.gd

@@ -8,6 +8,10 @@ signal style_changed(info:Dictionary)
 #region STATE
 ####################################################################################################
 
+func _ready() -> void:
+	DialogicStylesUtil.update_style_directory()
+
+
 func clear_game_state(_clear_flag := DialogicGameHandler.ClearFlags.FULL_CLEAR) -> void:
 	pass
 
@@ -33,7 +37,7 @@ func change_style(style_name := "", is_base_style := true) -> Node:
 ## [br] If [param state_reload] is true, the current state will be loaded into a new layout scenes nodes.
 ## That should not be done before calling start() or load() as it would be unnecessary or cause double-loading.
 func load_style(style_name := "", parent: Node = null, is_base_style := true, state_reload := false) -> Node:
-	var style := DialogicUtil.get_style_by_name(style_name)
+	var style := DialogicStylesUtil.get_style(style_name)
 
 	var signal_info := {'style':style_name}
 	dialogic.current_state_info['style'] = style_name
@@ -92,7 +96,7 @@ func create_layout(style: DialogicStyle, parent: Node = null) -> DialogicLayoutB
 	var base_scene: DialogicLayoutBase
 	var base_layer_info := style.get_layer_inherited_info("")
 	if base_layer_info.path.is_empty():
-		base_scene = DialogicUtil.get_default_layout_base().instantiate()
+		base_scene = DialogicStylesUtil.get_default_layout_base().instantiate()
 	else:
 		base_scene = load(base_layer_info.path).instantiate()
 
@@ -172,4 +176,8 @@ func get_first_node_in_layout(group_name: String) -> Node:
 			return node
 	return null
 
+
+func preload_style(name_or_path:String = "") -> void:
+	DialogicStylesUtil.start_style_preload(name_or_path)
+
 #endregion

addons/dialogic/Modules/StyleEditor/style_editor.gd

@@ -346,7 +346,7 @@ func _on_inheritance_index_pressed(index:int) -> void:
 
 
 func _on_start_styling_button_pressed() -> void:
-	var new_style := DialogicUtil.get_fallback_style().clone()
+	var new_style := DialogicStylesUtil.get_fallback_style().clone()
 
 	find_parent('EditorView').godot_file_dialog(
 		add_style_undoable.bind(new_style),

addons/dialogic/Resources/dialogic_style.gd

@@ -73,7 +73,7 @@ func get_layer_info(id:String) -> Dictionary:
 		if layer_resource.scene != null:
 			info.path = layer_resource.scene.resource_path
 		elif id == "":
-			info.path = DialogicUtil.get_default_layout_base().resource_path
+			info.path = DialogicStylesUtil.get_default_layout_base().resource_path
 
 		info.overrides = layer_resource.overrides.duplicate()
 

addons/dialogic/Resources/event.gd

@@ -443,6 +443,9 @@ func _get_icon() -> Resource:
 
 
 func set_default_color(value:Variant) -> void:
+	# Skip in running games
+	if not Engine.is_editor_hint():
+		return
 	dialogic_color_name = value
 	event_color = DialogicUtil.get_color(value)