Merge pull request #409 from roukaour/master

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

10 files changed, 37 insertions, 36 deletions

diff --git a/misc/battle_tower_5c.asm b/misc/battle_tower_5c.asm
index 54948591c..462e4f75a 100755
--- a/misc/battle_tower_5c.asm
+++ b/misc/battle_tower_5c.asm
@@ -1361,7 +1361,7 @@ BattleTowerAction_EggTicket: ; 17093c (5c:493c) BattleTowerAction $0e
 	cp EGG
 	jr nz, .not_egg
 	push hl
-	ld hl, PartyMonOT ; wddff (aliases: PartyMonOT)
+	ld hl, PartyMonOT
 	ld de, $6 ; NAME_LENGTH
 	ld a, b
 	and a
diff --git a/misc/fixed_words.asm b/misc/fixed_words.asm
index 8d1f73c28..56e53da91 100755
--- a/misc/fixed_words.asm
+++ b/misc/fixed_words.asm
@@ -3416,6 +3416,7 @@ MobileEZChatCategoryNames: ; 11da52
 ; 11daac
 
 MobileEZChatCategoryPointers: ; 11daac
+; entries correspond to EZCHAT_* constants
 	dw .Types          ; 01
 	dw .Greetings      ; 02
 	dw .People         ; 03
diff --git a/misc/gfx_41.asm b/misc/gfx_41.asm
index 952742ec1..8f128a7bd 100755
--- a/misc/gfx_41.asm
+++ b/misc/gfx_41.asm
@@ -632,7 +632,7 @@ HeartEmote:     INCBIN "gfx/emotes/heart.2bpp"
 BoltEmote:      INCBIN "gfx/emotes/bolt.2bpp"
 SleepEmote:     INCBIN "gfx/emotes/sleep.2bpp"
 FishEmote:      INCBIN "gfx/emotes/fish.2bpp"
-JumpShadowGFX:  INCBIN "gfx/misc/shadow.2bpp"
-FishingRodGFX2: INCBIN "gfx/misc/fishing2.2bpp"
-BoulderDustGFX: INCBIN "gfx/misc/boulderdust.2bpp"
-FishingRodGFX4: INCBIN "gfx/misc/fishing4.2bpp"
+JumpShadowGFX:  INCBIN "gfx/ow_fx/shadow.2bpp"
+FishingRodGFX:  INCBIN "gfx/ow_fx/fishing_rod.2bpp"
+BoulderDustGFX: INCBIN "gfx/ow_fx/boulder_dust.2bpp"
+GrassRustleGFX: INCBIN "gfx/ow_fx/grass_rustle.2bpp"
diff --git a/misc/mobile_12.asm b/misc/mobile_12.asm
index 69a5551a7..ea1e25bb8 100755
--- a/misc/mobile_12.asm
+++ b/misc/mobile_12.asm
@@ -40,9 +40,9 @@ InitMobileProfile: ; 4802f (12:402f)
 	ld a, $5
 	ld [MusicFade], a
 	ld a, MUSIC_MOBILE_ADAPTER_MENU % $100
-	ld [MusicFadeIDLo], a
+	ld [MusicFadeID], a
 	ld a, MUSIC_MOBILE_ADAPTER_MENU / $100
-	ld [MusicFadeIDHi], a
+	ld [MusicFadeID + 1], a
 	ld c, 20
 	call DelayFrames
 	ld b, $1
diff --git a/misc/mobile_40.asm b/misc/mobile_40.asm
index 8cd0311f0..fa6a39fdf 100644
--- a/misc/mobile_40.asm
+++ b/misc/mobile_40.asm
@@ -1804,14 +1804,14 @@ Function100b12: ; 100b12
 	call FarCall_de
 	ld a, BANK(BattleMenuDataHeader)
 	ld [wMenuData2_2DMenuItemStringsBank], a
-	ld a, [wd0d2]
+	ld a, [wBattleMenuCursorBuffer]
 	ld [wMenuCursorBuffer], a
 	call Function100e72
 	call Function100b45
 	callba InitPartyMenuBGPal7
 	call Function100ed4
 	ld a, [wMenuCursorBuffer]
-	ld [wd0d2], a
+	ld [wBattleMenuCursorBuffer], a
 	call ExitMenu
 	ret
 ; 100b45
@@ -5410,7 +5410,7 @@ Function1023c6: ; 1023c6
 	dec a
 	ld [CurPartyMon], a
 	xor a
-	ld [wd10b], a
+	ld [wPokemonWithdrawDepositParameter], a
 	callba RemoveMonFromPartyOrBox
 	ld hl, PartyCount
 	inc [hl]
diff --git a/misc/mobile_42.asm b/misc/mobile_42.asm
index d08bc8882..77cf9ac54 100644
--- a/misc/mobile_42.asm
+++ b/misc/mobile_42.asm
@@ -83,7 +83,7 @@ Function10804d: ; 10804d
 	mobiletradeanim_end
 
 RunMobileTradeAnim_Frontpics: ; 10805b
-	ld hl, wTradeAnimPointer
+	ld hl, wTradeAnimAddress
 	ld [hl], e
 	inc hl
 	ld [hl], d
@@ -113,7 +113,7 @@ RunMobileTradeAnim_Frontpics: ; 10805b
 ; 108089
 
 RunMobileTradeAnim_NoFrontpics: ; 108089
-	ld hl, wTradeAnimPointer
+	ld hl, wTradeAnimAddress
 	ld [hl], e
 	inc hl
 	ld [hl], d
@@ -411,7 +411,7 @@ MobileTradeAnim_Next: ; 1082b2
 ; 1082b7
 
 GetMobileTradeAnimByte: ; 1082b7
-	ld hl, wTradeAnimPointer
+	ld hl, wTradeAnimAddress
 	ld e, [hl]
 	inc hl
 	ld d, [hl]
@@ -1313,7 +1313,7 @@ MobileTradeAnim_DisplayEggData
 .EggTemplate: ; 108a1d
 	db   "タマゴ"
 	next "おや/?????"
-	next "<ID>№·?????"
+	next "<ID>№<DOT>?????"
 	db   "@"
 ; 108a33
 
@@ -1353,10 +1353,10 @@ MobileTradeAnim_LoadMonTemplate: ; 108a5b
 ; 108a79
 
 .MonTemplate: ; 108a79
-	db   "─ №·"
+	db   "─ №<DOT>"
 	next ""
 	next "おや/"
-	next "<ID>№·"
+	next "<ID>№<DOT>"
 	db   "@"
 ; 108a87
 
diff --git a/misc/mobile_45_sprite_engine.asm b/misc/mobile_45_sprite_engine.asm
index 57c45e43c..a85e7fce4 100755
--- a/misc/mobile_45_sprite_engine.asm
+++ b/misc/mobile_45_sprite_engine.asm
@@ -496,9 +496,9 @@ Function1161d5: ; 1161d5
 	ld [MusicFade], a
 	ld de, MUSIC_MOBILE_ADAPTER
 	ld a, e
-	ld [MusicFadeIDLo], a
+	ld [MusicFadeID], a
 	ld a, d
-	ld [MusicFadeIDHi], a
+	ld [MusicFadeID + 1], a
 	ld a, [$c319]
 	inc a
 	ld [$c319], a
@@ -680,9 +680,9 @@ Function11636e: ; 11636e
 	ld a, $8
 	ld [MusicFade], a
 	ld a, [wMapMusic]
-	ld [MusicFadeIDLo], a
+	ld [MusicFadeID], a
 	xor a
-	ld [MusicFadeIDHi], a
+	ld [MusicFadeID + 1], a
 	xor a
 	ld [$c319], a
 	ld [wc30d], a
@@ -728,18 +728,18 @@ Function1163c0: ; 1163c0
 	ld a, $8
 	ld [MusicFade], a
 	ld a, [wMapMusic]
-	ld [MusicFadeIDLo], a
+	ld [MusicFadeID], a
 	xor a
-	ld [MusicFadeIDHi], a
+	ld [MusicFadeID + 1], a
 	jr .asm_116439
 
 .asm_11642a
 	ld a, $8
 	ld [MusicFade], a
 	ld a, $0
-	ld [MusicFadeIDLo], a
+	ld [MusicFadeID], a
 	ld a, $0
-	ld [MusicFadeIDHi], a
+	ld [MusicFadeID + 1], a
 
 .asm_116439
 	xor a
@@ -757,9 +757,9 @@ Function116441: ; 116441
 	ld a, $8
 	ld [MusicFade], a
 	ld a, [wMapMusic]
-	ld [MusicFadeIDLo], a
+	ld [MusicFadeID], a
 	xor a
-	ld [MusicFadeIDHi], a
+	ld [MusicFadeID + 1], a
 	xor a
 	ld [$c319], a
 	ld [wc30d], a
diff --git a/misc/mobile_5f.asm b/misc/mobile_5f.asm
index 061b1357f..816e23394 100644
--- a/misc/mobile_5f.asm
+++ b/misc/mobile_5f.asm
@@ -559,9 +559,9 @@ Function17d2ce: ; 17d2ce
 	ld de, MUSIC_MOBILE_CENTER
 	ld a, e
 	ld [wMapMusic], a
-	ld [MusicFadeIDLo], a
+	ld [MusicFadeID], a
 	ld a, d
-	ld [MusicFadeIDHi], a
+	ld [MusicFadeID + 1], a
 	call PlayMusic
 	call ReturnToMapFromSubmenu
 	call CloseSubmenu
@@ -4728,9 +4728,9 @@ Function17f5e4: ; 17f5e4
 	ld [MusicFade], a
 	ld de, MUSIC_NONE
 	ld a, e
-	ld [MusicFadeIDLo], a
+	ld [MusicFadeID], a
 	ld a, d
-	ld [MusicFadeIDHi], a
+	ld [MusicFadeID + 1], a
 	ld a, " "
 	hlcoord 0, 0
 	ld bc, SCREEN_WIDTH * SCREEN_HEIGHT
@@ -5274,9 +5274,9 @@ Function17ff23: ; 17ff23
 	ld a, $8
 	ld [MusicFade], a
 	ld a, [wMapMusic]
-	ld [MusicFadeIDLo], a
+	ld [MusicFadeID], a
 	xor a
-	ld [MusicFadeIDHi], a
+	ld [MusicFadeID + 1], a
 	ld hl, wc303
 	set 7, [hl]
 	ret
diff --git a/misc/mobile_menu.asm b/misc/mobile_menu.asm
index 518ad9a25..1bee0cced 100755
--- a/misc/mobile_menu.asm
+++ b/misc/mobile_menu.asm
@@ -856,9 +856,9 @@ Function4a6c5: ; 4a6c5 (12:66c5)
 	ld a, $5
 	ld [MusicFade], a
 	ld a, e
-	ld [MusicFadeIDLo], a
+	ld [MusicFadeID], a
 	ld a, d
-	ld [MusicFadeIDHi], a
+	ld [MusicFadeID + 1], a
 	ld c, 22
 	call DelayFrames
 	ret
diff --git a/misc/printer_77.asm b/misc/printer_77.asm
index c36c21463..4f67909b0 100755
--- a/misc/printer_77.asm
+++ b/misc/printer_77.asm
@@ -150,9 +150,9 @@ PrintPartyMonPage1: ; 1dc381
 	lb bc, BANK(MobileLvIcon), 1
 	call Request1bpp
 
-	ld de, ShinyIcon
+	ld de, ShinyIconGFX
 	ld hl, VTiles2 tile $3f
-	lb bc, BANK(ShinyIcon), 1
+	lb bc, BANK(ShinyIconGFX), 1
 	call Get2bpp
 
 	xor a