Merge - v6.1.0

This update addresses a performance issue related to the new script extension sorting introduced in v6.0.0. It also includes a refactor of the *mod_main.gd* initialization to no longer require the `modLoader` parameter in the `_init()` function.

Author: KANAjetzt

.github/workflows/main.yml

@@ -1,7 +1,4 @@
-on:
-  pull_request:
-    branches-ignore:    
-       - 'main'
+on: [pull_request]
 jobs:
   check_dependencies:
     runs-on: ubuntu-latest

addons/mod_loader/internal/script_extension.gd

@@ -7,57 +7,35 @@ extends Reference
 
 const LOG_NAME := "ModLoader:ScriptExtension"
 
-
-# Couple the extension paths with the parent paths and the extension's mod id
-# in a ScriptExtensionData resource
+# Sort script extensions by inheritance and apply them in order
 static func handle_script_extensions() -> void:
-	var script_extension_data_array := []
+	var extension_paths := []
 	for extension_path in ModLoaderStore.script_extensions:
-
-		if not File.new().file_exists(extension_path):
+		if File.new().file_exists(extension_path):
+			extension_paths.push_back(extension_path)
+		else:
 			ModLoaderLog.error("The child script path '%s' does not exist" % [extension_path], LOG_NAME)
-			continue
-
-		var child_script = ResourceLoader.load(extension_path)
-
-		var mod_id: String = extension_path.trim_prefix(_ModLoaderPath.get_unpacked_mods_dir_path()).get_slice("/", 0)
-
-		var parent_script: Script = child_script.get_base_script()
-		var parent_script_path: String = parent_script.resource_path
-
-		script_extension_data_array.push_back(
-			ScriptExtensionData.new(extension_path, parent_script_path, mod_id)
-		)
-
-	# Sort the extensions based on dependencies
-	script_extension_data_array = _sort_extensions_from_load_order(script_extension_data_array)
-
-	# Inheritance is more important so this called last
-	script_extension_data_array.sort_custom(InheritanceSorting, "_check_inheritances")
-
+			
+	# Sort by inheritance
+	extension_paths.sort_custom(InheritanceSorting.new(), "_check_inheritances")
+	
 	# Load and install all extensions
-	for extension in script_extension_data_array:
-		var script: Script = apply_extension(extension.extension_path)
+	for extension in extension_paths:
+		var script: Script = apply_extension(extension)
 		_reload_vanilla_child_classes_for(script)
 
 
-# Inner class so the sort function can be called by handle_script_extensions()
+# Sorts script paths by their ancestors.  Scripts are organized by their common
+# acnestors then sorted such that scripts extending script A will be before
+# a script extending script B if A is an ancestor of B.
 class InheritanceSorting:
+	var stack_cache := {}
 
-	static func _check_inheritances(extension_a: ScriptExtensionData, extension_b: ScriptExtensionData) -> bool:
-		var a_stack := []
-		var parent_script: Script = load(extension_a.extension_path)
-		while parent_script:
-			a_stack.push_front(parent_script.resource_path)
-			parent_script = parent_script.get_base_script()
-		a_stack.pop_back()
-
-		var b_stack := []
-		parent_script = load(extension_b.extension_path)
-		while parent_script:
-			b_stack.push_front(parent_script.resource_path)
-			parent_script = parent_script.get_base_script()
-		b_stack.pop_back()
+	# Comparator function.  return true if a should go before b.  This may
+	# enforce conditions beyond the stated inheritance relationship.
+	func _check_inheritances(extension_a: String, extension_b: String) -> bool:
+		var a_stack := cached_inheritances_stack(extension_a)
+		var b_stack := cached_inheritances_stack(extension_b)
 
 		var last_index: int
 		for index in a_stack.size():
@@ -68,10 +46,28 @@ class InheritanceSorting:
 			last_index = index
 
 		if last_index < b_stack.size():
-			# 'a' has a shorter stack
 			return true
 
-		return extension_a.extension_path < extension_b.extension_path
+		return extension_a < extension_b
+	
+	# Returns a list of scripts representing all the ancestors of the extension
+	# script with the most recent ancestor last.
+	#
+	# Results are stored in a cache keyed by extension path
+	func cached_inheritances_stack(extension_path: String) -> Array:
+		if stack_cache.has(extension_path):
+			return stack_cache[extension_path]
+			
+		var stack := []
+		
+		var parent_script: Script = load(extension_path)
+		while parent_script:
+			stack.push_front(parent_script.resource_path)
+			parent_script = parent_script.get_base_script()
+		stack.pop_back()
+		
+		stack_cache[extension_path] = stack
+		return stack
 
 
 static func apply_extension(extension_path: String) -> Script:
@@ -114,19 +110,6 @@ static func apply_extension(extension_path: String) -> Script:
 
 	return child_script
 
-
-# Sort an array of ScriptExtensionData following the load order
-static func _sort_extensions_from_load_order(extensions: Array) -> Array:
-	var extensions_sorted := []
-
-	for _mod_data in ModLoaderStore.mod_load_order:
-		for script in extensions:
-			if script.mod_id == _mod_data.dir_name:
-				extensions_sorted.push_front(script)
-
-	return extensions_sorted
-
-
 # Reload all children classes of the vanilla class we just extended
 # Calling reload() the children of an extended class seems to allow them to be extended
 # e.g if B is a child class of A, reloading B after apply an extender of A allows extenders of B to properly extend B, taking A's extender(s) into account

addons/mod_loader/mod_loader.gd

@@ -333,10 +333,21 @@ func _init_mod(mod: ModData) -> void:
 		ModLoaderLog.debug("Initialized overwrite script -> %s" % mod_overwrites_path, LOG_NAME)
 
 	ModLoaderLog.debug("Loading script from -> %s" % mod_main_path, LOG_NAME)
-	var mod_main_script := ResourceLoader.load(mod_main_path)
+	var mod_main_script: GDScript = ResourceLoader.load(mod_main_path)
 	ModLoaderLog.debug("Loaded script -> %s" % mod_main_script, LOG_NAME)
 
-	var mod_main_instance: Node = mod_main_script.new(self)
+	var argument_found: bool = false
+	for method in mod_main_script.get_script_method_list():
+		if method.name == "_init":
+			if method.args.size() > 0:
+				argument_found = true
+	
+	var mod_main_instance: Node
+	if argument_found:
+		mod_main_instance = mod_main_script.new(self)
+		ModLoaderDeprecated.deprecated_message("The mod_main.gd _init argument (modLoader = ModLoader) is deprecated. Remove it from your _init to avoid crashes in the next major version.", "6.1.0")
+	else:
+		mod_main_instance = mod_main_script.new()
 	mod_main_instance.name = mod.manifest.get_mod_id()
 
 	ModLoaderStore.saved_mod_mains[mod_main_path] = mod_main_instance

addons/mod_loader/mod_loader_setup.gd

@@ -25,11 +25,6 @@ const new_global_classes := [
 		"class": "ModManifest",
 		"language": "GDScript",
 		"path": "res://addons/mod_loader/resources/mod_manifest.gd"
-	}, {
-		"base": "Resource",
-		"class": "ScriptExtensionData",
-		"language": "GDScript",
-		"path": "res://addons/mod_loader/resources/script_extension_data.gd"
 	}, {
 		"base": "Resource",
 		"class": "ModLoaderCurrentOptions",

addons/mod_loader/mod_loader_store.gd

@@ -12,7 +12,7 @@ extends Node
 # Most of these settings should never need to change, aside from the DEBUG_*
 # options (which should be `false` when distributing compiled PCKs)
 
-const MODLOADER_VERSION = "6.0.2"
+const MODLOADER_VERSION = "6.1.0"
 
 # If true, a complete array of filepaths is stored for each mod. This is
 # disabled by default because the operation can be very expensive, but may