Add comments associating constants with data, and identify some more data

10 files changed, 190 insertions, 30 deletions

diff --git a/data/credits/credits_text.asm b/data/credits/credits_text.asm
index a68c33d3..ded7f5d6 100755
--- a/data/credits/credits_text.asm
+++ b/data/credits/credits_text.asm
@@ -1,4 +1,5 @@
 CreditsTextPointers:
+; entries correspond to CRED_* constants
 	dw CredVersion
 	dw CredTajiri
 	dw CredTaOota
diff --git a/data/events/trades.asm b/data/events/trades.asm
index a92ad2fa..7018c22f 100755
--- a/data/events/trades.asm
+++ b/data/events/trades.asm
@@ -1,4 +1,5 @@
 TradeMons:
+; entries correspond to TRADE_FOR_* constants
 	; give mon, get mon, dialog id, nickname
 	db NIDORINO,   NIDORINA,  TRADE_DIALOGSET_CASUAL, "TERRY@@@@@@"
 	db ABRA,       MR_MIME,   TRADE_DIALOGSET_CASUAL, "MARCEL@@@@@"
diff --git a/data/icon_pointers.asm b/data/icon_pointers.asm
index 305dfcb1..79db936e 100644
--- a/data/icon_pointers.asm
+++ b/data/icon_pointers.asm
@@ -2,36 +2,36 @@ mon_icon_header: MACRO
 	dw \1 tile \2
 	db \3
 	db BANK(\1)
-	dw vSprites tile \4
+	dw vSprites tile (\4)
 ENDM
 
 MonPartySpritePointers:
 	; gfx pointer, gfx tile offset, # tiles, vSprites tile offset
-	mon_icon_header MonsterSprite,       12, 4, $00
-	mon_icon_header PokeBallSprite,       0, 8, $04
-	mon_icon_header FairySprite,         12, 4, $0c
-	mon_icon_header BirdSprite,          12, 4, $10
-	mon_icon_header SeelSprite,           0, 4, $14
-	mon_icon_header BugIconFrame2,        0, 1, $18
-	mon_icon_header BugIconFrame2,        1, 1, $1a
-	mon_icon_header PlantIconFrame2,      0, 1, $1c
-	mon_icon_header PlantIconFrame2,      1, 1, $1e
-	mon_icon_header SnakeIconFrame1,      0, 1, $20
-	mon_icon_header SnakeIconFrame1,      1, 1, $22
-	mon_icon_header QuadrupedIconFrame1,  0, 1, $24
-	mon_icon_header QuadrupedIconFrame1,  1, 1, $26
-	mon_icon_header TradeBubbleIconGFX,   0, 4, $38
-	mon_icon_header MonsterSprite,        0, 4, $40
-	mon_icon_header PokeBallSprite,       0, 8, $44
-	mon_icon_header FairySprite,          0, 4, $4c
-	mon_icon_header BirdSprite,           0, 4, $50
-	mon_icon_header SeelSprite,          12, 4, $54
-	mon_icon_header BugIconFrame1,        0, 1, $58
-	mon_icon_header BugIconFrame1,        1, 1, $5a
-	mon_icon_header PlantIconFrame1,      0, 1, $5c
-	mon_icon_header PlantIconFrame1,      1, 1, $5e
-	mon_icon_header SnakeIconFrame2,      0, 1, $60
-	mon_icon_header SnakeIconFrame2,      1, 1, $62
-	mon_icon_header QuadrupedIconFrame2,  0, 1, $64
-	mon_icon_header QuadrupedIconFrame2,  1, 1, $66
-	mon_icon_header TradeBubbleIconGFX,   4, 4, $78
+	mon_icon_header MonsterSprite,       12, 4, ICON_MON << 2
+	mon_icon_header PokeBallSprite,       0, 8, ICON_BALL << 2
+	mon_icon_header FairySprite,         12, 4, ICON_FAIRY << 2
+	mon_icon_header BirdSprite,          12, 4, ICON_BIRD << 2
+	mon_icon_header SeelSprite,           0, 4, ICON_WATER << 2
+	mon_icon_header BugIconFrame2,        0, 1, ICON_BUG << 2
+	mon_icon_header BugIconFrame2,        1, 1, ICON_BUG << 2 + 2
+	mon_icon_header PlantIconFrame2,      0, 1, ICON_GRASS << 2
+	mon_icon_header PlantIconFrame2,      1, 1, ICON_GRASS << 2 + 2
+	mon_icon_header SnakeIconFrame1,      0, 1, ICON_SNAKE << 2
+	mon_icon_header SnakeIconFrame1,      1, 1, ICON_SNAKE << 2 + 2
+	mon_icon_header QuadrupedIconFrame1,  0, 1, ICON_QUADRUPED << 2
+	mon_icon_header QuadrupedIconFrame1,  1, 1, ICON_QUADRUPED << 2 + 2
+	mon_icon_header TradeBubbleIconGFX,   0, 4, ICON_TRADEBUBBLE << 2
+	mon_icon_header MonsterSprite,        0, 4, ICONOFFSET + ICON_MON << 2
+	mon_icon_header PokeBallSprite,       0, 8, ICONOFFSET + ICON_BALL << 2
+	mon_icon_header FairySprite,          0, 4, ICONOFFSET + ICON_FAIRY << 2
+	mon_icon_header BirdSprite,           0, 4, ICONOFFSET + ICON_BIRD << 2
+	mon_icon_header SeelSprite,          12, 4, ICONOFFSET + ICON_WATER << 2
+	mon_icon_header BugIconFrame1,        0, 1, ICONOFFSET + ICON_BUG << 2
+	mon_icon_header BugIconFrame1,        1, 1, ICONOFFSET + ICON_BUG << 2 + 2
+	mon_icon_header PlantIconFrame1,      0, 1, ICONOFFSET + ICON_GRASS << 2
+	mon_icon_header PlantIconFrame1,      1, 1, ICONOFFSET + ICON_GRASS << 2 + 2
+	mon_icon_header SnakeIconFrame2,      0, 1, ICONOFFSET + ICON_SNAKE << 2
+	mon_icon_header SnakeIconFrame2,      1, 1, ICONOFFSET + ICON_SNAKE << 2 + 2
+	mon_icon_header QuadrupedIconFrame2,  0, 1, ICONOFFSET + ICON_QUADRUPED << 2
+	mon_icon_header QuadrupedIconFrame2,  1, 1, ICONOFFSET + ICON_QUADRUPED << 2 + 2
+	mon_icon_header TradeBubbleIconGFX,   4, 4, ICONOFFSET + ICON_TRADEBUBBLE << 2
diff --git a/data/maps/hide_show_data.asm b/data/maps/hide_show_data.asm
index f7276b8d..fa0599f4 100755
--- a/data/maps/hide_show_data.asm
+++ b/data/maps/hide_show_data.asm
@@ -256,7 +256,7 @@ NoHS:
 	db $FF, $FF, $FF
 
 MissableObjects:
-; entries correspond to HS_* constants
+; entries correspond to HS_* constants (see constants/hide_show_constants)
 ; format: map id, object id, HIDE/SHOW
 
 PalletTownHS:
diff --git a/data/moves/effects_pointers.asm b/data/moves/effects_pointers.asm
index 9858e82e..a5e3d852 100644
--- a/data/moves/effects_pointers.asm
+++ b/data/moves/effects_pointers.asm
@@ -1,4 +1,5 @@
 MoveEffectPointerTable:
+; entries correspond to *_EFFECT constants
 	dw SleepEffect               ; EFFECT_01
 	dw PoisonEffect              ; POISON_SIDE_EFFECT1
 	dw DrainHPEffect             ; DRAIN_HP_EFFECT
diff --git a/data/moves/field_move_names.asm b/data/moves/field_move_names.asm
new file mode 100644
index 00000000..b68ed828
--- /dev/null
+++ b/data/moves/field_move_names.asm
@@ -0,0 +1,10 @@
+FieldMoveNames:
+	db "CUT@"
+	db "FLY@"
+	db "@"
+	db "SURF@"
+	db "STRENGTH@"
+	db "FLASH@"
+	db "DIG@"
+	db "TELEPORT@"
+	db "SOFTBOILED@"
diff --git a/data/moves/field_moves.asm b/data/moves/field_moves.asm
new file mode 100644
index 00000000..d7e9219b
--- /dev/null
+++ b/data/moves/field_moves.asm
@@ -0,0 +1,14 @@
+FieldMoveDisplayData:
+	; move id, FieldMoveNames index, leftmost tile
+	; (leftmost tile = -1 + tile column in which the first
+	;  letter of the move's name should be displayed)
+	db CUT,        1, $0C
+	db FLY,        2, $0C
+	db ANIM_B4,    3, $0C ; unused
+	db SURF,       4, $0C
+	db STRENGTH,   5, $0A
+	db FLASH,      6, $0C
+	db DIG,        7, $0C
+	db TELEPORT,   8, $0A
+	db SOFTBOILED, 9, $08
+	db -1 ; end
diff --git a/data/sgb/sgb_palettes.asm b/data/sgb/sgb_palettes.asm
index 056ac8b9..7029b4e8 100755
--- a/data/sgb/sgb_palettes.asm
+++ b/data/sgb/sgb_palettes.asm
@@ -1,4 +1,5 @@
 SuperPalettes:
+; entries correspond to PAL_* constants
 	RGB 31,29,31, 21,28,11, 20,26,31, 03,02,02 ; PAL_ROUTE
 	RGB 31,29,31, 25,28,27, 20,26,31, 03,02,02 ; PAL_PALLET
 	RGB 31,29,31, 17,26,03, 20,26,31, 03,02,02 ; PAL_VIRIDIAN
diff --git a/data/text_boxes.asm b/data/text_boxes.asm
new file mode 100644
index 00000000..34e6a414
--- /dev/null
+++ b/data/text_boxes.asm
@@ -0,0 +1,88 @@
+TextBoxFunctionTable:
+	; text box ID, function address
+	dbw MONEY_BOX,           DisplayMoneyBox
+	dbw BUY_SELL_QUIT_MENU,  DoBuySellQuitMenu
+	dbw FIELD_MOVE_MON_MENU, DisplayFieldMoveMonMenu
+	db -1 ; end
+
+TextBoxCoordTable:
+	; text box ID, upper-left X, upper-left Y, lower-right X, lower-right Y
+	db MESSAGE_BOX,       0, 12, 19, 17
+	db MENU_TEMPLATE_03,  0,  0, 19, 14
+	db MENU_TEMPLATE_07,  0,  0, 11,  6
+	db LIST_MENU_BOX,     4,  2, 19, 12
+	db MENU_TEMPLATE_10,  7,  0, 19, 17
+	db MON_SPRITE_POPUP,  6,  4, 14, 13
+	db -1 ; end
+
+text_box_text: MACRO
+	db \1 ; text box ID
+	db \2, \3, \4, \5 ; text box coordinates
+	dw \6 ; text pointer
+	db \7, \8 ; text coordinates
+ENDM
+
+TextBoxTextAndCoordTable:
+	; text box ID, upper-left X, upper-left Y, lower-right X, lower-right Y, text pointer, text X, text Y
+	text_box_text JP_MOCHIMONO_MENU_TEMPLATE,         0,  0, 14, 17, JapaneseMochimonoText,    3,  0
+	text_box_text USE_TOSS_MENU_TEMPLATE,            13, 10, 19, 14, UseTossText,             15, 11
+	text_box_text JP_SAVE_MESSAGE_MENU_TEMPLATE,      0,  0,  7,  5, JapaneseSaveMessageText,  2,  2
+	text_box_text JP_SPEED_OPTIONS_MENU_TEMPLATE,     0,  6,  5, 10, JapaneseSpeedOptionsText, 2,  7
+	text_box_text BATTLE_MENU_TEMPLATE,               8, 12, 19, 17, BattleMenuText,          10, 14
+	text_box_text SAFARI_BATTLE_MENU_TEMPLATE,        0, 12, 19, 17, SafariZoneBattleMenuText, 2, 14
+	text_box_text SWITCH_STATS_CANCEL_MENU_TEMPLATE, 11, 11, 19, 17, SwitchStatsCancelText,   13, 12
+	text_box_text BUY_SELL_QUIT_MENU_TEMPLATE,        0,  0, 10,  6, BuySellQuitText,          2,  1
+	text_box_text MONEY_BOX_TEMPLATE,                11,  0, 19,  2, MoneyText,               13,  0
+	text_box_text JP_AH_MENU_TEMPLATE,                7,  6, 11, 10, JapaneseAhText,           8,  8
+	text_box_text JP_POKEDEX_MENU_TEMPLATE,          11,  8, 19, 17, JapanesePokedexMenu,     12, 10
+
+BuySellQuitText:
+	db   "BUY"
+	next "SELL"
+	next "QUIT@"
+
+	db "@" ; unused
+
+UseTossText:
+	db   "USE"
+	next "TOSS@"
+
+JapaneseSaveMessageText:
+	db   "きろく"
+	next "メッセージ@"
+
+JapaneseSpeedOptionsText:
+	db   "はやい"
+	next "おそい@"
+
+MoneyText:
+	db "MONEY@"
+
+JapaneseMochimonoText:
+	db "もちもの@"
+
+JapaneseMainMenuText:
+	db   "つづきから"
+	next "さいしょから@"
+
+BattleMenuText:
+	db   "FIGHT <PK><MN>"
+	next "ITEM  RUN@"
+
+SafariZoneBattleMenuText:
+	db   "BALL×       BAIT"
+	next "THROW ROCK  RUN@"
+
+SwitchStatsCancelText:
+	db   "SWITCH"
+	next "STATS"
+	next "CANCEL@"
+
+JapaneseAhText:
+	db "アッ！@"
+
+JapanesePokedexMenu:
+	db   "データをみる"
+	next "なきごえ"
+	next "ぶんぷをみる"
+	next "キャンセル@"
diff --git a/data/yes_no_menu_strings.asm b/data/yes_no_menu_strings.asm
new file mode 100644
index 00000000..db2eeb4c
--- /dev/null
+++ b/data/yes_no_menu_strings.asm
@@ -0,0 +1,44 @@
+two_option_menu: MACRO
+	db \1, \2, \3
+	dw \4
+ENDM
+
+TwoOptionMenuStrings:
+; entries correspond to *_MENU constants
+	; width, height, blank line before first menu item?, text pointer
+	two_option_menu 4, 3, FALSE, .YesNoMenu
+	two_option_menu 6, 3, FALSE, .NorthWestMenu
+	two_option_menu 6, 3, FALSE, .SouthEastMenu
+	two_option_menu 6, 3, FALSE, .YesNoMenu
+	two_option_menu 6, 3, FALSE, .NorthEastMenu
+	two_option_menu 7, 3, FALSE, .TradeCancelMenu
+	two_option_menu 7, 4, TRUE,  .HealCancelMenu
+	two_option_menu 4, 3, FALSE, .NoYesMenu
+
+.NoYesMenu:
+	db   "NO"
+	next "YES@"
+
+.YesNoMenu:
+	db   "YES"
+	next "NO@"
+
+.NorthWestMenu:
+	db   "NORTH"
+	next "WEST@"
+
+.SouthEastMenu:
+	db   "SOUTH"
+	next "EAST@"
+
+.NorthEastMenu:
+	db   "NORTH"
+	next "EAST@"
+
+.TradeCancelMenu:
+	db   "TRADE"
+	next "CANCEL@"
+
+.HealCancelMenu:
+	db   "HEAL"
+	next "CANCEL@"