sort functions and add doc comments

Author: Qubus0

addons/mod_loader/mod_data.gd

@@ -1,32 +1,41 @@
 extends Resource
 class_name ModData
 
-# These 2 files are always required by mods.
-# mod_main.gd = The main init file for the mod
-# manifest.json = Meta data for the mod, including its dependancies
+## Stores and validates all Data required to load a mod successfully
+## If some of the data is invalid, [member is_loadable] will be false
+
 const LOG_NAME := "ModLoader:ModData"
 
+## These 2 files are always required by mods.
+## [i]mod_main.gd[/i] = The main init file for the mod
+## [i]manifest.json[/i] = Meta data for the mod, including its dependencies
 enum required_mod_files {
 	MOD_MAIN,
 	MANIFEST,
 }
 
-var dir_name := "" # technically a duplicate with ModDetails
+## Directory of the mod. Has to be identical to [method ModDetails.get_mod_id]
+var dir_name := ""
+## Path to the Mod's Directory
 var dir_path := ""
+## False if any data is invalid
 var is_loadable := true
+## Is increased for every mod depending on this mod. Highest importance is loaded first
 var importance := 0
+## Contents of the manifest
 var details: ModDetails
-var config := {} # updated in _load_mod_configs
+## Updated in _load_mod_configs
+var config := {}
 
-# debug
+## only set if DEBUG_ENABLE_STORING_FILEPATHS is enabled
 var file_paths := []
 
 
 func _init(_dir_path: String) -> void:
 	dir_path = _dir_path
 
 
-# Load meta data from a mod's manifest.json file
+## Load meta data from a mod's manifest.json file
 func load_details(modLoader = ModLoader) -> void:
 	if not has_required_files():
 		return
@@ -48,9 +57,8 @@ func load_details(modLoader = ModLoader) -> void:
 	details = mod_details
 
 
+## Validates if [member dir_name] matches [method ModDetails.get_mod_id]
 func is_mod_dir_name_same_as_id() -> bool:
-	# Check that the mod ID is correct. This will fail if the mod's folder in
-	# "res://mods-unpacked" does not match its full ID, which is `namespace.name`
 	var manifest_id = details.get_mod_id()
 	if dir_name != manifest_id:
 		ModLoader.mod_log('ERROR - Mod directory name "%s" does not match the data in manifest.json. Expected "%s"' % [ dir_name, manifest_id ], LOG_NAME)
@@ -59,6 +67,7 @@ func is_mod_dir_name_same_as_id() -> bool:
 	return true
 
 
+## Confirms that all files from [member required_mod_files] exist
 func has_required_files() -> bool:
 	var file_check = File.new()
 
@@ -71,10 +80,12 @@ func has_required_files() -> bool:
 	return is_loadable
 
 
+## Validates if details are set
 func has_details() -> bool:
 	return not details == null
 
 
+## Converts enum indices [member required_mod_files] into their respective file paths
 func get_required_mod_file_path(required_file: int) -> String:
 	match required_file:
 		required_mod_files.MOD_MAIN:

addons/mod_loader/mod_details.gd

@@ -1,20 +1,32 @@
 extends Resource
+## Stores and validates contents of the manifest set by the user
 class_name ModDetails
 
+
+## Mod name.
+## Validated by [method is_name_or_namespace_valid]
 var name := ""
+## Mod namespace, most commonly the main author.
+## Validated by [method is_name_or_namespace_valid]
 var namespace := ""
-var version_number := "v0.0.0"
+## Semantic version. Not a number, but required to be named like this by Thunderstore
+## Validated by [method is_semver_valid]
+var version_number := "0.0.0"
 var description := ""
 var website_url := ""
+## Used to determine mod load order
 var dependencies := []				# Array[String]
 
 var authors := [] 					# Array[String]
+## only used for information
 var compatible_game_version := [] 	# Array[String]
+## only used for information
+var incompatibilities := [] 			# Array[String]
 var tags := [] 						# Array[String]
 var description_rich := ""
-var incompatibilities := [] 			# Array[String]
 var image: StreamTexture
 
+
 ## Required keys in a mod's manifest.json file
 const REQUIRED_MANIFEST_KEYS_ROOT = [
 	"name",
@@ -36,6 +48,8 @@ const REQUIRED_MANIFEST_KEYS_EXTRA = [
 ]
 
 
+## Takes the manifest as [Dictionary] and validates everything.
+## Will return null if something is invalid.
 func _init(manifest: Dictionary) -> void:
 	if (not dict_has_fields(manifest, REQUIRED_MANIFEST_KEYS_ROOT) or
 		not dict_has_fields(manifest.extra, ["godot"]) or
@@ -50,7 +64,6 @@ func _init(manifest: Dictionary) -> void:
 		not is_semver_valid(version_number)):
 			return
 
-
 	description = manifest.description
 	website_url = manifest.website_url
 	dependencies = manifest.dependencies
@@ -66,14 +79,21 @@ func _init(manifest: Dictionary) -> void:
 #	image StreamTexture
 
 
+## Mod ID used in the mod loader
+## Format: {namespace}-{name}
 func get_mod_id() -> String:
 	return "%s-%s" % [namespace, name]
 
 
+## Package ID used by Thunderstore
+## Format: {namespace}-{name}-{version_number}
 func get_package_id() -> String:
 	return "%s-%s-%s" % [namespace, name, version_number]
 
 
+## A valid namespace may only use letters (any case), numbers and underscores
+## and has to be longer than 3 characters
+## /^[a-zA-Z0-9_]{3,}$/
 static func is_name_or_namespace_valid(name: String) -> bool:
 	var re := RegEx.new()
 	re.compile("^[a-zA-Z0-9_]*$") # alphanumeric and _
@@ -90,29 +110,37 @@ static func is_name_or_namespace_valid(name: String) -> bool:
 	return true
 
 
-func _get_string_from_dict(dict: Dictionary, key: String) -> String:
-	if not dict.has(key):
-		return ""
-	return dict[key]
-
-
-func _get_array_from_dict(dict: Dictionary, key: String) -> Array:
-	if not dict.has(key):
-		return []
-	return dict[key]
-
-
+## A valid semantic version should follow this format: {mayor}.{minor}.{patch}
+## reference https://semver.org/ for details
+## /^[0-9]+\\.[0-9]+\\.[0-9]+$/
 static func is_semver_valid(version_number: String) -> bool:
 	var re := RegEx.new()
 	re.compile("^[0-9]+\\.[0-9]+\\.[0-9]+$")
 
 	if re.search(version_number) == null:
-		printerr('Invalid semantic version: "%s". You may only use numbers and periods in this format {mayor}.{minor}.{patch}' % version_number)
+		printerr('Invalid semantic version: "%s". ' +
+		'You may only use numbers and periods in this format {mayor}.{minor}.{patch}' % version_number)
 		return false
 
 	return true
 
 
+## Returns an empty String if the key does not exist
+static func _get_string_from_dict(dict: Dictionary, key: String) -> String:
+	if not dict.has(key):
+		return ""
+	return dict[key]
+
+
+## Returns an empty Array if the key does not exist
+static func _get_array_from_dict(dict: Dictionary, key: String) -> Array:
+	if not dict.has(key):
+		return []
+	return dict[key]
+
+
+## Works like [method Dictionary.has_all],
+## but allows for more specific errors if a field is missing
 static func dict_has_fields(dict: Dictionary, required_fields: Array) -> bool:
 	var missing_fields := required_fields