Merge pull request #776 from Rangi42/unreferenced

Comment, remove, or revise many unreferenced labels

8 files changed, 98 insertions, 95 deletions

diff --git a/engine/gfx/cgb_layouts.asm b/engine/gfx/cgb_layouts.asm
index cd6f16cdb..66aeca079 100644
--- a/engine/gfx/cgb_layouts.asm
+++ b/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
-
-.ReturnFromJumpTable:
+.done:
 	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
diff --git a/engine/gfx/color.asm b/engine/gfx/color.asm
index 76c2dc504..9f42d24f6 100644
--- a/engine/gfx/color.asm
+++ b/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
-	ld [wcfbe], a
+	set JOYPAD_DISABLE_SGB_TRANSFER_F, 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
-	ld [wcfbe], a
+	set JOYPAD_DISABLE_SGB_TRANSFER_F, 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"
-
-SGBBorderPalettes:
-; assumed to come after SGBBorderMap
+; four SGB palettes of 16 colors each; only the first 4 colors are used
 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:
diff --git a/engine/gfx/crystal_layouts.asm b/engine/gfx/crystal_layouts.asm
index 9c47797d1..1d3cca3ed 100644
--- a/engine/gfx/crystal_layouts.asm
+++ b/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
-	dw MG_Mobile_Layout00
-	dw MG_Mobile_Layout01
-	dw MG_Mobile_Layout02
+.Jumptable:
+	dw _CrystalCGB_MobileLayout0
+	dw _CrystalCGB_MobileLayout1
+	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
-
-.asm_49467
+.done
 	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:
-	ld hl, .Palette_49732
+_CrystalCGB_NameCard:
+	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
diff --git a/engine/gfx/load_pics.asm b/engine/gfx/load_pics.asm
index a8dc82892..98dbdc17b 100644
--- a/engine/gfx/load_pics.asm
+++ b/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
diff --git a/engine/gfx/pic_animation.asm b/engine/gfx/pic_animation.asm
index f2a59b75a..90bb06620 100644
--- a/engine/gfx/pic_animation.asm
+++ b/engine/gfx/pic_animation.asm
@@ -648,7 +648,7 @@ PokeAnim_ConvertAndApplyBitmask:
 .skip2
 	ret
 
-; unused
+.UnusedSizeData: ; unreferenced
 	db 6, 5, 4
 
 .GetTilemap:
diff --git a/engine/gfx/player_gfx.asm b/engine/gfx/player_gfx.asm
index 9a395e048..149c0ef4a 100644
--- a/engine/gfx/player_gfx.asm
+++ b/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:
diff --git a/engine/gfx/sgb_layouts.asm b/engine/gfx/sgb_layouts.asm
index bfdaeb098..1e5055f26 100644
--- a/engine/gfx/sgb_layouts.asm
+++ b/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
diff --git a/engine/gfx/sprite_anims.asm b/engine/gfx/sprite_anims.asm
index 53fe6b882..0c2c42bcb 100644
--- a/engine/gfx/sprite_anims.asm
+++ b/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