diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/bugs_and_glitches.md | 266 | ||||
| -rw-r--r-- | docs/design_flaws.md | 428 |
2 files changed, 468 insertions, 226 deletions
diff --git a/docs/bugs_and_glitches.md b/docs/bugs_and_glitches.md index d79f386a8..61fc4d63c 100644 --- a/docs/bugs_and_glitches.md +++ b/docs/bugs_and_glitches.md @@ -164,12 +164,12 @@ BattleCommand_BellyDrum: ; 37c1a ; before checking that it has enough HP to use the move. ; Swap the order of these two blocks to fix. call BattleCommand_AttackUp2 - ld a, [AttackMissed] + ld a, [wAttackMissed] and a jr nz, .failed - callab GetHalfMaxHP - callab CheckUserHasEnoughHP + callfar GetHalfMaxHP + callfar CheckUserHasEnoughHP jr nc, .failed ``` @@ -178,12 +178,12 @@ BattleCommand_BellyDrum: ; 37c1a ```asm BattleCommand_BellyDrum: ; 37c1a ; bellydrum - callab GetHalfMaxHP - callab CheckUserHasEnoughHP + callfar GetHalfMaxHP + callfar CheckUserHasEnoughHP jr nc, .failed call BattleCommand_AttackUp2 - ld a, [AttackMissed] + ld a, [wAttackMissed] and a jr nz, .failed ``` @@ -256,8 +256,7 @@ This is a bug with `CheckPlayerHasUsableMoves` in [engine/battle/core.asm](/engi ```asm .done ; Bug: this will result in a move with PP Up confusing the game. - ; Replace with "and $3f" to fix. - and a + and a ; should be "and PP_MASK" ret nz .force_struggle @@ -269,7 +268,7 @@ This is a bug with `CheckPlayerHasUsableMoves` in [engine/battle/core.asm](/engi ret ``` -**Fix:** Change `and a` to `and $3f`. +**Fix:** Change `and a` to `and PP_MASK`. ## A Pokémon that fainted from Pursuit will have its old status condition when revived @@ -312,7 +311,7 @@ This is a bug with `BattleCommand_BeatUp` in [engine/battle/move_effects/beat_up ```asm .got_mon ld a, [wd002] - ld hl, PartyMonNicknames + ld hl, wPartyMonNicknames call GetNick ld a, MON_HP call GetBeatupMonLocation @@ -321,11 +320,11 @@ This is a bug with `BattleCommand_BeatUp` in [engine/battle/move_effects/beat_up jp z, .beatup_fail ; fainted ld a, [wd002] ld c, a - ld a, [CurBattleMon] + ld a, [wCurBattleMon] ; BUG: this can desynchronize link battles ; Change "cp [hl]" to "cp c" to fix cp [hl] - ld hl, BattleMonStatus + ld hl, wBattleMonStatus jr z, .active_mon ld a, MON_STATUS call GetBeatupMonLocation @@ -391,13 +390,13 @@ This is a bug with `AI_Smart_MeanLook` in [engine/battle/ai/scoring.asm](/engine ```asm ; 80% chance to greatly encourage this move if the enemy is badly poisoned (buggy). -; Should check PlayerSubStatus5 instead. - ld a, [EnemySubStatus5] +; Should check wPlayerSubStatus5 instead. + ld a, [wEnemySubStatus5] bit SUBSTATUS_TOXIC, a jr nz, .asm_38e26 ``` -**Fix:** Change `EnemySubStatus5` to `PlayerSubStatus5`. +**Fix:** Change `wEnemySubStatus5` to `wPlayerSubStatus5`. ## AI makes a false assumption about `CheckTypeMatchup` @@ -406,11 +405,11 @@ In [engine/battle/effect_commands.asm](/engine/battle/effect_commands.asm): ```asm BattleCheckTypeMatchup: ; 347c8 - ld hl, EnemyMonType1 + ld hl, wEnemyMonType1 ld a, [hBattleTurn] and a jr z, CheckTypeMatchup - ld hl, BattleMonType1 + ld hl, wBattleMonType1 CheckTypeMatchup: ; 347d3 ; There is an incorrect assumption about this function made in the AI related code: when ; the AI calls CheckTypeMatchup (not BattleCheckTypeMatchup), it assumes that placing the @@ -437,24 +436,24 @@ This is a bug with `AI_HealStatus` in [engine/battle/ai/items.asm](/engine/battl ```asm AI_HealStatus: ; 384e0 - ld a, [CurOTMon] - ld hl, OTPartyMon1Status + ld a, [wCurOTMon] + ld hl, wOTPartyMon1Status ld bc, PARTYMON_STRUCT_LENGTH call AddNTimes xor a ld [hl], a - ld [EnemyMonStatus], a + ld [wEnemyMonStatus], a ; Bug: this should reset SUBSTATUS_NIGHTMARE too ; Uncomment the lines below to fix - ; ld hl, EnemySubStatus1 + ; ld hl, wEnemySubStatus1 ; res SUBSTATUS_NIGHTMARE, [hl] - ld hl, EnemySubStatus5 + ld hl, wEnemySubStatus5 res SUBSTATUS_TOXIC, [hl] ret ; 384f7 ``` -**Fix:** Uncomment `ld hl, EnemySubStatus1` and `res SUBSTATUS_NIGHTMARE, [hl]`. +**Fix:** Uncomment `ld hl, wEnemySubStatus1` and `res SUBSTATUS_NIGHTMARE, [hl]`. ## HP bar animation is slow for high HP @@ -493,11 +492,12 @@ This is a bug with `ShortHPBar_CalcPixelFrame` in [engine/anim_hp_bar.asm](/engi ```asm ld b, 0 -; This routine is buggy. If [wCurHPAnimMaxHP] * [wCurHPBarPixels] is divisible -; by 48, the loop runs one extra time. To fix, uncomment the line below. +; This routine is buggy. If [wCurHPAnimMaxHP] * [wCurHPBarPixels] is +; divisible by HP_BAR_LENGTH_PX, the loop runs one extra time. +; To fix, uncomment the line below. .loop ld a, l - sub 6 * 8 + sub HP_BAR_LENGTH_PX ld l, a ld a, h sbc $0 @@ -517,12 +517,12 @@ This is a bug with `ShortHPBar_CalcPixelFrame` in [engine/anim_hp_bar.asm](/engi This can bring Pokémon straight from level 1 to 100 by gaining just a few experience points. -This is a bug with `CalcExpAtLevel` in [main.asm](/main.asm): +This is a bug with `CalcExpAtLevel` in [engine/experience.asm](/engine/experience.asm): ```asm CalcExpAtLevel: ; 50e47 ; (a/b)*n**3 + c*n**2 + d*n - e - ld a, [BaseGrowthRate] + ld a, [wBaseGrowthRate] add a add a ld c, a @@ -549,7 +549,7 @@ CalcExpAtLevel: ; 50e47 ret .UseExpFormula - ld a, [BaseGrowthRate] + ld a, [wBaseGrowthRate] add a add a ld c, a @@ -563,45 +563,44 @@ CalcExpAtLevel: ; 50e47 ([Video](https://www.youtube.com/watch?v=o54VjpAEoO8)) -This is a bug with `Text_ABoostedStringBuffer2ExpPoints` and `Text_StringBuffer2ExpPoints` in [text/common_2.asm](/text/common_2.asm): +This is a bug with `Text_ABoostedStringBuffer2ExpPoints` and `Text_StringBuffer2ExpPoints` in [data/text/common_2.asm](/data/text/common_2.asm): ```asm Text_ABoostedStringBuffer2ExpPoints:: text_start line "a boosted" cont "@" - deciram StringBuffer2, 2, 4 + deciram wStringBuffer2, 2, 4 text " EXP. Points!" prompt Text_StringBuffer2ExpPoints:: text_start line "@" - deciram StringBuffer2, 2, 4 + deciram wStringBuffer2, 2, 4 text " EXP. Points!" prompt ``` -**Fix:** Change both `deciram StringBuffer2, 2, 4` to `deciram StringBuffer2, 2, 5`. +**Fix:** Change both `deciram wStringBuffer2, 2, 4` to `deciram wStringBuffer2, 2, 5`. ## BRN/PSN/PAR do not affect catch rate -This is a bug with `PokeBall` in [items/item_effects.asm](/items/item_effects.asm): +This is a bug with `PokeBall` in [engine/item_effects.asm](/engine/item_effects.asm): ```asm -.statuscheck ; This routine is buggy. It was intended that SLP and FRZ provide a higher ; catch rate than BRN/PSN/PAR, which in turn provide a higher catch rate than ; no status effect at all. But instead, it makes BRN/PSN/PAR provide no ; benefit. ; Uncomment the line below to fix this. ld b, a - ld a, [EnemyMonStatus] + ld a, [wEnemyMonStatus] and 1 << FRZ | SLP ld c, 10 jr nz, .addstatus - ; ld a, [EnemyMonStatus] + ; ld a, [wEnemyMonStatus] and a ld c, 5 jr nz, .addstatus @@ -614,7 +613,7 @@ This is a bug with `PokeBall` in [items/item_effects.asm](/items/item_effects.as .max_1 ``` -**Fix:** Uncomment `ld a, [EnemyMonStatus]`. +**Fix:** Uncomment `ld a, [wEnemyMonStatus]`. ## Moon Ball does not boost catch rate @@ -695,7 +694,7 @@ FastBallMultiplier: *Fixing this bug will break compatibility with standard Pokémon Crystal for link battles.* -This is a bug with `ItemAttributes` in [items/attributes.asm](/items/attributes.asm): +This is a bug with `ItemAttributes` in [data/items/attributes.asm](/data/items/attributes.asm): ```asm ; DRAGON FANG @@ -733,7 +732,7 @@ This is a bug with `HaircutOrGrooming` in [engine/events/special.asm](/engine/ev .ok inc hl ld a, [hli] - ld [ScriptVar], a + ld [wScriptVar], a ld c, [hl] call ChangeHappiness ret @@ -743,8 +742,8 @@ This is a bug with `HaircutOrGrooming` in [engine/events/special.asm](/engine/ev INCLUDE "data/events/happiness_chances.asm" CopyPokemonName_Buffer1_Buffer3: ; 746e - ld hl, StringBuffer1 - ld de, StringBuffer3 + ld hl, wStringBuffer1 + ld de, wStringBuffer3 ld bc, MON_NAME_LENGTH jp CopyBytes ``` @@ -771,19 +770,23 @@ This is a bug with `LoadEnemyMon.CheckMagikarpArea` in [engine/battle/core.asm]( ```asm .CheckMagikarpArea: -; The z checks are supposed to be nz -; Instead, all maps in GROUP_LAKE_OF_RAGE (mahogany area) -; and routes 20 and 44 are treated as Lake of Rage +; The "jr z" checks are supposed to be "jr nz". + +; Instead, all maps in GROUP_LAKE_OF_RAGE (Mahogany area) +; and Routes 20 and 44 are treated as Lake of Rage. ; This also means Lake of Rage Magikarp can be smaller than ones -; caught elsewhere rather than the other way around +; caught elsewhere rather than the other way around. + +; Intended behavior enforces a minimum size at Lake of Rage. +; The real behavior prevents a minimum size in the Lake of Rage area. -; Intended behavior enforces a minimum size at Lake of Rage -; The real behavior prevents size flooring in the Lake of Rage area - ld a, [MapGroup] +; Moreover, due to the check not being translated to feet+inches, all Magikarp +; smaller than 4'0" may be caught by the filter, a lot more than intended. + ld a, [wMapGroup] cp GROUP_LAKE_OF_RAGE jr z, .Happiness - ld a, [MapNumber] + ld a, [wMapNumber] cp MAP_LAKE_OF_RAGE jr z, .Happiness ``` @@ -797,31 +800,31 @@ This is a bug with `LoadEnemyMon.CheckMagikarpArea` in [engine/battle/core.asm]( ```asm ; Get Magikarp's length - ld de, EnemyMonDVs - ld bc, PlayerID + ld de, wEnemyMonDVs + ld bc, wPlayerID callfar CalcMagikarpLength -; No reason to keep going if length > 1536 (i.e. if length / 256 != 6) +; No reason to keep going if length > 1536 mm (i.e. if HIGH(length) > 6 feet) ld a, [wMagikarpLength] - cp HIGH(1536) ; this compares to 6'0'', should be cp 5 + cp HIGH(1536) ; should be "cp 5", since 1536 mm = 5'0", but HIGH(1536) = 6 jr nz, .CheckMagikarpArea ; 5% chance of skipping both size checks call Random cp 5 percent jr c, .CheckMagikarpArea -; Try again if length > 1615 +; Try again if length >= 1616 mm (i.e. if LOW(length) >= 3 inches) ld a, [wMagikarpLength + 1] - cp LOW(1616) ; this compares to 6'80'', should be cp 3 + cp LOW(1616) ; should be "cp 3", since 1616 mm = 5'3", but LOW(1616) = 80 jr nc, .GenerateDVs ; 20% chance of skipping this check call Random cp 20 percent - 1 jr c, .CheckMagikarpArea -; Try again if length > 1599 +; Try again if length >= 1600 mm (i.e. if LOW(length) >= 2 inches) ld a, [wMagikarpLength + 1] - cp LOW(1600) ; this compares to 6'64'', should be cp 2 + cp LOW(1600) ; should be "cp 2", since 1600 mm = 5'2", but LOW(1600) = 64 jr nc, .GenerateDVs ``` @@ -853,18 +856,18 @@ This is a bug with `CalcMagikarpLength.BCLessThanDE` in [engine/events/magikarp. ([Video](https://www.youtube.com/watch?v=eij_1060SMc)) -This is a bug with `StartTrainerBattle_DetermineWhichAnimation` in [engine/battle_start.asm](/engine/battle_start.asm): +This is a bug with `StartTrainerBattle_DetermineWhichAnimation` in [engine/battle/battle_transition.asm](/engine/battle/battle_transition.asm): ```asm StartTrainerBattle_DetermineWhichAnimation: ; 8c365 (23:4365) ; The screen flashes a different number of times depending on the level of ; your lead Pokemon relative to the opponent's. -; BUG: BattleMonLevel and EnemyMonLevel are not set at this point, so whatever +; BUG: wBattleMonLevel and wEnemyMonLevel are not set at this point, so whatever ; values happen to be there will determine the animation. ld de, 0 - ld a, [BattleMonLevel] + ld a, [wBattleMonLevel] add 3 - ld hl, EnemyMonLevel + ld hl, wEnemyMonLevel cp [hl] jr nc, .okay set 0, e @@ -905,7 +908,7 @@ This is a bug with `Slots_PayoutAnim` in [engine/slot_machine.asm](/engine/slot_ ld [hl], e dec hl ld [hl], d - ld a, [wcf64] + ld a, [wSlotsDelay] and $7 ret z ; ret nz would be more appropriate ld de, SFX_GET_COIN_FROM_SLOTS @@ -918,10 +921,10 @@ This is a bug with `Slots_PayoutAnim` in [engine/slot_machine.asm](/engine/slot_ ## Team Rocket battle music is not used for Executives or Scientists -This is a bug with `PlayBattleMusic` in [main.asm](/main.asm): +This is a bug with `PlayBattleMusic` in [engine/battle/start_battle.asm](/engine/battle/start_battle.asm): ```asm - ; really, they should have included admins and scientists here too... + ; They should have included EXECUTIVEM, EXECUTIVEF, and SCIENTIST too... ld de, MUSIC_ROCKET_BATTLE cp GRUNTM jr z, .done @@ -956,20 +959,20 @@ This is a bug with `DoPlayerMovement.CheckWarp` in [engine/player_movement.asm]( ; This causes wd041 to be nonzero when standing on tile $3e, ; making bumps silent. - ld a, [WalkingDirection] + ld a, [wWalkingDirection] ; cp STANDING ; jr z, .not_warp ld e, a ld d, 0 ld hl, .EdgeWarps add hl, de - ld a, [PlayerStandingTile] + ld a, [wPlayerStandingTile] cp [hl] jr nz, .not_warp ld a, 1 ld [wd041], a - ld a, [WalkingDirection] + ld a, [wWalkingDirection] ; This is in the wrong place. cp STANDING jr z, .not_warp @@ -978,20 +981,20 @@ This is a bug with `DoPlayerMovement.CheckWarp` in [engine/player_movement.asm]( **Fix:** ```asm - ld a, [WalkingDirection] + ld a, [wWalkingDirection] cp STANDING jr z, .not_warp ld e, a ld d, 0 ld hl, .EdgeWarps add hl, de - ld a, [PlayerStandingTile] + ld a, [wPlayerStandingTile] cp [hl] jr nz, .not_warp ld a, 1 ld [wd041], a - ld a, [WalkingDirection] + ld a, [wWalkingDirection] ``` @@ -1051,7 +1054,7 @@ This bug prevents you from using blocksets with more than 128 blocks. In [home/map.asm](/home/map.asm): ```asm - ; Set hl to the address of the current metatile data ([TilesetBlocksAddress] + (a) tiles). + ; Set hl to the address of the current metatile data ([wTilesetBlocksAddress] + (a) tiles). ; This is buggy; it wraps around past 128 blocks. ; To fix, uncomment the line below. add a ; Comment or delete this line to fix the above bug. @@ -1061,10 +1064,10 @@ In [home/map.asm](/home/map.asm): add hl, hl add hl, hl add hl, hl - ld a, [TilesetBlocksAddress] + ld a, [wTilesetBlocksAddress] add l ld l, a - ld a, [TilesetBlocksAddress + 1] + ld a, [wTilesetBlocksAddress + 1] adc h ld h, a ``` @@ -1081,7 +1084,7 @@ In [home/map.asm](/home/map.asm): ## `Function6ec1` does not correctly limit object movement -This bug is why the Lapras in Union Cave, which uses `SPRITEMOVEDATA_SWIM_WANDER`, is not restricted by its `1, 1` movement radius. +This bug is why the Lapras in [maps/UnionCaveB2F.asm](/maps/UnionCaveB2F.asm), which uses `SPRITEMOVEDATA_SWIM_WANDER`, is not restricted by its `1, 1` movement radius. In [engine/npc_movement.asm](/engine/npc_movement.asm): @@ -1108,7 +1111,7 @@ In [engine/search.asm](/engine/search.asm): ; This only checks five characters, which is fine for the Japanese version, ; but in the English version the player name is 7 characters, so this is wrong. - ld hl, PlayerName + ld hl, wPlayerName rept NAME_LENGTH_JAPANESE + -2 ; should be PLAYER_NAME_LENGTH + -2 ld a, [de] @@ -1123,13 +1126,6 @@ endr ld a, [de] cp [hl] jr z, .found - -.notfound - pop de - pop hl - pop bc - and a - ret ``` **Fix:** Change `rept NAME_LENGTH_JAPANESE + -2` to `rept PLAYER_NAME_LENGTH + -2`. @@ -1139,49 +1135,49 @@ endr This bug can affect Mew or Pokémon other than Ditto that used Transform via Mirror Move or Sketch. -This is a bug with `PokeBall` in [items/item_effects.asm](/items/item_effects.asm): +This is a bug with `PokeBall` in [engine/item_effects.asm](/engine/item_effects.asm): ```asm - ld hl, EnemySubStatus5 + ld hl, wEnemySubStatus5 ld a, [hl] push af set SUBSTATUS_TRANSFORMED, [hl] ; This code is buggy. Any wild Pokémon that has Transformed will be ; caught as a Ditto, even if it was something else like Mew. -; To fix, do not set [TempEnemyMonSpecies] to DITTO. +; To fix, do not set [wTempEnemyMonSpecies] to DITTO. bit SUBSTATUS_TRANSFORMED, a jr nz, .ditto jr .not_ditto .ditto ld a, DITTO - ld [TempEnemyMonSpecies], a + ld [wTempEnemyMonSpecies], a jr .load_data .not_ditto set SUBSTATUS_TRANSFORMED, [hl] ld hl, wEnemyBackupDVs - ld a, [EnemyMonDVs] + ld a, [wEnemyMonDVs] ld [hli], a - ld a, [EnemyMonDVs + 1] + ld a, [wEnemyMonDVs + 1] ld [hl], a .load_data - ld a, [TempEnemyMonSpecies] - ld [CurPartySpecies], a - ld a, [EnemyMonLevel] - ld [CurPartyLevel], a - callba LoadEnemyMon + ld a, [wTempEnemyMonSpecies] + ld [wCurPartySpecies], a + ld a, [wEnemyMonLevel] + ld [wCurPartyLevel], a + farcall LoadEnemyMon pop af - ld [EnemySubStatus5], a + ld [wEnemySubStatus5], a ``` **Fix:** ```asm - ld hl, EnemySubStatus5 + ld hl, wEnemySubStatus5 ld a, [hl] push af set SUBSTATUS_TRANSFORMED, [hl] @@ -1190,20 +1186,20 @@ This is a bug with `PokeBall` in [items/item_effects.asm](/items/item_effects.as jr nz, .load_data ld hl, wEnemyBackupDVs - ld a, [EnemyMonDVs] + ld a, [wEnemyMonDVs] ld [hli], a - ld a, [EnemyMonDVs + 1] + ld a, [wEnemyMonDVs + 1] ld [hl], a .load_data - ld a, [TempEnemyMonSpecies] - ld [CurPartySpecies], a - ld a, [EnemyMonLevel] - ld [CurPartyLevel], a - callba LoadEnemyMon + ld a, [wTempEnemyMonSpecies] + ld [wCurPartySpecies], a + ld a, [wEnemyMonLevel] + ld [wCurPartyLevel], a + farcall LoadEnemyMon pop af - ld [EnemySubStatus5], a + ld [wEnemySubStatus5], a ``` @@ -1211,13 +1207,13 @@ This is a bug with `PokeBall` in [items/item_effects.asm](/items/item_effects.as ([Video](https://www.youtube.com/watch?v=v1ErZdLCIyU)) -This is a bug with `ParkBall` in [items/item_effects.asm](/items/item_effects.asm): +This is a bug with `ParkBall` in [engine/item_effects.asm](/engine/item_effects.asm): ```asm .room_in_party xor a ld [wWildMon], a - ld a, [CurItem] + ld a, [wCurItem] cp PARK_BALL call nz, ReturnToBattle_UseBall ``` @@ -1228,7 +1224,7 @@ This is a bug with `ParkBall` in [items/item_effects.asm](/items/item_effects.as .room_in_party xor a ld [wWildMon], a - ld a, [BattleType] + ld a, [wBattleType] cp BATTLETYPE_CONTEST call nz, ReturnToBattle_UseBall ``` @@ -1236,23 +1232,26 @@ This is a bug with `ParkBall` in [items/item_effects.asm](/items/item_effects.as ## `HELD_CATCH_CHANCE` has no effect -This is a bug with `PokeBall` in [items/item_effects.asm](/items/item_effects.asm): +This is a bug with `PokeBall` in [engine/item_effects.asm](/engine/item_effects.asm): ```asm - ; BUG: callba overwrites a, - ; and GetItemHeldEffect takes b anyway. - - ; This is probably the reason - ; the HELD_CATCH_CHANCE effect - ; is never used. - + ; BUG: farcall overwrites a, and GetItemHeldEffect takes b anyway. + ; This is probably the reason the HELD_CATCH_CHANCE effect is never used. ; Uncomment the line below to fix. - - ld a, [BattleMonItem] -; ld b, a - callba GetItemHeldEffect + ld d, a + push de + ld a, [wBattleMonItem] + ; ld b, a + farcall GetItemHeldEffect ld a, b cp HELD_CATCH_CHANCE + pop de + ld a, d + jr nz, .max_2 + add c + jr nc, .max_2 + ld a, $ff +.max_2 ``` **Fix:** Uncomment `ld b, a`. @@ -1264,21 +1263,21 @@ This is a bug with `PlacePartyMonEvoStoneCompatibility.DetermineCompatibility` i ```asm .DetermineCompatibility: ; 50268 - ld de, StringBuffer1 + ld de, wStringBuffer1 ld a, BANK(EvosAttacksPointers) ld bc, 2 call FarCopyBytes - ld hl, StringBuffer1 + ld hl, wStringBuffer1 ld a, [hli] ld h, [hl] ld l, a - ld de, StringBuffer1 + ld de, wStringBuffer1 ld a, BANK(EvosAttacks) ld bc, 10 call FarCopyBytes ``` -**Fix:** Change `ld bc, 10` to `ld bc, StringBuffer2 - StringBuffer1` to support up to six Stone entries. +**Fix:** Change `ld bc, 10` to `ld bc, wStringBuffer2 - wStringBuffer1` to support up to six Stone entries. ## `ScriptCall` can overflow `wScriptStack` and crash @@ -1290,7 +1289,7 @@ ScriptCall: ; Bug: The script stack has a capacity of 5 scripts, yet there is ; nothing to stop you from pushing a sixth script. The high part ; of the script address can then be overwritten by modifications -; to ScriptDelay, causing the script to return to the rst/interrupt +; to wScriptDelay, causing the script to return to the rst/interrupt ; space. push de @@ -1303,18 +1302,18 @@ ScriptCall: add hl, de add hl, de pop de - ld a, [ScriptBank] + ld a, [wScriptBank] ld [hli], a - ld a, [ScriptPos] + ld a, [wScriptPos] ld [hli], a - ld a, [ScriptPos + 1] + ld a, [wScriptPos + 1] ld [hl], a ld a, b - ld [ScriptBank], a + ld [wScriptBank], a ld a, e - ld [ScriptPos], a + ld [wScriptPos], a ld a, d - ld [ScriptPos + 1], a + ld [wScriptPos + 1], a ret ``` @@ -1330,7 +1329,7 @@ LoadSpriteGFX: ; 14306 ; Bug: b is not preserved, so it's useless as a next count. ; Uncomment the lines below to fix. - ld hl, UsedSprites + ld hl, wUsedSprites ld b, SPRITE_GFX_LIST_CAPACITY .loop ld a, [hli] @@ -1365,9 +1364,8 @@ In [engine/wildmons.asm](/engine/wildmons.asm): ```asm ChooseWildEncounter: ; 2a14f ... - ld a, b - ld [CurPartyLevel], a + ld [wCurPartyLevel], a ld b, [hl] ; ld a, b call ValidateTempWildMonSpecies @@ -1387,7 +1385,7 @@ ValidateTempWildMonSpecies: ; 2a4a0 ```asm ld a, b - ld [CurPartyLevel], a + ld [wCurPartyLevel], a ld b, [hl] ld a, b call ValidateTempWildMonSpecies diff --git a/docs/design_flaws.md b/docs/design_flaws.md index 7dc4d13db..613f90b0c 100644 --- a/docs/design_flaws.md +++ b/docs/design_flaws.md @@ -8,8 +8,9 @@ These are parts of the code that do not work *incorrectly*, like [bugs and glitc - [Pic banks are offset by `PICS_FIX`](#pic-banks-are-offset-by-pics_fix) - [`PokemonPicPointers` and `UnownPicPointers` are assumed to start at the same address](#pokemonpicpointers-and-unownpicpointers-are-assumed-to-start-at-the-same-address) - [Footprints are split into top and bottom halves](#footprints-are-split-into-top-and-bottom-halves) -- [Pokédex entry banks are derived from their species IDs](#pokédex-entry-banks-are-derived-from-their-species-ids) - [`ITEM_C3` and `ITEM_DC` break up the continuous sequence of TM items](#item_c3-and-item_dc-break-up-the-continuous-sequence-of-tm-items) +- [Pokédex entry banks are derived from their species IDs](#pokédex-entry-banks-are-derived-from-their-species-ids) +- [Identical sine wave code and data is repeated five times](#identical-sine-wave-code-and-data-is-repeated-five-times) - [`GetForestTreeFrame` works, but it's still bad](#getforesttreeframe-works-but-its-still-bad) @@ -109,15 +110,15 @@ ROMX $49 Two routines in [engine/load_pics.asm](/engine/load_pics.asm) make this assumption; `GetFrontpicPointer`: ```asm - ld a, [CurPartySpecies] + ld a, [wCurPartySpecies] cp UNOWN jr z, .unown - ld a, [CurPartySpecies] + ld a, [wCurPartySpecies] ld d, BANK(PokemonPicPointers) jr .ok .unown - ld a, [UnownLetter] + ld a, [wUnownLetter] ld d, BANK(UnownPicPointers) .ok @@ -130,9 +131,7 @@ Two routines in [engine/load_pics.asm](/engine/load_pics.asm) make this assumpti And `GetMonBackpic`: ```asm - ; These are assumed to be at the same - ; address in their respective banks. - GLOBAL PokemonPicPointers, UnownPicPointers + ; These are assumed to be at the same address in their respective banks. ld hl, PokemonPicPointers ; UnownPicPointers ld a, b ld d, BANK(PokemonPicPointers) @@ -153,16 +152,16 @@ Don't enforce `org $4000` in pokecrystal.link. Modify `GetFrontpicPointer`: ```asm - ld a, [CurPartySpecies] + ld a, [wCurPartySpecies] cp UNOWN jr z, .unown - ld a, [CurPartySpecies] + ld a, [wCurPartySpecies] ld hl, PokemonPicPointers ld d, BANK(PokemonPicPointers) jr .ok .unown - ld a, [UnownLetter] + ld a, [wUnownLetter] ld hl, UnownPicPointers ld d, BANK(UnownPicPointers) @@ -175,7 +174,6 @@ Modify `GetFrontpicPointer`: And `GetMonBackpic`: ```asm - GLOBAL PokemonPicPointers, UnownPicPointers ld a, b ld hl, PokemonPicPointers ld d, BANK(PokemonPicPointers) @@ -234,7 +232,7 @@ INCBIN "gfx/footprints/wartortle.1bpp", footprint_bottom push hl ld e, l ld d, h - ld hl, VTiles2 tile $62 + ld hl, vTiles2 tile $62 lb bc, BANK(Footprints), 2 call Request1bpp pop hl @@ -246,7 +244,7 @@ INCBIN "gfx/footprints/wartortle.1bpp", footprint_bottom ld e, l ld d, h - ld hl, VTiles2 tile $64 + ld hl, vTiles2 tile $64 lb bc, BANK(Footprints), 2 call Request1bpp ``` @@ -272,12 +270,95 @@ Modify `Pokedex_LoadAnyFootprint`: ```asm ld e, l ld d, h - ld hl, VTiles2 tile $62 + ld hl, vTiles2 tile $62 lb bc, BANK(Footprints), 4 call Request1bpp ``` +## `ITEM_C3` and `ITEM_DC` break up the continuous sequence of TM items + +[constants/item_constants.asm](/constants/item_constants.asm) defined the 50 TMs in order with `add_tm`, but `ITEM_C3` and `ITEM_DC` break up that sequence. + +```asm + add_tm DYNAMICPUNCH ; bf + ... + add_tm ROLLOUT ; c2 + const ITEM_C3 ; c3 + add_tm ROAR ; c4 + ... + add_tm DIG ; db + const ITEM_DC ; dc + add_tm PSYCHIC_M ; dd + ... + add_tm NIGHTMARE ; f2 +NUM_TMS = const_value - TM01 - 2 ; discount ITEM_C3 and ITEM_DC +``` + +`GetTMHMNumber` and `GetNumberedTMHM` in [engine/items.asm](/engine/items.asm) have to compensate for this: + +```asm +GetTMHMNumber:: ; d407 +; Return the number of a TM/HM by item id c. + ld a, c +; Skip any dummy items. + cp ITEM_C3 ; TM04-05 + jr c, .done + cp ITEM_DC ; TM28-29 + jr c, .skip + dec a +.skip + dec a +.done + sub TM01 + inc a + ld c, a + ret + +GetNumberedTMHM: ; d417 +; Return the item id of a TM/HM by number c. + ld a, c +; Skip any gaps. + cp ITEM_C3 - (TM01 - 1) + jr c, .done + cp ITEM_DC - (TM01 - 1) - 1 + jr c, .skip_one +.skip_two + inc a +.skip_one + inc a +.done + add TM01 + dec a + ld c, a + ret +``` + +**Fix:** + +Move `ITEM_C3` and `ITEM_DC` above all the TMs in every table of item data. + +Modify engine/items.asm: + +```asm +GetTMHMNumber:: ; d407 +; Return the number of a TM/HM by item id c. + ld a, c + sub TM01 + inc a + ld c, a + ret + +GetNumberedTMHM: ; d417 +; Return the item id of a TM/HM by number c. + ld a, c + add TM01 + dec a + ld c, a + ret +``` + + ## Pokédex entry banks are derived from their species IDs `PokedexDataPointerTable` in [data/pokemon/dex_entry_pointers.asm](/data/pokemon/dex_entry_pointers.asm) is a table of `dw`, not `dba`, yet there are four banks used for Pokédex entries. The correct bank is derived from the species ID at the beginning of each Pokémon's base stats. (This is the only use the base stat species ID has.) @@ -301,7 +382,7 @@ GetDexEntryPointer: ; 44333 push de rlca rlca - and $3 + maskbits NUM_DEX_ENTRY_BANKS ld hl, .PokedexEntryBanks ld d, 0 ld e, a @@ -311,13 +392,7 @@ GetDexEntryPointer: ; 44333 pop hl ret -.PokedexEntryBanks: ; 44351 - -GLOBAL PokedexEntries1 -GLOBAL PokedexEntries2 -GLOBAL PokedexEntries3 -GLOBAL PokedexEntries4 - +.PokedexEntryBanks: db BANK(PokedexEntries1) db BANK(PokedexEntries2) db BANK(PokedexEntries3) @@ -330,10 +405,10 @@ GLOBAL PokedexEntries4 GetPokedexEntryBank: push hl push de - ld a, [EnemyMonSpecies] + ld a, [wEnemyMonSpecies] rlca rlca - and 3 + maskbits NUM_DEX_ENTRY_BANKS ld hl, .PokedexEntryBanks ld d, 0 ld e, a @@ -344,12 +419,6 @@ GetPokedexEntryBank: ret .PokedexEntryBanks: - -GLOBAL PokedexEntries1 -GLOBAL PokedexEntries2 -GLOBAL PokedexEntries3 -GLOBAL PokedexEntries4 - db BANK(PokedexEntries1) db BANK(PokedexEntries2) db BANK(PokedexEntries3) @@ -362,12 +431,12 @@ And `PokedexShow_GetDexEntryBank` in [engine/radio.asm](/engine/radio.asm): PokedexShow_GetDexEntryBank: push hl push de - ld a, [CurPartySpecies] + ld a, [wCurPartySpecies] dec a rlca rlca - and 3 - ld hl, .pokedexbanks + maskbits NUM_DEX_ENTRY_BANKS + ld hl, .PokedexEntryBanks ld d, 0 ld e, a add hl, de @@ -376,7 +445,7 @@ PokedexShow_GetDexEntryBank: pop hl ret -.pokedexbanks +.PokedexEntryBanks: db BANK(PokedexEntries1) db BANK(PokedexEntries2) db BANK(PokedexEntries3) @@ -386,88 +455,263 @@ PokedexShow_GetDexEntryBank: **Fix:** Use `dba` instead of `dw` in `PokedexDataPointerTable`, and modify the code that accesses it to match. -## `ITEM_C3` and `ITEM_DC` break up the continuous sequence of TM items +## Identical sine wave code and data is repeated five times -[constants/item_constants.asm](/constants/item_constants.asm) defined the 50 TMs in order with `add_tm`, but `ITEM_C3` and `ITEM_DC` break up that sequence. +`_Sine` in [engine/routines/sine.asm](/engine/routines/sine.asm): ```asm - add_tm DYNAMICPUNCH ; $BF - ... - add_tm ROLLOUT ; $C2 - const ITEM_C3 ; $C3 - add_tm ROAR ; $C4 - ... - add_tm DIG ; $DB - const ITEM_DC ; $DC - add_tm PSYCHIC_M ; $DD - ... - add_tm NIGHTMARE ; $F2 -NUM_TMS = const_value - TM01 - 2 ; discount ITEM_C3 and ITEM_DC +_Sine:: ; 84d9 +; A simple sine function. +; Return d * sin(e) in hl. + +; e is a signed 6-bit value. + ld a, e + and %111111 + cp %100000 + jr nc, .negative + call .ApplySineWave + ld a, h + ret + +.negative + and %011111 + call .ApplySineWave + ld a, h + xor $ff + inc a + ret + +.ApplySineWave: ; 84ef + ld e, a + ld a, d + ld d, 0 + ld hl, .sinewave + add hl, de + add hl, de + ld e, [hl] + inc hl + ld d, [hl] + ld hl, 0 +; Factor amplitude +.multiply + srl a + jr nc, .even + add hl, de +.even + sla e + rl d + and a + jr nz, .multiply + ret + +.sinewave ; 850b +; A 32-word table representing a sine wave. +; sin(90 degrees) is index $10 with an amplitude of $100. + sine_wave 32 ``` -`GetTMHMNumber` and `GetNumberedTMHM` in [engine/items.asm](/engine/items.asm) have to compensate for this: +`Sprites_Cosine` and `Sprites_Sine` in [engine/sprites.asm](/engine/sprites.asm): ```asm -GetTMHMNumber:: ; d407 -; Return the number of a TM/HM by item id c. - ld a, c -; Skip any dummy items. - cp ITEM_C3 ; TM04-05 - jr c, .done - cp ITEM_DC ; TM28-29 - jr c, .skip - dec a -.skip - dec a -.done - sub TM01 - inc a - ld c, a +Sprites_Cosine: ; 8e72a +; a = d * cos(a * pi/32) + add %010000 +Sprites_Sine: ; 8e72c +; a = d * sin(a * pi/32) + and %111111 + cp %100000 + jr nc, .negative + call .ApplySineWave + ld a, h ret -GetNumberedTMHM: ; d417 -; Return the item id of a TM/HM by number c. - ld a, c -; Skip any gaps. - cp ITEM_C3 - (TM01 - 1) - jr c, .done - cp ITEM_DC - (TM01 - 1) - 1 - jr c, .skip_one -.skip_two +.negative + and %011111 + call .ApplySineWave + ld a, h + xor $ff inc a -.skip_one + ret +; 8e741 + +.ApplySineWave: ; 8e741 + ld e, a + ld a, d + ld d, 0 + ld hl, .sinewave + add hl, de + add hl, de + ld e, [hl] + inc hl + ld d, [hl] + ld hl, 0 +.multiply + srl a + jr nc, .even + add hl, de +.even + sla e + rl d + and a + jr nz, .multiply + ret +; 8e75d + +.sinewave ; 8e75d + sine_wave 32 +``` + +`BattleAnim_Cosine` and `BattleAnim_Sine` in [engine/battle_anims/functions.asm](/engine/battle_anims/functions.asm): + +```asm +BattleAnim_Cosine: ; ce732 (33:6732) +; a = d * cos(a * pi/32) + add %010000 +BattleAnim_Sine: ; ce734 (33:6734) +; a = d * sin(a * pi/32) + and %111111 + cp %100000 + jr nc, .negative + call .ApplySineWave + ld a, h + ret + +.negative + and %011111 + call .ApplySineWave + ld a, h + xor $ff inc a -.done - add TM01 - dec a - ld c, a ret + +.ApplySineWave: + ld e, a + ld a, d + ld d, 0 + ld hl, BattleAnimSineWave + add hl, de + add hl, de + ld e, [hl] + inc hl + ld d, [hl] + ld hl, 0 +.multiply + srl a + jr nc, .even + add hl, de +.even + sla e + rl d + and a + jr nz, .multiply + ret + +... + +BattleAnimSineWave: ; ce77f + sine_wave 32 +; ce7bf ``` -**Fix:** +`StartTrainerBattle_DrawSineWave` in [engine/battle/battle_transition.asm](/engine/battle/battle_transition.asm): -Move `ITEM_C3` and `ITEM_DC` above all the TMs in every table of item data. +```asm +StartTrainerBattle_DrawSineWave: ; 8c6f7 (23:46f7) +; a = d * sin(a * pi/32) + and %111111 + cp %100000 + jr nc, .negative + call .ApplySineWave + ld a, h + ret -Modify engine/items.asm: +.negative + and %011111 + call .ApplySineWave + ld a, h + xor $ff + inc a + ret + +.ApplySineWave: ; 8c70c (23:470c) + ld e, a + ld a, d + ld d, 0 + ld hl, .sinewave + add hl, de + add hl, de + ld e, [hl] + inc hl + ld d, [hl] + ld hl, 0 +.multiply + srl a + jr nc, .even + add hl, de +.even + sla e + rl d + and a + jr nz, .multiply + ret +; 8c728 (23:4728) + +.sinewave ; 8c728 + sine_wave 32 +; 8c768 +``` + +And `CelebiEvent_Cosine` in [engine/events/celebi.asm](/engine/events/celebi.asm): ```asm -GetTMHMNumber:: ; d407 -; Return the number of a TM/HM by item id c. - ld a, c - sub TM01 +CelebiEvent_Cosine: ; 49b3b (12:5b3b) +; a = d * cos(a * pi/32) + add %010000 + and %111111 + cp %100000 + jr nc, .negative + call .ApplySineWave + ld a, h + ret + +.negative + and %011111 + call .ApplySineWave + ld a, h + xor $ff inc a - ld c, a ret -GetNumberedTMHM: ; d417 -; Return the item id of a TM/HM by number c. - ld a, c - add TM01 - dec a - ld c, a +.ApplySineWave: ; 49b52 (12:5b52) + ld e, a + ld a, d + ld d, 0 + ld hl, .sinewave + add hl, de + add hl, de + ld e, [hl] + inc hl + ld d, [hl] + ld hl, 0 +.multiply + srl a + jr nc, .even + add hl, de +.even + sla e + rl d + and a + jr nz, .multiply ret +; 49b6e (12:5b6e) + +.sinewave ; 49b6e + sine_wave 32 +; 49bae ``` +**Fix:** Call a single shared copy of the (co)sine code in bank 0. + ## `GetForestTreeFrame` works, but it's still bad |