Merge pull request #776 from Rangi42/unreferenced

Comment, remove, or revise many unreferenced labels

INSTALL.md

@@ -9,6 +9,12 @@ If you run into trouble, ask for help on IRC or Discord (see [README.md](README.
 
 Download and install [**Windows Subsystem for Linux**](https://docs.microsoft.com/en-us/windows/wsl/install-win10). Then open the **WSL terminal**.
 
+Update WSL's software before continuing. If you chose Debian, Ubuntu, or another distribution that uses `apt-get`, then enter this command:
+
+```bash
+apt-get update && apt-get upgrade
+```
+
 WSL has its own file system that's not accessible from Windows, but Windows files *are* accessible from WSL. So you're going to want to install pokecrystal within Windows. You'll have to change the **current working directory** every time you open WSL.
 
 For example, if you want to store pokecrystal in **C:\Users\\*\<user>*\Desktop**, enter this command:
@@ -19,9 +25,9 @@ cd /mnt/c/Users/<user>/Desktop
 
 (The Windows `C:\` drive is called `/mnt/c/` in WSL. Replace *\<user>* in the example path with your username.)
 
-Then follow [the instructions for **Linux**](#linux).
+If this works, then follow [the instructions for **Linux**](#linux) below for whatever distribution you installed for WSL.
 
-If this doesn't work, try following [the regular Windows instructions](#windows) below.
+Otherwise, continue reading below for [the older Windows instructions](#windows).
 
 
 ## Windows
@@ -36,9 +42,9 @@ Run setup and leave the default settings. At the "**Select Packages**" step, cho
 
 Double click on the text that says "**Skip**" next to each package to select the most recent version to install.
 
-Then download [**rgbds**](https://github.com/gbdev/rgbds/releases/): the latest **win64.zip** or **win32.zip** release. Extract it and put all the `exe` and `dll` files individually in **C:\cygwin64\usr\local\bin**.
+Then follow the [**rgbds** instructions](https://rgbds.gbdev.io/install/windows) for Windows with Cygwin to install **rgbds 0.4.1**.
 
-**Note: If you already have an older rgbds, you will need to update to 0.4.1.** Ignore this if you have never installed rgbds before. If a version newer than 0.4.1 does not work, try downloading 0.4.1.
+**Note:** If you already have an older rgbds, you will need to update to 0.4.1. Ignore this if you have never installed rgbds before. If a version newer than 0.4.1 does not work, try downloading 0.4.1.
 
 Now open the **Cygwin terminal** and enter the following commands.
 
@@ -55,17 +61,13 @@ cd /cygdrive/c/Users/<user>/Desktop
 Now you're ready to [build **pokecrystal**](#build-pokecrystal).
 
 
-## Mac OS X
+## macOS
 
 Install [**Homebrew**](https://brew.sh/). Follow the official instructions.
 
-Open **Terminal** and enter the following commands.
+Open **Terminal** and prepare to enter commands.
 
-To install **rgbds**:
+Then follow the [**rgbds** instructions](https://rgbds.gbdev.io/install/macos) for macOS to install **rgbds 0.4.1**.
-
-```bash
-brew install rgbds
-```
 
 Now you're ready to [build **pokecrystal**](#build-pokecrystal).
 
@@ -82,13 +84,7 @@ To install the software required for **pokecrystal**:
 sudo apt-get install make gcc git
 ```
 
-To install **rgbds**:
+Then follow the [**rgbds** instructions](https://rgbds.gbdev.io/install/source) to build **rgbds 0.4.1** from source.
-
-```bash
-sudo apt-get install pkg-config flex bison libpng-dev
-git clone -b v0.4.1 --depth=1 https://github.com/gbdev/rgbds
-sudo make -C rgbds install
-```
 
 ### OpenSUSE
 
@@ -98,13 +94,7 @@ To install the software required for **pokecrystal**:
 sudo zypper install make gcc git
 ```
 
-To install **rgbds**:
+Then follow the [**rgbds** instructions](https://rgbds.gbdev.io/install/source) to build **rgbds 0.4.1** from source.
-
-```bash
-sudo zypper install pkg-config flex bison libpng16-devel
-git clone -b v0.4.1 --depth=1 https://github.com/gbdev/rgbds
-sudo make -C rgbds install
-```
 
 ### Arch Linux
 
@@ -114,13 +104,9 @@ To install the software required for **pokecrystal**:
 sudo pacman -S make gcc git rgbds
 ```
 
-If you want to compile and install **rgbds** manually instead of using the Arch package:
+Then follow the [**rgbds** instructions](https://rgbds.gbdev.io/install/arch) for Arch Linux to install **rgbds 0.4.1**.
 
-```bash
+If you want to compile and install **rgbds** yourself instead, then follow the [**rgbds** instructions](https://rgbds.gbdev.io/install/source) to build **rgbds 0.4.1** from source.
-sudo pacman -S pkg-config flex bison libpng
-git clone -b v0.4.1 --depth=1 https://github.com/gbdev/rgbds
-sudo make -C rgbds install
-```
 
 ### Termux
 
@@ -136,6 +122,8 @@ To install **rgbds**:
 sudo apt install rgbds
 ```
 
+If you want to compile and install **rgbds** yourself instead, then follow the [**rgbds** instructions](https://rgbds.gbdev.io/install/source) to build **rgbds 0.4.1** from source.
+
 ### Other distros
 
 If your distro is not listed here, try to find the required software in its repositories:
@@ -145,19 +133,7 @@ If your distro is not listed here, try to find the required software in its repo
 - `git`
 - `rgbds`
 
-If `rgbds` is not available, you'll also need these:
+If `rgbds` is not available, you'll need to follow the [**rgbds** instructions](https://rgbds.gbdev.io/install/source) to build **rgbds 0.4.1** from source.
-
-- `pkg-config`
-- `flex`
-- `bison`
-- `libpng` (and the development headers)
-
-To install **rgbds**:
-
-```bash
-git clone -b v0.4.1 --depth=1 https://github.com/gbdev/rgbds
-sudo make -C rgbds install
-```
 
 Now you're ready to [build **pokecrystal**](#build-pokecrystal).
 

STYLE.md

@@ -69,6 +69,7 @@ PascalCase: ; label
 PascalCase:: ; global label
 .snake_case ; local jump
 .PascalCase: ; an atomic chunk of code or data that's local
+; don't define unused labels when a comment would do
 
 ; Labels are prefixed with lower case letters depending on location
 wPascalCase: ; wram
@@ -151,9 +152,7 @@ endr
 
 	; do
 	db \1, \2, \3, \4, \5
-rept 5
+	shift 5
-	shift
-endr
 	db \1, \2, \3, \4, \5
 
 ENDM
@@ -161,7 +160,7 @@ ENDM
 
 UPPER_CASE_IS_OK_SOMETIMES: MACRO
 
-; but i can't think of any examples
+; but I can't think of any examples besides ACRONYMS
 
 ENDM
 

audio/cries.asm

@@ -464,7 +464,7 @@ Cry_Sentret_Ch6:
 	square_note 8, 15, 1, 1824
 	sound_ret
 
-Cry_Sentret_Ch8:
+Cry_Sentret_Ch8: ; unreferenced
 	noise_note 8, 3, -3, 0
 	noise_note 8, 9, 2, 0
 	sound_ret
@@ -1082,7 +1082,7 @@ Cry_Weepinbell:
 	channel 6, Cry_Weepinbell_Ch6
 	channel 8, Cry_Weepinbell_Ch8
 
-Cry_Unused_Ch5:
+Cry_Unused_Ch5: ; unreferenced
 	duty_cycle_pattern 3, 3, 0, 0
 	square_note 15, 14, 0, 1920
 	square_note 15, 15, 0, 1924
@@ -1092,7 +1092,7 @@ Cry_Unused_Ch5:
 	square_note 8, 7, 1, 1924
 	sound_ret
 
-Cry_Unused_Ch6:
+Cry_Unused_Ch6: ; unreferenced
 	duty_cycle_pattern 0, 0, 1, 1
 	square_note 15, 10, 0, 1857
 	square_note 15, 11, 0, 1859
@@ -1102,7 +1102,7 @@ Cry_Unused_Ch6:
 	square_note 8, 3, 1, 1862
 	sound_ret
 
-Cry_Unused_Ch8:
+Cry_Unused_Ch8: ; unreferenced
 	noise_note 2, 15, 2, 76
 	noise_note 6, 14, 0, 58
 	noise_note 15, 13, 0, 58

audio/engine.asm

@@ -38,15 +38,16 @@ _InitSound::
 	dec e
 	jr nz, .clearsound
 
-	ld hl, wChannels ; start of channel data
+	ld hl, wAudio
-	ld de, wChannelsEnd - wChannels ; length of area to clear (entire sound wram area)
+	ld de, wAudioEnd - wAudio
-.clearchannels
+.clearaudio
 	xor a
 	ld [hli], a
 	dec de
 	ld a, e
 	or d
-	jr nz, .clearchannels
+	jr nz, .clearaudio
+
 	ld a, MAX_VOLUME
 	ld [wVolume], a
 	call MusicOn
@@ -1614,9 +1615,9 @@ Music_JumpIf:
 	ret
 
 MusicEE:
+; unused
 ; conditional jump
 ; checks a byte in ram corresponding to the current channel
-; doesn't seem to be set by any commands
 ; params: 2
 ;		ll hh ; pointer
 
@@ -1666,15 +1667,15 @@ MusicEE:
 	ret
 
 MusicF9:
+; unused
 ; sets some flag
-; seems to be unused
 ; params: 0
 	ld a, TRUE
 	ld [wUnusedMusicF9Flag], a
 	ret
 
 MusicE2:
-; seems to have been dummied out
+; unused
 ; params: 1
 	call GetMusicByte
 	ld hl, CHANNEL_FIELD2C

audio/music/magnettrain.asm

@@ -246,7 +246,7 @@ Music_MagnetTrain_Ch4:
 	drum_note 12, 16
 	sound_ret
 
-.sub1: ; unused
+.sub1: ; unreferenced
 	drum_note 9, 1
 	drum_note 8, 1
 	drum_note 8, 1

audio/sfx.asm

@@ -21,7 +21,8 @@ Sfx_Menu:
 Sfx_ReadText:
 Sfx_ReadText2:
 	channel_count 1
-	channel 5, Sfx_ReadText2_Ch5
+	channel 5, Sfx_ReadText_Ch5
+	assert Sfx_ReadText_Ch5 == Sfx_ReadText2_Ch5
 
 Sfx_Poison:
 	channel_count 1
@@ -467,6 +468,7 @@ Sfx_Unknown5F:
 	channel 6, Sfx_Unknown5F_Ch6
 Sfx_Sandstorm:
 	channel 8, Sfx_Sandstorm_Ch8
+	assert Sfx_Sandstorm_Ch8 == Sfx_Unknown5F_Ch8
 
 Sfx_HangUp:
 	channel_count 1
@@ -490,6 +492,10 @@ Sfx_DexFanfare5079:
 	channel 6, Sfx_LevelUp_Ch6
 	channel 7, Sfx_LevelUp_Ch7
 	channel 8, Sfx_LevelUp_Ch8
+	assert Sfx_LevelUp_Ch5 == Sfx_DexFanfare5079_Ch5
+	assert Sfx_LevelUp_Ch6 == Sfx_DexFanfare5079_Ch6
+	assert Sfx_LevelUp_Ch7 == Sfx_DexFanfare5079_Ch7
+	assert Sfx_LevelUp_Ch8 == Sfx_DexFanfare5079_Ch8
 
 Sfx_LevelUp_Ch5:
 Sfx_DexFanfare5079_Ch5:
@@ -942,7 +948,7 @@ Sfx_Fanfare2:
 	channel 6, Sfx_Fanfare2_Ch6
 	channel 8, Sfx_Fanfare2_Ch8
 
-Sfx_Unused:
+Sfx_Unused: ; unreferenced
 	channel_count 4
 	channel 5, Sfx_Unused_Ch5
 	channel 6, Sfx_Unused_Ch6

audio/sfx_crystal.asm

@@ -184,7 +184,7 @@ Sfx_Tingle_Ch5:
 	duty_cycle 1
 	transpose 0, 11
 	note_type 1, 11, 1
-Sfx_Tingle_branch_17996c:
+.loop1:
 	octave 5
 	note C_, 3
 	octave 6
@@ -192,7 +192,7 @@ Sfx_Tingle_branch_17996c:
 	octave 5
 	note C_, 3
 	rest 2
-	sound_loop 2, Sfx_Tingle_branch_17996c
+	sound_loop 2, .loop1
 	note C_, 2
 	volume_envelope 10, 1
 	note G_, 13

constants/collision_constants.asm

@@ -1,11 +1,11 @@
-; collision permissions (see data/collision_permissions.asm)
+; collision permissions (see data/collision/collision_permissions.asm)
 LAND_TILE  EQU $00
 WATER_TILE EQU $01
 WALL_TILE  EQU $0f
 TALK       EQU $10
 
 ; collision data types (see data/tilesets/*_collision.asm)
-; TileCollisionTable indexes (see data/collision_permissions.asm)
+; TileCollisionTable indexes (see data/collision/collision_permissions.asm)
 COLL_FLOOR             EQU $00
 COLL_01                EQU $01 ; garbage
 COLL_03                EQU $03 ; garbage

constants/engine_flags.asm

@@ -15,7 +15,7 @@
 	const ENGINE_MOM_SAVING_MONEY
 	const ENGINE_MOM_ACTIVE
 ; wUnusedTwoDayTimerOn
-	const ENGINE_0A
+	const ENGINE_UNUSED_TWO_DAY_TIMER_ON
 ; wStatusFlags
 	const ENGINE_POKEDEX
 	const ENGINE_UNOWN_DEX
@@ -115,7 +115,7 @@
 ; wSwarmFlags
 	const ENGINE_BUENAS_PASSWORD_2
 	const ENGINE_GOLDENROD_DEPT_STORE_SALE_IS_ON
-; wGameTimerPause
+; wGameTimerPaused
 	const ENGINE_62
 ; wPlayerGender
 	const ENGINE_PLAYER_IS_FEMALE

constants/event_flags.asm

@@ -136,9 +136,9 @@
 	const EVENT_TIN_TOWER_5F_HIDDEN_FULL_RESTORE
 	const EVENT_TIN_TOWER_5F_HIDDEN_CARBOS
 	const EVENT_BURNED_TOWER_1F_HIDDEN_ETHER
-	const_skip ; unused
+	const_skip ; unused in Crystal
-	const_skip ; unused
+	const_skip ; unused in Crystal
-	const_skip ; unused
+	const_skip ; unused in Crystal
 	const EVENT_NATIONAL_PARK_HIDDEN_FULL_HEAL
 	const EVENT_OLIVINE_LIGHTHOUSE_5F_HIDDEN_HYPER_POTION
 	const EVENT_TEAM_ROCKET_BASE_B1F_HIDDEN_REVIVE
@@ -281,11 +281,11 @@
 	const EVENT_GAVE_KURT_PNK_APRICORN
 ; Phone events
 	const EVENT_JACK_ASKED_FOR_PHONE_NUMBER
-	const_skip ; unused
+	const_skip ; unused in Crystal
 	const EVENT_BEVERLY_ASKED_FOR_PHONE_NUMBER
-	const_skip ; unused
+	const_skip ; unused in Crystal
 	const EVENT_HUEY_ASKED_FOR_PHONE_NUMBER
-	const_skip ; unused
+	const_skip ; unused in Crystal
 	const EVENT_GOT_PROTEIN_FROM_HUEY
 	const EVENT_GOT_HP_UP_FROM_JOEY
 	const EVENT_GOT_CARBOS_FROM_VANCE
@@ -293,55 +293,55 @@
 	const EVENT_GOT_CALCIUM_FROM_ERIN
 	const EVENT_KENJI_ON_BREAK
 	const EVENT_GAVEN_ASKED_FOR_PHONE_NUMBER
-	const_skip ; unused
+	const_skip ; unused in Crystal
 	const EVENT_BETH_ASKED_FOR_PHONE_NUMBER
-	const_skip ; unused
+	const_skip ; unused in Crystal
 	const EVENT_JOSE_ASKED_FOR_PHONE_NUMBER
-	const_skip ; unused
+	const_skip ; unused in Crystal
 	const EVENT_REENA_ASKED_FOR_PHONE_NUMBER
-	const_skip ; unused
+	const_skip ; unused in Crystal
 	const EVENT_JOEY_ASKED_FOR_PHONE_NUMBER
-	const_skip ; unused
+	const_skip ; unused in Crystal
 	const EVENT_WADE_ASKED_FOR_PHONE_NUMBER
-	const_skip ; unused
+	const_skip ; unused in Crystal
 	const EVENT_RALPH_ASKED_FOR_PHONE_NUMBER
-	const_skip ; unused
+	const_skip ; unused in Crystal
 	const EVENT_LIZ_ASKED_FOR_PHONE_NUMBER
-	const_skip ; unused
+	const_skip ; unused in Crystal
 	const EVENT_ANTHONY_ASKED_FOR_PHONE_NUMBER
-	const_skip ; unused
+	const_skip ; unused in Crystal
 	const EVENT_TODD_ASKED_FOR_PHONE_NUMBER
-	const_skip ; unused
+	const_skip ; unused in Crystal
 	const EVENT_GINA_ASKED_FOR_PHONE_NUMBER
-	const_skip ; unused
+	const_skip ; unused in Crystal
 	const EVENT_IRWIN_ASKED_FOR_PHONE_NUMBER
-	const_skip ; unused
+	const_skip ; unused in Crystal
 	const EVENT_ARNIE_ASKED_FOR_PHONE_NUMBER
-	const_skip ; unused
+	const_skip ; unused in Crystal
 	const EVENT_ALAN_ASKED_FOR_PHONE_NUMBER
-	const_skip ; unused
+	const_skip ; unused in Crystal
 	const_skip ; unused
 	const_skip ; unused
 	const EVENT_DANA_ASKED_FOR_PHONE_NUMBER
-	const_skip ; unused
+	const_skip ; unused in Crystal
 	const EVENT_CHAD_ASKED_FOR_PHONE_NUMBER
-	const_skip ; unused
+	const_skip ; unused in Crystal
 	const EVENT_DEREK_ASKED_FOR_PHONE_NUMBER
-	const_skip ; unused
+	const_skip ; unused in Crystal
 	const EVENT_TULLY_ASKED_FOR_PHONE_NUMBER
-	const_skip ; unused
+	const_skip ; unused in Crystal
 	const EVENT_BRENT_ASKED_FOR_PHONE_NUMBER
 	const_skip ; unused
 	const EVENT_TIFFANY_ASKED_FOR_PHONE_NUMBER
-	const_skip ; unused
+	const_skip ; unused in Crystal
 	const EVENT_VANCE_ASKED_FOR_PHONE_NUMBER
-	const_skip ; unused
+	const_skip ; unused in Crystal
 	const EVENT_WILTON_ASKED_FOR_PHONE_NUMBER
-	const_skip ; unused
+	const_skip ; unused in Crystal
 	const EVENT_KENJI_ASKED_FOR_PHONE_NUMBER
-	const_skip ; unused
+	const_skip ; unused in Crystal
 	const EVENT_PARRY_ASKED_FOR_PHONE_NUMBER
-	const_skip ; unused
+	const_skip ; unused in Crystal
 	const EVENT_ERIN_ASKED_FOR_PHONE_NUMBER
 	const EVENT_BUENA_OFFERED_HER_PHONE_NUMBER_NO_BLUE_CARD
 	const_skip ; unused
@@ -1229,7 +1229,7 @@
 	const EVENT_COPYCAT_2
 	const EVENT_GOLDENROD_SALE_OFF
 	const EVENT_GOLDENROD_SALE_ON
-	const_skip ; unused
+	const_skip ; unused in Crystal
 	const EVENT_ILEX_FOREST_APPRENTICE
 	const EVENT_ILEX_FOREST_CHARCOAL_MASTER
 	const EVENT_CHARCOAL_KILN_FARFETCH_D

constants/gfx_constants.asm

@@ -21,6 +21,7 @@ SCREEN_META_WIDTH EQU 6 ; metatiles
 SCREEN_META_HEIGHT EQU 5 ; metatiles
 SURROUNDING_WIDTH  EQU SCREEN_META_WIDTH * METATILE_WIDTH ; tiles
 SURROUNDING_HEIGHT EQU SCREEN_META_HEIGHT * METATILE_WIDTH ; tiles
+MAP_CONNECTION_PADDING_WIDTH EQU 3 ; metatiles
 
 HP_BAR_LENGTH  EQU 6 ; tiles
 EXP_BAR_LENGTH EQU 8 ; tiles

constants/hardware_constants.asm

@@ -71,10 +71,10 @@ rTIMA       EQU $ff05 ; Timer counter (R/W)
 rTMA        EQU $ff06 ; Timer Modulo (R/W)
 rTAC        EQU $ff07 ; Timer Control (R/W)
 rTAC_ON        EQU 2
-rTAC_4096_HZ   EQU 0
+rTAC_4096_HZ   EQU %00
-rTAC_262144_HZ EQU 1
+rTAC_262144_HZ EQU %01
-rTAC_65536_HZ  EQU 2
+rTAC_65536_HZ  EQU %10
-rTAC_16384_HZ  EQU 3
+rTAC_16384_HZ  EQU %11
 rIF         EQU $ff0f ; Interrupt Flag (R/W)
 rNR10       EQU $ff10 ; Channel 1 Sweep register (R/W)
 rNR11       EQU $ff11 ; Channel 1 Sound length/Wave pattern duty (R/W)
@@ -147,6 +147,9 @@ rHDMA3      EQU $ff53 ; CGB Mode Only - New DMA Destination, High
 rHDMA4      EQU $ff54 ; CGB Mode Only - New DMA Destination, Low
 rHDMA5      EQU $ff55 ; CGB Mode Only - New DMA Length/Mode/Start
 rRP         EQU $ff56 ; CGB Mode Only - Infrared Communications Port
+rRP_LED_ON EQU 0
+rRP_RECEIVING EQU 1
+rRP_ENABLE_READ_MASK EQU %11000000
 rBGPI       EQU $ff68 ; CGB Mode Only - Background Palette Index
 rBGPI_AUTO_INCREMENT EQU 7 ; increment rBGPI after write to rBGPD
 rBGPD       EQU $ff69 ; CGB Mode Only - Background Palette Data

constants/landmark_constants.asm

@@ -102,8 +102,9 @@ KANTO_LANDMARK EQU const_value
 	const LANDMARK_FAST_SHIP         ; 5f
 
 ; used in CaughtData
-LANDMARK_GIFT  EQU $7e
+	const_def $7f, -1
-LANDMARK_EVENT EQU $7f
+	const LANDMARK_EVENT             ; $7f
+	const LANDMARK_GIFT              ; $7e
 
 ; Regions
 	const_def

constants/map_constants.asm

@@ -1,5 +1,5 @@
 newgroup: MACRO
-const_value = const_value + 1
+	const_skip
 __map_value__ = 1
 ENDM
 

constants/map_data_constants.asm

@@ -66,7 +66,7 @@ NUM_MAP_PALETTES EQU const_value
 	shift_const NORTH
 
 ; SpawnPoints indexes (see data/maps/spawn_points.asm)
-const_value = -1
+	const_def -1
 	const SPAWN_N_A
 	const SPAWN_HOME
 	const SPAWN_DEBUG

constants/misc_constants.asm

@@ -14,6 +14,8 @@ FEMALE EQU 1
 
 ; G/S version ID: 0 = Gold, 1 = Silver (used by checkver)
 GS_VERSION EQU 0
+; Pokémon Pikachu 2, a step counter / virtual pet device (used by Mystery Gift)
+POKEMON_PIKACHU_2_VERSION EQU 3
 
 ; save file corruption check values
 SAVE_CHECK_VALUE_1 EQU 99

constants/pokemon_constants.asm

@@ -10,14 +10,14 @@
 ; - PokemonPalettes (see data/pokemon/palettes.asm)
 ; - PokedexDataPointerTable (see data/pokemon/dex_entry_pointers.asm)
 ; - AlphabeticalPokedexOrder (see data/pokemon/dex_order_alpha.asm)
-; - EZChat_SortedPokemon (see data/pokemon/ezchat_order.asm)
 ; - NewPokedexOrder (see data/pokemon/dex_order_new.asm)
 ; - Pokered_MonIndices (see data/pokemon/gen1_order.asm)
+; - Footprints (see gfx/footprints.asm)
 ; - AnimationPointers (see gfx/pokemon/anim_pointers.asm)
 ; - AnimationIdlePointers (see gfx/pokemon/idle_pointers.asm)
 ; - BitmasksPointers (see gfx/pokemon/bitmask_pointers.asm)
 ; - FramesPointers (see gfx/pokemon/frame_pointers.asm)
-; - Footprints (see gfx/footprints.asm)
+; - EZChat_SortedPokemon (see data/pokemon/ezchat_order.asm)
 	const_def 1
 	const BULBASAUR  ; 01
 	const IVYSAUR    ; 02

constants/pokemon_data_constants.asm

@@ -179,7 +179,7 @@ NUM_TREEMON_SETS EQU const_value
 	const TREEMON_SCORE_RARE ; 2
 
 ; ChangeHappiness arguments (see data/happiness_changes.asm)
-const_value = 1
+	const_def 1
 	const HAPPINESS_GAINLEVEL         ; 01
 	const HAPPINESS_USEDITEM          ; 02
 	const HAPPINESS_USEDXITEM         ; 03

constants/scgb_constants.asm

@@ -35,6 +35,12 @@
 SCGB_PARTY_MENU_HP_BARS EQU $fc
 SCGB_DEFAULT EQU $ff
 
+; GetCrystalCGBLayout arguments (see engine/gfx/crystal_layouts.asm)
+	const_def
+	const CRYSTAL_CGB_MOBILE_0
+	const CRYSTAL_CGB_MOBILE_1
+	const CRYSTAL_CGB_NAME_CARD
+
 ; PredefPals indexes (see gfx/sgb/predef.pal)
 ; GetPredefPal arguments (see engine/gfx/color.asm)
 	const_def

constants/serial_constants.asm

@@ -30,3 +30,8 @@ SERIAL_NO_DATA_BYTE               EQU $fe
 SERIAL_PATCH_LIST_PART_TERMINATOR EQU $ff
 
 SERIAL_PREAMBLE_LENGTH EQU 6
+
+; timeout duration after exchanging a byte
+SERIAL_LINK_BYTE_TIMEOUT EQU $5000
+
+MAX_MYSTERY_GIFT_PARTNERS EQU 5

constants/trainer_constants.asm

@@ -3,7 +3,7 @@ __trainer_class__ = 0
 trainerclass: MACRO
 \1 EQU __trainer_class__
 __trainer_class__ = __trainer_class__ + 1
-const_value = 1
+	const_def 1
 ENDM
 
 ; trainer class ids

constants/wram_constants.asm

@@ -21,9 +21,13 @@ AUTO_INPUT EQU $ff
 	const TEMPMON    ; 3
 	const WILDMON    ; 4
 
-; wGameTimerPause::
+; wGameTimerPaused::
-GAMETIMERPAUSE_TIMER_PAUSED_F EQU 0
+GAME_TIMER_PAUSED_F EQU 0
-GAMETIMERPAUSE_MOBILE_7_F     EQU 7
+GAME_TIMER_MOBILE_F EQU 7
+
+; wJoypadDisable::
+JOYPAD_DISABLE_MON_FAINT_F    EQU 6
+JOYPAD_DISABLE_SGB_TRANSFER_F EQU 7
 
 ; wOptions::
 TEXT_DELAY_MASK EQU %111
@@ -80,11 +84,12 @@ LEFT_MASK  EQU 1 << LEFT
 RIGHT_MASK EQU 1 << RIGHT
 
 ; wFacingDirection::
+	const_def NUM_DIRECTIONS - 1, -1
+	shift_const FACE_DOWN  ; 8
+	shift_const FACE_UP    ; 4
+	shift_const FACE_LEFT  ; 2
+	shift_const FACE_RIGHT ; 1
 FACE_CURRENT EQU 0
-FACE_DOWN    EQU 8
-FACE_UP      EQU 4
-FACE_LEFT    EQU 2
-FACE_RIGHT   EQU 1
 
 ; wPokemonWithdrawDepositParameter::
 PC_WITHDRAW       EQU 0

data/battle/effect_command_pointers.asm

@@ -63,7 +63,7 @@ BattleCommandPointers:
 	dw BattleCommand_Charge
 	dw BattleCommand_CheckCharge
 	dw BattleCommand_TrapTarget
-	dw BattleCommand3c
+	dw BattleCommand_Unused3C
 	dw BattleCommand_Rampage
 	dw BattleCommand_CheckRampage
 	dw BattleCommand_ConstantDamage
@@ -96,7 +96,7 @@ BattleCommandPointers:
 	dw BattleCommand_Endure
 	dw BattleCommand_CheckCurl
 	dw BattleCommand_RolloutPower
-	dw BattleCommand5d
+	dw BattleCommand_Unused5D
 	dw BattleCommand_FuryCutter
 	dw BattleCommand_Attract
 	dw BattleCommand_HappinessPower

data/battle_tower/parties.asm

@@ -1,7 +1,7 @@
 BattleTowerMons:
-; 10 groups of 21 mons.
+; 10 groups (one per floor level) of 21 mons (BATTLETOWER_NUM_UNIQUE_MON).
 
-BattleTowerMons1:
+; BattleTowerMons group 1
 
 	db JOLTEON
 	db MIRACLEBERRY
@@ -550,7 +550,7 @@ BattleTowerMons1:
 	db "BARIYA-DO@@"
 
 
-BattleTowerMons2:
+; BattleTowerMons group 2
 
 	db UMBREON
 	db LEFTOVERS
@@ -1099,7 +1099,7 @@ BattleTowerMons2:
 	db "NUO-@@@@@@@"
 
 
-BattleTowerMons3:
+; BattleTowerMons group 3
 
 	db JOLTEON
 	db MIRACLEBERRY
@@ -1648,7 +1648,7 @@ BattleTowerMons3:
 	db "OKORIZARU@@"
 
 
-BattleTowerMons4:
+; BattleTowerMons group 4
 
 	db TAUROS
 	db GOLD_BERRY
@@ -2197,7 +2197,7 @@ BattleTowerMons4:
 	db "EREBU-@@@@@"
 
 
-BattleTowerMons5:
+; BattleTowerMons group 5
 
 	db KINGDRA
 	db GOLD_BERRY
@@ -2746,7 +2746,7 @@ BattleTowerMons5:
 	db "HURI-ZA-@@@"
 
 
-BattleTowerMons6:
+; BattleTowerMons group 6
 
 	db KINGDRA
 	db LEFTOVERS
@@ -3295,7 +3295,7 @@ BattleTowerMons6:
 	db "GORO-NIya@@"
 
 
-BattleTowerMons7:
+; BattleTowerMons group 7
 
 	db JOLTEON
 	db MIRACLEBERRY
@@ -3844,7 +3844,7 @@ BattleTowerMons7:
 	db "KAMEtuKUSU@"
 
 
-BattleTowerMons8:
+; BattleTowerMons group 8
 
 	db JOLTEON
 	db MIRACLEBERRY
@@ -4393,7 +4393,7 @@ BattleTowerMons8:
 	db "GURANBURU@@"
 
 
-BattleTowerMons9:
+; BattleTowerMons group 9
 
 	db UMBREON
 	db KINGS_ROCK
@@ -4942,7 +4942,7 @@ BattleTowerMons9:
 	db "BETOBETON@@"
 
 
-BattleTowerMons10:
+; BattleTowerMons group 10
 
 	db HOUNDOOM
 	db MINT_BERRY

data/battle_tower/unknown.asm

@@ -1,8 +1,8 @@
-BattleTowerTrainerData:: ; What exactly it is, I don't know
+BattleTowerTrainerData:: ; ???
-; Size is 70 (Nr of Trainers in BattleTower) * 0x24 (Nr of Bytes that are copied)
+; 70 tables (BATTLETOWER_NUM_UNIQUE_TRAINERS) of 18 two-argument entries (total size BATTLETOWER_TRAINERDATALENGTH).
 ; Second argument points to an entry in Unknown_170470, to which the first argument is compared.
 
-BattleTowerTrainer1DataTable:
+; BattleTowerTrainerData table 1:
 	db $37,  3
 	db $0e,  9
 	db $25, 11
@@ -22,7 +22,7 @@ BattleTowerTrainer1DataTable:
 	db $34,  3
 	db $06,  5
 
-BattleTowerTrainer2DataTable:
+; BattleTowerTrainerData table 2:
 	db $36,  3
 	db $ca,  0
 	db $22,  8
@@ -42,7 +42,7 @@ BattleTowerTrainer2DataTable:
 	db $28, 11
 	db $0c, 13
 
-BattleTowerTrainer3DataTable:
+; BattleTowerTrainerData table 3:
 	db $32,  6
 	db $31,  4
 	db $02,  2
@@ -62,7 +62,7 @@ BattleTowerTrainer3DataTable:
 	db $22,  2
 	db $13, 13
 
-BattleTowerTrainer4DataTable:
+; BattleTowerTrainerData table 4:
 	db $22, 12
 	db $22, 12
 	db $0a,  9
@@ -82,7 +82,7 @@ BattleTowerTrainer4DataTable:
 	db $1c, 11
 	db $41, 11
 
-BattleTowerTrainer5DataTable:
+; BattleTowerTrainerData table 5:
 	db $a3,  0
 	db $41,  3
 	db $1f,  4
@@ -102,7 +102,7 @@ BattleTowerTrainer5DataTable:
 	db $d1,  0
 	db $0a,  6
 
-BattleTowerTrainer6DataTable:
+; BattleTowerTrainerData table 6:
 	db $13,  2
 	db $31,  6
 	db $04,  2
@@ -122,7 +122,7 @@ BattleTowerTrainer6DataTable:
 	db $08,  5
 	db $1a, 13
 
-BattleTowerTrainer7DataTable:
+; BattleTowerTrainerData table 7:
 	db $0d,  2
 	db $07,  2
 	db $00,  5
@@ -142,7 +142,7 @@ BattleTowerTrainer7DataTable:
 	db $20,  4
 	db $23, 13
 
-BattleTowerTrainer8DataTable:
+; BattleTowerTrainerData table 8:
 	db $1e,  2
 	db $22,  2
 	db $00,  5
@@ -162,7 +162,7 @@ BattleTowerTrainer8DataTable:
 	db $14,  8
 	db $00,  5
 
-BattleTowerTrainer9DataTable:
+; BattleTowerTrainerData table 9:
 	db $06, 12
 	db $09,  6
 	db $00,  0
@@ -182,7 +182,7 @@ BattleTowerTrainer9DataTable:
 	db $31, 13
 	db $01,  5
 
-BattleTowerTrainer10DataTable:
+; BattleTowerTrainerData table 10:
 	db $22, 12
 	db $30,  4
 	db $01,  5
@@ -202,7 +202,7 @@ BattleTowerTrainer10DataTable:
 	db $30, 13
 	db $06,  5
 
-BattleTowerTrainer11DataTable:
+; BattleTowerTrainerData table 11:
 	db $0e,  6
 	db $04,  5
 	db $2c,  4
@@ -222,7 +222,7 @@ BattleTowerTrainer11DataTable:
 	db $26, 13
 	db $04,  5
 
-BattleTowerTrainer12DataTable:
+; BattleTowerTrainerData table 12:
 	db $18,  2
 	db $33,  3
 	db $28,  4
@@ -242,7 +242,7 @@ BattleTowerTrainer12DataTable:
 	db $0f,  2
 	db $00,  5
 
-BattleTowerTrainer13DataTable:
+; BattleTowerTrainerData table 13:
 	db $3a, 11
 	db $3a, 11
 	db $00,  5
@@ -262,7 +262,7 @@ BattleTowerTrainer13DataTable:
 	db $3a,  8
 	db $2a, 13
 
-BattleTowerTrainer14DataTable:
+; BattleTowerTrainerData table 14:
 	db $31,  5
 	db $11, 14
 	db $30,  4
@@ -282,7 +282,7 @@ BattleTowerTrainer14DataTable:
 	db $3b,  7
 	db $0e, 13
 
-BattleTowerTrainer15DataTable:
+; BattleTowerTrainerData table 15:
 	db $1b,  2
 	db $2c,  4
 	db $0d, 13
@@ -302,7 +302,7 @@ BattleTowerTrainer15DataTable:
 	db $06,  5
 	db $00,  0
 
-BattleTowerTrainer16DataTable:
+; BattleTowerTrainerData table 16:
 	db $42,  3
 	db $30,  4
 	db $1f, 11
@@ -322,7 +322,7 @@ BattleTowerTrainer16DataTable:
 	db $36,  8
 	db $41, 13
 
-BattleTowerTrainer17DataTable:
+; BattleTowerTrainerData table 17:
 	db $18,  3
 	db $42,  3
 	db $43,  4
@@ -342,7 +342,7 @@ BattleTowerTrainer17DataTable:
 	db $3f,  4
 	db $20, 14
 
-BattleTowerTrainer18DataTable:
+; BattleTowerTrainerData table 18:
 	db $0c,  5
 	db $36,  7
 	db $30,  4
@@ -362,7 +362,7 @@ BattleTowerTrainer18DataTable:
 	db $30,  7
 	db $06,  5
 
-BattleTowerTrainer19DataTable:
+; BattleTowerTrainerData table 19:
 	db $36,  3
 	db $06,  6
 	db $44,  4
@@ -382,7 +382,7 @@ BattleTowerTrainer19DataTable:
 	db $05, 13
 	db $00,  0
 
-BattleTowerTrainer20DataTable:
+; BattleTowerTrainerData table 20:
 	db $3f,  6
 	db $2c,  4
 	db $34, 13
@@ -402,7 +402,7 @@ BattleTowerTrainer20DataTable:
 	db $34,  7
 	db $04, 13
 
-BattleTowerTrainer21DataTable:
+; BattleTowerTrainerData table 21:
 	db $12,  3
 	db $02,  4
 	db $07,  7
@@ -422,7 +422,7 @@ BattleTowerTrainer21DataTable:
 	db $28, 11
 	db $02,  5
 
-BattleTowerTrainer22DataTable:
+; BattleTowerTrainerData table 22:
 	db $41,  4
 	db $3c, 11
 	db $34, 13
@@ -442,7 +442,7 @@ BattleTowerTrainer22DataTable:
 	db $0c,  4
 	db $3b, 13
 
-BattleTowerTrainer23DataTable:
+; BattleTowerTrainerData table 23:
 	db $03, 10
 	db $3a, 13
 	db $2c,  4
@@ -462,7 +462,7 @@ BattleTowerTrainer23DataTable:
 	db $13,  4
 	db $04,  5
 
-BattleTowerTrainer24DataTable:
+; BattleTowerTrainerData table 24:
 	db $06,  5
 	db $06,  5
 	db $06,  5
@@ -482,7 +482,7 @@ BattleTowerTrainer24DataTable:
 	db $33,  4
 	db $03,  5
 
-BattleTowerTrainer25DataTable:
+; BattleTowerTrainerData table 25:
 	db $27,  5
 	db $01,  5
 	db $00,  0
@@ -502,7 +502,7 @@ BattleTowerTrainer25DataTable:
 	db $0c,  4
 	db $19, 13
 
-BattleTowerTrainer26DataTable:
+; BattleTowerTrainerData table 26:
 	db $03,  2
 	db $43,  3
 	db $27,  4
@@ -522,7 +522,7 @@ BattleTowerTrainer26DataTable:
 	db $20,  4
 	db $41, 13
 
-BattleTowerTrainer27DataTable:
+; BattleTowerTrainerData table 27:
 	db $34,  3
 	db $00,  3
 	db $11, 13
@@ -542,7 +542,7 @@ BattleTowerTrainer27DataTable:
 	db $0d,  6
 	db $20,  6
 
-BattleTowerTrainer28DataTable:
+; BattleTowerTrainerData table 28:
 	db $19,  3
 	db $17, 11
 	db $20,  6
@@ -562,7 +562,7 @@ BattleTowerTrainer28DataTable:
 	db $06, 12
 	db $1a, 11
 
-BattleTowerTrainer29DataTable:
+; BattleTowerTrainerData table 29:
 	db $0a,  3
 	db $0c, 12
 	db $25, 10
@@ -582,7 +582,7 @@ BattleTowerTrainer29DataTable:
 	db $0a,  9
 	db $2f, 13
 
-BattleTowerTrainer30DataTable:
+; BattleTowerTrainerData table 30:
 	db $15,  2
 	db $2c,  4
 	db $03,  2
@@ -602,7 +602,7 @@ BattleTowerTrainer30DataTable:
 	db $0c,  4
 	db $3b, 13
 
-BattleTowerTrainer31DataTable:
+; BattleTowerTrainerData table 31:
 	db $10, 11
 	db $04,  4
 	db $00,  5
@@ -622,7 +622,7 @@ BattleTowerTrainer31DataTable:
 	db $13,  7
 	db $16, 13
 
-BattleTowerTrainer32DataTable:
+; BattleTowerTrainerData table 32:
 	db $0f, 14
 	db $19, 13
 	db $00,  5
@@ -642,7 +642,7 @@ BattleTowerTrainer32DataTable:
 	db $19, 13
 	db $01,  5
 
-BattleTowerTrainer33DataTable:
+; BattleTowerTrainerData table 33:
 	db $35,  3
 	db $06,  4
 	db $0d,  6
@@ -662,7 +662,7 @@ BattleTowerTrainer33DataTable:
 	db $29,  8
 	db $03,  5
 
-BattleTowerTrainer34DataTable:
+; BattleTowerTrainerData table 34:
 	db $18,  4
 	db $03,  5
 	db $0b, 13
@@ -682,7 +682,7 @@ BattleTowerTrainer34DataTable:
 	db $0c,  6
 	db $1a, 13
 
-BattleTowerTrainer35DataTable:
+; BattleTowerTrainerData table 35:
 	db $0c, 12
 	db $37,  3
 	db $1a,  3
@@ -702,7 +702,7 @@ BattleTowerTrainer35DataTable:
 	db $3b,  8
 	db $1b,  7
 
-BattleTowerTrainer36DataTable:
+; BattleTowerTrainerData table 36:
 	db $18,  3
 	db $1b,  8
 	db $29, 11
@@ -722,7 +722,7 @@ BattleTowerTrainer36DataTable:
 	db $2f,  8
 	db $27,  6
 
-BattleTowerTrainer37DataTable:
+; BattleTowerTrainerData table 37:
 	db $1c,  3
 	db $02, 14
 	db $31,  3
@@ -742,7 +742,7 @@ BattleTowerTrainer37DataTable:
 	db $27,  4
 	db $34, 13
 
-BattleTowerTrainer38DataTable:
+; BattleTowerTrainerData table 38:
 	db $33,  3
 	db $30,  4
 	db $2c,  4
@@ -762,7 +762,7 @@ BattleTowerTrainer38DataTable:
 	db $40,  6
 	db $22,  7
 
-BattleTowerTrainer39DataTable:
+; BattleTowerTrainerData table 39:
 	db $22, 12
 	db $22, 12
 	db $16, 10
@@ -782,7 +782,7 @@ BattleTowerTrainer39DataTable:
 	db $2c,  4
 	db $26,  7
 
-BattleTowerTrainer40DataTable:
+; BattleTowerTrainerData table 40:
 	db $0e,  6
 	db $05,  8
 	db $04, 13
@@ -802,7 +802,7 @@ BattleTowerTrainer40DataTable:
 	db $00,  0
 	db $00,  0
 
-BattleTowerTrainer41DataTable:
+; BattleTowerTrainerData table 41:
 	db $18,  3
 	db $27,  3
 	db $03,  5
@@ -822,7 +822,7 @@ BattleTowerTrainer41DataTable:
 	db $2f,  8
 	db $06,  5
 
-BattleTowerTrainer42DataTable:
+; BattleTowerTrainerData table 42:
 	db $36,  3
 	db $30,  4
 	db $17,  4
@@ -842,7 +842,7 @@ BattleTowerTrainer42DataTable:
 	db $07, 13
 	db $3b, 13
 
-BattleTowerTrainer43DataTable:
+; BattleTowerTrainerData table 43:
 	db $0b,  5
 	db $14,  6
 	db $24,  4
@@ -862,7 +862,7 @@ BattleTowerTrainer43DataTable:
 	db $00,  2
 	db $07,  5
 
-BattleTowerTrainer44DataTable:
+; BattleTowerTrainerData table 44:
 	db $0a,  3
 	db $32,  7
 	db $0b, 14
@@ -882,7 +882,7 @@ BattleTowerTrainer44DataTable:
 	db $1e,  6
 	db $14,  7
 
-BattleTowerTrainer45DataTable:
+; BattleTowerTrainerData table 45:
 	db $0e,  6
 	db $2c,  4
 	db $00, 13
@@ -902,7 +902,7 @@ BattleTowerTrainer45DataTable:
 	db $31,  4
 	db $21, 13
 
-BattleTowerTrainer46DataTable:
+; BattleTowerTrainerData table 46:
 	db $22,  5
 	db $07, 14
 	db $30,  4
@@ -922,7 +922,7 @@ BattleTowerTrainer46DataTable:
 	db $3f,  4
 	db $06,  5
 
-BattleTowerTrainer47DataTable:
+; BattleTowerTrainerData table 47:
 	db $3a,  7
 	db $3b,  7
 	db $36,  3
@@ -942,7 +942,7 @@ BattleTowerTrainer47DataTable:
 	db $3f,  4
 	db $0c, 13
 
-BattleTowerTrainer48DataTable:
+; BattleTowerTrainerData table 48:
 	db $43,  3
 	db $20,  4
 	db $41, 13
@@ -962,7 +962,7 @@ BattleTowerTrainer48DataTable:
 	db $39,  4
 	db $41, 13
 
-BattleTowerTrainer49DataTable:
+; BattleTowerTrainerData table 49:
 	db $36,  3
 	db $16,  4
 	db $08,  6
@@ -982,7 +982,7 @@ BattleTowerTrainer49DataTable:
 	db $2c, 13
 	db $00,  5
 
-BattleTowerTrainer50DataTable:
+; BattleTowerTrainerData table 50:
 	db $11,  5
 	db $25,  3
 	db $33,  4
@@ -1002,7 +1002,7 @@ BattleTowerTrainer50DataTable:
 	db $19, 13
 	db $06,  5
 
-BattleTowerTrainer51DataTable:
+; BattleTowerTrainerData table 51:
 	db $2c,  4
 	db $0a, 13
 	db $04,  5
@@ -1022,7 +1022,7 @@ BattleTowerTrainer51DataTable:
 	db $29,  8
 	db $05, 13
 
-BattleTowerTrainer52DataTable:
+; BattleTowerTrainerData table 52:
 	db $05,  3
 	db $1b,  4
 	db $41,  3
@@ -1042,7 +1042,7 @@ BattleTowerTrainer52DataTable:
 	db $1d, 11
 	db $03,  5
 
-BattleTowerTrainer53DataTable:
+; BattleTowerTrainerData table 53:
 	db $1c, 12
 	db $20,  6
 	db $05,  8
@@ -1062,7 +1062,7 @@ BattleTowerTrainer53DataTable:
 	db $06,  5
 	db $1f,  8
 
-BattleTowerTrainer54DataTable:
+; BattleTowerTrainerData table 54:
 	db $37,  3
 	db $0e,  1
 	db $08,  1
@@ -1082,7 +1082,7 @@ BattleTowerTrainer54DataTable:
 	db $41,  8
 	db $3b, 13
 
-BattleTowerTrainer55DataTable:
+; BattleTowerTrainerData table 55:
 	db $06,  2
 	db $00,  5
 	db $34,  3
@@ -1102,7 +1102,7 @@ BattleTowerTrainer55DataTable:
 	db $1b,  4
 	db $0c, 13
 
-BattleTowerTrainer56DataTable:
+; BattleTowerTrainerData table 56:
 	db $2c,  4
 	db $13,  9
 	db $20,  6
@@ -1122,7 +1122,7 @@ BattleTowerTrainer56DataTable:
 	db $06, 13
 	db $3b, 13
 
-BattleTowerTrainer57DataTable:
+; BattleTowerTrainerData table 57:
 	db $06,  3
 	db $20,  4
 	db $24, 13
@@ -1142,7 +1142,7 @@ BattleTowerTrainer57DataTable:
 	db $09,  6
 	db $06,  5
 
-BattleTowerTrainer58DataTable:
+; BattleTowerTrainerData table 58:
 	db $44,  7
 	db $23, 11
 	db $33, 13
@@ -1162,7 +1162,7 @@ BattleTowerTrainer58DataTable:
 	db $11,  8
 	db $41, 13
 
-BattleTowerTrainer59DataTable:
+; BattleTowerTrainerData table 59:
 	db $36,  3
 	db $06,  6
 	db $30,  4
@@ -1182,7 +1182,7 @@ BattleTowerTrainer59DataTable:
 	db $0b,  6
 	db $27,  6
 
-BattleTowerTrainer60DataTable:
+; BattleTowerTrainerData table 60:
 	db $14,  5
 	db $04,  2
 	db $09, 14
@@ -1202,7 +1202,7 @@ BattleTowerTrainer60DataTable:
 	db $39,  4
 	db $00,  5
 
-BattleTowerTrainer61DataTable:
+; BattleTowerTrainerData table 61:
 	db $34,  3
 	db $00,  3
 	db $11, 13
@@ -1222,7 +1222,7 @@ BattleTowerTrainer61DataTable:
 	db $1e,  6
 	db $14, 13
 
-BattleTowerTrainer62DataTable:
+; BattleTowerTrainerData table 62:
 	db $37,  5
 	db $37,  5
 	db $00,  5
@@ -1242,7 +1242,7 @@ BattleTowerTrainer62DataTable:
 	db $16,  5
 	db $01,  5
 
-BattleTowerTrainer63DataTable:
+; BattleTowerTrainerData table 63:
 	db $1f, 14
 	db $36,  4
 	db $40, 13
@@ -1262,7 +1262,7 @@ BattleTowerTrainer63DataTable:
 	db $27, 13
 	db $00,  0
 
-BattleTowerTrainer64DataTable:
+; BattleTowerTrainerData table 64:
 	db $41,  8
 	db $0b,  6
 	db $37,  3
@@ -1282,7 +1282,7 @@ BattleTowerTrainer64DataTable:
 	db $28,  6
 	db $06,  5
 
-BattleTowerTrainer65DataTable:
+; BattleTowerTrainerData table 65:
 	db $0c,  8
 	db $2c,  4
 	db $1c, 11
@@ -1302,7 +1302,7 @@ BattleTowerTrainer65DataTable:
 	db $20,  6
 	db $22,  7
 
-BattleTowerTrainer66DataTable:
+; BattleTowerTrainerData table 66:
 	db $22, 12
 	db $22, 12
 	db $0a,  9
@@ -1322,7 +1322,7 @@ BattleTowerTrainer66DataTable:
 	db $02,  7
 	db $04,  5
 
-BattleTowerTrainer67DataTable:
+; BattleTowerTrainerData table 67:
 	db $2d, 11
 	db $02,  8
 	db $37, 13
@@ -1342,7 +1342,7 @@ BattleTowerTrainer67DataTable:
 	db $10,  5
 	db $04,  5
 
-BattleTowerTrainer68DataTable:
+; BattleTowerTrainerData table 68:
 	db $3f,  3
 	db $16, 14
 	db $3f,  8
@@ -1362,7 +1362,7 @@ BattleTowerTrainer68DataTable:
 	db $26,  7
 	db $03,  5
 
-BattleTowerTrainer69DataTable:
+; BattleTowerTrainerData table 69:
 	db $3a,  6
 	db $2c,  3
 	db $12,  3
@@ -1382,7 +1382,7 @@ BattleTowerTrainer69DataTable:
 	db $1b,  7
 	db $00,  5
 
-BattleTowerTrainer70DataTable:
+; BattleTowerTrainerData table 70:
 	db $1b,  2
 	db $00,  5
 	db $0c,  8
@@ -1401,4 +1401,3 @@ BattleTowerTrainer70DataTable:
 	db $22,  7
 	db $d1,  0
 	db $32, 13
-BattleTowerTrainerDataEnd:

data/collision/field_move_blocks.asm

@@ -1,3 +1,4 @@
+; these blocks all use COLL_CUT_TREE in one quadrant
 CutTreeBlockPointers:
 ; tileset, block list pointer
 	dbw TILESET_JOHTO,        .johto
@@ -42,6 +43,8 @@ CutTreeBlockPointers:
 	db $0f, $17, 0
 	db -1 ; end
 
+
+; these blocks all use COLL_WHIRLPOOL in one quadrant
 WhirlpoolBlockPointers:
 	dbw TILESET_JOHTO, .johto
 	db -1 ; end

data/decorations/decorations.asm

@@ -48,7 +48,8 @@ DecorationIDs:
 	db DECO_BIG_SNORLAX_DOLL ; 1a
 	db DECO_BIG_ONIX_DOLL ; 1b
 	db DECO_BIG_LAPRAS_DOLL ; 1c
-TrophyIDs:
+
 	db DECO_GOLD_TROPHY_DOLL ; 33
 	db DECO_SILVER_TROPHY_DOLL ; 34
-	db -1
+
+	db -1 ; end

data/events/engine_flags.asm

@@ -125,7 +125,7 @@ EngineFlags:
 	engine_flag wSwarmFlags, SWARMFLAGS_BUENAS_PASSWORD_F
 	engine_flag wSwarmFlags, SWARMFLAGS_GOLDENROD_DEPT_STORE_SALE_F
 
-	engine_flag wGameTimerPause, GAMETIMERPAUSE_MOBILE_7_F
+	engine_flag wGameTimerPaused, GAME_TIMER_MOBILE_F
 
 	engine_flag wPlayerGender, PLAYERGENDER_FEMALE_F
 

data/events/special_pointers.asm

@@ -55,8 +55,8 @@ SpecialsPointers::
 	add_special UnownPuzzle
 	add_special SlotMachine
 	add_special CardFlip
-	add_special DummyNonfunctionalGameCornerGame
+	add_special UnusedDummyGame ; unused
-	add_special ClearBGPalettesBufferScreen
+	add_special ClearBGPalettesBufferScreen ; unused
 	add_special FadeOutPalettes
 	add_special BattleTowerFade
 	add_special FadeBlackQuickly
@@ -65,21 +65,21 @@ SpecialsPointers::
 	add_special ReloadSpritesNoPalettes ; bank 0
 	add_special ClearBGPalettes ; bank 0
 	add_special UpdateTimePals ; bank 0
-	add_special ClearTilemap ; bank 0
+	add_special ClearTilemap ; bank 0; unused as special
 	add_special UpdateSprites ; bank 0
 	add_special UpdatePlayerSprite ; bank 0
 	add_special GameCornerPrizeMonCheckDex
-	add_special UnusedSetSeenMon
+	add_special UnusedSetSeenMon ; unused
 	add_special WaitSFX ; bank 0
 	add_special PlayMapMusic ; bank 0
 	add_special RestartMapMusic ; bank 0
 	add_special HealMachineAnim
 	add_special SurfStartStep
-	add_special FindPartyMonAboveLevel
+	add_special FindPartyMonAboveLevel ; unused
-	add_special FindPartyMonAtLeastThatHappy
+	add_special FindPartyMonAtLeastThatHappy ; unused
 	add_special FindPartyMonThatSpecies
 	add_special FindPartyMonThatSpeciesYourTrainerID
-	add_special UnusedCheckUnusedTwoDayTimer
+	add_special UnusedCheckUnusedTwoDayTimer ; unused
 	add_special DayCareMon1
 	add_special DayCareMon2
 	add_special SelectRandomBugContestContestants
@@ -134,7 +134,7 @@ SpecialsPointers::
 	add_special Function170114
 	add_special BattleTowerBattle
 	add_special Function1704e1
-	add_special DummySpecial_17021d
+	add_special UnusedBattleTowerDummySpecial1
 	add_special LoadOpponentTrainerAndPokemonWithOTSprite
 	add_special Function11ba38
 	add_special CheckForBattleTowerRules
@@ -166,7 +166,7 @@ SpecialsPointers::
 	add_special BeastsCheck
 	add_special MonCheck
 	add_special SetPlayerPalette
-	add_special DummySpecial_170bd2
+	add_special UnusedBattleTowerDummySpecial2
 	add_special Mobile_SelectThreeMons
 	add_special Function1037eb
 	add_special Function10383c
@@ -179,6 +179,7 @@ SpecialsPointers::
 	add_special AskRememberPassword
 	add_special LoadMapPalettes
 	add_special UnusedFindItemInPCOrBag
+
 	add_special InitialSetDSTFlag
 	add_special InitialClearDSTFlag
-	add_special DummySpecial_c224
+	add_special UnusedDummySpecial ; unused

data/maps/blocks.asm

@@ -15,7 +15,7 @@ Route44_Blocks:
 Route28_Blocks:
 	INCBIN "maps/Route28.blk"
 
-BetaPlayersHouse2F_Blocks:
+BetaPlayersHouse2F_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaPlayersHouse2F.blk"
 
 CeladonCity_Blocks:
@@ -30,25 +30,25 @@ Route2_Blocks:
 ElmsHouse_Blocks:
 	INCBIN "maps/ElmsHouse.blk"
 
-BetaSproutTower1_Blocks:
+BetaSproutTower1_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaSproutTower1.blk"
 
 Route11_Blocks:
 	INCBIN "maps/Route11.blk"
 
-BetaSproutTower5_Blocks:
+BetaSproutTower5_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaSproutTower5.blk"
 
 Route15_Blocks:
 	INCBIN "maps/Route15.blk"
 
-BetaSproutTower9_Blocks:
+BetaSproutTower9_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaSproutTower9.blk"
 
 Route19_Blocks:
 	INCBIN "maps/Route19.blk"
 
-BetaBlackthornCity_Blocks:
+BetaBlackthornCity_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaBlackthornCity.blk"
 
 Route10South_Blocks:
@@ -94,7 +94,7 @@ Route25_Blocks:
 Route24_Blocks:
 	INCBIN "maps/Route24.blk"
 
-BetaVioletCity_Blocks:
+BetaVioletCity_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaVioletCity.blk"
 
 Route3_Blocks:
@@ -103,25 +103,25 @@ Route3_Blocks:
 PewterCity_Blocks:
 	INCBIN "maps/PewterCity.blk"
 
-BetaSilverCaveOutside_Blocks:
+BetaSilverCaveOutside_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaSilverCaveOutside.blk"
 
-BetaSproutTower2_Blocks:
+BetaSproutTower2_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaSproutTower2.blk"
 
 Route12_Blocks:
 	INCBIN "maps/Route12.blk"
 
-BetaGoldenrodCity_Blocks:
+BetaGoldenrodCity_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaGoldenrodCity.blk"
 
 Route20_Blocks:
 	INCBIN "maps/Route20.blk"
 
-BetaSproutTower6_Blocks:
+BetaSproutTower6_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaSproutTower6.blk"
 
-BetaPokecenter_Blocks:
+BetaPokecenter_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaPokecenter.blk"
 
 Route30_Blocks:
@@ -145,7 +145,7 @@ FuchsiaCity_Blocks:
 Route38_Blocks:
 	INCBIN "maps/Route38.blk"
 
-BetaCianwoodCity_Blocks:
+BetaCianwoodCity_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaCianwoodCity.blk"
 
 OlivineTimsHouse_Blocks:
@@ -214,10 +214,10 @@ Route29Route46Gate_Blocks:
 Route5SaffronGate_Blocks:
 	INCBIN "maps/NorthSouthGate.blk"
 
-BetaEcruteakCity_Blocks:
+BetaEcruteakCity_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaEcruteakCity.blk"
 
-BetaCherrygroveCity_Blocks:
+BetaCherrygroveCity_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaCherrygroveCity.blk"
 
 CinnabarIsland_Blocks:
@@ -229,7 +229,7 @@ Route4_Blocks:
 Route8_Blocks:
 	INCBIN "maps/Route8.blk"
 
-BetaSproutTower3_Blocks:
+BetaSproutTower3_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaSproutTower3.blk"
 
 ViridianCity_Blocks:
@@ -241,13 +241,13 @@ Route13_Blocks:
 Route21_Blocks:
 	INCBIN "maps/Route21.blk"
 
-BetaSproutTower7_Blocks:
+BetaSproutTower7_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaSproutTower7.blk"
 
 Route17_Blocks:
 	INCBIN "maps/Route17.blk"
 
-BetaMahoganyTown_Blocks:
+BetaMahoganyTown_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaMahoganyTown.blk"
 
 Route31_Blocks:
@@ -280,16 +280,16 @@ Route17Route18Gate_Blocks:
 Route31VioletGate_Blocks:
 	INCBIN "maps/EastWestGate.blk"
 
-BetaAzaleaTown_Blocks:
+BetaAzaleaTown_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaAzaleaTown.blk"
 
 VermilionCity_Blocks:
 	INCBIN "maps/VermilionCity.blk"
 
-BetaOlivineCity_Blocks:
+BetaOlivineCity_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaOlivineCity.blk"
 
-BetaNewBarkTown_Blocks:
+BetaNewBarkTown_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaNewBarkTown.blk"
 
 ElmsLab_Blocks:
@@ -316,7 +316,7 @@ SECTION "Map Blocks 2", ROMX
 Route14_Blocks:
 	INCBIN "maps/Route14.blk"
 
-BetaSproutTower8_Blocks:
+BetaSproutTower8_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaSproutTower8.blk"
 
 OlivineMart_Blocks:
@@ -337,7 +337,7 @@ CherrygroveMart_Blocks:
 Route10North_Blocks:
 	INCBIN "maps/Route10North.blk"
 
-BetaLakeOfRage_Blocks:
+BetaLakeOfRage_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaLakeOfRage.blk"
 
 OlivinePokecenter1F_Blocks:
@@ -363,25 +363,25 @@ SaffronPokecenter1F_Blocks:
 CherrygrovePokecenter1F_Blocks:
 	INCBIN "maps/Pokecenter1F.blk"
 
-BetaPewterMuseumOfScience1F_Blocks:
+BetaPewterMuseumOfScience1F_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaPewterMuseumOfScience1F.blk"
 
-BetaPewterMuseumOfScience2F_Blocks:
+BetaPewterMuseumOfScience2F_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaPewterMuseumOfScience2F.blk"
 
 EarlsPokemonAcademy_Blocks:
 	INCBIN "maps/EarlsPokemonAcademy.blk"
 
-BetaCinnabarPokemonLabHallway_Blocks:
+BetaCinnabarPokemonLabHallway_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaCinnabarPokemonLabHallway.blk"
 
-BetaCinnabarPokemonLabRoom1_Blocks:
+BetaCinnabarPokemonLabRoom1_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaCinnabarPokemonLabRoom1.blk"
 
-BetaCinnabarPokemonLabRoom2_Blocks:
+BetaCinnabarPokemonLabRoom2_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaCinnabarPokemonLabRoom2.blk"
 
-BetaCinnabarPokemonLabRoom3_Blocks:
+BetaCinnabarPokemonLabRoom3_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaCinnabarPokemonLabRoom3.blk"
 
 GoldenrodDeptStore1F_Blocks:
@@ -424,7 +424,7 @@ CeladonMansion3F_Blocks:
 CeladonMansionRoof_Blocks:
 	INCBIN "maps/CeladonMansionRoof.blk"
 
-BetaHouse_Blocks:
+BetaHouse_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaHouse.blk"
 
 CeladonGameCorner_Blocks:
@@ -446,7 +446,7 @@ VioletNicknameSpeechHouse_Blocks:
 VioletKylesHouse_Blocks:
 	INCBIN "maps/House2.blk"
 
-BetaUnionCave_Blocks:
+BetaUnionCave_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaUnionCave.blk"
 
 UnionCaveB1F_Blocks:
@@ -466,7 +466,7 @@ Route5UndergroundPathEntrance_Blocks:
 Route6UndergroundPathEntrance_Blocks:
 	INCBIN "maps/UndergroundPathEntrance.blk"
 
-BetaCapsuleHouse_Blocks:
+BetaCapsuleHouse_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaCapsuleHouse.blk"
 
 KurtsHouse_Blocks:
@@ -478,7 +478,7 @@ GoldenrodMagnetTrainStation_Blocks:
 RuinsOfAlphOutside_Blocks:
 	INCBIN "maps/RuinsOfAlphOutside.blk"
 
-BetaRuinsOfAlphUnsolvedPuzzleRoom_Blocks:
+BetaRuinsOfAlphUnsolvedPuzzleRoom_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaRuinsOfAlphUnsolvedPuzzleRoom.blk"
 
 RuinsOfAlphInnerChamber_Blocks:
@@ -493,19 +493,19 @@ RuinsOfAlphAerodactylChamber_Blocks:
 SproutTower1F_Blocks:
 	INCBIN "maps/SproutTower1F.blk"
 
-BetaSproutTowerCutOut1_Blocks:
+BetaSproutTowerCutOut1_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaSproutTowerCutOut1.blk"
 
 SproutTower2F_Blocks:
 	INCBIN "maps/SproutTower2F.blk"
 
-BetaSproutTowerCutOut2_Blocks:
+BetaSproutTowerCutOut2_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaSproutTowerCutOut2.blk"
 
 SproutTower3F_Blocks:
 	INCBIN "maps/SproutTower3F.blk"
 
-BetaSproutTowerCutOut3_Blocks:
+BetaSproutTowerCutOut3_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaSproutTowerCutOut3.blk"
 
 RadioTower1F_Blocks:
@@ -583,7 +583,7 @@ GoldenrodDeptStoreB1F_Blocks:
 GoldenrodUndergroundWarehouse_Blocks:
 	INCBIN "maps/GoldenrodUndergroundWarehouse.blk"
 
-BetaElevator_Blocks:
+BetaElevator_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaElevator.blk"
 
 TinTower1F_Blocks:
@@ -622,7 +622,7 @@ BurnedTower1F_Blocks:
 BurnedTowerB1F_Blocks:
 	INCBIN "maps/BurnedTowerB1F.blk"
 
-BetaCaveTestMap_Blocks:
+BetaCaveTestMap_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaCaveTestMap.blk"
 
 MountMortar1FOutside_Blocks:
@@ -685,16 +685,16 @@ SilverCaveRoom2_Blocks:
 SilverCaveRoom3_Blocks:
 	INCBIN "maps/SilverCaveRoom3.blk"
 
-BetaRocketHideoutB2F_Blocks:
+BetaRocketHideoutB2F_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaRocketHideoutB2F.blk"
 
-BetaRocketHideoutB1F_Blocks:
+BetaRocketHideoutB1F_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaRocketHideoutB1F.blk"
 
-BetaRocketHideout1F_Blocks:
+BetaRocketHideout1F_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaRocketHideout1F.blk"
 
-BetaRocketHideoutB3F_Blocks:
+BetaRocketHideoutB3F_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaRocketHideoutB3F.blk"
 
 MahoganyMart1F_Blocks:
@@ -710,7 +710,7 @@ TeamRocketBaseB2F_Blocks:
 TeamRocketBaseB3F_Blocks:
 	INCBIN "maps/TeamRocketBaseB3F.blk"
 
-BetaRoute23_Blocks:
+BetaRoute23_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaRoute23.blk"
 
 IndigoPlateauPokecenter1F_Blocks:
@@ -746,7 +746,7 @@ MahoganyGym_Blocks:
 OlivineGym_Blocks:
 	INCBIN "maps/OlivineGym.blk"
 
-BetaUnknownGym_Blocks:
+BetaUnknownGym_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaUnknownGym.blk"
 
 CianwoodGym_Blocks:
@@ -779,7 +779,7 @@ OlivineLighthouse6F_Blocks:
 
 SECTION "Map Blocks 3", ROMX
 
-BetaSlowpokeWell1F_Blocks:
+BetaSlowpokeWell1F_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaSlowpokeWell1F.blk"
 
 SlowpokeWellB1F_Blocks:
@@ -824,7 +824,7 @@ FastShip1F_Blocks:
 FastShipB1F_Blocks:
 	INCBIN "maps/FastShipB1F.blk"
 
-BetaFastShipInsideCutOut_Blocks:
+BetaFastShipInsideCutOut_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaFastShipInsideCutOut.blk"
 
 FastShipCabins_NNW_NNE_NE_Blocks:
@@ -913,13 +913,13 @@ PewterGym_Blocks:
 CeladonGym_Blocks:
 	INCBIN "maps/CeladonGym.blk"
 
-BetaCeladonMansion1F_Blocks:
+BetaCeladonMansion1F_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaCeladonMansion1F.blk"
 
 CeladonCafe_Blocks:
 	INCBIN "maps/CeladonCafe.blk"
 
-BetaCeladonMansion2F_Blocks:
+BetaCeladonMansion2F_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaCeladonMansion2F.blk"
 
 RockTunnel1F_Blocks:
@@ -1040,7 +1040,7 @@ BattleTowerElevator_Blocks:
 BattleTowerOutside_Blocks:
 	INCBIN "maps/BattleTowerOutside.blk"
 
-BetaBlank_Blocks:
+BetaBlank_Blocks: ; unreferenced
 	INCBIN "maps/unused/BetaBlank.blk"
 
 GoldenrodDeptStoreRoof_Blocks:

data/maps/landmarks.asm

@@ -128,7 +128,7 @@ WhirlIslandsName:    db "WHIRL¯ISLANDS@"
 MtMortarName:        db "MT.MORTAR@"
 DragonsDenName:      db "DRAGON'S¯DEN@"
 IcePathName:         db "ICE PATH@"
-NotApplicableName:   db "N/A@" ; "オバケやしき" ("HAUNTED HOUSE") in Japanese
+NotApplicableName:   db "N/A@" ; unreferenced ; "オバケやしき" ("HAUNTED HOUSE") in Japanese
 PalletTownName:      db "PALLET TOWN@"
 ViridianCityName:    db "VIRIDIAN¯CITY@"
 PewterCityName:      db "PEWTER CITY@"
@@ -144,11 +144,11 @@ VictoryRoadName:     db "VICTORY¯ROAD@"
 MtMoonName:          db "MT.MOON@"
 RockTunnelName:      db "ROCK TUNNEL@"
 LavRadioTowerName:   db "LAV¯RADIO TOWER@"
-SilphCoName:         db "SILPH CO.@"
+SilphCoName:         db "SILPH CO.@" ; unreferenced
-SafariZoneName:      db "SAFARI ZONE@"
+SafariZoneName:      db "SAFARI ZONE@" ; unreferenced
 SeafoamIslandsName:  db "SEAFOAM¯ISLANDS@"
-PokemonMansionName:  db "#MON¯MANSION@"
+PokemonMansionName:  db "#MON¯MANSION@" ; unreferenced
-CeruleanCaveName:    db "CERULEAN¯CAVE@"
+CeruleanCaveName:    db "CERULEAN¯CAVE@" ; unreferenced
 Route1Name:          db "ROUTE 1@"
 Route2Name:          db "ROUTE 2@"
 Route3Name:          db "ROUTE 3@"
@@ -199,7 +199,7 @@ DarkCaveName:        db "DARK CAVE@"
 IlexForestName:      db "ILEX¯FOREST@"
 BurnedTowerName:     db "BURNED¯TOWER@"
 FastShipName:        db "FAST SHIP@"
-ViridianForestName:  db "VIRIDIAN¯FOREST@"
+ViridianForestName:  db "VIRIDIAN¯FOREST@" ; unreferenced
 DiglettsCaveName:    db "DIGLETT'S¯CAVE@"
 TohjoFallsName:      db "TOHJO FALLS@"
 UndergroundName:     db "UNDERGROUND@"

data/moves/animations.asm

@@ -481,7 +481,7 @@ BattleAnim_SendOutMon:
 
 BattleAnim_ReturnMon:
 	anim_sound 0, 0, SFX_BALL_POOF
-.anim:
+BattleAnimSub_Return:
 	anim_bgeffect ANIM_BG_RETURN_MON, $0, BG_EFFECT_USER, $0
 	anim_wait 32
 	anim_ret
@@ -1314,7 +1314,7 @@ BattleAnim_RazorWind:
 	anim_wait 24
 	anim_ret
 
-BattleAnim_Sonicboom_JP:
+BattleAnim_Sonicboom_JP: ; unreferenced
 	anim_2gfx ANIM_GFX_WHIP, ANIM_GFX_HIT
 .loop
 	anim_sound 3, 0, SFX_RAZOR_WIND
@@ -4106,7 +4106,7 @@ BattleAnim_BatonPass:
 	anim_1gfx ANIM_GFX_MISC
 	anim_obj ANIM_OBJ_BATON_PASS, 44, 104, $20
 	anim_sound 0, 0, SFX_BATON_PASS
-	anim_call BattleAnim_ReturnMon.anim
+	anim_call BattleAnimSub_Return
 	anim_wait 64
 	anim_ret
 

data/phone/text/elm.asm

@@ -197,7 +197,6 @@ ElmPhoneGiftText:
 	para "See you later!"
 	done
 
-; unused
 ElmPhoneGotAholdOfSomethingNeatText:
 	text "Hello, <PLAY_G>?"
 	line "How's it going?"

data/phone/text/todd_overworld.asm

@@ -57,9 +57,8 @@ ToddRematchText:
 	line "my #MON better!"
 	done
 
-UnusedText_0xa43ca:
+ToddSaleText: ; unreferenced
-; This is unused; Todd says this during the department store sale,
+; This is a duplicate of CamperToddSaleText in maps/Route34.asm.
-; but this is a duplicate of the actual string in the Route 34 scripts.
 	text "Shopping under the"
 	line "sky!"
 

data/player_names.asm

@@ -2,8 +2,8 @@ ChrisNameMenuHeader:
 	db MENU_BACKUP_TILES ; flags
 	menu_coords 0, 0, 10, TEXTBOX_Y - 1
 	dw .MaleNames
-	db 1 ; ????
+	db 1 ; default option
-	db 0 ; default option
+	db 0 ; ????
 
 .MaleNames:
 	db STATICMENU_CURSOR | STATICMENU_PLACE_TITLE | STATICMENU_DISABLE_B ; flags
@@ -21,8 +21,8 @@ KrisNameMenuHeader:
 	db MENU_BACKUP_TILES ; flags
 	menu_coords 0, 0, 10, TEXTBOX_Y - 1
 	dw .FemaleNames
-	db 1 ; ????
+	db 1 ; default option
-	db 0 ; default option
+	db 0 ; ????
 
 .FemaleNames:
 	db STATICMENU_CURSOR | STATICMENU_PLACE_TITLE | STATICMENU_DISABLE_B ; flags

data/sprite_anims/framesets.asm

@@ -245,45 +245,45 @@ SpriteAnimFrameData:
 	frame SPRITE_ANIM_OAMSET_MAGNET_TRAIN_RED_2,  8, OAM_X_FLIP
 	dorestart
 
-; unused
+.Frameset_Unknown1: ; unreferenced
 	frame SPRITE_ANIM_OAMSET_UNUSED_43,  8
 	frame SPRITE_ANIM_OAMSET_UNUSED_44,  8
 	dorestart
 
-; unused
+.Frameset_Unknown2: ; unreferenced
 	frame SPRITE_ANIM_OAMSET_UNUSED_45,  8
 	frame SPRITE_ANIM_OAMSET_UNUSED_46,  8
 	dorestart
 
-; unused
+.Frameset_Unknown3: ; unreferenced
 	frame SPRITE_ANIM_OAMSET_UNUSED_47,  8
 	frame SPRITE_ANIM_OAMSET_UNUSED_48,  8
 	dorestart
 
-; unused
+.Frameset_Unknown4: ; unreferenced
 	frame SPRITE_ANIM_OAMSET_UNUSED_49,  1
 	frame SPRITE_ANIM_OAMSET_UNUSED_49,  1, OAM_X_FLIP
 	frame SPRITE_ANIM_OAMSET_UNUSED_49,  1, OAM_X_FLIP, OAM_Y_FLIP
 	frame SPRITE_ANIM_OAMSET_UNUSED_49,  1, OAM_Y_FLIP
 	dorestart
 
-; unused
+.Frameset_Unknown5: ; unreferenced
 	frame SPRITE_ANIM_OAMSET_UNUSED_4A, 32
 	endanim
 
-; unused
+.Frameset_Unknown6: ; unreferenced
 	frame SPRITE_ANIM_OAMSET_UNUSED_4B, 32
 	endanim
 
-; unused
+.Frameset_Unknown7: ; unreferenced
 	frame SPRITE_ANIM_OAMSET_UNUSED_4C, 32
 	endanim
 
-; unused
+.Frameset_Unknown8: ; unreferenced
 	frame SPRITE_ANIM_OAMSET_UNUSED_4D, 32
 	endanim
 
-; unused
+.Frameset_Unknown9: ; unreferenced
 	frame SPRITE_ANIM_OAMSET_UNUSED_4E,  3
 	dowait 3
 	dorestart

data/sprite_anims/oam.asm

@@ -181,7 +181,7 @@ SpriteAnimOAMData:
 	dbsprite -1,  0,  0,  0, $00, 7 | Y_FLIP
 	dbsprite  0,  0,  0,  0, $00, 7 | X_FLIP | Y_FLIP
 
-; unused
+.OAMData_Unknown1: ; unreferenced
 	db 4
 	dbsprite -1, -1,  0,  0, $00, 0 | PRIORITY
 	dbsprite  0, -1,  0,  0, $00, 0 | X_FLIP | PRIORITY
@@ -305,7 +305,7 @@ SpriteAnimOAMData:
 	dbsprite  1,  0,  4,  4, $17, 0
 	dbsprite  1,  1,  4,  4, $18, 0
 
-; unused
+.OAMData_Unknown2: ; unreferenced
 	db 36
 	dbsprite -3, -3,  0,  0, $00, 0
 	dbsprite -2, -3,  0,  0, $01, 0

data/text/battle.asm

@@ -349,7 +349,7 @@ BattleText_StringBuffer1GrewToLevel:
 	sound_dex_fanfare_50_79
 	text_end
 
-	text_end ; unused
+	text_end ; unreferenced
 
 BattleText_WildMonIsEating:
 	text "Wild @"
@@ -1085,7 +1085,7 @@ BeatUpAttackText:
 	line "attack!"
 	done
 
-RefusedGiftText:
+PresentFailedText:
 	text "<TARGET>"
 	line "refused the gift!"
 	prompt
@@ -1102,7 +1102,7 @@ BattleText_LinkErrorBattleCanceled:
 	line "been canceled…"
 	prompt
 
-BattleText_0x8188e:
+BattleText_NoTimeLeftToday: ; unreferenced
 	text "There is no time"
 	line "left today!"
 	done

data/text/common_1.asm

@@ -463,7 +463,6 @@ _MobileForPartnersMonText::
 	text "."
 	done
 
-; unreferenced
 _MobilePlayersMonTradeText::
 	text_ram wPlayerTrademonSenderName
 	text "'s"
@@ -1665,7 +1664,7 @@ _DayCareManIntroText::
 	cont "raise a #MON?"
 	done
 
-_DayCareManOddEggText::
+_DayCareManIntroEggText::
 	text "I'm the DAY-CARE"
 	line "MAN. Do you know"
 	cont "about EGGS?"
@@ -1692,7 +1691,7 @@ _DayCareLadyIntroText::
 	line "#MON for you?"
 	done
 
-_DayCareLadyOddEggText::
+_DayCareLadyIntroEggText::
 	text "I'm the DAY-CARE"
 	line "LADY. Do you know"
 	cont "about EGGS?"

data/text/common_2.asm

@@ -260,32 +260,32 @@ _MysteryGiftSentHomeText::
 	text "'s home."
 	prompt
 
-_MysteryGiftReceivedCardText::
+_NameCardReceivedCardText::
 	text "Received"
 	line "@"
-	text_ram wc850
+	text_ram wMysteryGiftCardHolderName
 	text "'s CARD."
 	prompt
 
-_MysteryGiftListedCardText::
+_NameCardListedCardText::
-	text_ram wc850
+	text_ram wMysteryGiftCardHolderName
 	text "'s CARD was"
 	line "listed as no.@"
 	text_decimal wDeciramBuffer, 1, 2
 	text "."
 	prompt
 
-_MysteryGiftNotRegisteredCardText::
+_NameCardNotRegisteredCardText::
 	text "The CARD was not"
 	line "registered."
 	prompt
 
-_MysteryGiftLinkCancelledText::
+_NameCardLinkCancelledText::
 	text "The link has been"
 	line "cancelled."
 	prompt
 
-_MysteryGiftLinkCommErrorText::
+_NameCardLinkCommErrorText::
 	text "Communication"
 	line "error."
 	prompt
@@ -487,7 +487,6 @@ _RodNothingText::
 	text "Not even a nibble!"
 	prompt
 
-; unreferenced
 _UnusedNothingHereText::
 	text "Looks like there's"
 	line "nothing here."

data/text/common_3.asm

@@ -72,7 +72,7 @@ _LinkAbnormalMonText::
 
 _LinkAskTradeForText::
 	text "Trade @"
-	text_ram wd004
+	text_ram wBufferTrademonNick
 	text_start
 	line "for @"
 	text_ram wStringBuffer1
@@ -620,7 +620,6 @@ _PharmacyComeAgainText::
 	line "See you around."
 	done
 
-; unreferenced
 _NothingToSellText::
 	text "You don't have"
 	line "anything to sell."
@@ -744,25 +743,21 @@ _MainMenuTimeUnknownText::
 	text "Clock time unknown"
 	done
 
-; unreferenced mobile
 _DeleteSavedLoginPasswordText::
 	text "Delete the saved"
 	line "LOG-IN PASSWORD?"
 	done
 
-; unreferenced mobile
 _DeletedTheLoginPasswordText::
 	text "Deleted the LOG-IN"
 	line "PASSWORD."
 	done
 
-; unreferenced mobile
 _MobilePickThreeMonForBattle::
 	text "Pick three #MON"
 	line "for battle."
 	prompt
 
-; unreferenced mobile
 _MobileUseTheseThreeMonText::
 	text_ram wMobileParticipant1Nickname
 	text ","
@@ -776,13 +771,11 @@ _MobileUseTheseThreeMonText::
 	para "Use these three?"
 	done
 
-; unreferenced mobile
 _MobileOnlyThreeMonMayEnterText::
 	text "Only three #MON"
 	line "may enter."
 	prompt
 
-; unreferenced mobile
 _MobileCardFolderIntro1Text::
 	text "The CARD FOLDER"
 	line "stores your and"
@@ -800,7 +793,6 @@ _MobileCardFolderIntro1Text::
 	para ""
 	done
 
-; unreferenced mobile
 _MobileCardFolderIntro2Text::
 	text "This is your CARD."
 
@@ -814,7 +806,6 @@ _MobileCardFolderIntro2Text::
 	para ""
 	done
 
-; unreferenced mobile
 _MobileCardFolderIntro3Text::
 	text "If you have your"
 	line "friend's CARD, you"
@@ -829,7 +820,6 @@ _MobileCardFolderIntro3Text::
 	para ""
 	done
 
-; unreferenced mobile
 _MobileCardFolderIntro4Text::
 	text "To safely store"
 	line "your collection of"
@@ -841,7 +831,6 @@ _MobileCardFolderIntro4Text::
 	para ""
 	done
 
-; unreferenced mobile
 _MobileCardFolderAskDeleteText::
 	text "If the CARD FOLDER"
 	line "is deleted, all"
@@ -858,13 +847,11 @@ _MobileCardFolderAskDeleteText::
 	line "your CARD FOLDER?"
 	done
 
-; unreferenced mobile
 _MobileCardFolderDeleteAreYouSureText::
 	text "Are you sure you"
 	line "want to delete it?"
 	done
 
-; unreferenced mobile
 _MobileCardFolderDeletedText::
 	text "The CARD FOLDER"
 	line "has been deleted."
@@ -872,7 +859,6 @@ _MobileCardFolderDeletedText::
 	para ""
 	done
 
-; unreferenced mobile
 _MobileCardFolderAskOpenOldText::
 	text "There is an older"
 	line "CARD FOLDER from a"
@@ -882,13 +868,11 @@ _MobileCardFolderAskOpenOldText::
 	line "open it?"
 	done
 
-; unreferenced mobile
 _MobileCardFolderAskDeleteOldText::
 	text "Delete the old"
 	line "CARD FOLDER?"
 	done
 
-; unreferenced mobile
 _MobileCardFolderFinishRegisteringCardsText::
 	text "Finish registering"
 	line "CARDS?"

data/text/unused_sweet_honey.asm

@@ -8,7 +8,7 @@
 ; Most of these texts seem to be associated with a single NPC.
 ; The last text is associated with a second NPC, probably a Butterfree.
 
-UnusedSweetHoneyText:
+UnusedSweetHoneyText: ; unreferenced
 	text "My #MON is an"
 	line "expert at collect-"
 	cont "ing SWEET HONEY."
@@ -17,7 +17,7 @@ UnusedSweetHoneyText:
 	line "with you."
 	done
 
-UnusedSweetHoneyBagFullText:
+UnusedSweetHoneyBagFullText: ; unreferenced
 	text "I want to give you"
 	line "some SWEET HONEY,"
 
@@ -25,17 +25,17 @@ UnusedSweetHoneyBagFullText:
 	line "room for it."
 	done
 
-UnusedSweetHoneyGiveText:
+UnusedSweetHoneyGiveText: ; unreferenced
 	text "Here you go! Have"
 	line "some SWEET HONEY!"
 	done
 
-UnusedGotSweetHoneyText:
+UnusedGotSweetHoneyText: ; unreferenced
 	text "<PLAYER> received"
 	line "SWEET HONEY."
 	done
 
-UnusedSweetHoneyAfterText1:
+UnusedSweetHoneyAfterText1: ; unreferenced
 	text "My little brother"
 	line "takes SWEET HONEY"
 
@@ -46,7 +46,7 @@ UnusedSweetHoneyAfterText1:
 	line "up to?"
 	done
 
-UnusedSweetHoneyAfterText2:
+UnusedSweetHoneyAfterText2: ; unreferenced
 	text "Did you put SWEET"
 	line "HONEY on a tree?"
 
@@ -54,7 +54,7 @@ UnusedSweetHoneyAfterText2:
 	line "it?"
 	done
 
-UnusedSweetHoneyAfterText3:
+UnusedSweetHoneyAfterText3: ; unreferenced
 	text "Did you put SWEET"
 	line "HONEY on a tree?"
 
@@ -63,6 +63,6 @@ UnusedSweetHoneyAfterText3:
 	cont "be drawn to it."
 	done
 
-UnusedSweetHoneyButterfreeText:
+UnusedSweetHoneyButterfreeText: ; unreferenced
 	text "BUTTERFREE: Freeh!"
 	done

docs/bugs_and_glitches.md

@@ -560,7 +560,7 @@ This bug affects Attract, Curse, Foresight, Mean Look, Mimic, Nightmare, Spider
 
 ```diff
  .got_mon
- 	ld a, [wd002]
+ 	ld a, [wCurBeatUpPartyMon]
  	ld hl, wPartyMonNicknames
  	call GetNick
  	ld a, MON_HP
@@ -568,7 +568,7 @@ This bug affects Attract, Curse, Foresight, Mean Look, Mimic, Nightmare, Spider
  	ld a, [hli]
  	or [hl]
  	jp z, .beatup_fail ; fainted
- 	ld a, [wd002]
+ 	ld a, [wCurBeatUpPartyMon]
  	ld c, a
  	ld a, [wCurBattleMon]
 -	; BUG: this can desynchronize link battles

engine/battle/ai/items.asm

@@ -20,8 +20,9 @@ AI_SwitchOrTryItem:
 	and a
 	jr nz, DontSwitch
 
+	; always load the first trainer class in wTrainerClass for Battle Tower trainers
 	ld hl, TrainerClassAttributes + TRNATTR_AI_ITEM_SWITCH
-	ld a, [wInBattleTowerBattle] ; always load the first trainer class in wTrainerClass for BattleTower-Trainers
+	ld a, [wInBattleTowerBattle]
 	and a
 	jr nz, .ok
 
@@ -29,6 +30,7 @@ AI_SwitchOrTryItem:
 	dec a
 	ld bc, NUM_TRAINER_ATTRIBUTES
 	call AddNTimes
+
 .ok
 	bit SWITCH_OFTEN_F, [hl]
 	jp nz, SwitchOften
@@ -145,7 +147,7 @@ SwitchSometimes:
 	ld [wEnemySwitchMonIndex], a
 	jp AI_TrySwitch
 
-CheckSubstatusCantRun:
+CheckSubstatusCantRun: ; unreferenced
 	ld a, [wEnemySubStatus5]
 	bit SUBSTATUS_CANT_RUN, a
 	ret
@@ -213,7 +215,7 @@ AI_TryItem:
 	inc hl
 	jr c, .loop
 
-.used_item
+; used item
 	xor a
 	ld [de], a
 	inc a
@@ -259,7 +261,7 @@ AI_TryItem:
 	cp e
 	jr nc, .yes
 
-.no
+.no ; unreferenced
 	and a
 	ret
 

engine/battle/battle_transition.asm

@@ -258,7 +258,7 @@ StartTrainerBattle_NextScene:
 StartTrainerBattle_SetUpBGMap:
 	call StartTrainerBattle_NextScene
 	xor a
-	ld [wcf64], a
+	ld [wBattleTransitionCounter], a
 	ldh [hBGMapMode], a
 	ret
 
@@ -272,7 +272,7 @@ StartTrainerBattle_Flash:
 	ld a, [wTimeOfDayPalset]
 	cp DARKNESS_PALSET
 	jr z, .done
-	ld hl, wcf64
+	ld hl, wBattleTransitionCounter
 	ld a, [hl]
 	inc [hl]
 	srl a
@@ -290,7 +290,7 @@ StartTrainerBattle_Flash:
 
 .done
 	xor a
-	ld [wcf64], a
+	ld [wBattleTransitionCounter], a
 	scf
 	ret
 
@@ -322,12 +322,12 @@ StartTrainerBattle_SetUpForWavyOutro:
 	ld a, $90
 	ldh [hLYOverrideEnd], a
 	xor a
-	ld [wcf64], a
+	ld [wBattleTransitionCounter], a
-	ld [wcf65], a
+	ld [wBattleTransitionSineWaveOffset], a
 	ret
 
 StartTrainerBattle_SineWave:
-	ld a, [wcf64]
+	ld a, [wBattleTransitionCounter]
 	cp $60
 	jr nc, .end
 	call .DoSineWave
@@ -339,10 +339,10 @@ StartTrainerBattle_SineWave:
 	ret
 
 .DoSineWave:
-	ld hl, wcf65
+	ld hl, wBattleTransitionSineWaveOffset
 	ld a, [hl]
 	inc [hl]
-	ld hl, wcf64
+	ld hl, wBattleTransitionCounter
 	ld d, [hl]
 	add [hl]
 	ld [hl], a
@@ -372,13 +372,13 @@ StartTrainerBattle_SetUpForSpinOutro:
 	ldh [rSVBK], a
 	call StartTrainerBattle_NextScene
 	xor a
-	ld [wcf64], a
+	ld [wBattleTransitionCounter], a
 	ret
 
 StartTrainerBattle_SpinToBlack:
 	xor a
 	ldh [hBGMapMode], a
-	ld a, [wcf64]
+	ld a, [wBattleTransitionCounter]
 	ld e, a
 	ld d, 0
 	ld hl, .spin_quadrants
@@ -388,13 +388,13 @@ endr
 	ld a, [hli]
 	cp -1
 	jr z, .end
-	ld [wcf65], a
+	ld [wBattleTransitionSineWaveOffset], a
 	call .load
 	ld a, 1
 	ldh [hBGMapMode], a
 	call DelayFrame
 	call DelayFrame
-	ld hl, wcf64
+	ld hl, wBattleTransitionCounter
 	inc [hl]
 	ret
 
@@ -449,7 +449,7 @@ ENDM
 	spin_quadrant LOWER_LEFT,  .wedge1,  1, 11
 	db -1
 
-.load
+.load:
 	ld a, [hli]
 	ld e, a
 	ld a, [hli]
@@ -464,7 +464,7 @@ ENDM
 	inc de
 .loop1
 	ld [hl], BATTLETRANSITION_BLACK
-	ld a, [wcf65]
+	ld a, [wBattleTransitionSineWaveOffset]
 	bit RIGHT_QUADRANT_F, a
 	jr z, .leftside
 	inc hl
@@ -475,7 +475,7 @@ ENDM
 	dec c
 	jr nz, .loop1
 	pop hl
-	ld a, [wcf65]
+	ld a, [wBattleTransitionSineWaveOffset]
 	bit LOWER_QUADRANT_F, a
 	ld bc, SCREEN_WIDTH
 	jr z, .upper
@@ -490,7 +490,7 @@ ENDM
 	jr z, .loop
 	ld c, a
 .loop2
-	ld a, [wcf65]
+	ld a, [wBattleTransitionSineWaveOffset]
 	bit RIGHT_QUADRANT_F, a
 	jr z, .leftside2
 	dec hl
@@ -514,13 +514,13 @@ StartTrainerBattle_SetUpForRandomScatterOutro:
 	ldh [rSVBK], a
 	call StartTrainerBattle_NextScene
 	ld a, $10
-	ld [wcf64], a
+	ld [wBattleTransitionCounter], a
 	ld a, 1
 	ldh [hBGMapMode], a
 	ret
 
 StartTrainerBattle_SpeckleToBlack:
-	ld hl, wcf64
+	ld hl, wBattleTransitionCounter
 	ld a, [hl]
 	and a
 	jr z, .done

engine/battle/core.asm

@@ -1697,7 +1697,7 @@ HandleWeather:
 	cp USING_EXTERNAL_CLOCK
 	jr z, .enemy_first
 
-.player_first
+; player first
 	call SetPlayerTurn
 	call .SandstormDamage
 	call SetEnemyTurn
@@ -2711,7 +2711,7 @@ AskUseNextPokemon:
 ForcePlayerMonChoice:
 	call EmptyBattleTextbox
 	call LoadStandardMenuHeader
-	call SetUpBattlePartyMenu_NoLoop
+	call SetUpBattlePartyMenu
 	call ForcePickPartyMonInBattle
 	ld a, [wLinkMode]
 	and a
@@ -2810,9 +2810,9 @@ IsMobileBattle:
 	cp LINK_MOBILE
 	ret
 
-SetUpBattlePartyMenu_NoLoop:
+SetUpBattlePartyMenu:
 	call ClearBGPalettes
-SetUpBattlePartyMenu: ; switch to fullscreen menu?
+SetUpBattlePartyMenu_Loop: ; switch to fullscreen menu?
 	farcall LoadPartyMenuGFX
 	farcall InitPartyMenuWithCancel
 	farcall InitPartyMenuBGPal7
@@ -3006,10 +3006,11 @@ PlayerMonFaintedAnimation:
 	jp MonFaintedAnimation
 
 MonFaintedAnimation:
-	ld a, [wcfbe]
+	ld a, [wJoypadDisable]
 	push af
-	set 6, a
+	set JOYPAD_DISABLE_MON_FAINT_F, a
-	ld [wcfbe], a
+	ld [wJoypadDisable], a
+
 	ld b, 7
 
 .OuterLoop:
@@ -3052,7 +3053,7 @@ MonFaintedAnimation:
 	jr nz, .OuterLoop
 
 	pop af
-	ld [wcfbe], a
+	ld [wJoypadDisable], a
 	ret
 
 .Spaces:
@@ -3486,7 +3487,7 @@ OfferSwitch:
 	ld a, [wMenuCursorY]
 	dec a
 	jr nz, .said_no
-	call SetUpBattlePartyMenu_NoLoop
+	call SetUpBattlePartyMenu
 	call PickSwitchMonInBattle
 	jr c, .canceled_switch
 	ld a, [wCurBattleMon]
@@ -4639,7 +4640,7 @@ CheckDanger:
 PrintPlayerHUD:
 	ld de, wBattleMonNick
 	hlcoord 10, 7
-	call ret_3e138
+	call Battle_DummyFunction
 	call PlaceString
 
 	push bc
@@ -4725,7 +4726,7 @@ DrawEnemyHUD:
 	call GetBaseData
 	ld de, wEnemyMonNick
 	hlcoord 1, 0
-	call ret_3e138
+	call Battle_DummyFunction
 	call PlaceString
 	ld h, b
 	ld l, c
@@ -4854,7 +4855,8 @@ UpdateHPPal:
 	ret z
 	jp FinishBattleAnim
 
-ret_3e138:
+Battle_DummyFunction:
+; called before placing either battler's nickname in the HUD
 	ret
 
 BattleMenu:
@@ -5043,7 +5045,7 @@ BattleMenuPKMN_ReturnFromStats:
 	call LoadStandardMenuHeader
 	call ClearBGPalettes
 BattleMenuPKMN_Loop:
-	call SetUpBattlePartyMenu
+	call SetUpBattlePartyMenu_Loop
 	xor a
 	ld [wPartyMenuActionText], a
 	call JumpToPartyMenuAndPrintText
@@ -7436,13 +7438,13 @@ AnimateExpBar:
 	jp nc, .finish
 
 	ldh a, [hProduct + 3]
-	ld [wd004], a
+	ld [wExperienceGained + 2], a
 	push af
 	ldh a, [hProduct + 2]
-	ld [wd003], a
+	ld [wExperienceGained + 1], a
 	push af
 	xor a
-	ld [wd002], a
+	ld [wExperienceGained], a
 	xor a ; PARTYMON
 	ld [wMonType], a
 	predef CopyMonToTempMon
@@ -7454,10 +7456,10 @@ AnimateExpBar:
 	call CalcExpBar
 	push bc
 	ld hl, wTempMonExp + 2
-	ld a, [wd004]
+	ld a, [wExperienceGained + 2]
 	add [hl]
 	ld [hld], a
-	ld a, [wd003]
+	ld a, [wExperienceGained + 1]
 	adc [hl]
 	ld [hld], a
 	jr nc, .NoOverflow
@@ -7781,7 +7783,8 @@ HandleSafariAngerEatingStatus: ; unreferenced
 	jr .finish
 
 .angry
-	dec hl ; wSafariMonAngerCount
+	dec hl
+	assert wSafariMonEating - 1 == wSafariMonAngerCount
 	ld a, [hl]
 	and a
 	ret z
@@ -8785,7 +8788,7 @@ AddLastLinkBattleToLinkRecord:
 .FindOpponentAndAppendRecord:
 	ld b, NUM_LINK_BATTLE_RECORDS
 	ld hl, sLinkBattleRecord1End - 1
-	ld de, wd002
+	ld de, wLinkBattleRecordBuffer
 .loop3
 	push bc
 	push de
@@ -8814,16 +8817,16 @@ AddLastLinkBattleToLinkRecord:
 	add b
 	add b
 	ld e, a
-	ld d, $0
+	ld d, 0
-	ld hl, wd002
+	ld hl, wLinkBattleRecordBuffer
 	add hl, de
 	push hl
 	ld a, c
 	add c
 	add c
 	ld e, a
-	ld d, $0
+	ld d, 0
-	ld hl, wd002
+	ld hl, wLinkBattleRecordBuffer
 	add hl, de
 	ld d, h
 	ld e, l
@@ -8855,7 +8858,7 @@ AddLastLinkBattleToLinkRecord:
 	ld hl, sLinkBattleRecord
 	call AddNTimes
 	push hl
-	ld de, wd002
+	ld de, wLinkBattleRecordBuffer
 	ld bc, LINK_BATTLE_RECORD_LENGTH
 	call CopyBytes
 	pop hl
@@ -8869,7 +8872,7 @@ AddLastLinkBattleToLinkRecord:
 	push hl
 	ld bc, LINK_BATTLE_RECORD_LENGTH
 	call CopyBytes
-	ld hl, wd002
+	ld hl, wLinkBattleRecordBuffer
 	ld bc, LINK_BATTLE_RECORD_LENGTH
 	pop de
 	call CopyBytes
@@ -8952,13 +8955,13 @@ InitBattleDisplay:
 	ldh [rSVBK], a
 
 	ld hl, wDecompressScratch
-	ld bc, wScratchAttrmap - wDecompressScratch
+	ld bc, BG_MAP_WIDTH * BG_MAP_HEIGHT
 	ld a, " "
 	call ByteFill
 
 	ld de, wDecompressScratch
 	hlbgcoord 0, 0
-	lb bc, BANK(.BlankBGMap), $40
+	lb bc, BANK(@), (BG_MAP_WIDTH * BG_MAP_HEIGHT) / LEN_2BPP_TILE
 	call Request2bpp
 
 	pop af

engine/battle/effect_commands.asm

@@ -134,7 +134,7 @@ BattleCommand_CheckTurn:
 	and a
 	jp nz, CheckEnemyTurn
 
-CheckPlayerTurn:
+; check player turn
 	ld hl, wPlayerSubStatus4
 	bit SUBSTATUS_RECHARGE, [hl]
 	jr z, .no_recharge
@@ -2586,7 +2586,7 @@ PlayerAttackDamage:
 	cp SPECIAL
 	jr nc, .special
 
-.physical
+; physical
 	ld hl, wEnemyMonDefense
 	ld a, [hli]
 	ld b, a
@@ -2826,9 +2826,9 @@ EnemyAttackDamage:
 
 	ld a, [hl]
 	cp SPECIAL
-	jr nc, .Special
+	jr nc, .special
 
-.physical
+; physical
 	ld hl, wBattleMonDefense
 	ld a, [hli]
 	ld b, a
@@ -2852,7 +2852,7 @@ EnemyAttackDamage:
 	ld hl, wEnemyAttack
 	jr .thickclub
 
-.Special:
+.special
 	ld hl, wBattleMonSpclDef
 	ld a, [hli]
 	ld b, a
@@ -5714,8 +5714,7 @@ BattleCommand_Charge:
 	text_far _BattleDugText
 	text_end
 
-BattleCommand3c:
+BattleCommand_Unused3C: ; unreferenced
-; unused
 	ret
 
 BattleCommand_TrapTarget:
@@ -6124,7 +6123,7 @@ INCLUDE "engine/battle/move_effects/conversion.asm"
 BattleCommand_ResetStats:
 ; resetstats
 
-	ld a, 7 ; neutral
+	ld a, BASE_STAT_LEVEL
 	ld hl, wPlayerStatLevels
 	call .Fill
 	ld hl, wEnemyStatLevels
@@ -6147,7 +6146,7 @@ BattleCommand_ResetStats:
 	jp StdBattleTextbox
 
 .Fill:
-	ld b, wPlayerStatLevelsEnd - wPlayerStatLevels
+	ld b, NUM_LEVEL_STATS
 .next
 	ld [hli], a
 	dec b
@@ -6489,8 +6488,7 @@ INCLUDE "engine/battle/move_effects/sandstorm.asm"
 
 INCLUDE "engine/battle/move_effects/rollout.asm"
 
-BattleCommand5d:
+BattleCommand_Unused5D: ; unreferenced
-; unused
 	ret
 
 INCLUDE "engine/battle/move_effects/fury_cutter.asm"

engine/battle/menu.asm

@@ -9,8 +9,7 @@ LoadBattleMenu:
 	call ExitMenu
 	ret
 
-SafariBattleMenu:
+SafariBattleMenu: ; unreferenced
-; untranslated
 	ld hl, SafariBattleMenuHeader
 	call LoadMenuHeader
 	jr CommonBattleMenu
@@ -19,6 +18,7 @@ ContestBattleMenu:
 	ld hl, ContestBattleMenuHeader
 	call LoadMenuHeader
 	; fallthrough
+
 CommonBattleMenu:
 	ld a, [wBattleMenuCursorBuffer]
 	ld [wMenuCursorBuffer], a

engine/battle/move_effects/baton_pass.asm

@@ -17,7 +17,7 @@ BattleCommand_BatonPass:
 
 ; Transition into switchmon menu
 	call LoadStandardMenuHeader
-	farcall SetUpBattlePartyMenu_NoLoop
+	farcall SetUpBattlePartyMenu
 
 	farcall ForcePickSwitchMonInBattle
 

engine/battle/move_effects/beat_up.asm

@@ -14,7 +14,7 @@ BattleCommand_BeatUp:
 	call DelayFrames
 	xor a
 	ld [wPlayerRolloutCount], a
-	ld [wd002], a
+	ld [wCurBeatUpPartyMon], a
 	ld [wBeatUpHitAtLeastOnce], a
 	jr .got_mon
 
@@ -23,10 +23,10 @@ BattleCommand_BeatUp:
 	ld b, a
 	ld a, [wPartyCount]
 	sub b
-	ld [wd002], a
+	ld [wCurBeatUpPartyMon], a
 
 .got_mon
-	ld a, [wd002]
+	ld a, [wCurBeatUpPartyMon]
 	ld hl, wPartyMonNicknames
 	call GetNick
 	ld a, MON_HP
@@ -34,7 +34,7 @@ BattleCommand_BeatUp:
 	ld a, [hli]
 	or [hl]
 	jp z, .beatup_fail ; fainted
-	ld a, [wd002]
+	ld a, [wCurBeatUpPartyMon]
 	ld c, a
 	ld a, [wCurBattleMon]
 	; BUG: this can desynchronize link battles
@@ -88,7 +88,7 @@ BattleCommand_BeatUp:
 
 	xor a
 	ld [wEnemyRolloutCount], a
-	ld [wd002], a
+	ld [wCurBeatUpPartyMon], a
 	ld [wBeatUpHitAtLeastOnce], a
 	jr .enemy_got_mon
 
@@ -97,7 +97,7 @@ BattleCommand_BeatUp:
 	ld b, a
 	ld a, [wOTPartyCount]
 	sub b
-	ld [wd002], a
+	ld [wCurBeatUpPartyMon], a
 
 .enemy_got_mon
 	ld a, [wBattleMode]
@@ -112,7 +112,7 @@ BattleCommand_BeatUp:
 	and a
 	jr nz, .link_or_tower
 
-	ld a, [wd002]
+	ld a, [wCurBeatUpPartyMon]
 	ld c, a
 	ld b, 0
 	ld hl, wOTPartySpecies
@@ -123,7 +123,7 @@ BattleCommand_BeatUp:
 	jr .got_enemy_nick
 
 .link_or_tower
-	ld a, [wd002]
+	ld a, [wCurBeatUpPartyMon]
 	ld hl, wOTPartyMonNicknames
 	ld bc, NAME_LENGTH
 	call AddNTimes
@@ -137,7 +137,7 @@ BattleCommand_BeatUp:
 	or [hl]
 	jp z, .beatup_fail
 
-	ld a, [wd002]
+	ld a, [wCurBeatUpPartyMon]
 	ld b, a
 	ld a, [wCurOTMon]
 	cp b
@@ -217,7 +217,7 @@ GetBeatupMonLocation:
 	ld hl, wOTPartyMon1Species
 
 .got_species
-	ld a, [wd002]
+	ld a, [wCurBeatUpPartyMon]
 	add hl, bc
 	call GetPartyLocation
 	pop bc

engine/battle/move_effects/present.asm

@@ -80,7 +80,7 @@ BattleCommand_Present:
 	call _CheckBattleScene
 	jr nc, .do_animation
 	call AnimateFailedMove
-	ld hl, RefusedGiftText
+	ld hl, PresentFailedText
 	call StdBattleTextbox
 .do_animation
 	jp EndMoveEffect

engine/battle_anims/anim_commands.asm

@@ -245,7 +245,8 @@ BattleAnim_ClearOAM:
 	ld c, NUM_SPRITE_OAM_STRUCTS
 .loop
 	ld a, [hl]
-	and $ff ^ (PALETTE_MASK | VRAM_BANK_1) ; PAL_BATTLE_OB_ENEMY (0)
+	and $ff ^ (PALETTE_MASK | VRAM_BANK_1) ; zeros out the palette bits
+	assert PAL_BATTLE_OB_ENEMY == 0
 	ld [hli], a
 rept SPRITEOAMSTRUCT_LENGTH - 1
 	inc hl
@@ -1050,7 +1051,7 @@ GetMinimizePic:
 	and a
 	jr z, .player
 
-	ld de, sScratch + $1a tiles
+	ld de, sScratch + (3 * 7 + 5) tiles
 	call CopyMinimizePic
 	ld hl, vTiles2 tile $00
 	ld de, sScratch
@@ -1058,7 +1059,7 @@ GetMinimizePic:
 	ret
 
 .player
-	ld de, sScratch + $160
+	ld de, sScratch + (3 * 6 + 4) tiles
 	call CopyMinimizePic
 	ld hl, vTiles2 tile $31
 	ld de, sScratch

engine/battle_anims/core.asm

@@ -263,14 +263,12 @@ InitBattleAnimBuffer:
 	jr nz, .no_sub
 	ld a, [wFXAnimID]
 	cp KINESIS
-	jr z, .kinesis
+	jr z, .do_sub
 	cp SOFTBOILED
-	jr z, .softboiled
+	jr z, .do_sub
 	cp MILK_DRINK
 	jr nz, .no_sub
-.kinesis
+.do_sub
-.softboiled
-.milk_drink
 	pop af
 	sub 1 * 8
 	jr .done

engine/battle_anims/functions.asm

@@ -4299,14 +4299,14 @@ BattleAnim_Cosine_e:
 	ld e, a
 	ret
 
-BattleAnim_AbsSinePrecise:
+BattleAnim_AbsSinePrecise: ; unreferenced
 	ld a, e
 	call BattleAnim_Sine
 	ld e, l
 	ld d, h
 	ret
 
-BattleAnim_AbsCosinePrecise:
+BattleAnim_AbsCosinePrecise: ; unreferenced
 	ld a, e
 	call BattleAnim_Cosine
 	ld e, l

engine/debug/color_picker.asm

@@ -32,7 +32,7 @@
 	const DEBUGCOLORMAIN_INITTMHM       ; 4
 	const DEBUGCOLORMAIN_TMHMJOYPAD     ; 5
 
-DebugColorPicker:
+DebugColorPicker: ; unreferenced
 ; A debug menu to test monster and trainer palettes at runtime.
 	ldh a, [hCGB]
 	and a
@@ -929,13 +929,13 @@ DebugColor_FillBoxWithByte:
 	ret
 
 DebugColor_PushSGBPals:
-	ld a, [wcfbe]
+	ld a, [wJoypadDisable]
 	push af
-	set 7, a
+	set JOYPAD_DISABLE_SGB_TRANSFER_F, a
-	ld [wcfbe], a
+	ld [wJoypadDisable], a
 	call _DebugColor_PushSGBPals
 	pop af
-	ld [wcfbe], a
+	ld [wJoypadDisable], a
 	ret
 
 _DebugColor_PushSGBPals:
@@ -1069,7 +1069,7 @@ INCBIN "gfx/debug/up_arrow.2bpp"
 DebugColor_GFX:
 INCBIN "gfx/debug/color_test.2bpp"
 
-TilesetColorPicker:
+TilesetColorPicker: ; unreferenced
 ; A debug menu to test tileset palettes at runtime.
 ; dummied out
 	ret
@@ -1437,8 +1437,8 @@ DebugTileset_CalculatePalette:
 	ld [hl], d
 	ret
 
-; unused
+.dummy1: ; unreferenced
 	ret
 
-; unused
+.dummy2: ; unreferenced
 	ret

engine/debug/debug_room.asm

@@ -1328,9 +1328,9 @@ DebugRoom_BoxStructStrings:
 .Move4:     db "MOVE 4@"
 .ID0:       db "ID[0]@"
 .ID1:       db "ID[1]@"
-.BaseExp0:  db "BASE EXP[0]@"
+.BaseExp0:  db "BASE EXP[0]@" ; unreferenced
-.BaseExp1:  db "BASE EXP[1]@"
+.BaseExp1:  db "BASE EXP[1]@" ; unreferenced
-.BaseExp2:  db "BASE EXP[2]@"
+.BaseExp2:  db "BASE EXP[2]@" ; unreferenced
 .HPExp0:    db "HP EXP[0]@"
 .HPExp1:    db "HP EXP[1]@"
 .AttkExp0:  db "ATTK EXP[0]@"

engine/events/battle_tower/battle_tower.asm

@@ -67,7 +67,7 @@ Function170114:
 	call Function170c8b
 	ret
 
-Function170139:
+Function170139: ; unreferenced
 ; Convert the 4-digit decimal number at s5_aa41 into binary
 	ld a, BANK(s5_aa41)
 	call OpenSRAM
@@ -183,7 +183,7 @@ BattleTowerBattle:
 	call _BattleTowerBattle
 	ret
 
-DummySpecial_17021d:
+UnusedBattleTowerDummySpecial1:
 	ret
 
 InitBattleTowerChallengeRAM:
@@ -374,7 +374,7 @@ ReadBTTrainerParty:
 	ld [bc], a
 	ret
 
-ValidateBTParty:
+ValidateBTParty: ; unreferenced
 ; Check for and fix errors in party data
 	ld hl, wBT_OTTempMon1Species
 	ld d, BATTLETOWER_PARTY_LENGTH
@@ -386,7 +386,7 @@ ValidateBTParty:
 	ld a, [hl]
 	and a
 x = $ff
-rept ($ff - NUM_POKEMON)
+rept $ff - NUM_POKEMON
 	jr z, .invalid
 	cp x
 x = x - 1
@@ -1008,11 +1008,11 @@ BattleTowerAction_SetExplanationRead:
 
 BattleTowerAction_SetByteToQuickSaveChallenge:
 	ld c, BATTLETOWER_SAVED_AND_LEFT
-	jr asm_17079f
+	jr SetBattleTowerChallengeState
 
 BattleTowerAction_SetByteToCancelChallenge:
 	ld c, BATTLETOWER_NO_CHALLENGE
-asm_17079f:
+SetBattleTowerChallengeState:
 	ld a, BANK(sBattleTowerChallengeState)
 	call OpenSRAM
 	ld a, c
@@ -1447,11 +1447,11 @@ Function1709bb: ; BattleTowerAction $10
 
 Function170a9c:
 	ld c, FALSE
-	jr asm_170aa2
+	jr Set_s5_aa8d
 
 Function170aa0:
 	ld c, TRUE
-asm_170aa2:
+Set_s5_aa8d:
 	ld a, BANK(s5_aa8d)
 	call OpenSRAM
 	ld a, c
@@ -1576,7 +1576,7 @@ LoadOpponentTrainerAndPokemonWithOTSprite:
 
 INCLUDE "data/trainers/sprites.asm"
 
-DummySpecial_170bd2:
+UnusedBattleTowerDummySpecial2:
 	ret
 
 CheckForBattleTowerRules:

engine/events/battle_tower/load_trainer.asm

@@ -95,7 +95,7 @@ Function_LoadRandomBattleTowerMon:
 	ld c, BATTLETOWER_PARTY_LENGTH
 .loop
 	push bc
-	ld a, BANK(sBTMonPrevTrainer1)
+	ld a, BANK(sBTMonOfTrainers)
 	call OpenSRAM
 
 .FindARandomBattleTowerMon:

engine/events/buena.asm

@@ -85,7 +85,7 @@ BuenaPrize:
 	call Buena_PrizeMenu
 	jr z, .done
 	ld [wMenuSelectionQuantity], a
-	call Buena_getprize
+	call Buena_GetPrize
 	ld a, [hl]
 	ld [wNamedObjectIndexBuffer], a
 	call GetItemName
@@ -95,7 +95,7 @@ BuenaPrize:
 	jr c, .loop
 
 	ld a, [wMenuSelectionQuantity]
-	call Buena_getprize
+	call Buena_GetPrize
 	inc hl
 	ld a, [hld]
 	ld c, a
@@ -258,11 +258,11 @@ Buena_PrizeMenu:
 	db SCROLLINGMENU_DISPLAY_ARROWS ; flags
 	db 4, 13 ; rows, columns
 	db SCROLLINGMENU_ITEMS_NORMAL ; item format
-	dba .indices
+	dba .Prizes
-	dba .prizeitem
+	dba .PrintPrizeItem
-	dba .prizepoints
+	dba .PrintPrizePoints
 
-.indices:
+.Prizes:
 	db NUM_BUENA_PRIZES
 x = 1
 rept NUM_BUENA_PRIZES
@@ -271,9 +271,9 @@ x = x + 1
 endr
 	db -1
 
-.prizeitem:
+.PrintPrizeItem:
 	ld a, [wMenuSelection]
-	call Buena_getprize
+	call Buena_GetPrize
 	ld a, [hl]
 	push de
 	ld [wNamedObjectIndexBuffer], a
@@ -282,9 +282,9 @@ endr
 	call PlaceString
 	ret
 
-.prizepoints:
+.PrintPrizePoints:
 	ld a, [wMenuSelection]
-	call Buena_getprize
+	call Buena_GetPrize
 	inc hl
 	ld a, [hl]
 	ld c, "0"
@@ -292,7 +292,7 @@ endr
 	ld [de], a
 	ret
 
-Buena_getprize:
+Buena_GetPrize:
 	dec a
 	ld hl, BuenaPrizeItems
 	ld b, 0

engine/events/bug_contest/judging.asm

@@ -68,7 +68,8 @@ ContestJudging_ThirdPlaceScoreText:
 
 LoadContestantName:
 ; If a = 1, get your name.
-	dec a ; BUG_CONTEST_PLAYER
+	assert BUG_CONTEST_PLAYER == 1
+	dec a
 	jr z, .player
 ; Find the pointer for the trainer class of the Bug Catching Contestant whose ID is in a.
 	ld c, a

engine/events/celebi.asm

@@ -1,6 +1,6 @@
 SPECIALCELEBIEVENT_CELEBI EQU $84
 
-UnusedForestTreeFrames:
+UnusedForestTreeFrames: ; unreferenced
 INCBIN "gfx/tilesets/forest-tree/1.2bpp"
 INCBIN "gfx/tilesets/forest-tree/2.2bpp"
 INCBIN "gfx/tilesets/forest-tree/3.2bpp"
@@ -99,9 +99,8 @@ CelebiEvent_CountDown:
 	set 7, [hl]
 	ret
 
-CelebiEvent_SpawnLeaf:
+CelebiEvent_SpawnLeaf: ; unreferenced
-; unused
+	ld hl, wFrameCounter2
-	ld hl, wcf65
 	ld a, [hl]
 	inc [hl]
 	and $7

engine/events/daycare.asm

@@ -1,9 +1,9 @@
 ; PrintDayCareText.TextTable indexes
 	const_def
 	const DAYCARETEXT_MAN_INTRO
-	const DAYCARETEXT_MAN_ODD_EGG
+	const DAYCARETEXT_MAN_INTRO_EGG
 	const DAYCARETEXT_LADY_INTRO
-	const DAYCARETEXT_LADY_ODD_EGG
+	const DAYCARETEXT_LADY_INTRO_EGG
 	const DAYCARETEXT_WHICH_ONE
 	const DAYCARETEXT_DEPOSIT
 	const DAYCARETEXT_CANT_BREED_EGG
@@ -166,7 +166,7 @@ DayCareAskDepositPokemon:
 	scf
 	ret
 
-.DaycareDummyText:
+.DaycareDummyText: ; unreferenced
 	text_far _DaycareDummyText
 	text_end
 
@@ -274,9 +274,9 @@ PrintDayCareText:
 .TextTable:
 ; entries correspond to DAYCARETEXT_* constants
 	dw .DayCareManIntroText ; 00
-	dw .DayCareManOddEggText ; 01
+	dw .DayCareManIntroEggText ; 01
 	dw .DayCareLadyIntroText ; 02
-	dw .DayCareLadyOddEggText ; 03
+	dw .DayCareLadyIntroEggText ; 03
 	dw .WhatShouldIRaiseText ; 04
 	dw .IllRaiseYourMonText ; 05
 	dw .CantAcceptEggText ; 06
@@ -298,16 +298,16 @@ PrintDayCareText:
 	text_far _DayCareManIntroText
 	text_end
 
-.DayCareManOddEggText:
+.DayCareManIntroEggText:
-	text_far _DayCareManOddEggText
+	text_far _DayCareManIntroEggText
 	text_end
 
 .DayCareLadyIntroText:
 	text_far _DayCareLadyIntroText
 	text_end
 
-.DayCareLadyOddEggText:
+.DayCareLadyIntroEggText:
-	text_far _DayCareLadyOddEggText
+	text_far _DayCareLadyIntroEggText
 	text_end
 
 .WhatShouldIRaiseText:

engine/events/diploma.asm

@@ -87,4 +87,5 @@ INCBIN "gfx/diploma/page1.tilemap"
 DiplomaPage2Tilemap:
 INCBIN "gfx/diploma/page2.tilemap"
 
-	ret ; unused
+Diploma_DummyFunction: ; unreferenced
+	ret

engine/events/engine_flags.asm

@@ -57,7 +57,7 @@ EngineFlagAction::
 	jr z, .set   ; b = 1
 
 ; Return the given flag in c.
-.check
+; check
 	ld a, [de]
 	and c
 	ld c, a

engine/events/field_moves.asm

@@ -426,7 +426,7 @@ FlyFunction_FrameTimer:
 	ret
 
 .SpawnLeaf:
-	ld hl, wcf65
+	ld hl, wFrameCounter2
 	ld a, [hl]
 	inc [hl]
 	and $7

engine/events/heal_machine_anim.asm

@@ -56,7 +56,7 @@ HealMachineAnim:
 .Pointers:
 ; entries correspond to HEALMACHINE_* constants
 	dw .Pokecenter
-	dw .ElmLab
+	dw .ElmsLab
 	dw .HallOfFame
 
 healmachineanimseq: MACRO
@@ -68,7 +68,7 @@ ENDM
 
 .Pokecenter:
 	healmachineanimseq LOADGFX, PCLOADBALLS, PLAYMUSIC, FINISH
-.ElmLab:
+.ElmsLab:
 	healmachineanimseq LOADGFX, PCLOADBALLS, PLAYMUSIC, FINISH
 .HallOfFame:
 	healmachineanimseq LOADGFX, HOFLOADBALLS, HOFPLAYSFX, FINISH

engine/events/magnet_train.asm

@@ -69,7 +69,7 @@ MagnetTrain:
 	ld [wRequested2bppSource + 1], a
 	ld [wRequested2bppDest], a
 	ld [wRequested2bppDest + 1], a
-	ld [wRequested2bpp], a
+	ld [wRequested2bppSize], a
 	call ClearTilemap
 
 	pop af

engine/events/mom_phone.asm

@@ -228,9 +228,12 @@ MomItsInYourRoomText:
 	text_far _MomItsInYourRoomText
 	text_end
 
-	db 0 ; unused
+
+DummyPredef3A_DummyData: ; unreferenced
+	db 0
 
 DummyPredef3A:
 	ret
 
-	ret ; unused
+DummyPredef3A_DummyFunction: ; unreferenced
+	ret

engine/events/npc_trade.asm

@@ -56,11 +56,12 @@ NPCTrade::
 	call DisableSpriteUpdates
 	ld a, [wJumptableIndex]
 	push af
-	ld a, [wcf64]
+	; wTradeDialog aliases wFrameCounter, which TradeAnimation uses
+	ld a, [wTradeDialog]
 	push af
 	predef TradeAnimation
 	pop af
-	ld [wcf64], a
+	ld [wTradeDialog], a
 	pop af
 	ld [wJumptableIndex], a
 	call ReturnToMapWithSpeechTextbox
@@ -107,7 +108,7 @@ Trade_GetDialog:
 	ld e, NPCTRADE_DIALOG
 	call GetTradeAttribute
 	ld a, [hl]
-	ld [wcf64], a
+	ld [wTradeDialog], a
 	ret
 
 DoNPCTrade:
@@ -392,7 +393,7 @@ PrintTradeText:
 	ld bc, 2 * 4
 	ld hl, TradeTexts
 	call AddNTimes
-	ld a, [wcf64]
+	ld a, [wTradeDialog]
 	ld c, a
 	add hl, bc
 	add hl, bc

engine/events/overworld.asm

@@ -271,7 +271,7 @@ CheckOverworldTileArrays:
 	xor a
 	ret
 
-INCLUDE "data/events/field_move_blocks.asm"
+INCLUDE "data/collision/field_move_blocks.asm"
 
 FlashFunction:
 	call .CheckUseFlash
@@ -1414,7 +1414,7 @@ HasRockSmash:
 	ld d, ROCK_SMASH
 	call CheckPartyMove
 	jr nc, .yes
-.no
+; no
 	ld a, 1
 	jr .done
 .yes
@@ -1616,7 +1616,7 @@ RodNothingText:
 	text_far _RodNothingText
 	text_end
 
-UnusedNothingHereText: ; unused
+UnusedNothingHereText: ; unreferenced
 	text_far _UnusedNothingHereText
 	text_end
 
@@ -1722,7 +1722,7 @@ Script_GetOnBike_Register:
 	special UpdatePlayerSprite
 	end
 
-; unused
+Overworld_DummyFunction: ; unreferenced
 	nop
 	ret
 

engine/events/poisonstep.asm

@@ -149,6 +149,6 @@ DoPoisonStep::
 	text_far _PoisonFaintText
 	text_end
 
-.PoisonWhiteoutText:
+.PoisonWhiteoutText: ; unreferenced
 	text_far _PoisonWhiteoutText
 	text_end

engine/events/print_unown_2.asm

@@ -9,7 +9,7 @@ RotateUnownFrontpic:
 	push bc
 	push hl
 	push bc
-	ld de, wd002
+	ld de, wPrintedUnownTileSource
 	call .Copy
 	call .Rotate
 	ld hl, UnownPrinter_GBPrinterRectangle
@@ -19,10 +19,10 @@ RotateUnownFrontpic:
 	ld a, [hli]
 	ld e, a
 	ld d, [hl]
-	ld hl, wd012
+	ld hl, wPrintedUnownTileDest
 	call .Copy
 	pop hl
-	ld bc, $10
+	ld bc, LEN_2BPP_TILE
 	add hl, bc
 	pop bc
 	inc c
@@ -30,7 +30,7 @@ RotateUnownFrontpic:
 	cp 7 * 7
 	jr c, .loop
 
-	ld hl, wGameboyPrinterRAM
+	ld hl, wGameboyPrinter2bppSource
 	ld de, sScratch
 	ld bc, 7 * 7 tiles
 	call CopyBytes
@@ -44,7 +44,7 @@ RotateUnownFrontpic:
 	ret
 
 .Copy:
-	ld c, $10
+	ld c, LEN_2BPP_TILE
 .loop_copy
 	ld a, [hli]
 	ld [de], a
@@ -54,18 +54,18 @@ RotateUnownFrontpic:
 	ret
 
 .Rotate:
-	ld hl, wd012
+	ld hl, wPrintedUnownTileDest
 	ld e, %10000000
 	ld d, 8
 .loop_decompress
 	push hl
-	ld hl, wd002
+	ld hl, wPrintedUnownTileSource
 	call .CountSetBit
 	pop hl
 	ld a, b
 	ld [hli], a
 	push hl
-	ld hl, wd003
+	ld hl, wPrintedUnownTileSource + 1
 	call .CountSetBit
 	pop hl
 	ld a, b
@@ -100,7 +100,7 @@ y = 0
 rept \1
 x = \1 * (\2 - 1) + y
 rept \2
-	dw wGameboyPrinterRAM tile x
+	dw wGameboyPrinter2bppSource tile x
 x = x - \2
 endr
 y = y + 1

engine/events/prof_oaks_pc.asm

@@ -36,18 +36,18 @@ Rate:
 	ld hl, wPokedexSeen
 	ld b, wEndPokedexSeen - wPokedexSeen
 	call CountSetBits
-	ld [wd002], a
+	ld [wTempPokedexSeenCount], a
 	ld hl, wPokedexCaught
 	ld b, wEndPokedexCaught - wPokedexCaught
 	call CountSetBits
-	ld [wd003], a
+	ld [wTempPokedexCaughtCount], a
 
 ; print appropriate rating
 	call .UpdateRatingBuffers
 	ld hl, OakPCText3
 	call PrintText
 	call JoyWaitAorB
-	ld a, [wd003]
+	ld a, [wTempPokedexCaughtCount]
 	ld hl, OakRatings
 	call FindOakRating
 	push de
@@ -57,10 +57,10 @@ Rate:
 
 .UpdateRatingBuffers:
 	ld hl, wStringBuffer3
-	ld de, wd002
+	ld de, wTempPokedexSeenCount
 	call .UpdateRatingBuffer
 	ld hl, wStringBuffer4
-	ld de, wd003
+	ld de, wTempPokedexCaughtCount
 	call .UpdateRatingBuffer
 	ret
 

engine/events/specials.asm

@@ -15,7 +15,7 @@ Special::
 
 INCLUDE "data/events/special_pointers.asm"
 
-DummySpecial_c224:
+UnusedDummySpecial:
 	ret
 
 SetPlayerPalette:
@@ -207,7 +207,7 @@ CardFlip:
 	call StartGameCornerGame
 	ret
 
-DummyNonfunctionalGameCornerGame:
+UnusedDummyGame:
 	call CheckCoinsAndCoinCase
 	ret c
 	ld a, BANK(_DummyGame)
@@ -380,17 +380,17 @@ GameboyCheck:
 	ldh a, [hCGB]
 	and a
 	jr nz, .cgb
-
 	ldh a, [hSGB]
 	and a
 	jr nz, .sgb
-
+; gb
-.gb
 	xor a ; GBCHECK_GB
 	jr .done
+
 .sgb
 	ld a, GBCHECK_SGB
 	jr .done
+
 .cgb
 	ld a, GBCHECK_CGB
 .done

engine/events/std_collision.asm

@@ -23,7 +23,7 @@ CheckFacingTileForStdScript::
 	xor a
 	ret
 
-INCLUDE "data/events/collision_stdscripts.asm"
+INCLUDE "data/collision/collision_stdscripts.asm"
 
 Script_JumpStdFromRAM:
 	sjump wJumpStdScriptBuffer

engine/events/treemons.asm

@@ -210,7 +210,7 @@ GetTreeScore:
 	cp 5
 	jr c, .good
 
-.bad
+; bad
 	xor a ; TREEMON_SCORE_BAD
 	ret
 

engine/games/card_flip.asm

@@ -1,7 +1,8 @@
 CARDFLIP_LIGHT_OFF EQU "♂" ; $ef
 CARDFLIP_LIGHT_ON  EQU "♀" ; $f5
 
-CARDFLIP_DECK_SIZE EQU 4 * 6
+CARDFLIP_DECK_SIZE EQUS "(wDeckEnd - wDeck)"
+	assert wDiscardPileEnd - wDiscardPile == wDeckEnd - wDeck
 
 DummyGameGFX:
 ; Graphics for an unused Game Corner

engine/games/dummy_game.asm

@@ -20,7 +20,7 @@ _DummyGame:
 	ld a, BANK(DummyGameGFX)
 	call FarCopyBytes
 	ld a, $8
-	ld hl, wc300
+	ld hl, wSpriteAnimDict
 	ld [hli], a
 	ld [hl], $0
 	hlcoord 0, 0
@@ -133,11 +133,11 @@ endr
 .next_try
 	dec [hl]
 	xor a
-	ld [wcf64], a
+	ld [wDummyGameCardChoice], a
 	ld hl, wJumptableIndex
 	inc [hl]
 .PickCard1:
-	ld a, [wcf64]
+	ld a, [wDummyGameCardChoice]
 	and a
 	ret z
 	dec a
@@ -155,13 +155,13 @@ endr
 	call DummyGame_Card2Coord
 	call DummyGame_PlaceCard
 	xor a
-	ld [wcf64], a
+	ld [wDummyGameCardChoice], a
 	ld hl, wJumptableIndex
 	inc [hl]
 	ret
 
 .PickCard2:
-	ld a, [wcf64]
+	ld a, [wDummyGameCardChoice]
 	and a
 	ret z
 	dec a
@@ -527,7 +527,7 @@ DummyGame_InterpretJoypad_AnimateCursor:
 	add hl, bc
 	ld a, [hl]
 	inc a
-	ld [wcf64], a
+	ld [wDummyGameCardChoice], a
 	ret
 
 .pressed_left

engine/games/slot_machine.asm

@@ -249,7 +249,7 @@ DebugPrintSlotBias: ; unreferenced
 
 AnimateSlotReelIcons: ; unreferenced
 ; This animation was present in pokegold-spaceworld.
-	ld hl, wcf66
+	ld hl, wUnusedSlotReelIconDelay
 	ld a, [hl]
 	inc [hl]
 	and $7

engine/games/unown_puzzle.asm

@@ -504,13 +504,13 @@ CheckSolvedUnownPuzzle:
 
 RedrawUnownPuzzlePieces:
 	call GetCurrentPuzzlePieceVTileCorner
-	ld [wd002], a
+	ld [wUnownPuzzleCornerTile], a
 	xor a
 	call GetUnownPuzzleCoordData ; get pixel positions
 	ld a, [hli]
 	ld b, [hl]
 	ld c, a
-	ld a, [wd002]
+	ld a, [wUnownPuzzleCornerTile]
 	cp $e0
 	jr z, .NoPiece
 	ld hl, .OAM_HoldingPiece
@@ -532,7 +532,7 @@ RedrawUnownPuzzlePieces:
 	add c
 	ld [de], a ; x
 	inc de
-	ld a, [wd002]
+	ld a, [wUnownPuzzleCornerTile]
 	add [hl]
 	ld [de], a ; tile id
 	inc hl

engine/gfx/cgb_layouts.asm

@@ -17,19 +17,18 @@ LoadSGBLayoutCGB:
 	ld l, a
 	ld h, 0
 	add hl, hl
-	ld de, .dw
+	ld de, .Jumptable
 	add hl, de
 	ld a, [hli]
 	ld h, [hl]
 	ld l, a
-	ld de, .ReturnFromJumpTable
+	ld de, .done
 	push de
 	jp hl
-
+.done:
-.ReturnFromJumpTable:
 	ret
 
-.dw
+.Jumptable:
 	dw _CGB_BattleGrayscale
 	dw _CGB_BattleColors
 	dw _CGB_PokegearPals
@@ -43,7 +42,7 @@ LoadSGBLayoutCGB:
 	dw _CGB_PartyMenu
 	dw _CGB_Evolution
 	dw _CGB_GSTitleScreen
-	dw _CGB0d
+	dw _CGB_Unused0D
 	dw _CGB_MoveList
 	dw _CGB_BetaPikachuMinigame
 	dw _CGB_PokedexSearchOption
@@ -60,7 +59,7 @@ LoadSGBLayoutCGB:
 	dw _CGB_TradeTube
 	dw _CGB_TrainerOrMonFrontpicPals
 	dw _CGB_MysteryGift
-	dw _CGB1e
+	dw _CGB_Unused1E
 
 _CGB_BattleGrayscale:
 	ld hl, PalPacket_BattleGrayscale + 1
@@ -321,12 +320,12 @@ _CGB_BillsPC:
 	ldh [hCGBPalUpdate], a
 	ret
 
-Function9009: ; unreferenced
+_CGB_Unknown: ; unreferenced
 	ld hl, BillsPCOrangePalette
 	call LoadHLPaletteIntoDE
 	jr .GotPalette
 
-.GetMonPalette:
+.GetMonPalette: ; unreferenced
 	ld bc, wTempMonDVs
 	call GetPlayerOrMonPalettePointer
 	call LoadPalette_White_Col1_Col2_Black
@@ -595,7 +594,7 @@ _CGB_GSTitleScreen:
 	ldh [hCGBPalUpdate], a
 	ret
 
-_CGB0d:
+_CGB_Unused0D:
 	ld hl, PalPacket_Diploma + 1
 	call CopyFourPalettes
 	call WipeAttrmap
@@ -911,7 +910,7 @@ _CGB_PlayerOrMonFrontpicPals:
 	call ApplyPals
 	ret
 
-_CGB1e:
+_CGB_Unused1E:
 	ld de, wBGPals1
 	ld a, [wCurPartySpecies]
 	call GetMonPalettePointer

engine/gfx/color.asm

@@ -15,31 +15,31 @@ CheckShininess:
 ; Attack
 	ld a, [hl]
 	and 1 << SHINY_ATK_BIT
-	jr z, .NotShiny
+	jr z, .not_shiny
 
 ; Defense
 	ld a, [hli]
 	and $f
 	cp  SHINY_DEF_VAL
-	jr nz, .NotShiny
+	jr nz, .not_shiny
 
 ; Speed
 	ld a, [hl]
 	and $f0
 	cp  SHINY_SPD_VAL << 4
-	jr nz, .NotShiny
+	jr nz, .not_shiny
 
 ; Special
 	ld a, [hl]
 	and $f
 	cp  SHINY_SPC_VAL
-	jr nz, .NotShiny
+	jr nz, .not_shiny
 
-.Shiny:
+; shiny
 	scf
 	ret
 
-.NotShiny:
+.not_shiny
 	and a
 	ret
 
@@ -49,30 +49,30 @@ Unused_CheckShininess:
 ; Attack
 	ld a, [hl]
 	cp 10 << 4
-	jr c, .NotShiny
+	jr c, .not_shiny
 
 ; Defense
 	ld a, [hli]
 	and $f
 	cp 10
-	jr c, .NotShiny
+	jr c, .not_shiny
 
 ; Speed
 	ld a, [hl]
 	cp 10 << 4
-	jr c, .NotShiny
+	jr c, .not_shiny
 
 ; Special
 	ld a, [hl]
 	and $f
 	cp 10
-	jr c, .NotShiny
+	jr c, .not_shiny
 
-.Shiny:
+; shiny
 	scf
 	ret
 
-.NotShiny:
+.not_shiny
 	and a
 	ret
 
@@ -136,6 +136,7 @@ SGB_ApplyPartyMenuHPPals:
 Intro_LoadMagikarpPalettes: ; unreferenced
 	call CheckCGB
 	ret z
+
 ; CGB only
 	ld hl, .BGPal
 	ld de, wBGPals1
@@ -789,13 +790,13 @@ endr
 	ret
 
 PushSGBPals:
-	ld a, [wcfbe]
+	ld a, [wJoypadDisable]
 	push af
-	set 7, a
+	set JOYPAD_DISABLE_SGB_TRANSFER_F, a
-	ld [wcfbe], a
+	ld [wJoypadDisable], a
 	call _PushSGBPals
 	pop af
-	ld [wcfbe], a
+	ld [wJoypadDisable], a
 	ret
 
 _PushSGBPals:
@@ -841,12 +842,14 @@ _PushSGBPals:
 InitSGBBorder:
 	call CheckCGB
 	ret nz
+
 ; SGB/DMG only
 	di
-	ld a, [wcfbe]
+	ld a, [wJoypadDisable]
 	push af
-	set 7, a
+	set JOYPAD_DISABLE_SGB_TRANSFER_F, a
-	ld [wcfbe], a
+	ld [wJoypadDisable], a
+
 	xor a
 	ldh [rJOYP], a
 	ldh [hSGB], a
@@ -866,13 +869,14 @@ InitSGBBorder:
 
 .skip
 	pop af
-	ld [wcfbe], a
+	ld [wJoypadDisable], a
 	ei
 	ret
 
 InitCGBPals::
 	call CheckCGB
 	ret z
+
 ; CGB only
 	ld a, BANK(vTiles3)
 	ldh [rVBK], a
@@ -977,7 +981,7 @@ PushSGBBorder:
 
 .LoadSGBBorderPointers:
 	ld hl, SGBBorderGFX
-	ld de, SGBBorderMap
+	ld de, SGBBorderMapAndPalettes
 	ret
 
 SGB_ClearVRAM:
@@ -1174,12 +1178,10 @@ INCLUDE "data/sgb_ctrl_packets.asm"
 PredefPals:
 INCLUDE "gfx/sgb/predef.pal"
 
-SGBBorderMap:
+SGBBorderMapAndPalettes:
 ; interleaved tile ids and palette ids, without the center 20x18 screen area
 INCBIN "gfx/sgb/sgb_border.sgb.tilemap"
-
+; four SGB palettes of 16 colors each; only the first 4 colors are used
-SGBBorderPalettes:
-; assumed to come after SGBBorderMap
 INCLUDE "gfx/sgb/sgb_border.pal"
 
 SGBBorderGFX:
@@ -1317,7 +1319,7 @@ INCLUDE "gfx/diploma/diploma.pal"
 PartyMenuOBPals:
 INCLUDE "gfx/stats/party_menu_ob.pal"
 
-UnusedBattleObjectPals:
+UnusedBattleObjectPals: ; unreferenced
 INCLUDE "gfx/battle_anims/unused_battle_anims.pal"
 
 UnusedGSTitleBGPals:

engine/gfx/crystal_layouts.asm

@@ -1,16 +1,16 @@
-GetMysteryGift_MobileAdapterLayout:
+GetCrystalCGBLayout:
 	ld a, b
 	cp SCGB_DEFAULT
-	jr nz, .not_ram
+	jr nz, .not_default
 	ld a, [wDefaultSGBLayout]
-.not_ram
+.not_default
 	push af
 	farcall ResetBGPals
 	pop af
 	ld l, a
 	ld h, 0
 	add hl, hl
-	ld de, .dw
+	ld de, .Jumptable
 	add hl, de
 	ld a, [hli]
 	ld h, [hl]
@@ -18,15 +18,16 @@ GetMysteryGift_MobileAdapterLayout:
 	ld de, .done
 	push de
 	jp hl
-.done
+.done:
 	ret
 
-.dw
+.Jumptable:
-	dw MG_Mobile_Layout00
+	dw _CrystalCGB_MobileLayout0
-	dw MG_Mobile_Layout01
+	dw _CrystalCGB_MobileLayout1
-	dw MG_Mobile_Layout02
+	dw _CrystalCGB_NameCard
 
-MG_Mobile_Layout_FillBox:
+Crystal_FillBoxCGB:
+; This is a copy of FillBoxCGB.
 .row
 	push bc
 	push hl
@@ -42,7 +43,8 @@ MG_Mobile_Layout_FillBox:
 	jr nz, .row
 	ret
 
-MG_Mobile_Layout_WipeAttrmap:
+Crystal_WipeAttrmap:
+; This is a copy of WipeAttrmap.
 	hlcoord 0, 0, wAttrmap
 	ld bc, SCREEN_HEIGHT * SCREEN_WIDTH
 	xor a
@@ -62,9 +64,9 @@ MG_Mobile_Layout_LoadPals:
 	call FarCopyWRAM
 	ret
 
-MG_Mobile_Layout00:
+_CrystalCGB_MobileLayout0:
 	call MG_Mobile_Layout_LoadPals
-	call MG_Mobile_Layout_WipeAttrmap
+	call Crystal_WipeAttrmap
 	call MG_Mobile_Layout_CreatePalBoxes
 	farcall ApplyAttrmap
 	farcall ApplyPals
@@ -74,33 +76,33 @@ MG_Mobile_Layout_CreatePalBoxes:
 	hlcoord 0, 0, wAttrmap
 	lb bc, 4, 1
 	ld a, $1
-	call MG_Mobile_Layout_FillBox
+	call Crystal_FillBoxCGB
 	lb bc, 2, 1
 	ld a, $2
-	call MG_Mobile_Layout_FillBox
+	call Crystal_FillBoxCGB
 	lb bc, 6, 1
 	ld a, $3
-	call MG_Mobile_Layout_FillBox
+	call Crystal_FillBoxCGB
 	hlcoord 1, 0, wAttrmap
 	ld a, $1
 	lb bc, 3, 18
-	call MG_Mobile_Layout_FillBox
+	call Crystal_FillBoxCGB
 	lb bc, 2, 18
 	ld a, $2
-	call MG_Mobile_Layout_FillBox
+	call Crystal_FillBoxCGB
 	lb bc, 12, 18
 	ld a, $3
-	call MG_Mobile_Layout_FillBox
+	call Crystal_FillBoxCGB
 	hlcoord 19, 0, wAttrmap
 	lb bc, 4, 1
 	ld a, $1
-	call MG_Mobile_Layout_FillBox
+	call Crystal_FillBoxCGB
 	lb bc, 2, 1
 	ld a, $2
-	call MG_Mobile_Layout_FillBox
+	call Crystal_FillBoxCGB
 	lb bc, 6, 1
 	ld a, $3
-	call MG_Mobile_Layout_FillBox
+	call Crystal_FillBoxCGB
 	hlcoord 0, 12, wAttrmap
 	ld bc, 6 * SCREEN_WIDTH
 	ld a, $7
@@ -129,14 +131,14 @@ Function49420::
 	call FarCopyWRAM
 	ret
 
-MG_Mobile_Layout01:
+_CrystalCGB_MobileLayout1:
 	call MG_Mobile_Layout_LoadPals
 	ld de, wBGPals1 palette PAL_BG_TEXT
-	ld hl, .Palette_49478
+	ld hl, .TextPalette
 	ld bc, 1 palettes
 	ld a, BANK(wBGPals1)
 	call FarCopyWRAM
-	call MG_Mobile_Layout_WipeAttrmap
+	call Crystal_WipeAttrmap
 	hlcoord 0, 0, wAttrmap
 	ld bc, SCREEN_WIDTH * SCREEN_HEIGHT
 	xor a
@@ -149,19 +151,18 @@ MG_Mobile_Layout01:
 	bit 6, a
 	jr z, .asm_49464
 	call Function49480
-	jr .asm_49467
+	jr .done
 
 .asm_49464
 	call Function49496
-
+.done
-.asm_49467
 	farcall ApplyAttrmap
 	farcall ApplyPals
 	ld a, TRUE
 	ldh [hCGBPalUpdate], a
 	ret
 
-.Palette_49478:
+.TextPalette:
 	RGB 31, 31, 31
 	RGB 26, 31, 00
 	RGB 20, 16, 03
@@ -171,7 +172,7 @@ Function49480:
 	hlcoord 0, 0, wAttrmap
 	lb bc, 4, SCREEN_WIDTH
 	ld a, $7
-	call MG_Mobile_Layout_FillBox
+	call Crystal_FillBoxCGB
 	hlcoord 0, 2, wAttrmap
 	ld a, $4
 	ld [hl], a
@@ -183,7 +184,7 @@ Function49496:
 	hlcoord 0, 0, wAttrmap
 	lb bc, 2, SCREEN_WIDTH
 	ld a, $7
-	call MG_Mobile_Layout_FillBox
+	call Crystal_FillBoxCGB
 	hlcoord 0, 1, wAttrmap
 	ld a, $4
 	ld [hl], a
@@ -193,29 +194,29 @@ Function49496:
 
 INCLUDE "engine/tilesets/tileset_palettes.asm"
 
-MG_Mobile_Layout02:
+_CrystalCGB_NameCard:
-	ld hl, .Palette_49732
+	ld hl, .BGPalette
 	ld de, wBGPals1
 	ld bc, 1 palettes
 	ld a, BANK(wBGPals1)
 	call FarCopyWRAM
 	farcall ApplyPals
-	call MG_Mobile_Layout_WipeAttrmap
+	call Crystal_WipeAttrmap
 	farcall ApplyAttrmap
-	ld hl, .Palette_4973a
+	ld hl, .OBPalette
 	ld de, wOBPals1
 	ld bc, 1 palettes
 	ld a, BANK(wOBPals1)
 	call FarCopyWRAM
 	ret
 
-.Palette_49732:
+.BGPalette:
 	RGB 31, 31, 31
 	RGB 23, 16, 07
 	RGB 23, 07, 07
 	RGB 03, 07, 20
 
-.Palette_4973a:
+.OBPalette:
 	RGB 00, 00, 00
 	RGB 07, 05, 31
 	RGB 14, 18, 31
@@ -237,38 +238,38 @@ _InitMG_Mobile_LinkTradePalMap:
 	hlcoord 0, 0, wAttrmap
 	lb bc, 16, 2
 	ld a, $4
-	call MG_Mobile_Layout_FillBox
+	call Crystal_FillBoxCGB
 	ld a, $3
 	ldcoord_a 0, 1, wAttrmap
 	ldcoord_a 0, 14, wAttrmap
 	hlcoord 2, 0, wAttrmap
 	lb bc, 8, 18
 	ld a, $5
-	call MG_Mobile_Layout_FillBox
+	call Crystal_FillBoxCGB
 	hlcoord 2, 8, wAttrmap
 	lb bc, 8, 18
 	ld a, $6
-	call MG_Mobile_Layout_FillBox
+	call Crystal_FillBoxCGB
 	hlcoord 0, 16, wAttrmap
 	lb bc, 2, SCREEN_WIDTH
 	ld a, $4
-	call MG_Mobile_Layout_FillBox
+	call Crystal_FillBoxCGB
 	ld a, $3
 	lb bc, 6, 1
 	hlcoord 6, 1, wAttrmap
-	call MG_Mobile_Layout_FillBox
+	call Crystal_FillBoxCGB
 	ld a, $3
 	lb bc, 6, 1
 	hlcoord 17, 1, wAttrmap
-	call MG_Mobile_Layout_FillBox
+	call Crystal_FillBoxCGB
 	ld a, $3
 	lb bc, 6, 1
 	hlcoord 6, 9, wAttrmap
-	call MG_Mobile_Layout_FillBox
+	call Crystal_FillBoxCGB
 	ld a, $3
 	lb bc, 6, 1
 	hlcoord 17, 9, wAttrmap
-	call MG_Mobile_Layout_FillBox
+	call Crystal_FillBoxCGB
 	ld a, $2
 	hlcoord 2, 16, wAttrmap
 	ld [hli], a

engine/gfx/load_pics.asm

@@ -208,7 +208,8 @@ GetMonBackpic:
 	push de
 
 	; These are assumed to be at the same address in their respective banks.
-	ld hl, PokemonPicPointers ; UnownPicPointers
+	assert PokemonPicPointers == UnownPicPointers
+	ld hl, PokemonPicPointers
 	ld a, b
 	ld d, BANK(PokemonPicPointers)
 	cp UNOWN

engine/gfx/pic_animation.asm

@@ -648,7 +648,7 @@ PokeAnim_ConvertAndApplyBitmask:
 .skip2
 	ret
 
-; unused
+.UnusedSizeData: ; unreferenced
 	db 6, 5, 4
 
 .GetTilemap:

engine/gfx/player_gfx.asm

@@ -113,10 +113,10 @@ GetCardPic:
 	ld bc, $23 tiles
 	ld a, BANK(ChrisCardPic) ; aka BANK(KrisCardPic)
 	call FarCopyBytes
-	ld hl, CardGFX
+	ld hl, TrainerCardGFX
 	ld de, vTiles2 tile $23
 	ld bc, 6 tiles
-	ld a, BANK(CardGFX)
+	ld a, BANK(TrainerCardGFX)
 	call FarCopyBytes
 	ret
 
@@ -126,7 +126,7 @@ INCBIN "gfx/trainer_card/chris_card.2bpp"
 KrisCardPic:
 INCBIN "gfx/trainer_card/kris_card.2bpp"
 
-CardGFX:
+TrainerCardGFX:
 INCBIN "gfx/trainer_card/trainer_card.2bpp"
 
 GetPlayerBackpic:

engine/gfx/sgb_layouts.asm

@@ -35,7 +35,7 @@ LoadSGBLayout:
 	dw .SGB_PartyMenu
 	dw .SGB_Evolution
 	dw .SGB_GSTitleScreen
-	dw .SGB0d
+	dw .SGB_Unused0D
 	dw .SGB_MoveList
 	dw .SGB_BetaPikachuMinigame
 	dw .SGB_PokedexSearchOption
@@ -52,7 +52,7 @@ LoadSGBLayout:
 	dw .SGB_TradeTube
 	dw .SGB_TrainerOrMonFrontpicPals
 	dw .SGB_MysteryGift
-	dw .SGB1e
+	dw .SGB_Unused1E
 
 .SGB_BattleGrayscale:
 	ld hl, PalPacket_BattleGrayscale
@@ -397,7 +397,7 @@ endr
 	ld de, BlkPacket_AllPal0
 	ret
 
-.SGB0d:
+.SGB_Unused0D:
 .SGB_TrainerCard:
 	ld hl, PalPacket_Diploma
 	ld de, BlkPacket_AllPal0
@@ -437,7 +437,7 @@ endr
 	ld de, wSGBPals + PALPACKET_LENGTH
 	ret
 
-.SGB1e:
+.SGB_Unused1E:
 	ld hl, PalPacket_Pal01
 	ld de, wSGBPals
 	ld bc, PALPACKET_LENGTH
@@ -450,7 +450,7 @@ endr
 	add hl, hl
 	ld de, PokemonPalettes
 	add hl, de
-	ld a, [wcf65]
+	ld a, [wUnusedSGB1eColorOffset]
 	and 3
 	sla a
 	sla a

engine/gfx/sprite_anims.asm

@@ -357,7 +357,7 @@ AnimSeq_SlotsGolem:
 
 AnimSeq_SlotsChansey:
 	callfar Slots_AnimateChansey
-	ld hl, wcf64
+	ld hl, wSlotsDelay
 	ld a, [hl]
 	cp $2
 	ret nz
@@ -382,7 +382,7 @@ AnimSeq_SlotsChanseyEgg:
 	jr c, .move_right
 	call DeinitializeSprite
 	ld a, $4
-	ld [wcf64], a
+	ld [wSlotsDelay], a
 	ld de, SFX_PLACE_PUZZLE_PIECE_DOWN
 	call PlaySFX
 	ret
@@ -819,7 +819,7 @@ AnimSeq_IntroUnown:
 	ret
 
 AnimSeq_IntroUnownF:
-	ld a, [wcf64]
+	ld a, [wSlotsDelay]
 	cp $40
 	ret nz
 	ld a, SPRITE_ANIM_FRAMESET_INTRO_UNOWN_F_2

engine/items/item_effects.asm

@@ -1062,14 +1062,13 @@ LevelBallMultiplier:
 	ld b, $ff
 	ret
 
-; These two texts were carried over from gen 1.
+; BallDodgedText and BallMissedText were used in Gen 1.
-; They are not used in gen 2, and are dummied out.
 
-BallDodgedText:
+BallDodgedText: ; unreferenced
 	text_far _BallDodgedText
 	text_end
 
-BallMissedText:
+BallMissedText: ; unreferenced
 	text_far _BallMissedText
 	text_end
 
@@ -1896,14 +1895,14 @@ LoadCurHPIntoBuffer5:
 	ld [wBuffer5], a
 	ret
 
-LoadHPIntoBuffer5:
+LoadHPIntoBuffer5: ; unreferenced
 	ld a, d
 	ld [wBuffer6], a
 	ld a, e
 	ld [wBuffer5], a
 	ret
 
-LoadHPFromBuffer5:
+LoadHPFromBuffer5: ; unreferenced
 	ld a, [wBuffer6]
 	ld d, a
 	ld a, [wBuffer5]
@@ -2167,11 +2166,12 @@ INCLUDE "data/items/x_stats.asm"
 PokeFluteEffect:
 	ld a, [wBattleMode]
 	and a
-	jr nz, .dummy
+	jr nz, .in_battle
-.dummy
+	; overworld flute code was dummied out here
 
+.in_battle
 	xor a
-	ld [wd002], a
+	ld [wPokeFluteCuredSleep], a
 
 	ld b, $ff ^ SLP
 
@@ -2194,7 +2194,7 @@ PokeFluteEffect:
 	and b
 	ld [hl], a
 
-	ld a, [wd002]
+	ld a, [wPokeFluteCuredSleep]
 	and a
 	ld hl, .PlayedFluteText
 	jp z, PrintText
@@ -2203,22 +2203,22 @@ PokeFluteEffect:
 
 	ld a, [wLowHealthAlarm]
 	and 1 << DANGER_ON_F
-	jr nz, .dummy2
+	jr nz, .dummy
-.dummy2
+	; more code was dummied out here
+.dummy
 	ld hl, .FluteWakeUpText
 	jp PrintText
 
 .CureSleep:
 	ld de, PARTYMON_STRUCT_LENGTH
 	ld c, PARTY_LENGTH
-
 .loop
 	ld a, [hl]
 	push af
 	and SLP
 	jr z, .not_asleep
-	ld a, 1
+	ld a, TRUE
-	ld [wd002], a
+	ld [wPokeFluteCuredSleep], a
 .not_asleep
 	pop af
 	and b
@@ -2291,7 +2291,7 @@ ItemfinderEffect:
 
 RestorePPEffect:
 	ld a, [wCurItem]
-	ld [wd002], a
+	ld [wTempRestorePPItem], a
 
 .loop
 	; Party Screen opens to choose on which mon to use the Item
@@ -2300,14 +2300,14 @@ RestorePPEffect:
 	jp c, PPRestoreItem_Cancel
 
 .loop2
-	ld a, [wd002]
+	ld a, [wTempRestorePPItem]
 	cp MAX_ELIXER
 	jp z, Elixer_RestorePPofAllMoves
 	cp ELIXER
 	jp z, Elixer_RestorePPofAllMoves
 
 	ld hl, RaiseThePPOfWhichMoveText
-	ld a, [wd002]
+	ld a, [wTempRestorePPItem]
 	cp PP_UP
 	jr z, .ppup
 	ld hl, RestoreThePPOfWhichMoveText
@@ -2338,7 +2338,7 @@ RestorePPEffect:
 	call CopyName1
 	pop hl
 
-	ld a, [wd002]
+	ld a, [wTempRestorePPItem]
 	cp PP_UP
 	jp nz, Not_PP_Up
 
@@ -2353,7 +2353,6 @@ RestorePPEffect:
 	jr c, .do_ppup
 
 .CantUsePPUpOnSketch:
-.pp_is_maxed_out
 	ld hl, PPIsMaxedOutText
 	call PrintText
 	jr .loop2
@@ -2488,7 +2487,7 @@ RestorePP:
 	cp b
 	jr nc, .dont_restore
 
-	ld a, [wd002]
+	ld a, [wTempRestorePPItem]
 	cp MAX_ELIXER
 	jr z, .restore_all
 	cp MAX_ETHER
@@ -2650,16 +2649,17 @@ WontHaveAnyEffectMessage:
 	ld hl, ItemWontHaveEffectText
 	jr CantUseItemMessage
 
-BelongsToSomeoneElseMessage:
+BelongsToSomeoneElseMessage: ; unreferenced
 	ld hl, ItemBelongsToSomeoneElseText
 	jr CantUseItemMessage
 
-CyclingIsntAllowedMessage:
+CyclingIsntAllowedMessage: ; unreferenced
 	ld hl, NoCyclingText
 	jr CantUseItemMessage
 
-CantGetOnYourBikeMessage:
+CantGetOnYourBikeMessage: ; unreferenced
 	ld hl, ItemCantGetOnText
+	; fallthrough
 
 CantUseItemMessage:
 ; Item couldn't be used.
@@ -2711,11 +2711,11 @@ ItemUsedText:
 	text_far _ItemUsedText
 	text_end
 
-ItemGotOnText:
+ItemGotOnText: ; unreferenced
 	text_far _ItemGotOnText
 	text_end
 
-ItemGotOffText:
+ItemGotOffText: ; unreferenced
 	text_far _ItemGotOffText
 	text_end
 

engine/items/items.asm

@@ -481,7 +481,7 @@ GetNumberedTMHM:
 	jr c, .done
 	cp ITEM_DC - (TM01 - 1) - 1
 	jr c, .skip_one
-.skip_two
+; skip two
 	inc a
 .skip_one
 	inc a

engine/items/pack.asm

@@ -1531,7 +1531,7 @@ PC_Mart_BallsPocketMenuHeader:
 	dba PlaceMenuItemQuantity
 	dba UpdateItemDescription
 
-PackNoItemText:
+PackNoItemText: ; unreferenced
 	text_far _PackNoItemText
 	text_end
 
@@ -1571,7 +1571,7 @@ PackEmptyText:
 	text_far _PackEmptyText
 	text_end
 
-YouCantUseItInABattleText:
+YouCantUseItInABattleText: ; unreferenced
 	text_far _YouCantUseItInABattleText
 	text_end
 

engine/items/tmhm.asm

@@ -159,7 +159,7 @@ TeachTMHM:
 	and a
 	ret
 
-.unused
+.didnt_use ; unreferenced
 	ld a, 2
 	ld [wItemEffectSucceeded], a
 .learned_move

engine/link/init_list.asm

@@ -44,9 +44,9 @@ InitList:
 	ld a, h
 	ld [wListPointer + 1], a
 	ld a, e
-	ld [wUnusedD102], a
+	ld [wUnusedNamesPointer], a
 	ld a, d
-	ld [wUnusedD102 + 1], a
+	ld [wUnusedNamesPointer + 1], a
 	ld bc, ItemAttributes
 	ld a, c
 	ld [wItemAttributesPtr], a

engine/link/link.asm

@@ -27,10 +27,11 @@ LinkCommunications:
 	call PlaceString
 	call SetTradeRoomBGPals
 	call WaitBGMap2
-	ld hl, wcf5d
+	ld hl, wLinkByteTimeout
-	xor a ; LOW($5000)
+	assert LOW(SERIAL_LINK_BYTE_TIMEOUT) == 0
+	xor a ; LOW(SERIAL_LINK_BYTE_TIMEOUT)
 	ld [hli], a
-	ld [hl], HIGH($5000)
+	ld [hl], HIGH(SERIAL_LINK_BYTE_TIMEOUT)
 	ld a, [wLinkMode]
 	cp LINK_TIMECAPSULE
 	jp nz, Gen2ToGen2LinkComms
@@ -101,14 +102,14 @@ Gen2ToGen1LinkComms:
 	ld a, [hl]
 	pop hl
 	and a
-	jp z, Function28b22
+	jp z, ExitLinkCommunications
 	cp $7
-	jp nc, Function28b22
+	jp nc, ExitLinkCommunications
 	ld de, wLinkData
 	ld bc, $1a2
 	call Link_CopyOTData
-	ld de, wPlayerTrademonSpecies
+	ld de, wPlayerTrademon
-	ld hl, wTimeCapsulePartyMon1Species
+	ld hl, wTimeCapsulePlayerData
 	ld c, 2
 .loop
 	ld a, [de]
@@ -162,12 +163,12 @@ Gen2ToGen1LinkComms:
 
 .done_party
 	ld [de], a
-	ld hl, wTimeCapsulePartyMon1Species
+	ld hl, wTimeCapsulePlayerData
-	call Function2868a
+	call Link_ConvertPartyStruct1to2
 	ld a, LOW(wOTPartyMonOT)
-	ld [wUnusedD102], a
+	ld [wUnusedNamesPointer], a
 	ld a, HIGH(wOTPartyMonOT)
-	ld [wUnusedD102 + 1], a
+	ld [wUnusedNamesPointer + 1], a
 	ld de, MUSIC_NONE
 	call PlayMusic
 	ldh a, [hSerialConnectionStatus]
@@ -253,8 +254,8 @@ Gen2ToGen2LinkComms:
 	ld de, wLinkData
 	ld bc, $1b9
 	call Link_CopyOTData
-	ld de, wPlayerTrademonSpecies
+	ld de, wPlayerTrademon
-	ld hl, wLinkPlayerPartyMon1Species
+	ld hl, wLinkPlayerData
 	ld c, 2
 .loop1
 	ld a, [de]
@@ -407,9 +408,9 @@ Gen2ToGen2LinkComms:
 	ld bc, wOTPartyDataEnd - wOTPartyMons
 	call CopyBytes
 	ld a, LOW(wOTPartyMonOT)
-	ld [wUnusedD102], a
+	ld [wUnusedNamesPointer], a
 	ld a, HIGH(wOTPartyMonOT)
-	ld [wUnusedD102 + 1], a
+	ld [wUnusedNamesPointer + 1], a
 	ld de, MUSIC_NONE
 	call PlayMusic
 	ldh a, [hSerialConnectionStatus]
@@ -467,7 +468,7 @@ Gen2ToGen2LinkComms:
 	pop af
 	ld [wOptions], a
 	farcall LoadPokemonData
-	jp Function28b22
+	jp ExitLinkCommunications
 
 .ready_to_trade
 	ld de, MUSIC_ROUTE_30
@@ -510,6 +511,8 @@ LinkTimeout:
 	text_end
 
 ExchangeBytes:
+; This is similar to Serial_ExchangeBytes,
+; but without a SERIAL_PREAMBLE_BYTE check.
 	ld a, TRUE
 	ldh [hSerialIgnoringInitialData], a
 .loop
@@ -520,9 +523,9 @@ ExchangeBytes:
 	ld b, a
 	inc hl
 	ld a, 48
-.delay_cycles
+.wait
 	dec a
-	jr nz, .delay_cycles
+	jr nz, .wait
 	ldh a, [hSerialIgnoringInitialData]
 	and a
 	ld a, b
@@ -584,7 +587,7 @@ FixDataForLinkTransfer:
 	ld [hli], a
 	dec b
 	jr nz, .loop3
-	ld hl, wTimeCapsulePartyMon1 - 1 + PARTY_LENGTH
+	ld hl, wTimeCapsulePlayerData - 1 + PARTY_LENGTH
 	ld de, wc612
 	lb bc, 0, 0
 .loop4
@@ -831,7 +834,7 @@ Link_PrepPartyData_Gen2:
 ; Fill 5 bytes at wc9f4 with $20
 	ld de, wc9f4
 	ld a, $20
-	call Function28682
+	call Link_CopyMailPreamble
 
 ; Copy all the mail messages to wc9f9
 	ld a, BANK(sPartyMail)
@@ -932,7 +935,8 @@ Link_PrepPartyData_Gen2:
 	ld [de], a
 	ret
 
-Function28682:
+Link_CopyMailPreamble:
+; fill 5 bytes with the value of a, starting at de
 	ld c, 5
 .loop
 	ld [de], a
@@ -941,7 +945,7 @@ Function28682:
 	jr nz, .loop
 	ret
 
-Function2868a:
+Link_ConvertPartyStruct1to2:
 	push hl
 	ld d, h
 	ld e, l
@@ -1245,7 +1249,7 @@ LinkTradeOTPartymonMenuLoop:
 .not_d_up
 	bit D_DOWN_F, a
 	jp z, LinkTradePartiesMenuMasterLoop
-	jp Function28ac9
+	jp LinkTradeCheckCancel
 
 LinkTrade_PlayerPartyMenu:
 	farcall InitMG_Mobile_LinkTradePalMap
@@ -1281,7 +1285,7 @@ LinkTradePartymonMenuLoop:
 .check_joypad
 	bit A_BUTTON_F, a
 	jr z, .not_a_button
-	jp Function28926
+	jp LinkTrade_TradeStatsMenu
 
 .not_a_button
 	bit D_DOWN_F, a
@@ -1327,7 +1331,7 @@ LinkTradePartiesMenuMasterLoop:
 	jp z, LinkTradePartymonMenuLoop ; PARTYMON
 	jp LinkTradeOTPartymonMenuLoop  ; OTPARTYMON
 
-Function28926:
+LinkTrade_TradeStatsMenu:
 	call LoadTilemapToTempTilemap
 	ld a, [wMenuCursorY]
 	push af
@@ -1423,14 +1427,14 @@ Function28926:
 	pop af
 	ld [wMenuCursorY], a
 	dec a
-	ld [wd002], a
+	ld [wCurTradePartyMon], a
 	ld [wPlayerLinkAction], a
-	farcall Function16d6ce
+	farcall PrintWaitingTextAndSyncAndExchangeNybble
 	ld a, [wOtherPlayerLinkMode]
 	cp $f
 	jp z, InitTradeMenuDisplay
-	ld [wd003], a
+	ld [wCurOTTradePartyMon], a
-	call Function28b68
+	call LinkTradePlaceArrow
 	ld c, 100
 	call DelayFrames
 	farcall ValidateOTTrademon
@@ -1454,7 +1458,7 @@ Function28926:
 	xor a
 	ld [wcf57], a
 	ld [wOtherPlayerLinkAction], a
-	ld a, [wd003]
+	ld a, [wCurOTTradePartyMon]
 	ld hl, wOTPartySpecies
 	ld c, a
 	ld b, 0
@@ -1481,7 +1485,7 @@ Function28926:
 	call PlaceString
 	ld a, $1
 	ld [wPlayerLinkAction], a
-	farcall Function16d6ce
+	farcall PrintWaitingTextAndSyncAndExchangeNybble
 	ld c, 100
 	call DelayFrames
 	jp InitTradeMenuDisplay
@@ -1497,7 +1501,7 @@ Function28926:
 	text_far _LinkAbnormalMonText
 	text_end
 
-Function28ac9:
+LinkTradeCheckCancel:
 	ld a, [wMenuCursorY]
 	cp 1
 	jp nz, LinkTradePartiesMenuMasterLoop
@@ -1540,18 +1544,18 @@ Function28ade:
 	ldcoord_a 9, 17
 	ld a, $f
 	ld [wPlayerLinkAction], a
-	farcall Function16d6ce
+	farcall PrintWaitingTextAndSyncAndExchangeNybble
 	ld a, [wOtherPlayerLinkMode]
 	cp $f
 	jr nz, .loop1
-Function28b22:
+ExitLinkCommunications:
 	call RotateThreePalettesRight
 	call ClearScreen
 	ld b, SCGB_DIPLOMA
 	call GetSGBLayout
 	call WaitBGMap2
 	xor a
-	ld [wcfbb], a
+	ld [wUnusedLinkCommunicationByte], a
 	xor a
 	ldh [rSB], a
 	ldh [hSerialSend], a
@@ -1561,15 +1565,18 @@ Function28b22:
 	ldh [rSC], a
 	ret
 
-Function28b42: ; unreferenced
+GSPlaceTradeScreenFooter: ; unreferenced
+; Fill the screen footer with pattern tile
 	hlcoord 0, 16
-	ld a, "┘"
+	ld a, $7e
 	ld bc, 2 * SCREEN_WIDTH
 	call ByteFill
+; Clear out area for cancel string
 	hlcoord 1, 16
 	ld a, " "
 	ld bc, SCREEN_WIDTH - 2
 	call ByteFill
+; Place the string
 	hlcoord 2, 16
 	ld de, .CancelString
 	jp PlaceString
@@ -1577,7 +1584,8 @@ Function28b42: ; unreferenced
 .CancelString:
 	db "CANCEL@"
 
-Function28b68:
+LinkTradePlaceArrow:
+; Indicates which pokemon the other player has selected to trade
 	ld a, [wOtherPlayerLinkMode]
 	hlcoord 6, 9
 	ld bc, SCREEN_WIDTH
@@ -1610,7 +1618,7 @@ LinkTrade:
 	ld c, 18
 	call LinkTextboxAtHL
 	farcall Link_WaitBGMap
-	ld a, [wd002]
+	ld a, [wCurTradePartyMon]
 	ld hl, wPartySpecies
 	ld c, a
 	ld b, 0
@@ -1619,10 +1627,10 @@ LinkTrade:
 	ld [wNamedObjectIndexBuffer], a
 	call GetPokemonName
 	ld hl, wStringBuffer1
-	ld de, wd004
+	ld de, wBufferTrademonNick
 	ld bc, MON_NAME_LENGTH
 	call CopyBytes
-	ld a, [wd003]
+	ld a, [wCurOTTradePartyMon]
 	ld hl, wOTPartySpecies
 	ld c, a
 	ld b, 0
@@ -1638,7 +1646,7 @@ LinkTrade:
 	ld b, 3
 	ld c, 7
 	call LinkTextboxAtHL
-	ld de, String28eab
+	ld de, String_TradeCancel
 	hlcoord 12, 8
 	call PlaceString
 	ld a, 8
@@ -1666,12 +1674,12 @@ LinkTrade:
 	call WaitBGMap2
 	pop af
 	bit 1, a
-	jr nz, .asm_28c33
+	jr nz, .canceled
 	ld a, [wMenuCursorY]
 	dec a
-	jr z, .asm_28c54
+	jr z, .try_trade
 
-.asm_28c33
+.canceled
 	ld a, $1
 	ld [wPlayerLinkAction], a
 	hlcoord 0, 12
@@ -1681,16 +1689,17 @@ LinkTrade:
 	hlcoord 1, 14
 	ld de, String_TooBadTheTradeWasCanceled
 	call PlaceString
-	farcall Function16d6ce
+	farcall PrintWaitingTextAndSyncAndExchangeNybble
-	jp Function28ea3
+	jp InitTradeMenuDisplay_Delay
 
-.asm_28c54
+.try_trade
 	ld a, $2
 	ld [wPlayerLinkAction], a
-	farcall Function16d6ce
+	farcall PrintWaitingTextAndSyncAndExchangeNybble
 	ld a, [wOtherPlayerLinkMode]
 	dec a
-	jr nz, .asm_28c7b
+	jr nz, .do_trade
+; If we're here, the other player canceled the trade
 	hlcoord 0, 12
 	ld b, 4
 	ld c, 18
@@ -1698,11 +1707,11 @@ LinkTrade:
 	hlcoord 1, 14
 	ld de, String_TooBadTheTradeWasCanceled
 	call PlaceString
-	jp Function28ea3
+	jp InitTradeMenuDisplay_Delay
 
-.asm_28c7b
+.do_trade
 	ld hl, sPartyMail
-	ld a, [wd002]
+	ld a, [wCurTradePartyMon]
 	ld bc, MAIL_STRUCT_LENGTH
 	call AddNTimes
 	ld a, BANK(sPartyMail)
@@ -1711,20 +1720,20 @@ LinkTrade:
 	ld e, l
 	ld bc, MAIL_STRUCT_LENGTH
 	add hl, bc
-	ld a, [wd002]
+	ld a, [wCurTradePartyMon]
 	ld c, a
-.asm_28c96
+.copy_mail
 	inc c
 	ld a, c
 	cp PARTY_LENGTH
-	jr z, .asm_28ca6
+	jr z, .copy_player_data
 	push bc
 	ld bc, MAIL_STRUCT_LENGTH
 	call CopyBytes
 	pop bc
-	jr .asm_28c96
+	jr .copy_mail
 
-.asm_28ca6
+.copy_player_data
 	ld hl, sPartyMail
 	ld a, [wPartyCount]
 	dec a
@@ -1732,18 +1741,22 @@ LinkTrade:
 	call AddNTimes
 	push hl
 	ld hl, wc9f4
-	ld a, [wd003]
+	ld a, [wCurOTTradePartyMon]
 	ld bc, MAIL_STRUCT_LENGTH
 	call AddNTimes
 	pop de
 	ld bc, MAIL_STRUCT_LENGTH
 	call CopyBytes
 	call CloseSRAM
+
+; Buffer player data
+; nickname
 	ld hl, wPlayerName
 	ld de, wPlayerTrademonSenderName
 	ld bc, NAME_LENGTH
 	call CopyBytes
-	ld a, [wd002]
+; species
+	ld a, [wCurTradePartyMon]
 	ld hl, wPartySpecies
 	ld b, 0
 	ld c, a
@@ -1751,27 +1764,31 @@ LinkTrade:
 	ld a, [hl]
 	ld [wPlayerTrademonSpecies], a
 	push af
-	ld a, [wd002]
+; OT name
+	ld a, [wCurTradePartyMon]
 	ld hl, wPartyMonOT
 	call SkipNames
 	ld de, wPlayerTrademonOTName
 	ld bc, NAME_LENGTH
 	call CopyBytes
+; ID
 	ld hl, wPartyMon1ID
-	ld a, [wd002]
+	ld a, [wCurTradePartyMon]
 	call GetPartyLocation
 	ld a, [hli]
 	ld [wPlayerTrademonID], a
 	ld a, [hl]
 	ld [wPlayerTrademonID + 1], a
+; DVs
 	ld hl, wPartyMon1DVs
-	ld a, [wd002]
+	ld a, [wCurTradePartyMon]
 	call GetPartyLocation
 	ld a, [hli]
 	ld [wPlayerTrademonDVs], a
 	ld a, [hl]
 	ld [wPlayerTrademonDVs + 1], a
-	ld a, [wd002]
+; caught data
+	ld a, [wCurTradePartyMon]
 	ld hl, wPartyMon1Species
 	call GetPartyLocation
 	ld b, h
@@ -1779,38 +1796,46 @@ LinkTrade:
 	farcall GetCaughtGender
 	ld a, c
 	ld [wPlayerTrademonCaughtData], a
+
+; Buffer other player data
+; nickname
 	ld hl, wOTPlayerName
 	ld de, wOTTrademonSenderName
 	ld bc, NAME_LENGTH
 	call CopyBytes
-	ld a, [wd003]
+; species
+	ld a, [wCurOTTradePartyMon]
 	ld hl, wOTPartySpecies
 	ld b, 0
 	ld c, a
 	add hl, bc
 	ld a, [hl]
 	ld [wOTTrademonSpecies], a
-	ld a, [wd003]
+; OT name
+	ld a, [wCurOTTradePartyMon]
 	ld hl, wOTPartyMonOT
 	call SkipNames
 	ld de, wOTTrademonOTName
 	ld bc, NAME_LENGTH
 	call CopyBytes
+; ID
 	ld hl, wOTPartyMon1ID
-	ld a, [wd003]
+	ld a, [wCurOTTradePartyMon]
 	call GetPartyLocation
 	ld a, [hli]
 	ld [wOTTrademonID], a
 	ld a, [hl]
 	ld [wOTTrademonID + 1], a
+; DVs
 	ld hl, wOTPartyMon1DVs
-	ld a, [wd003]
+	ld a, [wCurOTTradePartyMon]
 	call GetPartyLocation
 	ld a, [hli]
 	ld [wOTTrademonDVs], a
 	ld a, [hl]
 	ld [wOTTrademonDVs + 1], a
-	ld a, [wd003]
+; caught data
+	ld a, [wCurOTTradePartyMon]
 	ld hl, wOTPartyMon1Species
 	call GetPartyLocation
 	ld b, h
@@ -1818,14 +1843,16 @@ LinkTrade:
 	farcall GetCaughtGender
 	ld a, c
 	ld [wOTTrademonCaughtData], a
-	ld a, [wd002]
+
+	ld a, [wCurTradePartyMon]
 	ld [wCurPartyMon], a
 	ld hl, wPartySpecies
 	ld b, 0
 	ld c, a
 	add hl, bc
 	ld a, [hl]
-	ld [wd002], a
+	ld [wCurTradePartyMon], a
+
 	xor a ; REMOVE_PARTY
 	ld [wPokemonWithdrawDepositParameter], a
 	callfar RemoveMonFromPartyOrBox
@@ -1834,14 +1861,15 @@ LinkTrade:
 	ld [wCurPartyMon], a
 	ld a, TRUE
 	ld [wForceEvolution], a
-	ld a, [wd003]
+	ld a, [wCurOTTradePartyMon]
 	push af
 	ld hl, wOTPartySpecies
 	ld b, 0
 	ld c, a
 	add hl, bc
 	ld a, [hl]
-	ld [wd003], a
+	ld [wCurOTTradePartyMon], a
+
 	ld c, 100
 	call DelayFrames
 	call ClearTilemap
@@ -1933,7 +1961,7 @@ LinkTrade:
 	ld c, 18
 	call LinkTextboxAtHL
 	hlcoord 1, 14
-	ld de, String28ebd
+	ld de, String_TradeCompleted
 	call PlaceString
 	farcall Link_WaitBGMap
 	ld c, 50
@@ -1943,12 +1971,12 @@ LinkTrade:
 	jp z, Gen2ToGen1LinkComms
 	jp Gen2ToGen2LinkComms
 
-Function28ea3:
+InitTradeMenuDisplay_Delay:
 	ld c, 100
 	call DelayFrames
 	jp InitTradeMenuDisplay
 
-String28eab:
+String_TradeCancel:
 	db   "TRADE"
 	next "CANCEL@"
 
@@ -1956,7 +1984,7 @@ LinkAskTradeForText:
 	text_far _LinkAskTradeForText
 	text_end
 
-String28ebd:
+String_TradeCompleted:
 	db   "Trade completed!@"
 
 String_TooBadTheTradeWasCanceled:
@@ -2248,7 +2276,7 @@ CheckLinkTimeout_Receptionist:
 	ld a, $1
 	ld [wPlayerLinkAction], a
 	ld hl, wLinkTimeoutFrames
-	ld a, $3
+	ld a, 3
 	ld [hli], a
 	xor a
 	ld [hl], a

engine/link/link_trade.asm

@@ -15,7 +15,7 @@ Function16d42e:
 	call CopyBytes
 	ret
 
-Function16d43b:
+Function16d43b: ; unreferenced
 	call LoadStandardMenuHeader
 	call ClearBGPalettes
 	call ClearTilemap
@@ -153,15 +153,15 @@ LinkTextbox:
 	call _LinkTextbox
 	ret
 
-Function16d6ce:
+PrintWaitingTextAndSyncAndExchangeNybble:
 	call LoadStandardMenuHeader
-	call Function16d6e1
+	call .PrintWaitingText
 	farcall WaitLinkTransfer
 	call Call_ExitMenu
 	call WaitBGMap2
 	ret
 
-Function16d6e1:
+.PrintWaitingText:
 	hlcoord 4, 10
 	ld b, 1
 	ld c, 10

engine/link/mystery_gift_2.asm

@@ -1,24 +1,24 @@
-PrepMysteryGiftDataToSend:
+StageDataForMysteryGift:
 	ld de, wMysteryGiftStaging
-	ld a, $1 + GS_VERSION
+	ld a, GS_VERSION + 1
 	ld [de], a
-	inc de ; wc801
+	inc de ; wMysteryGiftStaging+1
 	ld a, BANK(sGameData)
 	call OpenSRAM
 	ld hl, sPlayerData + wPlayerID - wPlayerData
 	ld a, [hli]
 	ld [de], a
 	ld b, a
-	inc de ; wc802
+	inc de ; wMysteryGiftStaging+2
 	ld a, [hl]
 	ld [de], a
 	ld c, a
-	inc de ; wc803
+	inc de ; wMysteryGiftStaging+3
 	push bc
 	ld hl, sPlayerData + wPlayerName - wPlayerData
 	ld bc, NAME_LENGTH
 	call CopyBytes
-	push de ; wc80e
+	push de ; wMysteryGiftStaging+14
 	ld hl, sPokemonData + wPokedexCaught - wPokemonData
 	ld b, wEndPokedexCaught - wPokedexCaught
 	call CountSetBits
@@ -26,30 +26,30 @@ PrepMysteryGiftDataToSend:
 	pop bc
 	ld a, [wNumSetBits]
 	ld [de], a
-	inc de ; wc80f
+	inc de ; wMysteryGiftStaging+15
 	call CloseSRAM
 	call Random
 	and 1
 	ld [de], a
-	inc de ; wc810
+	inc de ; wMysteryGiftStaging+16
 	call .RandomSample
 	ld [de], a
-	inc de ; wc811
+	inc de ; wMysteryGiftStaging+17
 	ld a, c
 	ld c, b
 	ld b, a
 	call .RandomSample
 	ld [de], a
-	inc de ; wc812
+	inc de ; wMysteryGiftStaging+18
 	ld a, BANK(sBackupMysteryGiftItem)
 	call OpenSRAM
 	ld a, [sBackupMysteryGiftItem]
 	ld [de], a
 	inc de
-	ld a, [sBackupMysteryGiftItem + 1]
+	ld a, [sNumDailyMysteryGiftPartnerIDs]
 	ld [de], a
-	ld a, $14
+	ld a, wMysteryGiftPlayerDataEnd - wMysteryGiftPlayerData
-	ld [wca00], a
+	ld [wUnusedMysteryGiftStagedDataLength], a
 	call CloseSRAM
 	ld hl, wMysteryGiftStaging
 	ld de, wMysteryGiftPlayerData
@@ -121,7 +121,7 @@ PrepMysteryGiftDataToSend:
 	pop de
 	ret
 
-MysteryGiftGetItemHeldEffect:
+MysteryGiftGetItem:
 	ld a, c
 	cp MysteryGiftItems.End - MysteryGiftItems
 	jr nc, MysteryGiftFallbackItem

engine/link/time_capsule.asm

@@ -1,11 +1,11 @@
 ; These functions seem to be related to backwards compatibility
 
 ValidateOTTrademon:
-	ld a, [wd003]
+	ld a, [wCurOTTradePartyMon]
 	ld hl, wOTPartyMon1Species
 	call GetPartyLocation
 	push hl
-	ld a, [wd003]
+	ld a, [wCurOTTradePartyMon]
 	inc a
 	ld c, a
 	ld b, 0
@@ -30,7 +30,7 @@ ValidateOTTrademon:
 	cp LINK_TIMECAPSULE
 	jr nz, .normal
 	ld hl, wOTPartySpecies
-	ld a, [wd003]
+	ld a, [wCurOTTradePartyMon]
 	ld c, a
 	ld b, 0
 	add hl, bc
@@ -65,11 +65,11 @@ ValidateOTTrademon:
 	ret
 
 CheckAnyOtherAliveMonsForTrade:
-	ld a, [wd002]
+	ld a, [wCurTradePartyMon]
 	ld d, a
 	ld a, [wPartyCount]
 	ld b, a
-	ld c, $0
+	ld c, 0
 .loop
 	ld a, c
 	cp d
@@ -87,7 +87,7 @@ CheckAnyOtherAliveMonsForTrade:
 	inc c
 	dec b
 	jr nz, .loop
-	ld a, [wd003]
+	ld a, [wCurOTTradePartyMon]
 	ld hl, wOTPartyMon1HP
 	call GetPartyLocation
 	ld a, [hli]