Merge branch 'master' of https://github.com/pret/pokered

6 files changed, 24 insertions, 18 deletions

diff --git a/engine/events/starter_dex.asm b/engine/events/starter_dex.asm
index 7cfe9af2..9640a40e 100644
--- a/engine/events/starter_dex.asm
+++ b/engine/events/starter_dex.asm
@@ -1,4 +1,4 @@
-; this function temporarily makes the starters (and Ivysaur) seen
+; this function temporarily makes the starters (and Ivysaur) owned
 ; so that the full Pokedex information gets displayed in Oak's lab
 StarterDex:
 	ld a, 1 << (DEX_BULBASAUR - 1) | 1 << (DEX_IVYSAUR - 1) | 1 << (DEX_CHARMANDER - 1) | 1 << (DEX_SQUIRTLE - 1)
diff --git a/engine/gfx/oam_dma.asm b/engine/gfx/oam_dma.asm
index 11e52694..725c3dca 100644
--- a/engine/gfx/oam_dma.asm
+++ b/engine/gfx/oam_dma.asm
@@ -2,7 +2,7 @@ WriteDMACodeToHRAM::
 ; Since no other memory is available during OAM DMA,
 ; DMARoutine is copied to HRAM and executed there.
 	ld c, LOW(hDMARoutine)
-	ld b, DMARoutineEnd - DMARoutine
+	ld b, DMARoutine.End - DMARoutine
 	ld hl, DMARoutine
 .copy
 	ld a, [hli]
@@ -25,4 +25,4 @@ hDMARoutine::
 	jr nz, .wait
 	ret
 ENDL
-DMARoutineEnd:
+.End:
diff --git a/engine/items/item_effects.asm b/engine/items/item_effects.asm
index 2ce6587e..5e502cfa 100644
--- a/engine/items/item_effects.asm
+++ b/engine/items/item_effects.asm
@@ -23,7 +23,7 @@ ItemUsePtrTable:
 	dw ItemUseBall       ; POKE_BALL
 	dw ItemUseTownMap    ; TOWN_MAP
 	dw ItemUseBicycle    ; BICYCLE
-	dw ItemUseSurfboard  ; out-of-battle Surf effect
+	dw ItemUseSurfboard  ; SURFBOARD
 	dw ItemUseBall       ; SAFARI_BALL
 	dw ItemUsePokedex    ; POKEDEX
 	dw ItemUseEvoStone   ; MOON_STONE
@@ -60,19 +60,19 @@ ItemUsePtrTable:
 	dw UnusableItem      ; DOME_FOSSIL
 	dw UnusableItem      ; HELIX_FOSSIL
 	dw UnusableItem      ; SECRET_KEY
-	dw UnusableItem
+	dw UnusableItem      ; ITEM_2C
 	dw UnusableItem      ; BIKE_VOUCHER
 	dw ItemUseXAccuracy  ; X_ACCURACY
 	dw ItemUseEvoStone   ; LEAF_STONE
 	dw ItemUseCardKey    ; CARD_KEY
 	dw UnusableItem      ; NUGGET
-	dw UnusableItem      ; ??? PP_UP
-	dw ItemUsePokedoll   ; POKE_DOLL
+	dw UnusableItem      ; ITEM_32
+	dw ItemUsePokeDoll   ; POKE_DOLL
 	dw ItemUseMedicine   ; FULL_HEAL
 	dw ItemUseMedicine   ; REVIVE
 	dw ItemUseMedicine   ; MAX_REVIVE
 	dw ItemUseGuardSpec  ; GUARD_SPEC
-	dw ItemUseSuperRepel ; SUPER_REPL
+	dw ItemUseSuperRepel ; SUPER_REPEL
 	dw ItemUseMaxRepel   ; MAX_REPEL
 	dw ItemUseDireHit    ; DIRE_HIT
 	dw UnusableItem      ; COIN
@@ -89,13 +89,13 @@ ItemUsePtrTable:
 	dw ItemUseOaksParcel ; OAKS_PARCEL
 	dw ItemUseItemfinder ; ITEMFINDER
 	dw UnusableItem      ; SILPH_SCOPE
-	dw ItemUsePokeflute  ; POKE_FLUTE
+	dw ItemUsePokeFlute  ; POKE_FLUTE
 	dw UnusableItem      ; LIFT_KEY
 	dw UnusableItem      ; EXP_ALL
 	dw ItemUseOldRod     ; OLD_ROD
 	dw ItemUseGoodRod    ; GOOD_ROD
 	dw ItemUseSuperRod   ; SUPER_ROD
-	dw ItemUsePPUp       ; PP_UP (real one)
+	dw ItemUsePPUp       ; PP_UP
 	dw ItemUsePPRestore  ; ETHER
 	dw ItemUsePPRestore  ; MAX_ETHER
 	dw ItemUsePPRestore  ; ELIXER
@@ -696,7 +696,7 @@ ItemUseBicycle:
 	ld [wWalkBikeSurfState], a
 	ret
 
-; used for Surf out-of-battle effect
+; indirectly used by SURF in StartMenu_Pokemon.surf
 ItemUseSurfboard:
 	ld a, [wWalkBikeSurfState]
 	ld [wWalkBikeSurfStateCopy], a
@@ -1565,6 +1565,9 @@ VitaminNoEffectText:
 
 INCLUDE "data/battle/stat_names.asm"
 
+; for BOULDERBADGE when used from the
+; ITEM window, which corresponds to
+; SAFARI_BAIT during Safari Game encounters
 ItemUseBait:
 	ld hl, ThrewBaitText
 	call PrintText
@@ -1575,6 +1578,9 @@ ItemUseBait:
 	ld de, wSafariEscapeFactor ; escape factor
 	jr BaitRockCommon
 
+; for CASCADEBADGE when used from the
+; ITEM window, which corresponds to
+; SAFARI_ROCK during Safari Game encounters
 ItemUseRock:
 	ld hl, ThrewRockText
 	call PrintText
@@ -1620,7 +1626,7 @@ ThrewRockText:
 	text_far _ThrewRockText
 	text_end
 
-; also used for Dig out-of-battle effect
+; indirectly used by DIG in StartMenu_Pokemon.dig
 ItemUseEscapeRope:
 	ld a, [wIsInBattle]
 	and a
@@ -1746,7 +1752,7 @@ ItemUseCardKey:
 
 INCLUDE "data/events/card_key_coords.asm"
 
-ItemUsePokedoll:
+ItemUsePokeDoll:
 	ld a, [wIsInBattle]
 	dec a
 	jp nz, ItemUseNotTime
@@ -1839,7 +1845,7 @@ ItemUseXStat:
 	ld [hl], a ; restore [wPlayerMoveNum]
 	ret
 
-ItemUsePokeflute:
+ItemUsePokeFlute:
 	ld a, [wIsInBattle]
 	and a
 	jr nz, .inBattle
diff --git a/engine/menus/save.asm b/engine/menus/save.asm
index b7ad5d66..fb7526b3 100644
--- a/engine/menus/save.asm
+++ b/engine/menus/save.asm
@@ -666,8 +666,8 @@ ClearSAV:
 
 PadSRAM_FF:
 	ld [MBC1SRamBank], a
-	ld hl, SRAM_Begin
-	ld bc, SRAM_End - SRAM_Begin
+	ld hl, STARTOF(SRAM)
+	ld bc, SIZEOF(SRAM)
 	ld a, $ff
 	jp FillMemory
 
diff --git a/engine/movie/oak_speech/oak_speech2.asm b/engine/movie/oak_speech/oak_speech2.asm
index 65d02d18..cf657a7f 100644
--- a/engine/movie/oak_speech/oak_speech2.asm
+++ b/engine/movie/oak_speech/oak_speech2.asm
@@ -54,7 +54,7 @@ ChooseRivalName:
 	call ClearScreen
 	call Delay3
 	ld de, Rival1Pic
-	ld b, $13
+	ld b, BANK(Rival1Pic)
 	call IntroDisplayPicCenteredOrUpperRight
 .done
 	ld hl, HisNameIsText
diff --git a/engine/overworld/special_warps.asm b/engine/overworld/special_warps.asm
index c538938b..0cc2a474 100644
--- a/engine/overworld/special_warps.asm
+++ b/engine/overworld/special_warps.asm
@@ -14,7 +14,7 @@ PrepareForSpecialWarp::
 .setNewGameMatWarp
 	; This is called by OakSpeech during StartNewGame and
 	; loads the first warp event for the specified map index.
-	ld a, PALLET_TOWN 
+	ld a, PALLET_TOWN
 .next
 	ld b, a
 	ld a, [wd72d]