Revise some constant definitions

15 files changed, 66 insertions, 60 deletions

diff --git a/constants/audio_constants.asm b/constants/audio_constants.asm
index 640b1e8c..bf275385 100644
--- a/constants/audio_constants.asm
+++ b/constants/audio_constants.asm
@@ -13,6 +13,7 @@
 	const A_ ; a
 	const A# ; b
 	const B_ ; c
+NUM_NOTES EQU const_value - 1
 
 ; channel
 ; ChannelPointers indexes (see audio/engine.asm)
diff --git a/constants/battle_constants.asm b/constants/battle_constants.asm
index c7d3f155..f486bf51 100644
--- a/constants/battle_constants.asm
+++ b/constants/battle_constants.asm
@@ -41,15 +41,15 @@ BASE_AI_SWITCH_SCORE EQU 10
 NUM_LEVEL_STATS EQU const_value
 
 ; move struct members (see data/moves/moves.asm)
-	const_def
-	const MOVE_ANIM   ; 0
-	const MOVE_EFFECT ; 1
-	const MOVE_POWER  ; 2
-	const MOVE_TYPE   ; 3
-	const MOVE_ACC    ; 4
-	const MOVE_PP     ; 5
-	const MOVE_CHANCE ; 6
-MOVE_LENGTH EQU const_value
+rsreset
+MOVE_ANIM   rb ; 0
+MOVE_EFFECT rb ; 1
+MOVE_POWER  rb ; 2
+MOVE_TYPE   rb ; 3
+MOVE_ACC    rb ; 4
+MOVE_PP     rb ; 5
+MOVE_CHANCE rb ; 6
+MOVE_LENGTH EQU _RS
 
 ; stat constants
 ; indexes for:
@@ -95,7 +95,7 @@ SPDSPCDV_SHINY EQU $AA
 	const BATTLETYPE_TRAP
 	const BATTLETYPE_FORCEITEM
 
-; BattleVarPairs indexes (see home/battle.asm)
+; BattleVarPairs indexes (see home/battle_vars.asm)
 	const_def
 	const BATTLE_VARS_SUBSTATUS1
 	const BATTLE_VARS_SUBSTATUS2
@@ -120,7 +120,7 @@ SPDSPCDV_SHINY EQU $AA
 	const BATTLE_VARS_LAST_MOVE_OPP
 NUM_BATTLE_VARS EQU const_value
 
-; BattleVarLocations indexes (see home/battle.asm)
+; BattleVarLocations indexes (see home/battle_vars.asm)
 	const_def
 	const PLAYER_SUBSTATUS_1
 	const ENEMY_SUBSTATUS_1
diff --git a/constants/gfx_constants.asm b/constants/gfx_constants.asm
index fe042b15..546274a9 100644
--- a/constants/gfx_constants.asm
+++ b/constants/gfx_constants.asm
@@ -28,7 +28,7 @@ EXP_BAR_LENGTH EQU 8 ; tiles
 HP_BAR_LENGTH_PX  EQU HP_BAR_LENGTH  * TILE_WIDTH ; pixels
 EXP_BAR_LENGTH_PX EQU EXP_BAR_LENGTH * TILE_WIDTH ; pixels
 
-; GetHPPal return values (see home.asm)
+; GetHPPal return values (see home/tilemap.asm)
 HP_GREEN  EQU 0
 HP_YELLOW EQU 1
 HP_RED    EQU 2
diff --git a/constants/hardware_constants.asm b/constants/hardware_constants.asm
index f9014380..93f0dec6 100644
--- a/constants/hardware_constants.asm
+++ b/constants/hardware_constants.asm
@@ -1,5 +1,6 @@
-; Graciously aped from:
-; http://nocash.emubase.de/pandocs.htm
+; Graciously derived from:
+; https://gbdev.io/pandocs/
+; https://github.com/gbdev/hardware.inc
 ; http://gameboy.mongenel.com/dmg/asmmemmap.html
 
 ; memory map
diff --git a/constants/landmark_constants.asm b/constants/landmark_constants.asm
index afece24e..200e66d5 100644
--- a/constants/landmark_constants.asm
+++ b/constants/landmark_constants.asm
@@ -1,7 +1,7 @@
 ; Landmarks indexes (see data/maps/landmarks.asm)
 	const_def
-; Johto landmarks
 	const LANDMARK_SPECIAL           ; 00
+; Johto landmarks
 	const LANDMARK_NEW_BARK_TOWN     ; 01
 	const LANDMARK_ROUTE_29          ; 02
 	const LANDMARK_CHERRYGROVE_CITY  ; 03
diff --git a/constants/map_data_constants.asm b/constants/map_data_constants.asm
index 7af919b1..a521204c 100644
--- a/constants/map_data_constants.asm
+++ b/constants/map_data_constants.asm
@@ -18,6 +18,7 @@ MAP_FISHGROUP          rb ; 8
 MAP_LENGTH EQU _RS
 
 ; map environments (wEnvironment)
+; EnvironmentColorsPointers indexes (see data/maps/environment_colors.asm)
 	const_def 1
 	const TOWN
 	const ROUTE
@@ -26,6 +27,7 @@ MAP_LENGTH EQU _RS
 	const ENVIRONMENT_5
 	const GATE
 	const DUNGEON
+NUM_ENVIRONMENTS EQU const_value - 1
 
 ; map palettes (wEnvironment)
 	const_def
diff --git a/constants/map_setup_constants.asm b/constants/map_setup_constants.asm
index ae587e55..ba845664 100644
--- a/constants/map_setup_constants.asm
+++ b/constants/map_setup_constants.asm
@@ -12,6 +12,7 @@
 	const MAPSETUP_TRAIN      ; f9
 	const MAPSETUP_SUBMENU    ; fa
 	const MAPSETUP_BADWARP    ; fb
+NUM_MAPSETUP_SCRIPTS EQU const_value - $f1
 
 ; callback types
 	const_def 1
diff --git a/constants/npc_trade_constants.asm b/constants/npc_trade_constants.asm
index 51431e8c..72333a65 100644
--- a/constants/npc_trade_constants.asm
+++ b/constants/npc_trade_constants.asm
@@ -1,4 +1,4 @@
-	; npctrade struct members (see data/events/npc_trades.asm)
+; npctrade struct members (see data/events/npc_trades.asm)
 rsreset
 NPCTRADE_DIALOG  rb
 NPCTRADE_GIVEMON rb
diff --git a/constants/phone_constants.asm b/constants/phone_constants.asm
index 48ae6e2d..0721ca99 100644
--- a/constants/phone_constants.asm
+++ b/constants/phone_constants.asm
@@ -54,20 +54,18 @@ NUM_SPECIALCALLS EQU const_value - 1
 SPECIALCALL_SIZE EQU 6
 
 ; phone struct members
-	const_def
-	const PHONE_CONTACT_TRAINER_CLASS
-	const PHONE_CONTACT_TRAINER_NUMBER
-	const PHONE_CONTACT_MAP_GROUP
-	const PHONE_CONTACT_MAP_NUMBER
-	const PHONE_CONTACT_SCRIPT1_TIME
-	const PHONE_CONTACT_SCRIPT1_BANK
-	const PHONE_CONTACT_SCRIPT1_ADDR
-	const_skip ; high PHONE_CONTACT_SCRIPT1_ADDR byte
-	const PHONE_CONTACT_SCRIPT2_TIME
-	const PHONE_CONTACT_SCRIPT2_BANK
-	const PHONE_CONTACT_SCRIPT2_ADDR
-	const_skip ; high PHONE_CONTACT_SCRIPT2_ADDR byte
-PHONE_CONTACT_SIZE EQU const_value
+rsreset
+PHONE_CONTACT_TRAINER_CLASS  rb
+PHONE_CONTACT_TRAINER_NUMBER rb
+PHONE_CONTACT_MAP_GROUP      rb
+PHONE_CONTACT_MAP_NUMBER     rb
+PHONE_CONTACT_SCRIPT1_TIME   rb
+PHONE_CONTACT_SCRIPT1_BANK   rb
+PHONE_CONTACT_SCRIPT1_ADDR   rw
+PHONE_CONTACT_SCRIPT2_TIME   rb
+PHONE_CONTACT_SCRIPT2_BANK   rb
+PHONE_CONTACT_SCRIPT2_ADDR   rw
+PHONE_CONTACT_SIZE EQU _RS
 
 ; maximum number of pokegear contacts
 CONTACT_LIST_SIZE EQU 10
diff --git a/constants/radio_constants.asm b/constants/radio_constants.asm
index 0a6f5d49..9a4c181d 100644
--- a/constants/radio_constants.asm
+++ b/constants/radio_constants.asm
@@ -75,7 +75,7 @@ NUM_RADIO_CHANNELS EQU const_value
 	const POKEDEX_SHOW_8         ; 42
 NUM_RADIO_SEGMENTS EQU const_value
 
-; PlayRadio.StationPointers indexes (see engine/pokegear/pokegear.asm)
+; PlayRadioStationPointers indexes (see engine/pokegear/pokegear.asm)
 	const_def
 	const MAPRADIO_POKEMON_CHANNEL
 	const MAPRADIO_OAKS_POKEMON_TALK
@@ -86,6 +86,7 @@ NUM_RADIO_SEGMENTS EQU const_value
 	const MAPRADIO_PLACES_PEOPLE
 	const MAPRADIO_LETS_ALL_SING
 	const MAPRADIO_ROCKET
+NUM_MAP_RADIO_STATIONS EQU const_value
 
 ; These tables in engine/pokegear/radio.asm are all sized to a power of 2
 ; so there's no need for a rejection sampling loop
diff --git a/constants/scgb_constants.asm b/constants/scgb_constants.asm
index d07f89ae..3625c858 100644
--- a/constants/scgb_constants.asm
+++ b/constants/scgb_constants.asm
@@ -1,4 +1,5 @@
-; GetSGBLayout arguments (see engine/gfx/cgb_layouts.asm and engine/gfx/sgb_layouts.asm)
+; CGBLayoutJumptable indexes (see engine/gfx/cgb_layouts.asm)
+; SGBLayoutJumptable indexes (see engine/gfx/sgb_layouts.asm)
 	const_def
 	const SCGB_BATTLE_GRAYSCALE
 	const SCGB_BATTLE_COLORS
@@ -32,6 +33,7 @@
 	const SCGB_MYSTERY_GIFT
 	const SCGB_1E
 	const SCGB_POKEDEX_5X5
+NUM_SCGB_LAYOUTS EQU const_value
 
 SCGB_PARTY_MENU_HP_BARS EQU $fc
 SCGB_DEFAULT EQU $ff
diff --git a/constants/script_constants.asm b/constants/script_constants.asm
index 0c978484..0867a528 100644
--- a/constants/script_constants.asm
+++ b/constants/script_constants.asm
@@ -1,4 +1,4 @@
-; person constants
+; object constants
 PLAYER      EQU  0
 LAST_TALKED EQU -2
 
diff --git a/constants/sprite_data_constants.asm b/constants/sprite_data_constants.asm
index 271faca1..64ff9c83 100644
--- a/constants/sprite_data_constants.asm
+++ b/constants/sprite_data_constants.asm
@@ -1,12 +1,11 @@
-; overworld_sprite struct members (see data/sprites.asm)
-	const_def
-	const SPRITEDATA_ADDR    ; 0
-	const_skip ; high SPRITEDATA_ADDR byte
-	const SPRITEDATA_SIZE    ; 2
-	const SPRITEDATA_BANK    ; 3
-	const SPRITEDATA_TYPE    ; 4
-	const SPRITEDATA_PALETTE ; 5
-NUM_SPRITEDATA_FIELDS EQU const_value
+; overworld_sprite struct members (see data/sprites/sprites.asm)
+rsreset
+SPRITEDATA_ADDR    rw ; 0
+SPRITEDATA_SIZE    rb ; 2
+SPRITEDATA_BANK    rb ; 3
+SPRITEDATA_TYPE    rb ; 4
+SPRITEDATA_PALETTE rb ; 5
+NUM_SPRITEDATA_FIELDS EQU _RS
 
 ; sprite types
 	const_def 1
diff --git a/constants/text_constants.asm b/constants/text_constants.asm
index dbe06a36..a42835f2 100644
--- a/constants/text_constants.asm
+++ b/constants/text_constants.asm
@@ -1,10 +1,10 @@
 ; name lengths
-NAME_LENGTH          EQU 11
-PLAYER_NAME_LENGTH   EQU 8
-BOX_NAME_LENGTH      EQU 9
-MON_NAME_LENGTH      EQU 11
-MOVE_NAME_LENGTH     EQU 13
-ITEM_NAME_LENGTH     EQU 13
+NAME_LENGTH        EQU 11
+PLAYER_NAME_LENGTH EQU 8
+BOX_NAME_LENGTH    EQU 9
+MON_NAME_LENGTH    EQU 11
+MOVE_NAME_LENGTH   EQU 13
+ITEM_NAME_LENGTH   EQU 13
 TRAINER_CLASS_NAME_LENGTH EQU 13
 NAME_LENGTH_JAPANESE EQU 6
 
@@ -30,6 +30,9 @@ TEXTBOX_INNERX EQU TEXTBOX_X + 1
 TEXTBOX_Y      EQU SCREEN_HEIGHT - TEXTBOX_HEIGHT
 TEXTBOX_INNERY EQU TEXTBOX_Y + 2
 
+; see gfx/frames/*.png
+TEXTBOX_FRAME_TILES EQU 6
+
 ; PrintNum bit flags
 	const_def 5
 	const PRINTNUM_MONEY_F        ; 5
@@ -37,9 +40,9 @@ TEXTBOX_INNERY EQU TEXTBOX_Y + 2
 	const PRINTNUM_LEADINGZEROS_F ; 7
 
 ; PrintNum arguments (see engine/math/print_num.asm)
-PRINTNUM_MONEY          EQU 1 << PRINTNUM_MONEY_F
-PRINTNUM_LEFTALIGN      EQU 1 << PRINTNUM_LEFTALIGN_F
-PRINTNUM_LEADINGZEROS   EQU 1 << PRINTNUM_LEADINGZEROS_F
+PRINTNUM_MONEY        EQU 1 << PRINTNUM_MONEY_F
+PRINTNUM_LEFTALIGN    EQU 1 << PRINTNUM_LEFTALIGN_F
+PRINTNUM_LEADINGZEROS EQU 1 << PRINTNUM_LEADINGZEROS_F
 
 ; character sets (see charmap.asm)
 FIRST_REGULAR_TEXT_CHAR EQU $60
diff --git a/constants/trainer_data_constants.asm b/constants/trainer_data_constants.asm
index 0f893253..fd081b7c 100644
--- a/constants/trainer_data_constants.asm
+++ b/constants/trainer_data_constants.asm
@@ -1,13 +1,11 @@
 ; TrainerClassAttributes struct members (see data/trainers/attributes.asm)
-	const_def
-	const TRNATTR_ITEM1           ; 0
-	const TRNATTR_ITEM2           ; 1
-	const TRNATTR_BASEMONEY       ; 2
-	const TRNATTR_AI_MOVE_WEIGHTS ; 3
-	const_skip ; high TRNATTR_AI_MOVE_WEIGHTS byte
-	const TRNATTR_AI_ITEM_SWITCH  ; 5
-	const_skip ; high TRNATTR_AI_ITEM_SWITCH byte
-NUM_TRAINER_ATTRIBUTES EQU const_value
+rsreset
+TRNATTR_ITEM1           rb ; 0
+TRNATTR_ITEM2           rb ; 1
+TRNATTR_BASEMONEY       rb ; 2
+TRNATTR_AI_MOVE_WEIGHTS rw ; 3
+TRNATTR_AI_ITEM_SWITCH  rw ; 5
+NUM_TRAINER_ATTRIBUTES EQU _RS
 
 ; TRNATTR_AI_MOVE_WEIGHTS bit flags (wEnemyTrainerAIFlags)
 ; AIScoringPointers indexes (see engine/battle/ai/move.asm)