shithub: pokecrystal

Download patch

ref: abf3858fc4bc317f8cd43e04b46d5a11d14927de
parent: 5f197c53f47e19b860df7c92bd1971f2a73f1156
author: Rangi <remy.oukaour+rangi42@gmail.com>
date: Sat May 9 16:07:01 EDT 2020

Update some comments

--- a/constants/event_flags.asm
+++ b/constants/event_flags.asm
@@ -1,7 +1,7 @@
 ; wEventFlags bit flags
 	const_def
 ; The first eight flags are reset upon reloading the map
-	const EVENT_TEMPORARY_UNTIL_MAP_RELOAD_1 ; 000
+	const EVENT_TEMPORARY_UNTIL_MAP_RELOAD_1
 	const EVENT_TEMPORARY_UNTIL_MAP_RELOAD_2
 	const EVENT_TEMPORARY_UNTIL_MAP_RELOAD_3
 	const EVENT_TEMPORARY_UNTIL_MAP_RELOAD_4
@@ -25,7 +25,7 @@
 	const EVENT_GOT_HM04_STRENGTH
 	const EVENT_GOT_HM05_FLASH
 	const EVENT_GOT_HM06_WHIRLPOOL
-	const EVENT_016
+	const EVENT_016 ; unused
 ; Rods
 	const EVENT_GOT_OLD_ROD
 	const EVENT_GOT_GOOD_ROD
@@ -64,12 +64,12 @@
 	const EVENT_LAKE_OF_RAGE_EXPLAINED_WEIRD_MAGIKARP
 	const EVENT_LAKE_OF_RAGE_ASKED_FOR_MAGIKARP
 	const EVENT_LAKE_OF_RAGE_ELIXIR_ON_STANDBY
-	const EVENT_03B
-	const EVENT_03C
+	const EVENT_03B ; unused
+	const EVENT_03C ; unused
 	const EVENT_HEALED_MOOMOO
 	const EVENT_GOT_TM13_SNORE_FROM_MOOMOO_FARM
 	const EVENT_TALKED_TO_FARMER_ABOUT_MOOMOO
-	const EVENT_TALKED_TO_MOM_AFTER_MYSTERY_EGG_QUEST ; 040
+	const EVENT_TALKED_TO_MOM_AFTER_MYSTERY_EGG_QUEST
 	const EVENT_DUDE_TALKED_TO_YOU
 	const EVENT_LEARNED_TO_CATCH_POKEMON
 	const EVENT_ELM_CALLED_ABOUT_STOLEN_POKEMON
@@ -85,7 +85,7 @@
 	const EVENT_GOT_MYSTIC_WATER_IN_CHERRYGROVE
 	const EVENT_GOT_TM05_ROAR
 	const EVENT_GOT_EEVEE
-	const EVENT_GOT_KENYA ; 050
+	const EVENT_GOT_KENYA
 	const EVENT_GAVE_KENYA
 	const EVENT_GOT_HP_UP_FROM_RANDY
 	const EVENT_GOT_TM50_NIGHTMARE
@@ -101,7 +101,7 @@
 	const EVENT_GOT_MIRACLE_SEED_IN_ROUTE_32
 	const EVENT_GOT_CHARCOAL_IN_CHARCOAL_KILN
 	const EVENT_GOT_TM02_HEADBUTT
-	const EVENT_DECIDED_TO_HELP_LANCE ; 060
+	const EVENT_DECIDED_TO_HELP_LANCE
 	const EVENT_GOT_TYROGUE_FROM_KIYO
 	const EVENT_MET_FRIEDA_OF_FRIDAY
 	const EVENT_GOT_POISON_BARB_FROM_FRIEDA
@@ -116,7 +116,7 @@
 	const EVENT_MET_SANTOS_OF_SATURDAY
 	const EVENT_GOT_SPELL_TAG_FROM_SANTOS
 	const EVENT_MET_MONICA_OF_MONDAY
-	const EVENT_GOT_SHARP_BEAK_FROM_MONICA ; 070
+	const EVENT_GOT_SHARP_BEAK_FROM_MONICA
 	const EVENT_GOT_SOFT_SAND_FROM_KATE
 	const EVENT_GOT_METAL_COAT_FROM_GRANDPA_ON_SS_AQUA
 	const EVENT_GOT_BLACKGLASSES_IN_DARK_CAVE
@@ -134,10 +134,10 @@
 	const EVENT_TIN_TOWER_4F_HIDDEN_MAX_POTION
 	const EVENT_TIN_TOWER_5F_HIDDEN_FULL_RESTORE
 	const EVENT_TIN_TOWER_5F_HIDDEN_CARBOS
-	const EVENT_BURNED_TOWER_1F_HIDDEN_ETHER ; 080
-	const EVENT_081
-	const EVENT_082
-	const EVENT_083
+	const EVENT_BURNED_TOWER_1F_HIDDEN_ETHER
+	const EVENT_081 ; unused
+	const EVENT_082 ; unused
+	const EVENT_083 ; unused
 	const EVENT_NATIONAL_PARK_HIDDEN_FULL_HEAL
 	const EVENT_OLIVINE_LIGHTHOUSE_5F_HIDDEN_HYPER_POTION
 	const EVENT_TEAM_ROCKET_BASE_B1F_HIDDEN_REVIVE
@@ -201,6 +201,7 @@
 	const EVENT_GAVE_GS_BALL_TO_KURT
 	const EVENT_FOREST_IS_RESTLESS
 	const EVENT_ANSWERED_DRAGON_MASTER_QUIZ_WRONG
+; Unused
 	const EVENT_0C2
 	const EVENT_0C3
 	const EVENT_0C4
@@ -270,7 +271,7 @@
 	const EVENT_DANA_GAVE_THUNDERSTONE
 	const EVENT_TULLY_GAVE_WATER_STONE
 	const EVENT_TIFFANY_GAVE_PINK_BOW
-; ???
+; Unused
 	const EVENT_105
 	const EVENT_106
 	const EVENT_107
@@ -632,60 +633,60 @@
 	const EVENT_GOT_CALCIUM_FROM_ERIN
 	const EVENT_KENJI_ON_BREAK
 	const EVENT_GAVEN_ASKED_FOR_PHONE_NUMBER
-	const EVENT_26C
+	const EVENT_26C ; unused
 	const EVENT_BETH_ASKED_FOR_PHONE_NUMBER
-	const EVENT_26E
+	const EVENT_26E ; unused
 	const EVENT_JOSE_ASKED_FOR_PHONE_NUMBER
-	const EVENT_270
+	const EVENT_270 ; unused
 	const EVENT_REENA_ASKED_FOR_PHONE_NUMBER
-	const EVENT_272
+	const EVENT_272 ; unused
 	const EVENT_JOEY_ASKED_FOR_PHONE_NUMBER
-	const EVENT_274
+	const EVENT_274 ; unused
 	const EVENT_WADE_ASKED_FOR_PHONE_NUMBER
-	const EVENT_276
+	const EVENT_276 ; unused
 	const EVENT_RALPH_ASKED_FOR_PHONE_NUMBER
-	const EVENT_278
+	const EVENT_278 ; unused
 	const EVENT_LIZ_ASKED_FOR_PHONE_NUMBER
-	const EVENT_27A
+	const EVENT_27A ; unused
 	const EVENT_ANTHONY_ASKED_FOR_PHONE_NUMBER
-	const EVENT_27C
+	const EVENT_27C ; unused
 	const EVENT_TODD_ASKED_FOR_PHONE_NUMBER
-	const EVENT_27E
+	const EVENT_27E ; unused
 	const EVENT_GINA_ASKED_FOR_PHONE_NUMBER
-	const EVENT_280 ; 280
+	const EVENT_280 ; 280 ; unused
 	const EVENT_IRWIN_ASKED_FOR_PHONE_NUMBER
-	const EVENT_282
+	const EVENT_282 ; unused
 	const EVENT_ARNIE_ASKED_FOR_PHONE_NUMBER
-	const EVENT_284
+	const EVENT_284 ; unused
 	const EVENT_ALAN_ASKED_FOR_PHONE_NUMBER
-	const EVENT_286
-	const EVENT_287
-	const EVENT_288
+	const EVENT_286 ; unused
+	const EVENT_287 ; unused
+	const EVENT_288 ; unused
 	const EVENT_DANA_ASKED_FOR_PHONE_NUMBER
-	const EVENT_28A
+	const EVENT_28A ; unused
 	const EVENT_CHAD_ASKED_FOR_PHONE_NUMBER
-	const EVENT_28C
+	const EVENT_28C ; unused
 	const EVENT_DEREK_ASKED_FOR_PHONE_NUMBER
-	const EVENT_28E
+	const EVENT_28E ; unused
 	const EVENT_TULLY_ASKED_FOR_PHONE_NUMBER
-	const EVENT_290 ; 290
+	const EVENT_290 ; 290 ; unused
 	const EVENT_BRENT_ASKED_FOR_PHONE_NUMBER
-	const EVENT_292
+	const EVENT_292 ; unused
 	const EVENT_TIFFANY_ASKED_FOR_PHONE_NUMBER
-	const EVENT_294
+	const EVENT_294 ; unused
 	const EVENT_VANCE_ASKED_FOR_PHONE_NUMBER
-	const EVENT_296
+	const EVENT_296 ; unused
 	const EVENT_WILTON_ASKED_FOR_PHONE_NUMBER
-	const EVENT_298
+	const EVENT_298 ; unused
 	const EVENT_KENJI_ASKED_FOR_PHONE_NUMBER
-	const EVENT_29A
+	const EVENT_29A ; unused
 	const EVENT_PARRY_ASKED_FOR_PHONE_NUMBER
-	const EVENT_29C
+	const EVENT_29C ; unused
 	const EVENT_ERIN_ASKED_FOR_PHONE_NUMBER
 	const EVENT_BUENA_OFFERED_HER_PHONE_NUMBER_NO_BLUE_CARD
-	const EVENT_29F
+	const EVENT_29F ; unused
 ; Ruins of Alph puzzles
-	const EVENT_SOLVED_HO_OH_PUZZLE ; 2a0
+	const EVENT_SOLVED_HO_OH_PUZZLE
 	const EVENT_SOLVED_KABUTO_PUZZLE
 	const EVENT_SOLVED_OMANYTE_PUZZLE
 	const EVENT_SOLVED_AERODACTYL_PUZZLE
@@ -702,7 +703,7 @@
 	const EVENT_DECO_PLANT_2
 	const EVENT_DECO_PLANT_3
 	const EVENT_DECO_POSTER_1
-	const EVENT_DECO_POSTER_2 ; 2b0
+	const EVENT_DECO_POSTER_2
 	const EVENT_DECO_POSTER_3
 	const EVENT_DECO_POSTER_4
 	const EVENT_DECO_FAMICOM
@@ -718,7 +719,7 @@
 	const EVENT_DECO_SQUIRTLE_DOLL
 	const EVENT_DECO_POLIWAG_DOLL
 	const EVENT_DECO_DIGLETT_DOLL
-	const EVENT_DECO_STARMIE_DOLL ; 2c0
+	const EVENT_DECO_STARMIE_DOLL
 	const EVENT_DECO_MAGIKARP_DOLL
 	const EVENT_DECO_ODDISH_DOLL
 	const EVENT_DECO_GENGAR_DOLL
@@ -734,7 +735,7 @@
 	const EVENT_DECO_GOLD_TROPHY
 	const EVENT_DECO_SILVER_TROPHY
 	const EVENT_DECO_BIG_SNORLAX_DOLL
-	const EVENT_DECO_BIG_ONIX_DOLL ; 2d0
+	const EVENT_DECO_BIG_ONIX_DOLL
 	const EVENT_DECO_BIG_LAPRAS_DOLL
 ; More Johto story events
 	const EVENT_WARPED_FROM_ROUTE_35_NATIONAL_PARK_GATE
@@ -751,7 +752,7 @@
 	const EVENT_SWITCH_10
 	const EVENT_SWITCH_11
 	const EVENT_SWITCH_12
-	const EVENT_SWITCH_13 ; 2e0
+	const EVENT_SWITCH_13
 	const EVENT_SWITCH_14
 	const EVENT_UNCOVERED_STAIRCASE_IN_MAHOGANY_MART
 	const EVENT_TURNED_OFF_SECURITY_CAMERAS
@@ -767,7 +768,7 @@
 	const EVENT_EXPLODING_TRAP_5
 	const EVENT_EXPLODING_TRAP_6
 	const EVENT_EXPLODING_TRAP_7
-	const EVENT_EXPLODING_TRAP_8 ; 2f0
+	const EVENT_EXPLODING_TRAP_8
 	const EVENT_EXPLODING_TRAP_9
 	const EVENT_EXPLODING_TRAP_10
 	const EVENT_EXPLODING_TRAP_11
@@ -783,7 +784,7 @@
 	const EVENT_EXPLODING_TRAP_21
 	const EVENT_EXPLODING_TRAP_22
 	const EVENT_LEARNED_HAIL_GIOVANNI
-	const EVENT_OPENED_DOOR_TO_ROCKET_HIDEOUT_TRANSMITTER ; 300
+	const EVENT_OPENED_DOOR_TO_ROCKET_HIDEOUT_TRANSMITTER
 	const EVENT_LEARNED_SLOWPOKETAIL
 	const EVENT_LEARNED_RATICATE_TAIL
 	const EVENT_OPENED_DOOR_TO_GIOVANNIS_OFFICE
@@ -799,7 +800,7 @@
 	const EVENT_BRUNOS_ROOM_ENTRANCE_CLOSED
 	const EVENT_BRUNOS_ROOM_EXIT_OPEN
 	const EVENT_KARENS_ROOM_ENTRANCE_CLOSED
-	const EVENT_KARENS_ROOM_EXIT_OPEN ; 310
+	const EVENT_KARENS_ROOM_EXIT_OPEN
 	const EVENT_LANCES_ROOM_ENTRANCE_CLOSED
 	const EVENT_LANCES_ROOM_EXIT_OPEN
 	const EVENT_CONTEST_OFFICER_HAS_SUN_STONE
@@ -815,7 +816,7 @@
 	const EVENT_SHOWED_STARYU_TO_BILLS_GRANDPA
 	const EVENT_SHOWED_GROWLITHE_VULPIX_TO_BILLS_GRANDPA
 	const EVENT_SHOWED_PICHU_TO_BILLS_GRANDPA
-	const EVENT_GOT_EVERSTONE_FROM_BILLS_GRANDPA ; 320
+	const EVENT_GOT_EVERSTONE_FROM_BILLS_GRANDPA
 	const EVENT_GOT_LEAF_STONE_FROM_BILLS_GRANDPA
 	const EVENT_GOT_WATER_STONE_FROM_BILLS_GRANDPA
 	const EVENT_GOT_FIRE_STONE_FROM_BILLS_GRANDPA
@@ -847,9 +848,9 @@
 	const EVENT_BUENA_OFFERED_HER_PHONE_NUMBER
 	const EVENT_MET_BUENA
 	const EVENT_GOT_ODD_EGG
-	const EVENT_33F
+	const EVENT_33F ; unused
 	const EVENT_GOT_GS_BALL_FROM_POKECOM_CENTER
-; ???
+; Unused
 	const EVENT_341
 	const EVENT_342
 	const EVENT_343
@@ -1096,8 +1097,7 @@
 	const EVENT_BEAT_BURGLAR_DUNCAN
 	const EVENT_BEAT_BURGLAR_EDDIE
 	const EVENT_BEAT_BURGLAR_COREY
-; Unknown
-	const EVENT_430
+	const EVENT_430 ; unused
 ; Biker
 	const EVENT_BEAT_BIKER_BENNY
 	const EVENT_BEAT_BIKER_KAZU
@@ -1288,9 +1288,8 @@
 	const EVENT_BEAT_POKEFANF_BEVERLY2
 	const EVENT_BEAT_POKEFANF_BEVERLY3
 	const EVENT_BEAT_POKEFANF_GEORGIA
-; Unknown
-	const EVENT_4DE
 ; Kimono Girl
+	const EVENT_4DE ; unused
 	const EVENT_BEAT_KIMONO_GIRL_NAOKO
 	const EVENT_BEAT_KIMONO_GIRL_SAYO
 	const EVENT_BEAT_KIMONO_GIRL_ZUKI
@@ -1548,7 +1547,7 @@
 	const EVENT_BEAT_SAGE_GAKU
 	const EVENT_BEAT_SAGE_MASA
 	const EVENT_BEAT_SAGE_KOJI
-; ???
+; Unused
 	const EVENT_5CC
 	const EVENT_5CD
 	const EVENT_5CE
@@ -1849,7 +1848,7 @@
 	const EVENT_COPYCAT_2
 	const EVENT_GOLDENROD_SALE_OFF
 	const EVENT_GOLDENROD_SALE_ON
-	const EVENT_6F2
+	const EVENT_6F2 ; unused
 	const EVENT_ILEX_FOREST_APPRENTICE
 	const EVENT_ILEX_FOREST_CHARCOAL_MASTER
 	const EVENT_CHARCOAL_KILN_FARFETCH_D
@@ -1927,7 +1926,7 @@
 	const EVENT_WHIRL_ISLAND_LUGIA_CHAMBER_LUGIA
 	const EVENT_KURTS_HOUSE_KURT_1
 	const EVENT_KURTS_HOUSE_KURT_2
-	const EVENT_SLOWPOKE_WELL_KURT ; 740
+	const EVENT_SLOWPOKE_WELL_KURT
 	const EVENT_PLAYERS_HOUSE_2F_CONSOLE
 	const EVENT_PLAYERS_HOUSE_2F_DOLL_1
 	const EVENT_PLAYERS_HOUSE_2F_DOLL_2
@@ -1943,7 +1942,7 @@
 	const EVENT_BLACKTHORN_CITY_GRAMPS_NOT_BLOCKING_DRAGONS_DEN
 	const EVENT_RUINS_OF_ALPH_KABUTO_CHAMBER_RECEPTIONIST
 	const EVENT_OPENED_MT_SILVER
-	const EVENT_FOUGHT_SNORLAX ; 750
+	const EVENT_FOUGHT_SNORLAX
 	const EVENT_LAKE_OF_RAGE_RED_GYARADOS
 	const EVENT_GOLDENROD_UNDERGROUND_GRANNY
 	const EVENT_GOLDENROD_UNDERGROUND_GRAMPS
@@ -1959,7 +1958,7 @@
 	const EVENT_BLACKTHORN_CITY_SANTOS_OF_SATURDAY
 	const EVENT_ROUTE_40_MONICA_OF_MONDAY
 	const EVENT_LANCES_ROOM_OAK_AND_MARY
-	const EVENT_UNION_CAVE_B2F_LAPRAS ; 760
+	const EVENT_UNION_CAVE_B2F_LAPRAS
 	const EVENT_TEAM_ROCKET_DISBANDED
 	const EVENT_RED_IN_MT_SILVER
 	const EVENT_GOLDENROD_DEPT_STORE_5F_HAPPINESS_EVENT_LADY
@@ -1976,7 +1975,7 @@
 	const EVENT_CERULEAN_GYM_ROCKET
 	const EVENT_ROUTE_25_MISTY_BOYFRIEND
 	const EVENT_TRAINERS_IN_CERULEAN_GYM
-	const EVENT_VERMILION_CITY_SNORLAX ; 770
+	const EVENT_VERMILION_CITY_SNORLAX
 	const EVENT_ROUTE_5_6_POKEFAN_M_BLOCKS_UNDERGROUND_PATH
 	const EVENT_SAFFRON_TRAIN_STATION_POPULATION
 	const EVENT_COPYCATS_HOUSE_2F_DOLL
@@ -1993,7 +1992,7 @@
 	const EVENT_PICKED_UP_FOCUS_BAND
 	const EVENT_ROCK_TUNNEL_1F_ELIXER
 	const EVENT_ROCK_TUNNEL_1F_TM_STEEL_WING
-	const EVENT_ROCK_TUNNEL_B1F_IRON ; 780
+	const EVENT_ROCK_TUNNEL_B1F_IRON
 	const EVENT_ROCK_TUNNEL_B1F_PP_UP
 	const EVENT_ROCK_TUNNEL_B1F_REVIVE
 	const EVENT_ROUTE_2_DIRE_HIT
@@ -2010,7 +2009,7 @@
 	const EVENT_KURTS_HOUSE_GRANDDAUGHTER_2
 	const EVENT_RUINS_OF_ALPH_OUTSIDE_TOURIST_FISHER
 	const EVENT_RUINS_OF_ALPH_OUTSIDE_TOURIST_YOUNGSTERS
-	const EVENT_DRAGON_SHRINE_CLAIR ; 790
+	const EVENT_DRAGON_SHRINE_CLAIR
 	const EVENT_BATTLE_TOWER_BATTLE_ROOM_YOUNGSTER
 	const EVENT_PLAYERS_HOUSE_1F_NEIGHBOR
 	const EVENT_PLAYERS_NEIGHBORS_HOUSE_NEIGHBOR
@@ -2026,7 +2025,7 @@
 	const EVENT_PICKED_UP_MYSTIC_WATER_FROM_OMANYTE_ITEM_ROOM
 	const EVENT_PICKED_UP_STARDUST_FROM_OMANYTE_ITEM_ROOM
 	const EVENT_PICKED_UP_STAR_PIECE_FROM_OMANYTE_ITEM_ROOM
-	const EVENT_PICKED_UP_GOLD_BERRY_FROM_AERODACTYL_ITEM_ROOM ; 7a0
+	const EVENT_PICKED_UP_GOLD_BERRY_FROM_AERODACTYL_ITEM_ROOM
 	const EVENT_PICKED_UP_MOON_STONE_FROM_AERODACTYL_ITEM_ROOM
 	const EVENT_PICKED_UP_HEAL_POWDER_FROM_AERODACTYL_ITEM_ROOM
 	const EVENT_PICKED_UP_ENERGY_ROOT_FROM_AERODACTYL_ITEM_ROOM
@@ -2042,7 +2041,7 @@
 	const EVENT_CIANWOOD_CITY_EUSINE
 	const EVENT_SAW_SUICUNE_AT_CIANWOOD_CITY
 	const EVENT_SAW_SUICUNE_ON_ROUTE_42
-	const EVENT_SAW_SUICUNE_ON_ROUTE_36 ; 7b0
+	const EVENT_SAW_SUICUNE_ON_ROUTE_36
 	const EVENT_ECRUTEAK_TIN_TOWER_ENTRANCE_WANDERING_SAGE
 	const EVENT_TIN_TOWER_1F_SUICUNE
 	const EVENT_TIN_TOWER_1F_ENTEI
@@ -2058,7 +2057,7 @@
 	const EVENT_ROUTE_44_MAX_REPEL
 	const EVENT_ICE_PATH_1F_PROTEIN
 	const EVENT_DRAGONS_DEN_B1F_CALCIUM
-	const EVENT_DRAGONS_DEN_B1F_MAX_ELIXER ; 7c0
+	const EVENT_DRAGONS_DEN_B1F_MAX_ELIXER
 	const EVENT_SILVER_CAVE_ROOM_1_ULTRA_BALL
 	const EVENT_SILVER_CAVE_ROOM_2_CALCIUM
 	const EVENT_SILVER_CAVE_ROOM_2_ULTRA_BALL
--- a/engine/battle_anims/bg_effects.asm
+++ b/engine/battle_anims/bg_effects.asm
@@ -2606,7 +2606,7 @@
 BattleBGEffects_ClearLYOverrides:
 	xor a
 BattleBGEffects_SetLYOverrides:
-	ld hl, wLYOverrides ; wListPointer
+	ld hl, wLYOverrides
 	ld e, $99
 .loop1
 	ld [hli], a
--- a/engine/link/init_list.asm
+++ b/engine/link/init_list.asm
@@ -1,4 +1,5 @@
 InitList:
+; This entire function is useless.
 	ld a, [wInitListType]
 
 	cp INIT_ENEMYOT_LIST