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

This commit is contained in:
Remy Oukaour
2017-12-09 00:50:59 -05:00
parent 89b9292db0
commit 512863989f
86 changed files with 2222 additions and 1980 deletions

View File

@@ -803,7 +803,7 @@ EggHatch_CrackShell: ; 1736d (5:736d)
add 9 * 8 + 4
ld d, a
ld e, 11 * 8
ld a, SPRITE_ANIM_INDEX_19
ld a, SPRITE_ANIM_INDEX_EGG_CRACK
call _InitSpriteAnimStruct
ld hl, SPRITEANIMSTRUCT_TILE_ID
add hl, bc
@@ -833,7 +833,7 @@ Hatch_InitShellFragments: ; 173b3 (5:73b3)
push hl
push bc
ld a, SPRITE_ANIM_INDEX_1C
ld a, SPRITE_ANIM_INDEX_EGG_HATCH
call _InitSpriteAnimStruct
ld hl, SPRITEANIMSTRUCT_TILE_ID

View File

@@ -773,7 +773,7 @@ IntroScene7: ; e4b3f (39:4b3f)
call Intro_ResetLYOverrides
callba ClearSpriteAnims
depixel 13, 27, 4, 0
ld a, SPRITE_ANIM_INDEX_26
ld a, SPRITE_ANIM_INDEX_INTRO_SUICUNE
call _InitSpriteAnimStruct
ld a, $f0
ld [wGlobalAnimXOffset], a
@@ -866,7 +866,7 @@ IntroScene10: ; e4c4f (39:4c4f)
.pichu
depixel 21, 16, 1, 0
ld a, SPRITE_ANIM_INDEX_27
ld a, SPRITE_ANIM_INDEX_INTRO_PICHU
call _InitSpriteAnimStruct
ld de, SFX_INTRO_PICHU
call PlaySFX
@@ -874,7 +874,7 @@ IntroScene10: ; e4c4f (39:4c4f)
.wooper
depixel 22, 6
ld a, SPRITE_ANIM_INDEX_28
ld a, SPRITE_ANIM_INDEX_INTRO_WOOPER
call _InitSpriteAnimStruct
ld de, SFX_INTRO_PICHU
call PlaySFX
@@ -1054,7 +1054,7 @@ IntroScene13: ; e4d6d (39:4d6d)
ld [hWY], a
callba ClearSpriteAnims
depixel 13, 11, 4, 0
ld a, SPRITE_ANIM_INDEX_26
ld a, SPRITE_ANIM_INDEX_INTRO_SUICUNE
call _InitSpriteAnimStruct
ld de, MUSIC_CRYSTAL_OPENING
call PlayMusic
@@ -1165,10 +1165,10 @@ IntroScene15: ; e4e40 (39:4e40)
callba ClearSpriteAnims
call Intro_SetCGBPalUpdate
depixel 8, 5
ld a, SPRITE_ANIM_INDEX_2A
ld a, SPRITE_ANIM_INDEX_INTRO_UNOWN_F
call _InitSpriteAnimStruct
depixel 12, 0
ld a, SPRITE_ANIM_INDEX_2B
ld a, SPRITE_ANIM_INDEX_INTRO_SUICUNE_AWAY
call _InitSpriteAnimStruct
xor a
ld [wIntroSceneFrameCounter], a
@@ -1317,7 +1317,7 @@ IntroScene19: ; e4f7e (39:4f7e)
ld [hl], $7f
call Intro_SetCGBPalUpdate
depixel 12, 0
ld a, SPRITE_ANIM_INDEX_2B
ld a, SPRITE_ANIM_INDEX_INTRO_SUICUNE_AWAY
call _InitSpriteAnimStruct
xor a
ld [wIntroSceneFrameCounter], a
@@ -1617,7 +1617,7 @@ Intro_Scene24_ApplyPaletteFade: ; e5172 (39:5172)
CrystalIntro_InitUnownAnim: ; e51dc (39:51dc)
push de
ld a, SPRITE_ANIM_INDEX_29
ld a, SPRITE_ANIM_INDEX_INTRO_UNOWN
call _InitSpriteAnimStruct
ld hl, SPRITEANIMSTRUCT_0C
add hl, bc
@@ -1627,7 +1627,7 @@ CrystalIntro_InitUnownAnim: ; e51dc (39:51dc)
pop de
push de
ld a, SPRITE_ANIM_INDEX_29
ld a, SPRITE_ANIM_INDEX_INTRO_UNOWN
call _InitSpriteAnimStruct
ld hl, SPRITEANIMSTRUCT_0C
add hl, bc
@@ -1637,7 +1637,7 @@ CrystalIntro_InitUnownAnim: ; e51dc (39:51dc)
pop de
push de
ld a, SPRITE_ANIM_INDEX_29
ld a, SPRITE_ANIM_INDEX_INTRO_UNOWN
call _InitSpriteAnimStruct
ld hl, SPRITEANIMSTRUCT_0C
add hl, bc
@@ -1646,7 +1646,7 @@ CrystalIntro_InitUnownAnim: ; e51dc (39:51dc)
call ReinitSpriteAnimFrame
pop de
ld a, SPRITE_ANIM_INDEX_29
ld a, SPRITE_ANIM_INDEX_INTRO_UNOWN
call _InitSpriteAnimStruct
ld hl, SPRITEANIMSTRUCT_0C
add hl, bc

View File

@@ -109,7 +109,7 @@ endr
.spawn_object
depixel 6, 3, 4, 4
ld a, SPRITE_ANIM_INDEX_COMPOSE_MAIL_CURSOR
ld a, SPRITE_ANIM_INDEX_DUMMY_GAME
call _InitSpriteAnimStruct
ld a, 5
ld [wDummyGameNumberTriesRemaining], a

View File

@@ -208,7 +208,7 @@ ENDM
engine_flag WeeklyFlags, 6 ; move tutor
engine_flag WeeklyFlags, 7 ; buenas password
engine_flag SwarmFlags, 0 ; $60
engine_flag SwarmFlags, 0 ; buenas password 2
engine_flag SwarmFlags, 1 ; goldenrod dept store sale is on
engine_flag GameTimerPause, 7 ; $62

View File

@@ -316,7 +316,7 @@ EvolutionAnimation: ; 4e5e1
.GenerateBallOfLight: ; 4e7e8
push de
depixel 9, 11
ld a, SPRITE_ANIM_INDEX_13
ld a, SPRITE_ANIM_INDEX_EVOLUTION_BALL_OF_LIGHT
call _InitSpriteAnimStruct
ld hl, SPRITEANIMSTRUCT_JUMPTABLE_INDEX
add hl, bc

View File

@@ -1,4 +1,5 @@
Facings: ; 4049
; entries correspond to FACING_* constants
dw FacingStepDown0
dw FacingStepDown1
dw FacingStepDown2
@@ -31,7 +32,8 @@ Facings: ; 4049
dw FacingBoulderDust2
dw FacingGrass1
dw FacingGrass2
FacingsEnd: dw 0
FacingsEnd:
dw 0
NUM_FACINGS EQU (FacingsEnd - Facings) / 2
@@ -41,12 +43,6 @@ NUM_FACINGS EQU (FacingsEnd - Facings) / 2
; Format:
; db y, x, attributes, tile index
; Attributes:
X_FLIP EQU 1 << OAM_X_FLIP
Y_FLIP EQU 1 << OAM_Y_FLIP
BEHIND_BG EQU 1 << OAM_PRIORITY
FacingStepDown0:
FacingStepDown2:
FacingWeirdTree0:

View File

@@ -1143,7 +1143,7 @@ TimeCapsule_ReplaceTeruSama: ; 28771
db ITEM_BE, BERRY
db ITEM_C3, BERRY
db ITEM_DC, BERRY
db HM_08, BERRY
db ITEM_FA, BERRY
db -1, BERRY
db 0
; 2879e

View File

@@ -1,36 +1,22 @@
ld hl, OBJECT_ACTION
add hl, bc
ld a, [hl]
ld l, a
ld h, 0
add hl, hl
add hl, hl
add hl, de
ld a, [hli]
ld h, [hl]
ld l, a
call _hl_
ret
; 445f
Pointers445f: ; 445f
dw SetFacingStanding, SetFacingStanding ; 00
dw SetFacingStandAction, SetFacingCurrent ; 01 standing?
dw SetFacingStepAction, SetFacingCurrent ; 02 walking?
dw SetFacingBumpAction, SetFacingCurrent ; 03 bumping?
dw SetFacingCounterclockwiseSpin, SetFacingCurrent ; 04
dw SetFacingCounterclockwiseSpin2, SetFacingStanding ; 05
dw SetFacingFish, SetFacingFish ; 06
dw SetFacingShadow, SetFacingStanding ; 07
dw SetFacingEmote, SetFacingEmote ; 08
dw SetFacingBigDollSym, SetFacingBigDollSym ; 09
dw SetFacingBounce, SetFacingFreezeBounce ; 0a
dw SetFacingWeirdTree, SetFacingCurrent ; 0b
dw SetFacingBigDollAsym, SetFacingBigDollAsym ; 0c
dw SetFacingBigDoll, SetFacingBigDoll ; 0d
dw SetFacingBoulderDust, SetFacingStanding ; 0e
dw SetFacingGrassShake, SetFacingStanding ; 0f
dw SetFacingSkyfall, SetFacingCurrent ; 10
PersonActionPairPointers: ; 445f
; entries correspond to PERSON_ACTION_* constants
dw SetFacingStanding, SetFacingStanding
dw SetFacingStandAction, SetFacingCurrent
dw SetFacingStepAction, SetFacingCurrent
dw SetFacingBumpAction, SetFacingCurrent
dw SetFacingCounterclockwiseSpin, SetFacingCurrent
dw SetFacingCounterclockwiseSpin2, SetFacingStanding
dw SetFacingFish, SetFacingFish
dw SetFacingShadow, SetFacingStanding
dw SetFacingEmote, SetFacingEmote
dw SetFacingBigDollSym, SetFacingBigDollSym
dw SetFacingBounce, SetFacingFreezeBounce
dw SetFacingWeirdTree, SetFacingCurrent
dw SetFacingBigDollAsym, SetFacingBigDollAsym
dw SetFacingBigDoll, SetFacingBigDoll
dw SetFacingBoulderDust, SetFacingStanding
dw SetFacingGrassShake, SetFacingStanding
dw SetFacingSkyfall, SetFacingCurrent
; 44a3
SetFacingStanding: ; 44a3

View File

@@ -155,8 +155,8 @@ Function437b: ; 437b
jr nz, SetFacingStanding
bit 5, [hl]
jr nz, asm_4448
ld de, Pointers445f ; use first column
jr asm_444d
ld de, PersonActionPairPointers ; use first column
jr _HandleObjectAction
; 4440
Function4440: ; 4440
@@ -164,13 +164,28 @@ Function4440: ; 4440
add hl, bc
bit INVISIBLE, [hl]
jr nz, SetFacingStanding
asm_4448 ; use second column
ld de, Pointers445f + 2
jr asm_444d
asm_4448
ld de, PersonActionPairPointers + 2 ; use second column
jr _HandleObjectAction
; 444d
asm_444d
_HandleObjectAction
; call [4 * ObjectStructs[ObjInd, OBJECT_ACTION] + de]
ld hl, OBJECT_ACTION
add hl, bc
ld a, [hl]
ld l, a
ld h, 0
add hl, hl
add hl, hl
add hl, de
ld a, [hli]
ld h, [hl]
ld l, a
call _hl_
ret
; 445f
INCLUDE "engine/map_object_action.asm"
CopyNextCoordsTileToStandingCoordsTile: ; 4600
@@ -535,6 +550,7 @@ MapObjectMovementPattern: ; 47dd
ret
.Pointers: ; 47e9
; entries correspond to SPRITEMOVEFN_* constants
dw .Null_00 ; 00
dw .RandomWalkY ; 01
dw .RandomWalkX ; 02
@@ -1085,7 +1101,7 @@ SetRandomStepDuration: ; 4b2d
; 4b45
StepTypesJumptable: ; 4b45
; These pointers use OBJECT_STEP_TYPE. See constants/sprite_constants.asm
; entries correspond to STEP_TYPE_* constants
dw ObjectMovementReset ; 00
dw MapObjectMovementPattern ; unused
dw NPCStep ; 02 npc walk

View File

@@ -178,7 +178,7 @@ InitPartyMenuIcon: ; 8e908 (23:6908)
; x coord
ld e, $10
; type is partymon icon
ld a, SPRITE_ANIM_INDEX_00
ld a, SPRITE_ANIM_INDEX_PARTY_MON
call InitSpriteAnimStruct
pop af
ld hl, SPRITEANIMSTRUCT_TILE_ID
@@ -215,7 +215,9 @@ SetPartyMonIconAnimSpeed: ; 8e936 (23:6936)
; 8e95e (23:695e)
.speeds ; 8e95e
db $00, $40, $80
db $00 ; HP_GREEN
db $40 ; HP_YELLOW
db $80 ; HP_RED
; 8e961
NamingScreen_InitAnimatedMonIcon: ; 8e961 (23:6961)
@@ -225,7 +227,7 @@ NamingScreen_InitAnimatedMonIcon: ; 8e961 (23:6961)
xor a
call GetIconGFX
depixel 4, 4, 4, 0
ld a, SPRITE_ANIM_INDEX_00
ld a, SPRITE_ANIM_INDEX_PARTY_MON
call InitSpriteAnimStruct
ld hl, SPRITEANIMSTRUCT_ANIM_SEQ_ID
add hl, bc
@@ -240,7 +242,7 @@ MoveList_InitAnimatedMonIcon: ; 8e97d (23:697d)
call GetIconGFX
ld d, 3 * 8 + 2
ld e, 4 * 8 + 4
ld a, SPRITE_ANIM_INDEX_00
ld a, SPRITE_ANIM_INDEX_PARTY_MON
call InitSpriteAnimStruct
ld hl, SPRITEANIMSTRUCT_ANIM_SEQ_ID
add hl, bc
@@ -376,7 +378,7 @@ FreezeMonIcons: ; 8ea4a
jr .ok
.loadwithtwo
ld a, SPRITE_ANIM_SEQ_02
ld a, SPRITE_ANIM_SEQ_PARTY_MON_SWITCH
.ok
push hl
@@ -407,7 +409,7 @@ UnfreezeMonIcons: ; 8ea71
ld b, h
ld hl, SPRITEANIMSTRUCT_ANIM_SEQ_ID
add hl, bc
ld [hl], SPRITE_ANIM_SEQ_01
ld [hl], SPRITE_ANIM_SEQ_PARTY_MON
pop hl
.next
ld bc, $10
@@ -428,11 +430,11 @@ HoldSwitchmonIcon: ; 8ea8c
jr z, .next
cp d
jr z, .is_switchmon
ld a, SPRITE_ANIM_SEQ_03
ld a, SPRITE_ANIM_SEQ_PARTY_MON_SELECTED
jr .join_back
.is_switchmon
ld a, SPRITE_ANIM_SEQ_02
ld a, SPRITE_ANIM_SEQ_PARTY_MON_SWITCH
.join_back
push hl
ld c, l

View File

@@ -9,8 +9,7 @@ MonMenuOptionStrings: ; 24caf
; 24cd9
MonMenuOptions: ; 24cd9
; Moves
; moves
db MONMENU_FIELD_MOVE, MONMENU_CUT, CUT
db MONMENU_FIELD_MOVE, MONMENU_FLY, FLY
db MONMENU_FIELD_MOVE, MONMENU_SURF, SURF
@@ -25,8 +24,7 @@ MonMenuOptions: ; 24cd9
db MONMENU_FIELD_MOVE, MONMENU_ROCKSMASH, ROCK_SMASH
db MONMENU_FIELD_MOVE, MONMENU_MILKDRINK, MILK_DRINK
db MONMENU_FIELD_MOVE, MONMENU_SWEETSCENT, SWEET_SCENT
; Options
; options
db MONMENU_MENUOPTION, MONMENU_STATS, 1 ; STATS
db MONMENU_MENUOPTION, MONMENU_SWITCH, 2 ; SWITCH
db MONMENU_MENUOPTION, MONMENU_ITEM, 3 ; ITEM
@@ -34,7 +32,6 @@ MonMenuOptions: ; 24cd9
db MONMENU_MENUOPTION, MONMENU_MOVE, 5 ; MOVE
db MONMENU_MENUOPTION, MONMENU_MAIL, 6 ; MAIL
db MONMENU_MENUOPTION, MONMENU_ERROR, 7 ; ERROR!
db -1
; 24d19
@@ -216,7 +213,7 @@ GetMonSubmenuItems: ; 24dd4
.skip2
ld a, [Buffer1]
cp NUM_MON_SUBMENU_ITEMS
cp NUM_MONMENU_ITEMS
jr z, .ok2
ld a, MONMENU_CANCEL
call AddMonMenuItem
@@ -261,7 +258,7 @@ ResetMonSubmenu: ; 24e68
xor a
ld [Buffer1], a
ld hl, Buffer2
ld bc, NUM_MON_SUBMENU_ITEMS + 1
ld bc, NUM_MONMENU_ITEMS + 1
call ByteFill
ret
; 24e76

View File

@@ -1543,7 +1543,7 @@ CalcPkmnStatC: ; e17b
call Divide
ld a, c
cp STAT_HP
ld a, 5
ld a, STAT_MIN_NORMAL
jr nz, .not_hp
ld a, [CurPartyLevel]
ld b, a
@@ -1556,7 +1556,7 @@ CalcPkmnStatC: ; e17b
ld [hMultiplicand + 1], a
.no_overflow_3
ld a, 10
ld a, STAT_MIN_HP
.not_hp
ld b, a

View File

@@ -419,7 +419,7 @@ NamingScreenJoypadLoop: ; 11915
jr nz, .got_cursor_position
ld d, 8 * 8
.got_cursor_position
ld a, SPRITE_ANIM_INDEX_02
ld a, SPRITE_ANIM_INDEX_NAMING_SCREEN_CURSOR
call _InitSpriteAnimStruct
ld a, c
ld [wNamingScreenCursorObjectPointer], a
@@ -1039,7 +1039,7 @@ _ComposeMailMessage: ; 11e75 (mail?)
; init mail icon
depixel 3, 2
ld a, SPRITE_ANIM_INDEX_00
ld a, SPRITE_ANIM_INDEX_PARTY_MON
call _InitSpriteAnimStruct
ld hl, SPRITEANIMSTRUCT_ANIM_SEQ_ID
@@ -1174,7 +1174,7 @@ INCBIN "gfx/icon/mail2.2bpp"
.init_blinking_cursor ; 1201b (4:601b)
depixel 9, 2
ld a, SPRITE_ANIM_INDEX_09
ld a, SPRITE_ANIM_INDEX_COMPOSE_MAIL_CURSOR
call _InitSpriteAnimStruct
ld a, c
ld [wNamingScreenCursorObjectPointer], a

View File

@@ -181,7 +181,7 @@ MapCallbackSprites_LoadUsedSpritesGFX: ; 14209
callba LoadEmote
call GetMapPermission
call CheckOutdoorMap
ld c, EMOTE_0B
ld c, EMOTE_GRASS_RUSTLE
jr z, .outdoor
ld c, EMOTE_BOULDER_DUST
.outdoor
@@ -723,10 +723,7 @@ emote_header: MACRO
ENDM
EmotesPointers: ; 144d
; dw source address
; db length, bank
; dw dest address
; graphics address, length, starting tile
emote_header ShockEmote, 4, $78
emote_header QuestionEmote, 4, $78
emote_header HappyEmote, 4, $78

View File

@@ -769,7 +769,7 @@ phone: MACRO
db \6
dba \7 ; script 2
ENDM
; entries correspond to PHONE_* constants
phone TRAINER_NONE, PHONE_00, N_A, 0, UnusedPhoneScript, 0, UnusedPhoneScript
phone TRAINER_NONE, PHONECONTACT_MOM, KRISS_HOUSE_1F, 7, MomPhoneScript, 0, UnusedPhoneScript
phone TRAINER_NONE, PHONECONTACT_BIKESHOP, OAKS_LAB, 0, UnusedPhoneScript, 0, UnusedPhoneScript

View File

@@ -751,7 +751,7 @@ TownMap_GetKantoLandmarkLimits: ; 910e8
PokegearRadio_Init: ; 910f9 (24:50f9)
call InitPokegearTilemap
depixel 4, 10, 4, 4
ld a, SPRITE_ANIM_INDEX_14
ld a, SPRITE_ANIM_INDEX_RADIO_TUNING_KNOB
call _InitSpriteAnimStruct
ld hl, SPRITEANIMSTRUCT_TILE_ID
add hl, bc
@@ -2910,7 +2910,7 @@ TownMapMon: ; 91f7b
callba GetSpeciesIcon
; Animation/palette
depixel 0, 0
ld a, SPRITE_ANIM_INDEX_00
ld a, SPRITE_ANIM_INDEX_PARTY_MON
call _InitSpriteAnimStruct
ld hl, SPRITEANIMSTRUCT_TILE_ID
add hl, bc

View File

@@ -234,7 +234,7 @@ OaksPkmnTalk4:
jr z, .done
.next
dec hl
ld de, WILDMON_GRASS_STRUCTURE_LENGTH
ld de, GRASS_WILDDATA_LENGTH
add hl, de
jr .loop
@@ -249,12 +249,12 @@ endr
cp 3
jr z, .loop2
ld bc, 2 * NUM_WILDMONS_PER_AREA_TIME_OF_DAY
ld bc, 2 * NUM_GRASSMON
call AddNTimes
.loop3
; Choose one of the middle three Pokemon.
call Random
and NUM_WILDMONS_PER_AREA_TIME_OF_DAY
and NUM_GRASSMON
cp 2
jr c, .loop3
cp 5

View File

@@ -979,7 +979,7 @@ Script_cry:
ret
GetScriptPerson:
and a
and a ; PLAYER?
ret z
cp LAST_TALKED
ret z
@@ -2170,7 +2170,7 @@ Script_givepokeitem:
ld b, a
push bc
inc hl
ld bc, MAIL_MAX_LENGTH
ld bc, MAIL_MSG_LENGTH
ld de, wd002
ld a, [ScriptBank]
call FarCopyBytes
@@ -2955,9 +2955,9 @@ ExitScriptSubroutine:
ld e, [hl]
ld d, $0
ld hl, wScriptStack
add hl,de
add hl,de
add hl,de
add hl, de
add hl, de
add hl, de
ld a, [hli]
ld b, a
and " "

View File

@@ -1067,7 +1067,7 @@ ReelAction_InitGolem: ; 92d20
push bc
push af
depixel 12, 13
ld a, SPRITE_ANIM_INDEX_SLOT_GOLEM
ld a, SPRITE_ANIM_INDEX_SLOTS_GOLEM
call _InitSpriteAnimStruct
ld hl, SPRITEANIMSTRUCT_0E
add hl, bc

View File

@@ -50,9 +50,8 @@ LoadSpawnPoint: ; 1531f
jr z, .spawn_n_a
ld l, a
ld h, 0
rept 2 ; multiply hl by 4
add hl,hl
endr
add hl, hl
add hl, hl
ld de, SpawnPoints
add hl, de
ld a, [hli]

Some files were not shown because too many files have changed in this diff Show More