mirror of
https://github.com/JHDev2006/Super-Mario-Bros.-Remastered-Public.git
synced 2025-10-26 09:20:49 +00:00
117 lines
4.4 KiB
GDScript
117 lines
4.4 KiB
GDScript
@tool
|
|
class_name _ModLoaderGodot
|
|
extends Object
|
|
|
|
|
|
# This Class provides methods for interacting with Godot.
|
|
# Currently all of the included methods are internal and should only be used by the mod loader itself.
|
|
|
|
const LOG_NAME := "ModLoader:Godot"
|
|
const AUTOLOAD_CONFIG_HELP_MSG := "To configure your autoloads, go to Project > Project Settings > Autoload."
|
|
|
|
const ENGINE_VERSION_HEX_4_2_2 := 0x040202
|
|
const ENGINE_VERSION_HEX_4_2_0 := 0x040200
|
|
|
|
static var engine_version_hex: int = Engine.get_version_info().hex
|
|
|
|
|
|
# Check autoload positions:
|
|
# Ensure 1st autoload is `ModLoaderStore`, and 2nd is `ModLoader`.
|
|
static func check_autoload_positions() -> void:
|
|
var override_cfg_path := _ModLoaderPath.get_override_path()
|
|
var is_override_cfg_setup := _ModLoaderFile.file_exists(override_cfg_path)
|
|
# If the override file exists we assume the ModLoader was setup with the --setup-create-override-cfg cli arg
|
|
# In that case the ModLoader will be the last entry in the autoload array
|
|
if is_override_cfg_setup:
|
|
ModLoaderLog.info("override.cfg setup detected, ModLoader will be the last autoload loaded.", LOG_NAME)
|
|
return
|
|
|
|
# If there are Autoloads that need to be before the ModLoader
|
|
# "allow_modloader_autoloads_anywhere" in the ModLoader Options can be enabled.
|
|
# With that only the correct order of, ModLoaderStore first and ModLoader second, is checked.
|
|
if ModLoaderStore.ml_options.allow_modloader_autoloads_anywhere:
|
|
is_autoload_before("ModLoaderStore", "ModLoader", true)
|
|
else:
|
|
var _pos_ml_store := check_autoload_position("ModLoaderStore", 0, true)
|
|
var _pos_ml_core := check_autoload_position("ModLoader", 1, true)
|
|
|
|
|
|
# Check if autoload_name_before is before autoload_name_after
|
|
# Returns a bool if the position does not match.
|
|
# Optionally triggers a fatal error
|
|
static func is_autoload_before(autoload_name_before: String, autoload_name_after: String, trigger_error := false) -> bool:
|
|
var autoload_name_before_index := get_autoload_index(autoload_name_before)
|
|
var autoload_name_after_index := get_autoload_index(autoload_name_after)
|
|
|
|
# Check if the Store is before the ModLoader
|
|
if not autoload_name_before_index < autoload_name_after_index:
|
|
var error_msg := (
|
|
"Expected %s ( position: %s ) to be loaded before %s ( position: %s ). "
|
|
% [autoload_name_before, autoload_name_before_index, autoload_name_after, autoload_name_after_index]
|
|
)
|
|
var help_msg := AUTOLOAD_CONFIG_HELP_MSG if OS.has_feature("editor") else ""
|
|
|
|
if trigger_error:
|
|
var final_message = error_msg + help_msg
|
|
push_error(final_message)
|
|
ModLoaderLog._write_to_log_file(final_message)
|
|
ModLoaderLog._write_to_log_file(JSON.stringify(get_stack(), " "))
|
|
assert(false, final_message)
|
|
|
|
return false
|
|
|
|
return true
|
|
|
|
|
|
# Check the index position of the provided autoload (0 = 1st, 1 = 2nd, etc).
|
|
# Returns a bool if the position does not match.
|
|
# Optionally triggers a fatal error
|
|
static func check_autoload_position(autoload_name: String, position_index: int, trigger_error := false) -> bool:
|
|
var autoload_array := get_autoload_array()
|
|
var autoload_index := autoload_array.find(autoload_name)
|
|
var position_matches := autoload_index == position_index
|
|
|
|
if not position_matches and trigger_error:
|
|
var error_msg := (
|
|
"Expected %s to be the autoload in position %s, but this is currently %s. "
|
|
% [autoload_name, str(position_index + 1), autoload_array[position_index]]
|
|
)
|
|
var help_msg := AUTOLOAD_CONFIG_HELP_MSG if OS.has_feature("editor") else ""
|
|
var final_message = error_msg + help_msg
|
|
|
|
push_error(final_message)
|
|
ModLoaderLog._write_to_log_file(final_message)
|
|
ModLoaderLog._write_to_log_file(JSON.stringify(get_stack(), " "))
|
|
assert(false, final_message)
|
|
|
|
return position_matches
|
|
|
|
|
|
# Get an array of all autoloads -> ["autoload/AutoloadName", ...]
|
|
static func get_autoload_array() -> Array:
|
|
var autoloads := []
|
|
|
|
# Get all autoload settings
|
|
for prop in ProjectSettings.get_property_list():
|
|
var name: String = prop.name
|
|
if name.begins_with("autoload/"):
|
|
autoloads.append(name.trim_prefix("autoload/"))
|
|
|
|
return autoloads
|
|
|
|
|
|
# Get the index of a specific autoload
|
|
static func get_autoload_index(autoload_name: String) -> int:
|
|
var autoloads := get_autoload_array()
|
|
var autoload_index := autoloads.find(autoload_name)
|
|
|
|
return autoload_index
|
|
|
|
|
|
static func is_version_below(version_hex: int) -> bool:
|
|
return engine_version_hex < version_hex
|
|
|
|
|
|
static func is_version_above(version_hex: int) -> bool:
|
|
return engine_version_hex > version_hex
|