Battle animation annotations

engine/anim_hp_bar.asm

@@ -1,8 +1,8 @@
 _AnimateHPBar: ; d627
-	call Functiond65f
-	jr c, .do_player
-	call Functiond670
-.enemy_loop
+	call .IsMaximumMoreThan48Pixels
+	jr c, .MoreThan48Pixels
+	call .ComputePixels
+.ShortAnimLoop
 	push bc
 	push hl
 	call Functiond6e2
@@ -16,12 +16,12 @@ _AnimateHPBar: ; d627
 	pop hl
 	pop bc
 	pop af
-	jr nc, .enemy_loop
+	jr nc, .ShortAnimLoop
 	ret
 
-.do_player
-	call Functiond670
-.player_loop
+.MoreThan48Pixels
+	call .ComputePixels
+.LongAnimLoop
 	push bc
 	push hl
 	call Functiond6f5
@@ -36,11 +36,11 @@ _AnimateHPBar: ; d627
 	pop hl
 	pop bc
 	pop af
-	jr nc, .player_loop
+	jr nc, .LongAnimLoop
 	ret
 ; d65f
 
-Functiond65f: ; d65f
+.IsMaximumMoreThan48Pixels: ; d65f
 	ld a, [Buffer2]
 	and a
 	jr nz, .player
@@ -55,7 +55,7 @@ Functiond65f: ; d65f
 	ret
 ; d670
 
-Functiond670: ; d670
+.ComputePixels: ; d670
 ; Buffer1-2: Max HP
 ; Buffer3-4: Old HP
 ; Buffer5-6: New HP
@@ -72,7 +72,7 @@ Functiond670: ; d670
 	pop hl
 	call ComputeHPBarPixels
 	ld a, e
-	ld [wd1f1], a
+	ld [wCurHPBarPixels], a
 
 	ld a, [Buffer5]
 	ld c, a
@@ -84,7 +84,7 @@ Functiond670: ; d670
 	ld d, a
 	call ComputeHPBarPixels
 	ld a, e
-	ld [wd1f2], a
+	ld [wNewHPBarPixels], a
 
 	push hl
 	ld hl, Buffer3
@@ -103,15 +103,15 @@ Functiond670: ; d670
 	ld a, d
 	sbc b
 	ld d, a
-	jr c, .asm_d6c1
+	jr c, .negative
 	ld a, [Buffer3]
 	ld [wd1f5], a
 	ld a, [Buffer5]
 	ld [wd1f6], a
 	ld bc, 1
-	jr .asm_d6d9
+	jr .got_direction
 
-.asm_d6c1
+.negative
 	ld a, [Buffer3]
 	ld [wd1f6], a
 	ld a, [Buffer5]
@@ -123,8 +123,8 @@ Functiond670: ; d670
 	ld a, d
 	xor $ff
 	ld d, a
-	ld bc, rIE
-.asm_d6d9
+	ld bc, -1
+.got_direction
 	ld a, d
 	ld [wd1f3], a
 	ld a, e
@@ -133,14 +133,14 @@ Functiond670: ; d670
 ; d6e2
 
 Functiond6e2: ; d6e2
-	ld hl, wd1f1
-	ld a, [wd1f2]
+	ld hl, wCurHPBarPixels
+	ld a, [wNewHPBarPixels]
 	cp [hl]
-	jr nz, .asm_d6ed
+	jr nz, .not_finished
 	scf
 	ret
 
-.asm_d6ed
+.not_finished
 	ld a, c
 	add [hl]
 	ld [hl], a
@@ -150,7 +150,7 @@ Functiond6e2: ; d6e2
 ; d6f5
 
 Functiond6f5: ; d6f5
-.asm_d6f5
+.loop
 	ld hl, Buffer3
 	ld a, [hli]
 	ld e, a
@@ -158,22 +158,22 @@ Functiond6f5: ; d6f5
 	ld d, a
 	ld a, e
 	cp [hl]
-	jr nz, .asm_d707
+	jr nz, .next
 	inc hl
 	ld a, d
 	cp [hl]
-	jr nz, .asm_d707
+	jr nz, .next
 	scf
 	ret
 
-.asm_d707
+.next
 	ld l, e
 	ld h, d
 	add hl, bc
 	ld a, l
 	ld [Buffer3], a
 	ld a, h
-	ld [wd1ed], a
+	ld [Buffer4], a
 	push hl
 	push de
 	push bc
@@ -191,9 +191,9 @@ Functiond6f5: ; d6f5
 	pop de
 	pop hl
 	ld a, e
-	ld hl, wd1f1
+	ld hl, wCurHPBarPixels
 	cp [hl]
-	jr z, .asm_d6f5
+	jr z, .loop
 	ld [hl], a
 	and a
 	ret
@@ -205,7 +205,7 @@ Functiond730: ; d730
 	ld a, [wWhichHPBar]
 	and $1
 	ld b, a
-	ld a, [wd1f1]
+	ld a, [wCurHPBarPixels]
 	ld e, a
 	ld c, a
 	push de
@@ -219,7 +219,7 @@ Functiond749: ; d749
 	call Functiond784
 	ld a, [Buffer3]
 	ld c, a
-	ld a, [wd1ed]
+	ld a, [Buffer4]
 	ld b, a
 	ld a, [Buffer1]
 	ld e, a
@@ -275,7 +275,7 @@ endr
 	dec hl
 	ld a, [Buffer3]
 	ld [StringBuffer2 + 1], a
-	ld a, [wd1ed]
+	ld a, [Buffer4]
 	ld [StringBuffer2], a
 	ld de, StringBuffer2
 	lb bc, 2, 3
@@ -375,7 +375,7 @@ Functiond839: ; d839
 	ld c, a
 	ld b, 0
 	ld hl, 0
-	ld a, [wd1f1]
+	ld a, [wCurHPBarPixels]
 	cp 6 * 8
 	jr nc, .coppy_buffer
 	and a

engine/battle_start.asm

@@ -1,5 +1,5 @@
 Predef_StartBattle: ; 8c20f
-	call Function8c26d
+	call .InitGFX
 	ld a, [rBGP]
 	ld [wBGP], a
 	ld a, [rOBP0]
@@ -52,15 +52,15 @@ Predef_StartBattle: ; 8c20f
 	ret
 ; 8c26d
 
-Function8c26d: ; 8c26d
+.InitGFX: ; 8c26d
 	ld a, [wLinkMode]
 	cp LINK_MOBILE
 	jr z, .mobile
 	callba Function6454
 	call UpdateSprites
 	call DelayFrame
-	call Function8c2a0
-	call Function8cf4f
+	call .NonMobile_LoadPokeballTiles
+	call BattleStart_LoadEDTile
 	jr .resume
 
 .mobile
@@ -81,7 +81,7 @@ Function8c26d: ; 8c26d
 	ret
 ; 8c2a0
 
-Function8c2a0: ; 8c2a0
+.NonMobile_LoadPokeballTiles: ; 8c2a0
 	call LoadTrainerBattlePokeballTiles
 	hlbgcoord 0, 0
 	call Function8c2cf
@@ -663,7 +663,7 @@ StartTrainerBattle_LoadPokeBallGraphics: ; 8c5dc (23:45dc)
 	ld a, $1
 	ld [hCGBPalUpdate], a
 	call DelayFrame
-	call Function8cf4f
+	call BattleStart_LoadEDTile
 
 .nextscene: ; 8c673 (23:4673)
 	call StartTrainerBattle_NextScene

engine/init_gender.asm

@@ -67,7 +67,7 @@ TextJump_AreYouABoyOrAreYouAGirl: ; 0x48e0f
 InitGenderScreen: ; 48e14 (12:4e14)
 	ld a, $10
 	ld [MusicFade], a
-	ld a, $0
+	ld a, MUSIC_NONE
 	ld [MusicFadeIDLo], a
 	ld a, $0
 	ld [MusicFadeIDHi], a

engine/main_menu.asm

@@ -202,7 +202,7 @@ MainMenuJoypadLoop: ; 49de4
 	ld a, [w2DMenuFlags1]
 	set 5, a
 	ld [w2DMenuFlags1], a
-	call Function1f1a
+	call GetScrollingMenuJoypad
 	ld a, [wMenuJoypad]
 	cp B_BUTTON
 	jr z, .b_button

engine/mon_icons.asm

@@ -14,7 +14,7 @@ LoadOverworldMonIcon: ; 8e82b
 	ret
 ; 8e83f
 
-Function8e83f: ; 8e83f
+LoadMenuMonIcon: ; 8e83f
 	push hl
 	push de
 	push bc
@@ -28,9 +28,8 @@ Function8e83f: ; 8e83f
 .LoadIcon: ; 8e849
 	ld d, 0
 	ld hl, .Jumptable
-rept 2
 	add hl, de
-endr
+	add hl, de
 	ld a, [hli]
 	ld h, [hl]
 	ld l, a
@@ -39,13 +38,13 @@ endr
 
 
 .Jumptable: ; 8e854 (23:6854)
-	dw Function8e8d5 ; init
-	dw Function8e961
-	dw Function8e97d
-	dw Trade_LoadMonIconGFX
-	dw Function8e898
-	dw Mobile_InitPartyMenuBGPal71
-	dw .GetPartyMenuMonIcon
+	dw Function8e8d5 ; party menu
+	dw Function8e961 ; naming screen
+	dw Function8e97d ; moves (?)
+	dw Trade_LoadMonIconGFX ; trade
+	dw Function8e898 ; mobile
+	dw Mobile_InitPartyMenuBGPal71 ; mobile
+	dw .GetPartyMenuMonIcon ; unused
 
 
 .GetPartyMenuMonIcon: ; 8e862 (23:6862)
@@ -89,7 +88,7 @@ Function8e898: ; 8e898 (23:6898)
 	call Function8e8d5
 	ld hl, SPRITEANIMSTRUCT_ANIM_SEQ_ID
 	add hl, bc
-	ld a, $0
+	ld a, SPRITE_ANIM_SEQ_NULL
 	ld [hl], a
 	ld hl, SPRITEANIMSTRUCT_XCOORD
 	add hl, bc
@@ -106,7 +105,7 @@ Mobile_InitPartyMenuBGPal71: ; 8e8b1 (23:68b1)
 	call SetPartyMonIconAnimSpeed
 	ld hl, SPRITEANIMSTRUCT_ANIM_SEQ_ID
 	add hl, bc
-	ld a, $0
+	ld a, SPRITE_ANIM_SEQ_NULL
 	ld [hl], a
 	ld hl, SPRITEANIMSTRUCT_XCOORD
 	add hl, bc
@@ -229,7 +228,7 @@ Function8e961: ; 8e961 (23:6961)
 	call InitSpriteAnimStruct
 	ld hl, SPRITEANIMSTRUCT_ANIM_SEQ_ID
 	add hl, bc
-	ld [hl], $0
+	ld [hl], SPRITE_ANIM_SEQ_NULL
 	ret
 
 Function8e97d: ; 8e97d (23:697d)

engine/movement.asm

@@ -55,8 +55,8 @@ MovementPointers: ; 5075
 	dw Movement_fast_jump_step_up     ; 35
 	dw Movement_fast_jump_step_left   ; 36
 	dw Movement_fast_jump_step_right  ; 37
-	dw Movement_38                    ; 38
-	dw Movement_39                    ; 39
+	dw Movement_remove_sliding                    ; 38
+	dw Movement_set_sliding                    ; 39
 	dw Movement_remove_fixed_facing   ; 3a
 	dw Movement_fix_facing            ; 3b
 	dw Movement_show_person           ; 3c
@@ -373,14 +373,14 @@ Movement_56: ; 5279
 	ret
 ; 5293
 
-Movement_38: ; 5293
+Movement_remove_sliding: ; 5293
 	ld hl, OBJECT_FLAGS1
 	add hl, bc
 	res SLIDING, [hl]
 	jp ContinueReadingMovement
 ; 529c
 
-Movement_39: ; 529c
+Movement_set_sliding: ; 529c
 	ld hl, OBJECT_FLAGS1
 	add hl, bc
 	set SLIDING, [hl]

engine/namingscreen.asm

@@ -88,10 +88,10 @@ endr
 .Pokemon: ; 1173e (4:573e)
 	ld a, [CurPartySpecies]
 	ld [wd265], a
-	ld hl, Function8e83f
-	ld a, BANK(Function8e83f)
+	ld hl, LoadMenuMonIcon
+	ld a, BANK(LoadMenuMonIcon)
 	ld e, $1
-	rst FarCall ;  ; indirect jump to Function8e83f (8e83f (23:683f))
+	rst FarCall ;  ; indirect jump to LoadMenuMonIcon (8e83f (23:683f))
 	ld a, [CurPartySpecies]
 	ld [wd265], a
 	call GetPokemonName

engine/party_menu.asm

@@ -658,8 +658,8 @@ InitPartyMenuGFX: ; 503e0
 .loop
 	push bc
 	push hl
-	ld hl, Function8e83f
-	ld a, BANK(Function8e83f)
+	ld hl, LoadMenuMonIcon
+	ld a, BANK(LoadMenuMonIcon)
 	ld e, $0
 	rst FarCall
 	ld a, [hObjectStructIndexBuffer]
@@ -752,8 +752,8 @@ PartyMenuSelect: ; 0x50457
 	ld [wPartyMenuCursor], a
 	ld a, [hJoyLast]
 	ld b, a
-	bit 1, b
-	jr nz, .exitmenu ; B button?
+	bit B_BUTTON_F, b
+	jr nz, .exitmenu ; B button
 	ld a, [wMenuCursorY]
 	dec a
 	ld [CurPartyMon], a

engine/player_movement.asm

@@ -121,12 +121,12 @@ DoPlayerMovement:: ; 80000
 	ld a, [PlayerStandingTile]
 	ld c, a
 	call CheckWhirlpoolTile
-	jr c, .asm_800c4
+	jr c, .not_whirlpool
 	ld a, 3
 	scf
 	ret
 
-.asm_800c4
+.not_whirlpool
 	and $f0
 	cp $30 ; moving water
 	jr z, .water

engine/scrolling_menu.asm

@@ -210,17 +210,17 @@ ScrollingMenu_GetCursorPosition: ; 246fc
 	ret
 ; 24706
 
-Function24706: ; 24706 (9:4706)
+ScrollingMenu_ClearLeftColumn: ; 24706 (9:4706)
 	call MenuBoxCoord2Tile
 	ld de, SCREEN_WIDTH
 	add hl, de
 	ld de, 2 * SCREEN_WIDTH
 	ld a, [wMenuData2_ScrollingMenuHeight]
-.asm_24713
+.loop
 	ld [hl], " "
 	add hl, de
 	dec a
-	jr nz, .asm_24713
+	jr nz, .loop
 	ret
 
 InitScrollingMenuCursor: ; 2471a

engine/startmenu.asm

@@ -91,7 +91,7 @@ StartMenu:: ; 125cd
 	ld [MenuSelection], a
 .loop
 	call .PrintMenuAccount
-	call Function1f1a
+	call GetScrollingMenuJoypad
 	ld a, [wMenuJoypad]
 	cp B_BUTTON
 	jr z, .b
@@ -591,70 +591,66 @@ HasNoItems: ; 129d5
 	and a
 	ret
 
-Function129f4: ; 129f4
+TossItemFromPC: ; 129f4
 	push de
 	call PartyMonItemName
 	callba _CheckTossableItem
 	ld a, [wItemAttributeParamBuffer]
 	and a
-	jr nz, .asm_12a3f
-	ld hl, UnknownText_0x12a45
+	jr nz, .key_item
+	ld hl, .TossHowMany
 	call MenuTextBox
 	callba SelectQuantityToToss
 	push af
 	call CloseWindow
 	call ExitMenu
 	pop af
-	jr c, .asm_12a42
-	ld hl, UnknownText_0x12a4a
+	jr c, .quit
+	ld hl, .ConfirmToss
 	call MenuTextBox
 	call YesNoBox
 	push af
 	call ExitMenu
 	pop af
-	jr c, .asm_12a42
+	jr c, .quit
 	pop hl
 	ld a, [wd107]
 	call TossItem
 	call PartyMonItemName
-	ld hl, UnknownText_0x12a4f
+	ld hl, .TossedThisMany
 	call MenuTextBox
 	call ExitMenu
 	and a
 	ret
-.asm_12a3f
-	call Function12a54
-.asm_12a42
+
+.key_item
+	call .CantToss
+.quit
 	pop hl
 	scf
 	ret
-; 12a45 (4:6a45)
 
-UnknownText_0x12a45: ; 0x12a45
+.TossHowMany
 	; Toss out how many @ (S)?
 	text_jump UnknownText_0x1c1a90
 	db "@"
-; 0x12a4a
 
-UnknownText_0x12a4a: ; 0x12a4a
+.ConfirmToss
 	; Throw away @ @ (S)?
 	text_jump UnknownText_0x1c1aad
 	db "@"
-; 0x12a4f
 
-UnknownText_0x12a4f: ; 0x12a4f
+.TossedThisMany
 	; Discarded @ (S).
 	text_jump UnknownText_0x1c1aca
 	db "@"
-; 0x12a54
 
-Function12a54: ; 12a54 (4:6a54)
-	ld hl, UnknownText_0x12a5b
+.CantToss
+	ld hl, .TooImportantToToss
 	call MenuTextBoxBackup
 	ret
-; 12a5b (4:6a5b)
 
-UnknownText_0x12a5b: ; 0x12a5b
+.TooImportantToToss
 	; That's too impor- tant to toss out!
 	text_jump UnknownText_0x1c1adf
 	db "@"
@@ -830,7 +826,7 @@ GiveTakePartyMonItem: ; 12b60
 ; 12ba9
 
 
-.GiveItem: ; 12ba9
+.GiveItem
 
 	callba DepositSellInitPackBuffers
 
@@ -1168,7 +1164,7 @@ MonMailAction: ; 12d45
 ; 12dc9
 
 
-.MenuDataHeader: ; 0x12dc9
+.MenuDataHeader
 	db $40 ; flags
 	db 10, 12 ; start coords
 	db 17, 19 ; end coords
@@ -1176,7 +1172,7 @@ MonMailAction: ; 12d45
 	db 1 ; default option
 ; 0x12dd1
 
-.MenuData2: ; 0x12dd1
+.MenuData2
 	db $80 ; flags
 	db 3 ; items
 	db "READ@"
@@ -1185,37 +1181,37 @@ MonMailAction: ; 12d45
 ; 0x12de2
 
 
-.mailwilllosemessagetext: ; 0x12de2
+.mailwilllosemessagetext
 ; The MAIL will lose its message. OK?
 	text_jump UnknownText_0x1c1c22
 	db "@"
 ; 0x12de7
 
-.tookmailfrommontext: ; 0x12de7
+.tookmailfrommontext
 ; MAIL detached from <POKEMON>.
 	text_jump UnknownText_0x1c1c47
 	db "@"
 ; 0x12dec
 
-.bagfulltext: ; 0x12dec
+.bagfulltext
 ; There's no space for removing MAIL.
 	text_jump UnknownText_0x1c1c62
 	db "@"
 ; 0x12df1
 
-.sendmailtopctext: ; 0x12df1
+.sendmailtopctext
 ; Send the removed MAIL to your PC?
 	text_jump UnknownText_0x1c1c86
 	db "@"
 ; 0x12df6
 
-.mailboxfulltext: ; 0x12df6
+.mailboxfulltext
 ; Your PC's MAILBOX is full.
 	text_jump UnknownText_0x1c1ca9
 	db "@"
 ; 0x12dfb
 
-.sentmailtopctext: ; 0x12dfb
+.sentmailtopctext
 ; The MAIL was sent to your PC.
 	text_jump UnknownText_0x1c1cc4
 	db "@"
@@ -1392,13 +1388,13 @@ MonMenu_Softboiled_MilkDrink: ; 12ee6
 	ret
 ; 12f00
 
-.Text_NotEnoughHP: ; 0x12f00
+.Text_NotEnoughHP
 	; Not enough HP!
 	text_jump UnknownText_0x1c1ce3
 	db "@"
 ; 0x12f05
 
-.CheckMonHasEnoughHP: ; 12f05
+.CheckMonHasEnoughHP
 ; Need to have at least (MaxHP / 5) HP left.
 	ld a, MON_MAXHP
 	call GetPartyParamLocation
@@ -1471,7 +1467,7 @@ ChooseMoveToDelete: ; 12f5b
 	ret
 ; 12f73
 
-.asm_12f73: ; 12f73
+.asm_12f73
 	call SetUpMoveScreenBG
 	ld de, DeleteMoveScreenAttrs
 	call SetMenuAttributes
@@ -1480,27 +1476,27 @@ ChooseMoveToDelete: ; 12f5b
 	set 6, [hl]
 	jr .asm_12f93
 
-.asm_12f86: ; 12f86
+.asm_12f86
 	call ScrollingMenuJoypad
 	bit 1, a
 	jp nz, .asm_12f9f
 	bit 0, a
 	jp nz, .asm_12f9c
 
-.asm_12f93: ; 12f93
+.asm_12f93
 	call PrepareToPlaceMoveData
 	call PlaceMoveData
 	jp .asm_12f86
 ; 12f9c
 
-.asm_12f9c: ; 12f9c
+.asm_12f9c
 	and a
 	jr .asm_12fa0
 
-.asm_12f9f: ; 12f9f
+.asm_12f9f
 	scf
 
-.asm_12fa0: ; 12fa0
+.asm_12fa0
 	push af
 	xor a
 	ld [wSwitchMon], a
@@ -1583,7 +1579,7 @@ MoveScreenLoop: ; 12fd5
 	ld de, String_1316b
 	call PlaceString
 	jp .joy_loop
-.b_button: ; 13038
+.b_button
 	call PlayClickSFX
 	call WaitSFX
 	ld a, [wMoveSwapBuffer]
@@ -1600,7 +1596,7 @@ MoveScreenLoop: ; 12fd5
 	jp .loop
 ; 1305b
 
-.d_right: ; 1305b
+.d_right
 	ld a, [wMoveSwapBuffer]
 	and a
 	jp nz, .joy_loop
@@ -1615,7 +1611,7 @@ MoveScreenLoop: ; 12fd5
 	jp z, .joy_loop
 	jp MoveScreenLoop
 
-.d_left: ; 13075
+.d_left
 	ld a, [wMoveSwapBuffer]
 	and a
 	jp nz, .joy_loop
@@ -1665,7 +1661,7 @@ MoveScreenLoop: ; 12fd5
 	jr .cycle_left_loop
 ; 130c6
 
-.a_button: ; 130c6
+.a_button
 	call PlayClickSFX
 	call WaitSFX
 	ld a, [wMoveSwapBuffer]
@@ -1716,7 +1712,7 @@ MoveScreenLoop: ; 12fd5
 	jp .loop
 ; 1313a
 
-.copy_move: ; 1313a
+.copy_move
 	push hl
 	ld a, [wMenuCursorY]
 	dec a
@@ -1739,7 +1735,7 @@ MoveScreenLoop: ; 12fd5
 	ret
 ; 13154
 
-.exit: ; 13154
+.exit
 	xor a
 	ld [wMoveSwapBuffer], a
 	ld hl, w2DMenuFlags1
@@ -1776,7 +1772,7 @@ SetUpMoveScreenBG: ; 13172
 	ld a, [hl]
 	ld [wd265], a
 	ld e, $2
-	callba Function8e83f
+	callba LoadMenuMonIcon
 	hlcoord 0, 1
 	ld b, 9
 	ld c, 18

engine/tile_events.asm

@@ -21,17 +21,17 @@ CheckDirectionalWarp:: ; 149af
 ; Else, set carry (immediate warp).
 	ld a, [PlayerStandingTile]
 	cp $70 ; Warp on down
-	jr z, .not_warp
+	jr z, .directional
 	cp $76 ; Warp on left
-	jr z, .not_warp
+	jr z, .directional
 	cp $78 ; Warp on up
-	jr z, .not_warp
+	jr z, .directional
 	cp $7e ; Warp on right
-	jr z, .not_warp
+	jr z, .directional
 	scf
 	ret
 
-.not_warp
+.directional
 	xor a
 	ret
 ; 149c6

engine/time.asm

@@ -133,7 +133,7 @@ endr
 ; 11485
 
 Special_SampleKenjiBreakCountdown: ; 11485
-; Generate a random number between 3 and 5
+; Generate a random number between 3 and 6
 	call Random
 	and 3
 	add 3

engine/trade/animation.asm

@@ -1440,7 +1440,7 @@ LoadTradeBallAndCableGFX: ; 2982b
 LoadTradeBubbleGFX: ; 2985a
 	call DelayFrame
 	ld e, $3
-	callab Function8e83f
+	callab LoadMenuMonIcon
 	ld de, TradeBubbleGFX
 	ld hl, VTiles0 tile $72
 	lb bc, BANK(TradeBubbleGFX), $4