Comments

sources/minigames/base/base_minigame.gd

@@ -14,6 +14,9 @@ var stimuli: = {}
 var distractions: = {}
 
 
+# ------------ Initialisation ------------
+
+
 func _ready() -> void:
 	_find_stimuli_and_distractions()
 	
@@ -28,6 +31,9 @@ func _start() -> void:
 	return
 
 
+# ------------ Logs ------------
+
+
 func _save_logs() -> void:
 	LessonLogger.save_logs(logs, GameGlobals.teacher_id, GameGlobals.user_id, minigame_name, lesson, Time.get_time_string_from_system())
 	
@@ -38,7 +44,10 @@ func _reset_logs() -> void:
 	logs = {}
 
 
-func _back_to_the_garden() -> void:
+# ------------ UI ------------
+
+
+func _go_back_to_the_garden() -> void:
 	return
 
 
@@ -54,11 +63,8 @@ func _play_kalulu() -> void:
 	return
 
 
-# ------------ UI ------------
-
-
 func _on_minigame_ui_garden_button_pressed() -> void:
-	_back_to_the_garden()
+	_go_back_to_the_garden()
 
 
 func _on_minigame_ui_stimulus_button_pressed() -> void:

sources/minigames/base/minigame_ui.gd

@@ -6,6 +6,7 @@ signal stimulus_button_pressed
 signal pause_button_pressed
 signal kalulu_button_pressed
 
+# Using unique names to avoid changing the path if the interface architecture changes
 @onready var garden_button: TextureButton = get_node("%GardenButton")
 @onready var stimulus_button: TextureButton = get_node("%StimulusButton")
 @onready var pause_button: TextureButton = get_node("%PauseButton")
@@ -16,11 +17,13 @@ signal kalulu_button_pressed
 @onready var progression_empty_icons_rect: TextureRect = get_node("%ProgressionEmptyIconsRect")
 @onready var progression_full_icons_rect: TextureRect = get_node("%ProgressionFullIconsRect")
 
+# Lives management
 var max_number_of_lives: = 1
 var number_of_lives: = 1
 var empty_life_size: = 0.0
 var life_size: = 0.0
 
+# Progression management
 var max_progression: = 1
 var current_progression: = 1
 var progression_gauge_unit_size: = 0.0
@@ -28,6 +31,9 @@ var progression_empty_icon_size: = 0.0
 var progression_full_icon_size: = 0.0
 
 
+# ------------ Initialisation ------------
+
+
 func _ready() -> void:
 	empty_life_size = empty_lives_rect.custom_minimum_size.x
 	life_size = lives_rect.custom_minimum_size.x
@@ -37,6 +43,9 @@ func _ready() -> void:
 	progression_full_icon_size = progression_full_icons_rect.custom_minimum_size.y
 
 
+# ------------ Lock/Unlock ------------
+
+
 func lock() -> void:
 	garden_button.disabled = true
 	stimulus_button.disabled = true
@@ -51,6 +60,9 @@ func unlock() -> void:
 	Kalulu_button.disabled = false
 
 
+# ------------ Lives ------------
+
+
 func set_maximum_number_of_lives(new_max_number_of_lives: int) -> void:
 	max_number_of_lives = number_of_lives
 	
@@ -66,6 +78,9 @@ func set_number_of_lives(new_number_of_lives: int) -> void:
 	lives_rect.custom_minimum_size.x = new_number_of_lives * life_size
 
 
+# ------------ Progression ------------
+
+
 func set_max_progression(new_max_progression: int) -> void:
 	max_progression = new_max_progression
 	
@@ -82,6 +97,9 @@ func set_current_progression(new_current_progression: int) -> void:
 	progression_full_icons_rect.custom_minimum_size.y = new_current_progression * progression_full_icon_size
 
 
+# ------------ Actions ------------
+
+
 func _on_garden_button_pressed() -> void:
 	garden_button_pressed.emit()
 

sources/utils/autoloads/game_globals.gd

@@ -1,9 +1,13 @@
 extends Node
 class_name GameGlobalData
 
+# Language specifics
 var language: = "French"
+
+# User
 var teacher_id: = ""
 var user_id: = ""
 
+# Difficulty
 var minigame_difficulty: = 0
 var lesson_difficulty: = 0

sources/utils/autoloads/lesson_logger.gd

@@ -3,6 +3,7 @@ class_name Logger
 
 const log_resource_class: = preload("res://sources/utils/minigame_resources/log.gd")
 
+# Contains the current log resource
 var log_resources: = {}