shithub: pokecrystal

Download patch

ref: 9a3088e50cf58158cbfb8de5ad80170967d975dc
parent: f27f79488a460f0a89670f3611e1e9e175baf5d6
author: xCrystal <[email protected]>
date: Tue Jan 2 08:24:05 EST 2018

Clean up XXX comments for unused content

--- a/data/sprite_anims/framesets.asm
+++ b/data/sprite_anims/framesets.asm
@@ -246,22 +246,22 @@
 	frame SPRITE_ANIM_OAMSET_MAGNET_TRAIN_RED_2,  8, OAM_X_FLIP
 	dorestart
 
-; XXX
+; unused
 	frame SPRITE_ANIM_OAMSET_43,  8
 	frame SPRITE_ANIM_OAMSET_44,  8
 	dorestart
 
-; XXX
+; unused
 	frame SPRITE_ANIM_OAMSET_45,  8
 	frame SPRITE_ANIM_OAMSET_46,  8
 	dorestart
 
-; XXX
+; unused
 	frame SPRITE_ANIM_OAMSET_47,  8
 	frame SPRITE_ANIM_OAMSET_48,  8
 	dorestart
 
-; XXX
+; unused
 	frame SPRITE_ANIM_OAMSET_49,  1
 	frame SPRITE_ANIM_OAMSET_49,  1, OAM_X_FLIP
 	frame SPRITE_ANIM_OAMSET_49,  1, OAM_X_FLIP, OAM_Y_FLIP
@@ -268,23 +268,23 @@
 	frame SPRITE_ANIM_OAMSET_49,  1, OAM_Y_FLIP
 	dorestart
 
-; XXX
+; unused
 	frame SPRITE_ANIM_OAMSET_4A, 32
 	endanim
 
-; XXX
+; unused
 	frame SPRITE_ANIM_OAMSET_4B, 32
 	endanim
 
-; XXX
+; unused
 	frame SPRITE_ANIM_OAMSET_4C, 32
 	endanim
 
-; XXX
+; unused
 	frame SPRITE_ANIM_OAMSET_4D, 32
 	endanim
 
-; XXX
+; unused
 	frame SPRITE_ANIM_OAMSET_4E,  3
 	dorepeat  3
 	dorestart
--- a/engine/battle/battle_transition.asm
+++ b/engine/battle/battle_transition.asm
@@ -863,8 +863,7 @@
 	ret
 ; 8c7c9 (23:47c9)
 
-Function8c7c9:
-; XXX
+Unreferenced_Function8c7c9:
 	ld a, $1
 	ld [hBGMapMode], a
 	call WaitBGMap
--- a/engine/battle/core.asm
+++ b/engine/battle/core.asm
@@ -8551,8 +8551,7 @@
 	ret
 ; 3f662
 
-Function3f662: ; 3f662
-; XXX
+Unreferenced_Function3f662: ; 3f662
 	ld hl, EnemyMonMoves
 	ld de, wListMoves_MoveIndicesBuffer
 	ld b, NUM_MOVES
--- a/engine/billspc.asm
+++ b/engine/billspc.asm
@@ -2559,7 +2559,7 @@
 	ret
 ; e3778 (38:7778)
 
-	hlcoord 11, 7 ; XXX
+	hlcoord 11, 7 ; unused
 
 .MenuDataHeader: ; 0xe377b
 	db $40 ; flags
--- a/engine/color.asm
+++ b/engine/color.asm
@@ -78,8 +78,7 @@
 	and a
 	ret
 
-Function8aa4:
-; XXX
+Unreferenced_Function8aa4:
 	push de
 	push bc
 	ld hl, PalPacket_9ce6
@@ -180,8 +179,7 @@
 	ld hl, BlkPacket_9a86
 	jp PushSGBPals_
 
-Function8b4d:
-; XXX
+Unreferenced_Function8b4d:
 	call CheckCGB
 	jr nz, .cgb
 	ld a, [hSGB]
@@ -196,8 +194,7 @@
 	call GetPredefPal
 	jp LoadHLPaletteIntoDE
 
-Function8b67:
-; XXX
+Unreferenced_Function8b67:
 	call CheckCGB
 	jr nz, .cgb
 	ld a, [hSGB]
@@ -212,8 +209,7 @@
 	call GetPredefPal
 	jp LoadHLPaletteIntoDE
 
-Function8b81:
-; XXX
+Unreferenced_Function8b81:
 	call CheckCGB
 	jr nz, .cgb
 	ld a, [hSGB]
@@ -281,8 +277,7 @@
 	call LoadPalette_White_Col1_Col2_Black
 	ret
 
-Function8bec:
-; XXX
+Unreferenced_Function8bec:
 	ld a, [hCGB]
 	and a
 	jr nz, .cgb
@@ -455,8 +450,7 @@
 
 INCLUDE "engine/cgb_layouts.asm"
 
-Function95f0:
-; XXX
+Unreferenced_Function95f0:
 	ld hl, .Palette
 	ld de, wBGPals1
 	ld bc, 1 palettes
@@ -768,8 +762,7 @@
 BattleObjectPals:
 INCLUDE "data/palettes/battle_objects.pal"
 
-Function97cc:
-; XXX
+Unreferenced_Function97cc:
 	call CheckCGB
 	ret z
 	ld a, $90
@@ -979,8 +972,7 @@
 	dw PalPacket_9dd6
 	dw PalPacket_9de6
 
-Function9911:
-; XXX
+Unreferenced_Function9911:
 	di
 	xor a
 	ld [rJOYP], a
--- a/engine/dma_transfer.asm
+++ b/engine/dma_transfer.asm
@@ -112,7 +112,7 @@
 	ret
 ; 1040d4
 
-; XXX
+; unused
 	ld hl, .unreferenced_1040da
 	jp CallInSafeGFXMode
 
@@ -136,7 +136,7 @@
 	ret
 ; 1040fb
 
-; XXX
+; unused
 	ld hl, .unreferenced_104101
 	jp CallInSafeGFXMode
 
--- a/engine/events/kurt.asm
+++ b/engine/events/kurt.asm
@@ -163,7 +163,7 @@
 	db 09, 06 ; start coords
 	db 12, 19 ; end coords
 
-	db 0, 0, -1, 0 ; XXX
+	db 0, 0, -1, 0 ; unused
 
 .PlaceApricornName: ; 88116
 	call MenuBoxCoord2Tile
--- a/engine/events/mom_phone.asm
+++ b/engine/events/mom_phone.asm
@@ -217,7 +217,7 @@
 
 INCLUDE "data/items/mom_phone.asm"
 
-	db 0, 0, 0 ; XXX
+	db 0, 0, 0 ; unused
 
 _MomText_HiHowAreYou: ; 0xfd1b1
 	; Hi,  ! How are you?
@@ -255,10 +255,10 @@
 	db "@"
 ; 0xfd1cf
 
-	db 0 ; XXX
+	db 0 ; unused
 
 Predef3A: ; fd1d0
 	ret
 ; fd1d1
 
-	ret ; XXX
+	ret ; unused
--- a/engine/events/overworld.asm
+++ b/engine/events/overworld.asm
@@ -1749,7 +1749,7 @@
 	special ReplaceKrisSprite
 	end
 
-; XXX
+; unused
 	nop
 	ret
 
--- a/engine/evolve.asm
+++ b/engine/evolve.asm
@@ -333,7 +333,7 @@
 	inc hl
 	jp .loop
 
-; XXX
+; unused
 	pop hl
 .ReturnToMap:
 	pop de
--- a/engine/mail_2.asm
+++ b/engine/mail_2.asm
@@ -725,8 +725,7 @@
 	jp PlaceString
 ; b984e
 
-Functionb984e: ; b984e
-; XXX
+Unreferenced_Functionb984e: ; b984e
 .loop
 	ld a, [hl]
 	xor $ff
--- a/engine/mon_stats.asm
+++ b/engine/mon_stats.asm
@@ -324,8 +324,7 @@
 	jr nz, .load_loop
 	ret
 
-Function50cd0: ; 50cd0
-; XXX
+Unreferenced_Function50cd0: ; 50cd0
 .loop
 	ld [hl], $32
 	inc hl
--- a/engine/move_mon.asm
+++ b/engine/move_mon.asm
@@ -1795,7 +1795,7 @@
 	pop hl
 	ld de, StringBuffer1
 	call InitName
-	ld a, $4 ; XXX could this be in bank 4 in pokered?
+	ld a, $4 ; ExitAllMenus is in bank 0, XXX could this be in bank 4 in pokered?
 	ld hl, ExitAllMenus
 	rst FarCall
 	ret
--- a/engine/namingscreen.asm
+++ b/engine/namingscreen.asm
@@ -739,7 +739,7 @@
 
 ; 11b39 (4:5b39)
 
-; XXX
+; unused
 	ld a, [wNamingScreenCurrNameLength]
 	and a
 	ret z
@@ -1434,7 +1434,7 @@
 
 ; 121b2 (4:61b2)
 
-; XXX
+; unused
 	ld a, [wNamingScreenCurrNameLength]
 	and a
 	ret z
--- a/engine/pic_animation.asm
+++ b/engine/pic_animation.asm
@@ -695,7 +695,7 @@
 	ret
 ; d03f4
 
-; XXX
+; unused
 	db 6, 5, 4
 
 .GetTilemap: ; d03f7
--- a/engine/player_gfx.asm
+++ b/engine/player_gfx.asm
@@ -1,5 +1,4 @@
-Function88248: ; 88248
-; XXX
+Unreferenced_Function88248: ; 88248
 	ld c, CAL
 	ld a, [wPlayerGender]
 	bit 0, a
--- a/engine/pokegear.asm
+++ b/engine/pokegear.asm
@@ -1309,7 +1309,7 @@
 
 ; 9146e
 
-; XXX
+; unused
 	ld a, [hHours]
 	cp 12
 	jr c, .am
@@ -1499,7 +1499,7 @@
 
 ; 916a1 (24:56a1)
 
-; XXX
+; unused
 	ld [wPokegearRadioChannelBank], a
 	ld a, [hli]
 	ld [wPokegearRadioChannelAddr], a
@@ -2932,7 +2932,7 @@
 FlyMapLabelBorderGFX: ; 922e1
 INCBIN "gfx/pokegear/flymap_label_border.1bpp"
 
-; XXX
+Unreferenced_Function92311:
 	xor a
 	ld [wTownMapPlayerIconLandmark], a
 	call ClearBGPalettes
--- a/engine/printer.asm
+++ b/engine/printer.asm
@@ -596,8 +596,7 @@
 	ret
 ; 847bd
 
-Function847bd: ; 847bd
-; XXX
+Unreferenced_Function847bd: ; 847bd
 	ld a, [wPrinterStatus]
 	and a
 	ret z
--- a/engine/printnum.asm
+++ b/engine/printnum.asm
@@ -165,7 +165,7 @@
 	dec e
 	jr nz, .money_leading_zero
 	inc hl
-	ld [hl], $f2 ; XXX
+	ld [hl], "<DOT>"
 
 .money_leading_zero
 	call .AdvancePointer
--- a/engine/routines/printhoursmins.asm
+++ b/engine/routines/printhoursmins.asm
@@ -1,5 +1,4 @@
-Function1dd6a9: ; 1dd6a9
-; XXX
+Unreferenced_Function1dd6a9: ; 1dd6a9
 	ld a, b
 	ld b, c
 	ld c, a
--- a/engine/rtc.asm
+++ b/engine/rtc.asm
@@ -1,4 +1,4 @@
-StopRTC: ; Unreferenced???
+StopRTC: ; Unreferenced
 	ld a, SRAM_ENABLE
 	ld [MBC3SRamEnable], a
 	call LatchClock
--- a/engine/save.asm
+++ b/engine/save.asm
@@ -415,8 +415,7 @@
 	jp CloseSRAM
 ; 14d18
 
-Function14d18: ; 14d18
-; XXX
+Unreferenced_Function14d18: ; 14d18
 ; copy .Data to SRA4:a007
 	ld a, $4
 	call GetSRAMBank
@@ -452,8 +451,7 @@
 	ret
 ; 14d6c
 
-Function14d6c: ; 14d6c
-; XXX
+Unreferenced_Function14d6c: ; 14d6c
 	ld a, $4
 	call GetSRAMBank
 	ld a, [$a60b]
@@ -469,8 +467,7 @@
 	ret
 ; 14d83
 
-Function14d83: ; 14d83
-; XXX
+Unreferenced_Function14d83: ; 14d83
 	ld a, $4
 	call GetSRAMBank
 	xor a
@@ -480,8 +477,7 @@
 	ret
 ; 14d93
 
-Function14d93: ; 14d93
-; XXX
+Unreferenced_Function14d93: ; 14d93
 	ld a, $7
 	call GetSRAMBank
 	xor a
--- a/engine/scripting.asm
+++ b/engine/scripting.asm
@@ -2852,7 +2852,7 @@
 	ld [wc2cf], a
 	ret
 
-	ld c, c ; XXX
+	ld c, c ; unused
 
 Script_closetext:
 ; script command 0x49
--- a/engine/time.asm
+++ b/engine/time.asm
@@ -225,13 +225,13 @@
 	ret
 ; 1151c
 
-; XXX
+; unused
 	ld hl, wDailyFlags
 	set 2, [hl]
 	ret
 ; 11522
 
-; XXX
+; unused
 	and a
 	ld hl, wDailyFlags
 	bit 2, [hl]
--- a/home.asm
+++ b/home.asm
@@ -552,7 +552,7 @@
 	jr .CopyTilemapAtOnce
 ; 323f
 
-; XXX
+; unused
 	farcall HDMATransferAttrMapAndTileMapToWRAMBank3
 	ret
 ; 3246
@@ -1127,8 +1127,7 @@
 	jp PrintNum
 ; 384d
 
-Function384d:: ; 384d
-; XXX
+Unreferenced_Function384d:: ; 384d
 ; GetNthMove
 	ld hl, wListMoves_MoveIndicesBuffer
 	ld c, a
@@ -1321,8 +1320,7 @@
 	jp AddNTimes
 ; 392d
 
-Function392d:: ; 392d
-; XXX
+Unreferenced_Function392d:: ; 392d
 ; GetDexNumber
 ; Probably used in gen 1 to convert index number to dex number
 ; Not required in gen 2 because index number == dex number
--- a/home/fade.asm
+++ b/home/fade.asm
@@ -1,8 +1,7 @@
 ; Functions to fade the screen in and out.
 
 
-Function48c:: ; 48c
-; XXX
+Unreferenced_Function48c:: ; 48c
 ; TimeOfDayFade
 	ld a, [TimeOfDayPal]
 	ld b, a
--- a/home/map.asm
+++ b/home/map.asm
@@ -384,7 +384,7 @@
 	ret
 ; 2300
 
-; XXX
+; unused
 	cp INDOOR
 	ret z
 	cp GATE
@@ -2075,7 +2075,6 @@
 
 ; inputs:
 ; b = map group, c = map number
-; XXX de = ???
 
 ; outputs:
 ; hl points to the map header
@@ -2247,7 +2246,7 @@
 	ret
 ; 2c98
 
-	ret ; XXX
+	ret ; unused
 ; 2c99
 
 GetAnyMapEnvironment:: ; 2c99
--- a/home/map_objects.asm
+++ b/home/map_objects.asm
@@ -316,7 +316,7 @@
 	ret
 ; 194d
 
-; XXX
+; unused
 	ld [hMapObjectIndexBuffer], a
 	call GetMapObject
 	call CopyObjectStruct
@@ -383,7 +383,7 @@
 	ret
 ; 19b8
 
-; XXX
+Unreferenced_Function19b8:
 	call GetMapObject
 	ld hl, MAPOBJECT_OBJECT_STRUCT_ID
 	add hl, bc
--- a/home/serial.asm
+++ b/home/serial.asm
@@ -398,8 +398,7 @@
 	ret
 ; 919
 
-Function919:: ; 919
-; XXX
+Unreferenced_Function919:: ; 919
 	ld a, [wLinkMode]
 	and a
 	ret nz
--- a/home/text.asm
+++ b/home/text.asm
@@ -1015,8 +1015,7 @@
 	ret
 ; 1522
 
-Function1522:: ; 1522
-; XXX
+Unreferenced_Function1522:: ; 1522
 ; TX_CRY
 	push de
 	ld e, [hl]
--- a/home/window.asm
+++ b/home/window.asm
@@ -99,7 +99,7 @@
 	ld [hOAMUpdate], a
 	ret
 
-; XXX
+; unused
 	scf
 	ret
 ; 2e50
--- a/lib/mobile/main.asm
+++ b/lib/mobile/main.asm
@@ -6908,7 +6908,7 @@
 	dec a
 	jp .asm_112e46
 
-; XXX
+; unused
 	ret
 
 .asm_112d4d
@@ -8611,7 +8611,7 @@
 	ld [$cc0d], a
 	ld a, l
 	ld [$cc0c], a
-	cp $8e ; XXX ; LOW(Unknown_113b8e + $100) ???
+	cp $8e ; XXX LOW(Unknown_113b8e + $100) ???
 	jp nz, .asm_113751
 	ld de, $cc18
 	ld hl, $cbe7
--- a/mobile/fixed_words.asm
+++ b/mobile/fixed_words.asm
@@ -33,8 +33,7 @@
 	ret
 ; 11c082
 
-Function11c082: ; 11c082
-; XXX
+Unreferenced_Function11c082: ; 11c082
 	push de
 	ld a, c
 	call Function11c254
--- a/mobile/mobile_45.asm
+++ b/mobile/mobile_45.asm
@@ -7350,7 +7350,7 @@
 
 ; everything from here to the end of the bank is related to the
 ; Mobile Stadium option from the continue/newgame menu.
-; XXX better function names
+; Needs better function names
 MobileStudium: ; 0x117a7f
 	ld a, [hInMenu]
 	push af
--- a/mobile/news/news.asm
+++ b/mobile/news/news.asm
@@ -1,9 +1,8 @@
 ; http://forums.glitchcity.info/index.php?topic=7509.msg206449#msg206449
 
-	db $cc, $6b, $1e ; XXX
+	db $cc, $6b, $1e ; unused
 
-Function1f4003: ; 1f4003
-; XXX
+Unreferenced_Function1f4003: ; 1f4003
 	ld a, $6
 	call GetSRAMBank
 	ld hl, .news_data
@@ -16,8 +15,7 @@
 .news_data
 INCBIN "mobile/news/news_1.bin"
 
-Function1f4dbe: ; 1f4dbe
-; XXX
+Unreferenced_Function1f4dbe: ; 1f4dbe
 	ld a, $6
 	call GetSRAMBank
 	ld hl, .news_data
--- a/text/unused_gen_1_trainers.asm
+++ b/text/unused_gen_1_trainers.asm
@@ -1,5 +1,4 @@
-GetGen1TrainerClassName: ; 50a28
-; XXX
+Unreferenced_GetGen1TrainerClassName: ; 50a28
 	ld hl, .Strings
 	ld a, [TrainerClass]
 	dec a