nett00n/skelly
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Comments and documentation update

Browse Source
This commit is contained in:
Vladimir nett00n Budylnikov
2025-09-27 21:00:45 +04:00
parent 821d9aa42c
commit 0cf76d595f
4 changed files with 102 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
src/autoloads/DebugManager.gd
View File

@@ -1,3 +1,9 @@
## Debug Manager - Global Debug and Logging System
##
## Provides centralized debug functionality and structured logging for the Skelly project.
## Manages debug state, overlay visibility, and log levels with formatted output.
## Replaces direct print() and push_error() calls with structured logging system.
extends Node
signal debug_toggled(enabled: bool)
@@ -9,52 +15,63 @@ var debug_overlay_visible: bool = false
var current_log_level: LogLevel = LogLevel.INFO
func _ready():
func _ready() -> void:
"""Initialize the DebugManager on game startup"""
log_info("DebugManager loaded")
func toggle_debug():
func toggle_debug() -> void:
"""Toggle debug mode on/off and emit signal to connected systems"""
debug_enabled = !debug_enabled
debug_toggled.emit(debug_enabled)
log_info("Debug mode: " + ("ON" if debug_enabled else "OFF"))
func set_debug_enabled(enabled: bool):
func set_debug_enabled(enabled: bool) -> void:
"""Set debug mode to specific state without toggling"""
if debug_enabled != enabled:
debug_enabled = enabled
debug_toggled.emit(debug_enabled)
func is_debug_enabled() -> bool:
"""Check if debug mode is currently enabled"""
return debug_enabled
func toggle_overlay():
func toggle_overlay() -> void:
"""Toggle debug overlay visibility"""
debug_overlay_visible = !debug_overlay_visible
func set_overlay_visible(visible: bool):
func set_overlay_visible(visible: bool) -> void:
"""Set debug overlay visibility to specific state"""
debug_overlay_visible = visible
func is_overlay_visible() -> bool:
"""Check if debug overlay is currently visible"""
return debug_overlay_visible
func set_log_level(level: LogLevel):
func set_log_level(level: LogLevel) -> void:
"""Set minimum log level for output filtering"""
current_log_level = level
log_info("Log level set to: " + _log_level_to_string(level))
func get_log_level() -> LogLevel:
"""Get current minimum log level"""
return current_log_level
func _should_log(level: LogLevel) -> bool:
"""Determine if message should be logged based on current log level"""
return level >= current_log_level
func _log_level_to_string(level: LogLevel) -> String:
"""Convert LogLevel enum to string representation"""
match level:
LogLevel.TRACE:
return "TRACE"
@@ -73,47 +90,54 @@ func _log_level_to_string(level: LogLevel) -> String:
func _format_log_message(level: LogLevel, message: String, category: String = "") -> String:
"""Format log message with timestamp, level, category, and content"""
var timestamp = Time.get_datetime_string_from_system()
var level_str = _log_level_to_string(level)
var category_str = (" [" + category + "]") if category != "" else ""
return "[%s] %s%s: %s" % [timestamp, level_str, category_str, message]
func log_trace(message: String, category: String = ""):
func log_trace(message: String, category: String = "") -> void:
"""Log trace-level message (lowest priority, only shown in debug mode)"""
if _should_log(LogLevel.TRACE):
var formatted = _format_log_message(LogLevel.TRACE, message, category)
if debug_enabled:
print(formatted)
func log_debug(message: String, category: String = ""):
func log_debug(message: String, category: String = "") -> void:
"""Log debug-level message (development information, only shown in debug mode)"""
if _should_log(LogLevel.DEBUG):
var formatted = _format_log_message(LogLevel.DEBUG, message, category)
if debug_enabled:
print(formatted)
func log_info(message: String, category: String = ""):
func log_info(message: String, category: String = "") -> void:
"""Log info-level message (general information, always shown)"""
if _should_log(LogLevel.INFO):
var formatted = _format_log_message(LogLevel.INFO, message, category)
print(formatted)
func log_warn(message: String, category: String = ""):
func log_warn(message: String, category: String = "") -> void:
"""Log warning-level message (potential issues that don't break functionality)"""
if _should_log(LogLevel.WARN):
var formatted = _format_log_message(LogLevel.WARN, message, category)
print(formatted)
push_warning(formatted)
func log_error(message: String, category: String = ""):
func log_error(message: String, category: String = "") -> void:
"""Log error-level message (serious issues that may break functionality)"""
if _should_log(LogLevel.ERROR):
var formatted = _format_log_message(LogLevel.ERROR, message, category)
print(formatted)
push_error(formatted)
func log_fatal(message: String, category: String = ""):
func log_fatal(message: String, category: String = "") -> void:
"""Log fatal-level message (critical errors that prevent normal operation)"""
if _should_log(LogLevel.FATAL):
var formatted = _format_log_message(LogLevel.FATAL, message, category)
print(formatted)

19
src/autoloads/GameManager.gd
View File

@@ -1,3 +1,9 @@
## Game Manager - Centralized Scene Transition System
##
## Manages all scene transitions with race condition protection and input validation.
## Provides safe scene switching for different gameplay modes with error handling.
## Never call get_tree().change_scene_to_file() directly - use GameManager methods.
extends Node
const GAME_SCENE_PATH := "res://scenes/game/game.tscn"
@@ -8,26 +14,31 @@ var is_changing_scene: bool = false
func start_new_game() -> void:
"""Start a new match-3 game with fresh save data"""
SaveManager.start_new_game()
start_game_with_mode("match3")
func continue_game() -> void:
"""Continue existing match-3 game with saved score intact"""
# Don't reset score
start_game_with_mode("match3")
func start_match3_game() -> void:
"""Start new match-3 gameplay mode"""
SaveManager.start_new_game()
start_game_with_mode("match3")
func start_clickomania_game() -> void:
"""Start new clickomania gameplay mode"""
SaveManager.start_new_game()
start_game_with_mode("clickomania")
func start_game_with_mode(gameplay_mode: String) -> void:
"""Load game scene with specified gameplay mode and safety validation"""
# Input validation
if not gameplay_mode or gameplay_mode.is_empty():
DebugManager.log_error("Empty or null gameplay mode provided", "GameManager")
@@ -39,7 +50,7 @@ func start_game_with_mode(gameplay_mode: String) -> void:
)
return
# Prevent concurrent scene changes
# Prevent concurrent scene changes (race condition protection)
if is_changing_scene:
DebugManager.log_warn("Scene change already in progress, ignoring request", "GameManager")
return
@@ -72,7 +83,7 @@ func start_game_with_mode(gameplay_mode: String) -> void:
# Wait for scene instantiation and tree addition
await get_tree().process_frame
await get_tree().process_frame # Additional frame for complete initialization
await get_tree().process_frame # Additional frame ensures complete initialization
# Validate scene was loaded successfully
if not get_tree().current_scene:
@@ -80,7 +91,7 @@ func start_game_with_mode(gameplay_mode: String) -> void:
is_changing_scene = false
return
# Set gameplay mode with timeout protection
# Configure game scene with requested gameplay mode
if get_tree().current_scene.has_method("set_gameplay_mode"):
DebugManager.log_info("Setting gameplay mode to: %s" % pending_gameplay_mode, "GameManager")
get_tree().current_scene.set_gameplay_mode(pending_gameplay_mode)
@@ -97,6 +108,7 @@ func start_game_with_mode(gameplay_mode: String) -> void:
func save_game() -> void:
"""Save current game state and score via SaveManager"""
# Get current score from the active game scene
var current_score = 0
if get_tree().current_scene and get_tree().current_scene.has_method("get_global_score"):
@@ -107,6 +119,7 @@ func save_game() -> void:
func exit_to_main_menu() -> void:
"""Exit to main menu with race condition protection"""
# Prevent concurrent scene changes
if is_changing_scene:
DebugManager.log_warn(

11
src/autoloads/SaveManager.gd
View File

@@ -1,3 +1,9 @@
## Save Manager - Secure Game Data Persistence System
##
## Provides secure save/load functionality with tamper detection, race condition protection,
## and permissive validation. Features backup/restore, version migration, and data integrity.
## Implements multi-layered security: checksums, size limits, type validation, and bounds checking.
extends Node
const SAVE_FILE_PATH: String = "user://savegame.save"
@@ -8,7 +14,7 @@ const MAX_SCORE: int = 999999999
const MAX_GAMES_PLAYED: int = 100000
const MAX_FILE_SIZE: int = 1048576 # 1MB limit
# Save operation protection
# Save operation protection - prevents race conditions
var _save_in_progress: bool = false
var _restore_in_progress: bool = false
@@ -28,10 +34,12 @@ var game_data: Dictionary = {
func _ready() -> void:
"""Initialize SaveManager and load existing save data on startup"""
load_game()
func save_game() -> bool:
"""Save current game data with race condition protection and error handling"""
# Prevent concurrent saves
if _save_in_progress:
DebugManager.log_warn("Save already in progress, skipping", "SaveManager")
@@ -82,6 +90,7 @@ func _perform_save() -> bool:
func load_game() -> void:
"""Load game data from disk with comprehensive validation and error recovery"""
if not FileAccess.file_exists(SAVE_FILE_PATH):
DebugManager.log_info("No save file found, using defaults", "SaveManager")
return