Merge pull request #409 from roukaour/master

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

9 files changed, 50 insertions, 45 deletions

diff --git a/event/celebi.asm b/event/celebi.asm
index 7c8646ec7..c9be9cb39 100755
--- a/event/celebi.asm
+++ b/event/celebi.asm
@@ -6,14 +6,14 @@ Special_CelebiShrineEvent: ; 4989a
 	ld [VramState], a
 	call LoadCelebiGFX
 	depixel 0, 10, 7, 0
-	ld a, SPRITE_ANIM_INDEX_2C
+	ld a, SPRITE_ANIM_INDEX_CELEBI
 	call _InitSpriteAnimStruct
 	ld hl, SPRITEANIMSTRUCT_TILE_ID
 	add hl, bc
 	ld [hl], $84
 	ld hl, SPRITEANIMSTRUCT_ANIM_SEQ_ID
 	add hl, bc
-	ld [hl], SPRITE_ANIM_SEQ_1F
+	ld [hl], SPRITE_ANIM_SEQ_CELEBI
 	ld hl, SPRITEANIMSTRUCT_0F
 	add hl, bc
 	ld a, $80
diff --git a/event/elevator.asm b/event/elevator.asm
index 7626989b3..9170b642d 100755
--- a/event/elevator.asm
+++ b/event/elevator.asm
@@ -21,9 +21,9 @@ Elevator:: ; 1342d
 	ld a, b
 	ld [wElevatorPointerBank], a
 	ld a, e
-	ld [wElevatorPointerLo], a
+	ld [wElevatorPointer], a
 	ld a, d
-	ld [wElevatorPointerHi], a
+	ld [wElevatorPointer + 1], a
 	call .LoadFloors
 	ret
 ; 1345a
@@ -31,7 +31,7 @@ Elevator:: ; 1342d
 .LoadFloors: ; 1345a
 	ld de, CurElevator
 	ld bc, 4
-	ld hl, wElevatorPointerLo
+	ld hl, wElevatorPointer
 	ld a, [hli]
 	ld h, [hl]
 	ld l, a
@@ -52,7 +52,7 @@ Elevator:: ; 1342d
 ; 1347d
 
 .FindCurrentFloor: ; 1347d
-	ld hl, wElevatorPointerLo
+	ld hl, wElevatorPointer
 	ld a, [hli]
 	ld h, [hl]
 	ld l, a
@@ -102,7 +102,7 @@ Elevator:: ; 1342d
 
 Elevator_GoToFloor: ; 134c0
 	push af
-	ld hl, wElevatorPointerLo
+	ld hl, wElevatorPointer
 	ld a, [hli]
 	ld h, [hl]
 	ld l, a
diff --git a/event/field_moves.asm b/event/field_moves.asm
index 82bc6d3f8..2869f9be9 100755
--- a/event/field_moves.asm
+++ b/event/field_moves.asm
@@ -30,7 +30,7 @@ ShakeHeadbuttTree: ; 8c80a
 	lb bc, BANK(HeadbuttTreeGFX), 8
 	call Request2bpp
 	call Cut_Headbutt_GetPixelFacing
-	ld a, SPRITE_ANIM_INDEX_1B
+	ld a, SPRITE_ANIM_INDEX_HEADBUTT
 	call _InitSpriteAnimStruct
 	ld hl, SPRITEANIMSTRUCT_TILE_ID
 	add hl, bc
@@ -75,7 +75,7 @@ ShakeHeadbuttTree: ; 8c80a
 ; 8c893
 
 HeadbuttTreeGFX: ; 8c893
-INCBIN "gfx/overworld/headbutt_tree.2bpp"
+INCBIN "gfx/ow_fx/headbutt_tree.2bpp"
 ; 8c913
 
 HideHeadbuttTree: ; 8c913
@@ -152,11 +152,11 @@ OWCutAnimation: ; 8c940
 ; 8c98c
 
 CutTreeGFX: ; c898c
-INCBIN "gfx/misc/cut_tree.2bpp"
+INCBIN "gfx/ow_fx/cut_tree.2bpp"
 ; c89cc
 
 CutGrassGFX: ; 8c9cc
-INCBIN "gfx/misc/cut_grass.2bpp"
+INCBIN "gfx/ow_fx/cut_grass.2bpp"
 ; 8ca0c
 
 OWCutJumptable: ; 8ca0c
diff --git a/event/halloffame.asm b/event/halloffame.asm
index 8d542addb..4f37200a4 100755
--- a/event/halloffame.asm
+++ b/event/halloffame.asm
@@ -1,3 +1,5 @@
+HALLOFFAME_COLON EQU $63
+
 HallOfFame:: ; 0x8640e
 	call HallOfFame_FadeOutMusic
 	ld a, [StatusFlags]
@@ -35,9 +37,9 @@ HallOfFame:: ; 0x8640e
 
 RedCredits:: ; 86455
 	ld a, MUSIC_NONE % $100
-	ld [MusicFadeIDLo], a
+	ld [MusicFadeID], a
 	ld a, MUSIC_NONE / $100
-	ld [MusicFadeIDHi], a
+	ld [MusicFadeID + 1], a
 	ld a, 10
 	ld [MusicFade], a
 	callba FadeOutPalettes
@@ -58,9 +60,9 @@ RedCredits:: ; 86455
 
 HallOfFame_FadeOutMusic: ; 8648e
 	ld a, MUSIC_NONE % $100
-	ld [MusicFadeIDLo], a
+	ld [MusicFadeID], a
 	ld a, MUSIC_NONE / $100
-	ld [MusicFadeIDHi], a
+	ld [MusicFadeID + 1], a
 	ld a, 10
 	ld [MusicFade], a
 	callba FadeOutPalettes
@@ -487,7 +489,7 @@ DisplayHOFMon: ; 86748
 	hlcoord 1, 13
 	ld a, "№"
 	ld [hli], a
-	ld [hl], "·"
+	ld [hl], "<DOT>"
 	hlcoord 3, 13
 	ld de, wd265
 	lb bc, PRINTNUM_LEADINGZEROS | 1, 3
@@ -531,8 +533,8 @@ DisplayHOFMon: ; 86748
 
 HOF_AnimatePlayerPic: ; 86810
 	call ClearBGPalettes
-	ld hl, VTiles2 tile $63
-	ld de, FontExtra + 13 tiles
+	ld hl, VTiles2 tile HALLOFFAME_COLON
+	ld de, FontExtra + 13 tiles ; "<COLON>"
 	lb bc, BANK(FontExtra), 1
 	call Request2bpp
 	hlcoord 0, 0
@@ -604,7 +606,7 @@ HOF_AnimatePlayerPic: ; 86810
 	ld de, GameTimeHours
 	lb bc, 2, 3
 	call PrintNum
-	ld [hl], 99
+	ld [hl], HALLOFFAME_COLON
 	inc hl
 	ld de, GameTimeMinutes
 	lb bc, PRINTNUM_LEADINGZEROS | 1, 2
diff --git a/event/magikarp.asm b/event/magikarp.asm
index f926196cd..e18d087dd 100644
--- a/event/magikarp.asm
+++ b/event/magikarp.asm
@@ -33,14 +33,14 @@ Special_CheckMagikarpLength: ; fbb32
 	call PrintText
 
 	; Did we beat the record?
-	ld hl, Buffer1
+	ld hl, wMagikarpLength
 	ld de, wBestMagikarpLengthFeet
 	ld c, 2
 	call StringCmp
 	jr nc, .not_long_enough
 
 	; NEW RECORD!!! Let's save that.
-	ld hl, Buffer1
+	ld hl, wMagikarpLength
 	ld de, wBestMagikarpLengthFeet
 	ld a, [hli]
 	ld [de], a
@@ -79,7 +79,7 @@ Special_CheckMagikarpLength: ; fbb32
 ; 0xfbbae
 
 Magikarp_LoadFeetInchesChars: ; fbbae
-	ld hl, VTiles2 tile "′"
+	ld hl, VTiles2 tile "′" ; $6e
 	ld de, .feetinchchars
 	lb bc, BANK(.feetinchchars), 2
 	call Request2bpp
@@ -87,18 +87,18 @@ Magikarp_LoadFeetInchesChars: ; fbbae
 ; fbbbb
 
 .feetinchchars ; fbbb
-INCBIN "gfx/unknown/0fbbbb.2bpp"
+INCBIN "gfx/font/feet_inches.2bpp"
 ; fbbdb
 
 PrintMagikarpLength: ; fbbdb
 	call Magikarp_LoadFeetInchesChars
 	ld hl, StringBuffer1
-	ld de, Buffer1
+	ld de, wMagikarpLength
 	lb bc, PRINTNUM_RIGHTALIGN | 1, 2
 	call PrintNum
 	ld [hl], "′"
 	inc hl
-	ld de, Buffer2
+	ld de, wMagikarpLength + 1
 	lb bc, PRINTNUM_RIGHTALIGN | 1, 2
 	call PrintNum
 	ld [hl], "″"
@@ -108,7 +108,7 @@ PrintMagikarpLength: ; fbbdb
 ; fbbfc
 
 CalcMagikarpLength: ; fbbfc
-; Return Magikarp's length (in mm) at MagikarpLength (big endian).
+; Return Magikarp's length (in mm) at wMagikarpLength (big endian).
 ;
 ; input:
 ;   de: EnemyMonDVs
@@ -125,9 +125,9 @@ CalcMagikarpLength: ; fbbfc
 
 ; bc = rrc(dv[0]) ++ rrc(dv[1]) ^ rrc(id)
 
-; if bc < 10:    [MagikarpLength] = c + 190
-; if bc ≥ $ff00: [MagikarpLength] = c + 1370
-; else:          [MagikarpLength] = z × 100 + (bc − x) / y
+; if bc < 10:    [wMagikarpLength] = c + 190
+; if bc ≥ $ff00: [wMagikarpLength] = c + 1370
+; else:          [wMagikarpLength] = z × 100 + (bc − x) / y
 
 ; X, Y, and Z depend on the value of b as follows:
 
@@ -274,7 +274,7 @@ CalcMagikarpLength: ; fbbfc
 .ok
 	ld e, a
 
-	ld hl, MagikarpLength
+	ld hl, wMagikarpLength
 	ld [hl], d
 	inc hl
 	ld [hl], e
@@ -326,9 +326,9 @@ CalcMagikarpLength: ; fbbfc
 
 Special_MagikarpHouseSign: ; fbcd2
 	ld a, [wBestMagikarpLengthFeet]
-	ld [Buffer1], a
+	ld [wMagikarpLength], a
 	ld a, [wBestMagikarpLengthInches]
-	ld [Buffer2], a
+	ld [wMagikarpLength + 1], a
 	call PrintMagikarpLength
 	ld hl, .CurrentRecordtext
 	call PrintText
diff --git a/event/magnet_train.asm b/event/magnet_train.asm
index 75bd12cd7..c6c6da846 100755
--- a/event/magnet_train.asm
+++ b/event/magnet_train.asm
@@ -323,7 +323,7 @@ MagnetTrain_Jumptable: ; 8cdf7
 	ld d, 10 * 8 + 5
 	ld a, [wMagnetTrainPlayerSpriteInitX]
 	ld e, a
-	ld b, SPRITE_ANIM_INDEX_15
+	ld b, SPRITE_ANIM_INDEX_MAGNET_TRAIN_RED
 	ld a, [rSVBK]
 	push af
 	ld a, $1
@@ -331,7 +331,7 @@ MagnetTrain_Jumptable: ; 8cdf7
 	ld a, [PlayerGender]
 	bit 0, a
 	jr z, .got_gender
-	ld b, SPRITE_ANIM_INDEX_1F
+	ld b, SPRITE_ANIM_INDEX_MAGNET_TRAIN_BLUE
 
 .got_gender
 	pop af
diff --git a/event/mom_phone.asm b/event/mom_phone.asm
index f689745f1..818010091 100755
--- a/event/mom_phone.asm
+++ b/event/mom_phone.asm
@@ -1,3 +1,7 @@
+const_value = 1
+	const MOM_ITEM
+	const MOM_DOLL
+
 MomTriesToBuySomething:: ; fcfec
 	ld a, [wMapReentryScriptQueueFlag]
 	and a
@@ -215,7 +219,6 @@ momitem: macro
 	db \3, \4
 ENDM
 
-
 MomItems_1: ; fd136
 	momitem      0,   600, MOM_ITEM, SUPER_POTION
 	momitem      0,    90, MOM_ITEM, ANTIDOTE
diff --git a/event/overworld.asm b/event/overworld.asm
index 156ef389f..4d67bf61e 100755
--- a/event/overworld.asm
+++ b/event/overworld.asm
@@ -77,9 +77,9 @@ CheckPartyMove: ; c742
 	ld a, [hl]
 	and a
 	jr z, .no
-	cp a, -1
+	cp -1
 	jr z, .no
-	cp a, EGG
+	cp EGG
 	jr z, .next
 
 	ld bc, PARTYMON_STRUCT_LENGTH
@@ -432,7 +432,7 @@ SurfFunction: ; c909
 
 .DoSurf: ; c95f (3:495f)
 	call GetSurfType
-	ld [Buffer2], a ; wd1eb (aliases: MovementType)
+	ld [Buffer2], a
 	call GetPartyNick
 	ld hl, SurfFromMenuScript
 	call QueueScript
@@ -510,7 +510,7 @@ CheckDirection: ; c9cb
 
 ; Get player direction
 	ld a, [PlayerDirection]
-	and a, %00001100 ; bits 2 and 3 contain direction
+	and %00001100 ; bits 2 and 3 contain direction
 	rrca
 	rrca
 	ld e, a
@@ -569,7 +569,7 @@ TrySurfOW:: ; c9e7
 	jr nz, .quit
 
 	call GetSurfType
-	ld [MovementType], a
+	ld [Buffer2], a
 	call GetPartyNick
 
 	ld a, BANK(AskSurfScript)
@@ -632,7 +632,7 @@ FlyFunction: ; ca3b
 	cp NUM_SPAWNS
 	jr nc, .illegal
 
-	ld [wd001], a
+	ld [DefaultSpawnpoint], a
 	call CloseWindow
 	ld a, $1
 	ret
@@ -837,7 +837,7 @@ dig_incave
 	ret
 
 .incave
-	ld hl, wDigWarp
+	ld hl, wDigWarpNumber
 	ld a, [hli]
 	and a
 	jr z, .fail
@@ -851,7 +851,7 @@ dig_incave
 	ret
 
 .DoDig: ; cbd8
-	ld hl, wDigWarp
+	ld hl, wDigWarpNumber
 	ld de, wNextWarp
 	ld bc, 3
 	call CopyBytes
@@ -962,7 +962,7 @@ TeleportFunction: ; cc61
 	callba IsSpawnPoint
 	jr nc, .nope
 	ld a, c
-	ld [wd001], a
+	ld [DefaultSpawnpoint], a
 	ld a, $1
 	ret
 
diff --git a/event/whiteout.asm b/event/whiteout.asm
index 38049b3b5..159f3a519 100755
--- a/event/whiteout.asm
+++ b/event/whiteout.asm
@@ -77,6 +77,6 @@ GetWhiteoutSpawn: ; 12527
 	xor a ; SPAWN_HOME
 
 .yes
-	ld [wd001], a
+	ld [DefaultSpawnpoint], a
 	ret
 ; 1253d