More or less standardised separator comments in the code

2025-12-08 13:44:59 +00:00 · 2024-06-27 21:21:26 +01:00
parent 225549bfce
commit 509a414f37
198 changed files with 1907 additions and 1263 deletions
--- a/Data/Scripts/020_Debug/003_Debug
+++ b/Data/Scripts/020_Debug/003_Debug
@@ -412,14 +412,23 @@ class PokemonPartyScreen
  include PokemonDebugMixin
 end

+#===============================================================================
+#
+#===============================================================================
 class PokemonStorageScreen
  include PokemonDebugMixin
 end

+#===============================================================================
+#
+#===============================================================================
 class PokemonDebugPartyScreen
  include PokemonDebugMixin
 end

+#===============================================================================
+#
+#===============================================================================
 class Battle
  include Battle::DebugMixin
 end
--- a/Data/Scripts/020_Debug/003_Debug
+++ b/Data/Scripts/020_Debug/003_Debug
@@ -1,6 +1,7 @@
 #===============================================================================
-# Field options
+# Field options.
 #===============================================================================
+
 MenuHandlers.add(:debug_menu, :field_menu, {
  "name"        => _INTL("Field options..."),
  "parent"      => :main,
@@ -264,8 +265,9 @@ MenuHandlers.add(:debug_menu, :skip_credits, {
 })

 #===============================================================================
-# Battle options
+# Battle options.
 #===============================================================================
+
 MenuHandlers.add(:debug_menu, :battle_menu, {
  "name"        => _INTL("Battle options..."),
  "parent"      => :main,
@@ -543,8 +545,9 @@ MenuHandlers.add(:debug_menu, :toggle_logging, {
 })

 #===============================================================================
-# Pokémon options
+# Pokémon options.
 #===============================================================================
+
 MenuHandlers.add(:debug_menu, :pokemon_menu, {
  "name"        => _INTL("Pokémon options..."),
  "parent"      => :main,
@@ -716,8 +719,9 @@ MenuHandlers.add(:debug_menu, :open_storage, {
 })

 #===============================================================================
-# Shadow Pokémon options
+# Shadow Pokémon options.
 #===============================================================================
+
 MenuHandlers.add(:debug_menu, :shadow_pokemon_menu, {
  "name"        => _INTL("Shadow Pokémon options..."),
  "parent"      => :pokemon_menu,
@@ -766,8 +770,9 @@ MenuHandlers.add(:debug_menu, :relic_stone, {
 })

 #===============================================================================
-# Item options
+# Item options.
 #===============================================================================
+
 MenuHandlers.add(:debug_menu, :items_menu, {
  "name"        => _INTL("Item options..."),
  "parent"      => :main,
@@ -837,8 +842,9 @@ MenuHandlers.add(:debug_menu, :empty_bag, {
 })

 #===============================================================================
-# Player options
+# Player options.
 #===============================================================================
+
 MenuHandlers.add(:debug_menu, :player_menu, {
  "name"        => _INTL("Player options..."),
  "parent"      => :main,
@@ -1143,8 +1149,9 @@ MenuHandlers.add(:debug_menu, :random_id, {
 })

 #===============================================================================
-# PBS file editors
+# PBS file editors.
 #===============================================================================
+
 MenuHandlers.add(:debug_menu, :pbs_editors_menu, {
  "name"        => _INTL("PBS file editors..."),
  "parent"      => :main,
@@ -1261,8 +1268,9 @@ MenuHandlers.add(:debug_menu, :set_pokedex_lists, {
 })

 #===============================================================================
-# Other editors
+# Other editors.
 #===============================================================================
+
 MenuHandlers.add(:debug_menu, :editors_menu, {
  "name"        => _INTL("Other editors..."),
  "parent"      => :main,
@@ -1324,8 +1332,9 @@ MenuHandlers.add(:debug_menu, :fix_invalid_tiles, {
 })

 #===============================================================================
-# Other options
+# Other options.
 #===============================================================================
+
 MenuHandlers.add(:debug_menu, :files_menu, {
  "name"        => _INTL("Files options..."),
  "parent"      => :main,
--- a/menus/003_Debug_MenuExtraCode.rb
+++ b/menus/003_Debug_MenuExtraCode.rb
@@ -39,7 +39,7 @@ def pbWarpToMap
 end

 #===============================================================================
-# Debug Variables screen
+# Debug Variables screen.
 #===============================================================================
 class SpriteWindow_DebugVariables < Window_DrawableCommand
  attr_reader :mode
@@ -227,7 +227,7 @@ def pbDebugVariables(mode)
 end

 #===============================================================================
-# Debug Day Care screen
+# Debug Day Care screen.
 #===============================================================================
 def pbDebugDayCare
  day_care = $PokemonGlobal.day_care
@@ -376,7 +376,7 @@ def pbDebugDayCare
 end

 #===============================================================================
-# Debug roaming Pokémon screen
+# Debug roaming Pokémon screen.
 #===============================================================================
 class SpriteWindow_DebugRoamers < Window_DrawableCommand
  def initialize(viewport)
@@ -548,7 +548,7 @@ def pbDebugRoamers
 end

 #===============================================================================
-# Battle animations import/export
+# Battle animations import/export.
 #===============================================================================
 def pbExportAllAnimations
  begin
@@ -663,7 +663,7 @@ def pbImportAllAnimations
 end

 #===============================================================================
-# Properly erases all non-existent tiles in maps (including event graphics)
+# Properly erases all non-existent tiles in maps (including event graphics).
 #===============================================================================
 def pbDebugFixInvalidTiles
  total_errors = 0
@@ -739,7 +739,7 @@ def pbCheckTileValidity(tile_id, map, tilesets, passages)
 end

 #===============================================================================
-# Pseudo-party screen for editing Pokémon being set up for a wild battle
+# Pseudo-party screen for editing Pokémon being set up for a wild battle.
 #===============================================================================
 class PokemonDebugPartyScreen
  def initialize
--- a/menus/004_Debug_BattleCommands.rb
+++ b/menus/004_Debug_BattleCommands.rb
@@ -1,6 +1,7 @@
 #===============================================================================
-# Battler Options
+# Battler options.
 #===============================================================================
+
 MenuHandlers.add(:battle_debug_menu, :battlers, {
  "name"        => _INTL("Battlers..."),
  "parent"      => :main,
@@ -71,8 +72,9 @@ MenuHandlers.add(:battle_debug_menu, :speed_order, {
 })

 #===============================================================================
-# Pokémon
+# Pokémon.
 #===============================================================================
+
 MenuHandlers.add(:battle_debug_menu, :pokemon_teams, {
  "name"        => _INTL("Pokémon teams"),
  "parent"      => :main,
@@ -130,8 +132,9 @@ MenuHandlers.add(:battle_debug_menu, :pokemon_teams, {
 })

 #===============================================================================
-# Trainer Options
+# Trainer options.
 #===============================================================================
+
 MenuHandlers.add(:battle_debug_menu, :trainers, {
  "name"        => _INTL("Trainer options..."),
  "parent"      => :main,
@@ -226,8 +229,9 @@ MenuHandlers.add(:battle_debug_menu, :mega_evolution, {
 })

 #===============================================================================
-# Field Options
+# Field options.
 #===============================================================================
+
 MenuHandlers.add(:battle_debug_menu, :field, {
  "name"        => _INTL("Field effects..."),
  "parent"      => :main,
--- a/menus/005_Debug_BattlePkmnCommands.rb
+++ b/menus/005_Debug_BattlePkmnCommands.rb
@@ -1,6 +1,7 @@
 #===============================================================================
-# HP/Status options
+# HP/Status options.
 #===============================================================================
+
 MenuHandlers.add(:battle_pokemon_debug_menu, :hp_status_menu, {
  "name"   => _INTL("HP/status..."),
  "parent" => :main,
@@ -129,8 +130,9 @@ MenuHandlers.add(:battle_pokemon_debug_menu, :full_heal, {
 })

 #===============================================================================
-# Level/stats options
+# Level/stats options.
 #===============================================================================
+
 MenuHandlers.add(:battle_pokemon_debug_menu, :level_stats, {
  "name"   => _INTL("Stats/level..."),
  "parent" => :main,
@@ -408,8 +410,9 @@ MenuHandlers.add(:battle_pokemon_debug_menu, :set_happiness, {
 })

 #===============================================================================
-# Types
+# Types.
 #===============================================================================
+
 MenuHandlers.add(:battle_pokemon_debug_menu, :set_types, {
  "name"   => _INTL("Set types"),
  "parent" => :main,
@@ -457,8 +460,9 @@ MenuHandlers.add(:battle_pokemon_debug_menu, :set_types, {
 })

 #===============================================================================
-# Moves options
+# Moves options.
 #===============================================================================
+
 MenuHandlers.add(:battle_pokemon_debug_menu, :moves, {
  "name"   => _INTL("Moves..."),
  "parent" => :main,
@@ -600,8 +604,9 @@ MenuHandlers.add(:battle_pokemon_debug_menu, :reset_moves, {
 })

 #===============================================================================
-# Other options
+# Other options.
 #===============================================================================
+
 MenuHandlers.add(:battle_pokemon_debug_menu, :set_item, {
  "name"   => _INTL("Set item"),
  "parent" => :main,
--- a/menus/007_Debug_PokemonCommands.rb
+++ b/menus/007_Debug_PokemonCommands.rb
@@ -1,6 +1,7 @@
 #===============================================================================
-# HP/Status options
+# HP/Status options.
 #===============================================================================
+
 MenuHandlers.add(:pokemon_debug_menu, :hp_status_menu, {
  "name"   => _INTL("HP/status..."),
  "parent" => :main
@@ -146,8 +147,9 @@ MenuHandlers.add(:pokemon_debug_menu, :set_pokerus, {
 })

 #===============================================================================
-# Level/stats options
+# Level/stats options.
 #===============================================================================
+
 MenuHandlers.add(:pokemon_debug_menu, :level_stats, {
  "name"   => _INTL("Level/stats..."),
  "parent" => :main
@@ -450,8 +452,9 @@ MenuHandlers.add(:pokemon_debug_menu, :set_sheen, {
 })

 #===============================================================================
-# Moves options
+# Moves options.
 #===============================================================================
+
 MenuHandlers.add(:pokemon_debug_menu, :moves, {
  "name"   => _INTL("Moves..."),
  "parent" => :main
@@ -571,8 +574,9 @@ MenuHandlers.add(:pokemon_debug_menu, :set_initial_moves, {
 })

 #===============================================================================
-# Other options
+# Other options.
 #===============================================================================
+
 MenuHandlers.add(:pokemon_debug_menu, :set_item, {
  "name"   => _INTL("Set item"),
  "parent" => :main,
@@ -802,8 +806,9 @@ MenuHandlers.add(:pokemon_debug_menu, :species_and_form, {
 })

 #===============================================================================
-# Cosmetic options
+# Cosmetic options.
 #===============================================================================
+
 MenuHandlers.add(:pokemon_debug_menu, :cosmetic, {
  "name"   => _INTL("Cosmetic info..."),
  "parent" => :main
@@ -973,8 +978,9 @@ MenuHandlers.add(:pokemon_debug_menu, :ownership, {
 })

 #===============================================================================
-# Can store/release/trade
+# Can store/release/trade.
 #===============================================================================
+
 MenuHandlers.add(:pokemon_debug_menu, :set_discardable, {
  "name"   => _INTL("Set discardable"),
  "parent" => :main,
@@ -1002,8 +1008,9 @@ MenuHandlers.add(:pokemon_debug_menu, :set_discardable, {
 })

 #===============================================================================
-# Other options
+# Other options.
 #===============================================================================
+
 MenuHandlers.add(:pokemon_debug_menu, :set_egg, {
  "name"        => _INTL("Set egg"),
  "parent"      => :main,