Harmonize engine/menus with pokecrystal

9 files changed, 76 insertions, 63 deletions

diff --git a/engine/menus/intro_menu.asm b/engine/menus/intro_menu.asm
index bdd456ac..d144d0fe 100644
--- a/engine/menus/intro_menu.asm
+++ b/engine/menus/intro_menu.asm
@@ -1,4 +1,3 @@
-MainMenu_NewGame:
 NewGame:
 	xor a
 	ld [wDebugFlags], a
@@ -242,7 +241,6 @@ LoadOrRegenerateLuckyIDNumber:
 	ld [sLuckyIDNumber + 1], a
 	jp CloseSRAM
 
-MainMenu_Continue:
 Continue:
 	farcall TryLoadSaveFile
 	jr c, .FailToLoad
@@ -521,7 +519,7 @@ OakSpeech:
 	call GetBaseData
 
 	hlcoord 6, 4
-	hlcoord 6, 4 ; TriHard
+	hlcoord 6, 4 ; redundant
 	call PrepMonFrontpic
 
 	xor a
@@ -714,14 +712,14 @@ ShrinkPlayer:
 
 MovePlayerPicRight:
 	hlcoord 6, 4
-	ld de, $1
+	ld de, 1
 	jr MovePlayerPic
 
 MovePlayerPicLeft:
 	hlcoord 13, 4
 	ld de, -1
 MovePlayerPic:
-	ld c, $8
+	ld c, 7 + 1
 .loop
 	push bc
 	push hl
@@ -822,7 +820,7 @@ Intro_PlaceChrisSprite:
 	inc de
 	ld [hli], a ; tile id
 	xor a ; PAL_OW_RED
-	ld [hli], a
+	ld [hli], a ; attributes
 	dec c
 	jr nz, .loop
 	ret
@@ -983,6 +981,8 @@ TitleScreenMain:
 	and D_DOWN + B_BUTTON + SELECT
 	cp  D_DOWN + B_BUTTON + SELECT
 	jr z, .clock_reset
+
+; Press Start or A to start the game.
 	ld a, [hl]
 	and START | A_BUTTON
 	jr nz, .incave
diff --git a/engine/menus/main_menu.asm b/engine/menus/main_menu.asm
index 5907324d..141f6987 100644
--- a/engine/menus/main_menu.asm
+++ b/engine/menus/main_menu.asm
@@ -1,3 +1,16 @@
+	; MainMenuItems indexes
+	const_def
+	const MAINMENU_NEW_GAME ; 0
+	const MAINMENU_CONTINUE ; 1
+	const MAINMENU_MYSTERY  ; 2
+
+	; MainMenu.Strings and MainMenu.Jumptable indexes
+	const_def
+	const MAINMENUITEM_CONTINUE     ; 0
+	const MAINMENUITEM_NEW_GAME     ; 1
+	const MAINMENUITEM_OPTION       ; 2
+	const MAINMENUITEM_MYSTERY_GIFT ; 3
+
 MainMenu:
 	ld de, MUSIC_NONE
 	call PlayMusic
@@ -45,43 +58,41 @@ MainMenu:
 	dw .Strings
 
 .Strings:
+; entries correspond to MAINMENUITEM_* constants
 	db "CONTINUE@"
 	db "NEW GAME@"
 	db "OPTION@"
 	db "MYSTERY GIFT@"
 
 .Jumptable:
-	dw MainMenu_Continue
-	dw MainMenu_NewGame
-	dw MainMenu_Options
-	dw MainMenu_MysteryGift
-
-CONTINUE       EQU 0
-NEW_GAME       EQU 1
-OPTION         EQU 2
-MYSTERY_GIFT   EQU 3
+; entries correspond to MAINMENUITEM_* constants
+	dw Continue
+	dw NewGame
+	dw Option
+	dw MysteryGift
 
 MainMenuItems:
+; entries correspond to MAINMENU_* constants
 
-NewGameMenu:
+	; MAINMENU_NEW_GAME
 	db 2
-	db NEW_GAME
-	db OPTION
+	db MAINMENUITEM_NEW_GAME
+	db MAINMENUITEM_OPTION
 	db -1
 
-ContinueMenu:
+	; MAINMENU_CONTINUE
 	db 3
-	db CONTINUE
-	db NEW_GAME
-	db OPTION
+	db MAINMENUITEM_CONTINUE
+	db MAINMENUITEM_NEW_GAME
+	db MAINMENUITEM_OPTION
 	db -1
 
-MysteryMenu:
+	; MAINMENU_MYSTERY
 	db 4
-	db CONTINUE
-	db NEW_GAME
-	db OPTION
-	db MYSTERY_GIFT
+	db MAINMENUITEM_CONTINUE
+	db MAINMENUITEM_NEW_GAME
+	db MAINMENUITEM_OPTION
+	db MAINMENUITEM_MYSTERY_GIFT
 	db -1
 
 MainMenu_GetWhichMenu:
@@ -91,22 +102,22 @@ MainMenu_GetWhichMenu:
 	ld a, [wSaveFileExists]
 	and a
 	jr nz, .next
-	ld a, $0 ; New Game
+	ld a, MAINMENU_NEW_GAME
 	ret
 
 .next
 	ldh a, [hCGB]
-	cp $1
-	ld a, $1
+	cp TRUE
+	ld a, MAINMENU_CONTINUE
 	ret nz
 	ld a, BANK(sNumDailyMysteryGiftPartnerIDs)
 	call OpenSRAM
 	ld a, [sNumDailyMysteryGiftPartnerIDs]
 	cp -1
 	call CloseSRAM
-	ld a, $1 ; Continue
+	ld a, MAINMENU_CONTINUE
 	ret z
-	ld a, $2 ; New Game
+	ld a, MAINMENU_MYSTERY
 	ret
 
 MainMenuJoypadLoop:
@@ -240,14 +251,12 @@ ClearTilemapEtc:
 	call ClearWindowData
 	ret
 
-MainMenu_MysteryGift:
 MysteryGift:
 	call UpdateTime
 	farcall DoMysteryGiftIfDayHasPassed
 	farcall DoMysteryGift
 	ret
 
-MainMenu_Options:
-OptionsMenu:
-	farcall _OptionsMenu
+Option:
+	farcall _Option
 	ret
diff --git a/engine/menus/menu.asm b/engine/menus/menu.asm
index b678d714..c12c505c 100644
--- a/engine/menus/menu.asm
+++ b/engine/menus/menu.asm
@@ -442,8 +442,9 @@ _PushWindow::
 	inc hl
 	ld d, [hl]
 	push de
-	ld b, $10
-	ld hl, wMenuFlags
+
+	ld b, wMenuHeaderEnd - wMenuHeader
+	ld hl, wMenuHeader
 .loop
 	ld a, [hli]
 	ld [de], a
diff --git a/engine/menus/menu_2.asm b/engine/menus/menu_2.asm
index ed7221e8..745a666c 100644
--- a/engine/menus/menu_2.asm
+++ b/engine/menus/menu_2.asm
@@ -108,7 +108,8 @@ MoneyString:
 CoinString:
 	db "COIN@"
 ShowMoney_TerminatorString:
-	db "@@"
+	db "@"
+	db "@" ; unused
 
 Unreferenced_StartMenu_PrintSafariGameStatus:
 	ld hl, wOptions
diff --git a/engine/menus/naming_screen.asm b/engine/menus/naming_screen.asm
index 34e2c6f2..0e064362 100644
--- a/engine/menus/naming_screen.asm
+++ b/engine/menus/naming_screen.asm
@@ -195,7 +195,7 @@ NamingScreen:
 	ld hl, wSpriteAnimDict
 	ld [hli], a
 	ld [hl], a
-	lb de, $24, $20
+	depixel 4, 4, 4, 0
 	ld a, SPRITE_ANIM_INDEX_RED_WALK
 	call InitSpriteAnimStruct
 	ret
@@ -649,11 +649,11 @@ NamingScreen_AnimateCursor:
 NamingScreen_TryAddCharacter:
 	ld a, [wNamingScreenLastCharacter]
 	ld hl, Dakutens
-	cp "ﾞ" ; $e5
-	jr z, asm_11f06
+	cp "ﾞ"
+	jr z, AddDakutenToCharacter
 	ld hl, Handakutens
-	cp "ﾟ" ; $e4
-	jr z, asm_11f06
+	cp "ﾟ"
+	jr z, AddDakutenToCharacter
 
 MailComposition_TryAddCharacter:
 	ld a, [wNamingScreenMaxNameLength]
@@ -683,7 +683,7 @@ NamingScreen_AdvanceCursor_CheckEndOfString:
 	scf
 	ret
 
-asm_11f06:
+AddDakutenToCharacter:
 	ld a, [wNamingScreenCurNameLength]
 	and a
 	ret z
@@ -696,7 +696,7 @@ asm_11f06:
 
 .loop
 	ld a, [hli]
-	cp $ff
+	cp -1
 	jr z, NamingScreen_AdvanceCursor_CheckEndOfString
 	cp c
 	jr z, .done
@@ -960,8 +960,8 @@ INCBIN "gfx/icons/mail_big.2bpp"
 	ld [wNamingScreenMaxNameLength], a
 	ret
 
-.UnusedString11f7a:
-	db "メールを かいてね@"
+.Unreferenced_PleaseWriteAMailString:
+	db "メールを　かいてね@"
 
 .InitCharset:
 	call WaitTop
@@ -1334,13 +1334,13 @@ ComposeMail_GetCursorPosition:
 MailComposition_TryAddLastCharacter:
 	ld a, [wNamingScreenLastCharacter]
 	ld hl, Dakutens
-	cp "ﾞ" ; $e5
-	jr z, .asm_1258b
+	cp "ﾞ"
+	jr z, .add_dakuten
 	ld hl, Handakutens
-	cp "ﾟ" ; $e4
+	cp "ﾟ"
 	jp nz, MailComposition_TryAddCharacter
 
-.asm_1258b
+.add_dakuten
 	ld a, [wNamingScreenCurNameLength]
 	and a
 	ret z
diff --git a/engine/menus/options_menu.asm b/engine/menus/options_menu.asm
index d0a6afc5..4e5ea3b7 100644
--- a/engine/menus/options_menu.asm
+++ b/engine/menus/options_menu.asm
@@ -10,7 +10,7 @@
 	const OPT_CANCEL       ; 7
 NUM_OPTIONS EQU const_value    ; 8
 
-_OptionsMenu:
+_Option:
 	ld hl, hInMenu
 	ld a, [hl]
 	push af
diff --git a/engine/menus/save.asm b/engine/menus/save.asm
index 93250034..9c3eced3 100644
--- a/engine/menus/save.asm
+++ b/engine/menus/save.asm
@@ -591,7 +591,7 @@ TryLoadSaveData:
 	call OpenSRAM
 	ld hl, sPlayerData + wStartDay - wPlayerData
 	ld de, wStartDay
-	ld bc, $e
+	ld bc, 14
 	call CopyBytes
 	call CloseSRAM
 	ret
@@ -606,7 +606,7 @@ TryLoadSaveData:
 	call OpenSRAM
 	ld hl, sBackupPlayerData1 + wStartDay - wPlayerData
 	ld de, wStartDay
-	ld bc, $e
+	ld bc, 14
 	call CopyBytes
 	call CloseSRAM
 	ret
diff --git a/engine/menus/start_menu.asm b/engine/menus/start_menu.asm
index dbadf637..9d520592 100644
--- a/engine/menus/start_menu.asm
+++ b/engine/menus/start_menu.asm
@@ -433,10 +433,11 @@ StartMenu_Save:
 
 	call BufferScreen
 	farcall SaveMenu
-	jr nc, .asm_12ce0
+	jr nc, .saved
 	ld a, 0
 	ret
-.asm_12ce0
+
+.saved
 	ld a, 1
 	ret
 
@@ -444,7 +445,7 @@ StartMenu_Option:
 ; Game options.
 
 	call FadeToMenu
-	farcall OptionsMenu
+	farcall Option
 	ld a, 6
 	ret
 
@@ -460,13 +461,13 @@ StartMenu_Status:
 StartMenu_Pokedex:
 	ld a, [wPartyCount]
 	and a
-	jr z, .asm_12de0
+	jr z, .empty
 
 	call FadeToMenu
 	farcall Pokedex
 	call CloseSubmenu
 
-.asm_12de0
+.empty
 	ld a, 0
 	ret
 
diff --git a/engine/menus/trainer_card.asm b/engine/menus/trainer_card.asm
index 7144c0d9..9c0beb14 100644
--- a/engine/menus/trainer_card.asm
+++ b/engine/menus/trainer_card.asm
@@ -367,6 +367,7 @@ TrainerCard_InitBorder:
 
 	ld a, $23
 	ld [hli], a
+
 	ld e, SCREEN_WIDTH - 3
 	ld a, " "
 .loop2
@@ -374,7 +375,7 @@ TrainerCard_InitBorder:
 	dec e
 	jr nz, .loop2
 
-	ld a, $4
+	ld a, $04
 	ld [hli], a
 	ld a, $23
 	ld [hli], a
@@ -618,8 +619,8 @@ TrainerCard_JohtoBadgesOAM:
 	db $1c,            $20, $24, $20 | (1 << 7)
 	db $1c | (1 << 7), $20, $24, $20 | (1 << 7)
 
-ChrisCardPic: INCBIN "gfx/trainer_card/chris_card.2bpp"
-CardGFX: INCBIN "gfx/trainer_card/trainer_card.2bpp"
+ChrisCardPic:  INCBIN "gfx/trainer_card/chris_card.2bpp"
+CardGFX:       INCBIN "gfx/trainer_card/trainer_card.2bpp"
 CardStatusGFX: INCBIN "gfx/trainer_card/card_status.2bpp"
 
 LeaderGFX:  INCBIN "gfx/trainer_card/leaders.2bpp"