Document constants with comments, actual names, and more thorough usage

1 files changed, 26 insertions, 1 deletions

diff --git a/constants/engine_flags.asm b/constants/engine_flags.asm
index 31a038196..080939f2c 100644
--- a/constants/engine_flags.asm
+++ b/constants/engine_flags.asm
@@ -1,22 +1,29 @@
+; EngineFlags indexes (see engine/engine_flasg.asm)
 	const_def
-
+; wPokegearFlags
 	const ENGINE_RADIO_CARD
 	const ENGINE_MAP_CARD
 	const ENGINE_PHONE_CARD
 	const ENGINE_EXPN_CARD
 	const ENGINE_POKEGEAR
+; wDaycareMan
 	const ENGINE_DAYCARE_MAN_HAS_EGG
 	const ENGINE_DAYCARE_MAN_HAS_MON
+; wDaycareLady
 	const ENGINE_DAYCARE_LADY_HAS_MON
+; wMomSavingMoney
 	const ENGINE_MOM_SAVING_MONEY
 	const ENGINE_DST
+; wUnusedTwoDayTimerOn
 	const ENGINE_0A
+; StatusFlags
 	const ENGINE_POKEDEX
 	const ENGINE_UNOWN_DEX
 	const ENGINE_POKERUS
 	const ENGINE_ROCKET_SIGNAL_ON_CH20
 	const ENGINE_CREDITS_SKIP
 	const ENGINE_BUG_CONTEST_ON ; 10
+; StatusFlags2
 	const ENGINE_BUG_CONTEST_TIMER
 	const ENGINE_SAFARI_ZONE
 	const ENGINE_ROCKETS_IN_RADIO_TOWER
@@ -24,9 +31,11 @@
 	const ENGINE_GIVE_POKERUS
 	const ENGINE_FLORIA
 	const ENGINE_ROCKETS_IN_MAHOGANY
+; BikeFlags
 	const ENGINE_STRENGTH_ACTIVE
 	const ENGINE_ALWAYS_ON_BIKE
 	const ENGINE_DOWNHILL
+; JohtoBadges
 	const ENGINE_ZEPHYRBADGE
 	const ENGINE_HIVEBADGE
 	const ENGINE_PLAINBADGE
@@ -35,6 +44,7 @@
 	const ENGINE_STORMBADGE ; 20
 	const ENGINE_GLACIERBADGE
 	const ENGINE_RISINGBADGE
+; KantoBadges
 	const ENGINE_BOULDERBADGE
 	const ENGINE_CASCADEBADGE
 	const ENGINE_THUNDERBADGE
@@ -43,6 +53,7 @@
 	const ENGINE_MARSHBADGE
 	const ENGINE_VOLCANOBADGE
 	const ENGINE_EARTHBADGE
+; UnlockedUnowns
 	const ENGINE_UNLOCKED_UNOWNS_1
 	const ENGINE_UNLOCKED_UNOWNS_2
 	const ENGINE_UNLOCKED_UNOWNS_3
@@ -51,6 +62,7 @@
 	const ENGINE_UNLOCKED_UNOWNS_6 ; 30
 	const ENGINE_UNLOCKED_UNOWNS_7
 	const ENGINE_UNLOCKED_UNOWNS_8
+; VisitedSpawns
 	const ENGINE_FLYPOINT_KRISS_HOUSE
 	const ENGINE_FLYPOINT_VIRIDIAN_POKECENTER
 	const ENGINE_FLYPOINT_PALLET
@@ -78,8 +90,11 @@
 	const ENGINE_FLYPOINT_BLACKTHORN
 	const ENGINE_FLYPOINT_SILVER_CAVE
 	const ENGINE_FLYPOINT_UNUSED
+; wLuckyNumberShowFlag
 	const ENGINE_LUCKY_NUMBER_SHOW
+; StatusFlags2
 	const ENGINE_4F
+; DailyFlags
 	const ENGINE_KURT_MAKING_BALLS ; 50
 	const ENGINE_DAILY_BUG_CONTEST
 	const ENGINE_SPECIAL_WILDDATA
@@ -88,6 +103,7 @@
 	const ENGINE_SHUCKLE_GIVEN
 	const ENGINE_GOLDENROD_UNDERGROUND_MERCHANT_CLOSED
 	const ENGINE_FOUGHT_IN_TRAINER_HALL_TODAY
+; WeeklyFlags
 	const ENGINE_MT_MOON_SQUARE_CLEFAIRY
 	const ENGINE_UNION_CAVE_LAPRAS
 	const ENGINE_GOLDENROD_UNDERGROUND_GOT_HAIRCUT
@@ -96,11 +112,16 @@
 	const ENGINE_INDIGO_PLATEAU_RIVAL_FIGHT
 	const ENGINE_DAILY_MOVE_TUTOR
 	const ENGINE_BUENAS_PASSWORD
+; SwarmFlags
 	const ENGINE_BUENAS_PASSWORD_2 ; 60
 	const ENGINE_GOLDENROD_DEPT_STORE_SALE_IS_ON
+; GameTimerPause
 	const ENGINE_62
+; PlayerGender
 	const ENGINE_PLAYER_IS_FEMALE
+; wCelebiEvent
 	const ENGINE_HAVE_EXAMINED_GS_BALL
+; wDailyRematchFlags
 	const ENGINE_JACK
 	const ENGINE_HUEY
 	const ENGINE_GAVEN
@@ -125,6 +146,7 @@
 	const ENGINE_WILTON
 	const ENGINE_PARRY
 	const ENGINE_ERIN
+; wDailyPhoneItemFlags
 	const ENGINE_BEVERLY_HAS_NUGGET
 	const ENGINE_JOSE_HAS_STAR_PIECE
 	const ENGINE_WADE_HAS_ITEM
@@ -135,6 +157,7 @@
 	const ENGINE_TULLY_HAS_WATER_STONE
 	const ENGINE_TIFFANY_HAS_PINK_BOW
 	const ENGINE_WILTON_HAS_ITEM
+; wDailyPhoneTimeOfDayFlags
 	const ENGINE_JACK_MONDAY_MORNING
 	const ENGINE_HUEY_WEDNESDAY_NIGHT
 	const ENGINE_GAVEN_THURSDAY_MORNING
@@ -159,7 +182,9 @@
 	const ENGINE_WILTON_THRUSDAY_MORNING
 	const ENGINE_PARRY_FRIDAY_AFTERNOON
 	const ENGINE_ERIN_SATURDAY_NIGHT
+; wPlayerSpriteSetupFlags
 	const ENGINE_KRIS_IN_CABLE_CLUB
+; SwarmFlags
 	const ENGINE_DUNSPARCE_SWARM ; a0
 	const ENGINE_YANMA_SWARM
 NUM_ENGINE_FLAGS EQU const_value