@pkmn/engine 0.1.0-dev.c4dec0f7 → 0.1.0-dev.d716e940

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -28,35 +28,36 @@ list of additional reference [**resources**](#resources).
28
28
 
29
29
  The following information is required to simulate a Generation I Pokémon battle:
30
30
 
31
- | pkmn | Pokémon Red (pret) | Pokémon Showdown |
32
- | ------------------------------------ | ---------------------------------- | -------------------------------------- |
33
- | `battle.seed` | `Random{Add,Sub}` | `battle.seed` |
34
- | `battle.turn` | - | `battle.turn` |
35
- | `battle.last_damage` | `Damage` | `battle.lastDamage` |
36
- | `side.{active,pokemon}` | `PlayerMonNumber`/`BattleMon` | `side.active` |
37
- | `side.team` | `PartyMons` | `side.pokemon` |
38
- | `side.last_used_move` | `PlayerUsedMove` | `pokemon.lastMove` |
39
- | `side.last_selected_move` | `PlayerSelectedMove` | `side.lastSelectedMove` |
40
- | `battle.last_selected_indexes` | `PlayerMoveListIndex` | `side.lastMove` |
41
- | `side.order` | - | `pokemon.position` |
42
- | `{pokemon,active}.moves` | `{party,battle}_struct.{Moves,PP}` | `pokemon.{baseMoveSlots,moveSlots}` |
43
- | `pokemon.hp` | `{party,battle}_struct.HP` | `pokemon.hp` |
44
- | `{pokemon,active}.status` | `{party,battle}_struct.Status` | `pokemon.status` |
45
- | `{pokemon,active}.level` | `PlayerMonUnmodifiedLevel` | `pokemon.level` |
46
- | `pokemon.species` | `party_struct.Species` | `pokemon.baseSpecies` |
47
- | `pokemon.stats` | `box_struct.Stats` | `pokemon.baseStoredStats` |
48
- | `active.stats` | `battle_struct.Stats` | `pokemon.modifiedStats` |
49
- | `volatiles.transform` | `PlayerMonUnmodified*` | `pokemon.storedStats` |
50
- | `active.species` | `battle_struct.Species` | `pokemon.species` |
51
- | `{pokemon,active}.types` | `{party,battle}_struct.Type` | `pokemon.types` |
52
- | `active.boosts` | `PlayerMon*Mod` | `pokemon.boosts` |
53
- | `active.volatiles` | `PlayerBattleStatus{1,2,3}` | `pokemon.volatiles` |
54
- | `volatiles.state` | `PlayerBideAccumulatedDamage` | `volatiles.bide.totalDamage` |
55
- | `volatiles.attacks` | `PlayerNumAttacksLeft` | `volatiles.{bide,lockedmove}.duration` |
56
- | `volatiles.confusion` | `PlayerConfusedCounter` | `volatiles.confusion.duration` |
57
- | `volatiles.toxic` | `PlayerToxicCounter` | `volatiles.residualdmg.counter` |
58
- | `volatiles.substitute` | `PlayerSubstituteHP` | `volatiles.substitute.hp` |
59
- | `volatiles.disabled_{move,duration}` | `PlayerDisabledMove{,Number}` | `volatiles.disable.{move,time}` |
31
+ | pkmn | Pokémon Red (pret) | Pokémon Showdown |
32
+ | --------------------------------------- | ---------------------------------- | -------------------------------------- |
33
+ | `battle.seed` | `Random{Add,Sub}` | `battle.seed` |
34
+ | `battle.turn` | - | `battle.turn` |
35
+ | `battle.last_damage` | `Damage` | `battle.lastDamage` |
36
+ | `side.{active,pokemon}` | `PlayerMonNumber`/`BattleMon` | `side.active` |
37
+ | `side.team` | `PartyMons` | `side.pokemon` |
38
+ | `side.last_used_move` | `PlayerUsedMove` | `pokemon.lastMove` |
39
+ | `side.last_selected_move` | `PlayerSelectedMove` | `side.lastSelectedMove` |
40
+ | `battle.last_moves.{p1,p2}_index` | `PlayerMoveListIndex` | - |
41
+ | `battle.last_moves.{p1,p2}_counterable` | - | `side.lastMove` |
42
+ | `side.order` | - | `pokemon.position` |
43
+ | `{pokemon,active}.moves` | `{party,battle}_struct.{Moves,PP}` | `pokemon.{baseMoveSlots,moveSlots}` |
44
+ | `pokemon.hp` | `{party,battle}_struct.HP` | `pokemon.hp` |
45
+ | `{pokemon,active}.status` | `{party,battle}_struct.Status` | `pokemon.status` |
46
+ | `{pokemon,active}.level` | `PlayerMonUnmodifiedLevel` | `pokemon.level` |
47
+ | `pokemon.species` | `party_struct.Species` | `pokemon.baseSpecies` |
48
+ | `pokemon.stats` | `box_struct.Stats` | `pokemon.baseStoredStats` |
49
+ | `active.stats` | `battle_struct.Stats` | `pokemon.modifiedStats` |
50
+ | `volatiles.transform` | `PlayerMonUnmodified*` | `pokemon.storedStats` |
51
+ | `active.species` | `battle_struct.Species` | `pokemon.species` |
52
+ | `{pokemon,active}.types` | `{party,battle}_struct.Type` | `pokemon.types` |
53
+ | `active.boosts` | `PlayerMon*Mod` | `pokemon.boosts` |
54
+ | `active.volatiles` | `PlayerBattleStatus{1,2,3}` | `pokemon.volatiles` |
55
+ | `volatiles.state` | `PlayerBideAccumulatedDamage` | `volatiles.bide.totalDamage` |
56
+ | `volatiles.attacks` | `PlayerNumAttacksLeft` | `volatiles.{bide,lockedmove}.duration` |
57
+ | `volatiles.confusion` | `PlayerConfusedCounter` | `volatiles.confusion.duration` |
58
+ | `volatiles.toxic` | `PlayerToxicCounter` | `volatiles.residualdmg.counter` |
59
+ | `volatiles.substitute` | `PlayerSubstituteHP` | `volatiles.substitute.hp` |
60
+ | `volatiles.disabled_{move,duration}` | `PlayerDisabledMove{,Number}` | `volatiles.disable.{move,time}` |
60
61
 
61
62
  - Pokémon Showdown [does not implement the correct Generation I RNG](#rng) and as such its `seed` is
62
63
  different
@@ -68,6 +69,9 @@ The following information is required to simulate a Generation I Pokémon battle
68
69
  Counter and is not set and cleared in the correct locations. `Pokemon.lastMove` matches
69
70
  `PlayerUsedMove` more often so is what the engine attempts to model, despite the implications for
70
71
  Counter)
72
+ - `battle.last_moves` doesn't map precisely to cartridge concepts because it is used to track desyncs
73
+ which instead are represented on the cartridge as discrepancies between the two separate battle states
74
+ that exist in the link battle.
71
75
  - Pokémon Showdown does not implement the [partial-trapping move Mirror Move
72
76
  glitch](https://glitchcity.wiki/Partial_trapping_move_Mirror_Move_link_battle_glitch) and as such
73
77
  does not need to keep track of a player's last selected move index (`PlayerMoveListIndex`)
@@ -98,8 +102,8 @@ The following information is required to simulate a Generation I Pokémon battle
98
102
  store general information about the battle. Unlike in Pokémon Showdown there is a distinction
99
103
  between the data structure for the "active" Pokémon and its party members (see below).
100
104
 
101
- Due to layout constraints, the index of the last selected move for a side is stored in what would
102
- otherwise be the padding bytes of`Battle` (the `last_selected_indexes` field) instead of in `Side`.
105
+ Due to layout constraints, details about the last moves for a side are stored in what would
106
+ otherwise be the padding bytes of`Battle` (the `last_moves` field) instead of in `Side`.
103
107
 
104
108
  ### `Pokemon` / `ActivePokemon`
105
109
 
@@ -198,7 +202,7 @@ above, PP information isn't strictly necessary in Generation I so is dropped. `M
198
202
  a special sentinel value to indicate `null`. Move PP data is only included for testing and is not
199
203
  necessary for the actual engine implementation.
200
204
 
201
- In order to workaround various [Pokémon Showdown bugs](#bugs) and to support its protocol in traces,
205
+ In order to workaround various [Pokémon Showdown bugs](#bugs) and to support its protocol in logs,
202
206
  additional information is stored in `Move.Data` (`targets`) about what Pokémon Showdown believes the
203
207
  `Move.Target` to be (despite the concept of targeting not existing until Generation III when Double
204
208
  battles were introduced). More specifically, a move's "targeting" status is required in various
@@ -331,28 +335,33 @@ does not produce an equivalent to Pokémon Showdown's `|request|` protocol messa
331
335
  must be gleaned through the `Battle` state). Useful size and offset information can be found in
332
336
  the [`layout.json`](../../data/layout.json) which exists to simplify writing driver code.
333
337
 
334
- Documentation of the wire protocol used for logging traces when `-Dtrace` is enabled can be found in
335
- [PROTOCOL.md](../../../docs/PROTOCOL.md).
338
+ Documentation of the wire protocol used for protocol message logging when `-Dlog` is enabled can be
339
+ found in [PROTOCOL.md](../../../docs/PROTOCOL.md). Note that the
340
+ [`pkmn-debug`](../../../README.md#pkmn-debug) tool exists to display the binary protocol and battle
341
+ data in the browser for ease of debugging.
336
342
 
337
343
  ### `Battle`
338
344
 
339
- | Start | End | Data | Description |
340
- | ------- | ------- | ----------------------- | ------------------------------------------------------- |
341
- | 0 | 184 | [`sides[0]`](#side) | Player 1's side |
342
- | 184 | 368 | [`sides[1]`](#side) | Player 2's side |
343
- | 368 | 370 | `turn` | The current turn number |
344
- | 370 | 372 | `last_damage` | The last damage dealt by either side |
345
- | 372 | 373-376 | `last_selected_indexes` | The slot index of the last selected moves for each side |
346
- | 373-376 | 384 | `rng` | The RNG state |
345
+ | Start | End | Data | Description |
346
+ | ------- | ------- | ------------------- | ------------------------------------------------------- |
347
+ | 0 | 184 | [`sides[0]`](#side) | Player 1's side |
348
+ | 184 | 368 | [`sides[1]`](#side) | Player 2's side |
349
+ | 368 | 370 | `turn` | The current turn number |
350
+ | 370 | 372 | `last_damage` | The last damage dealt by either side |
351
+ | 372 | 373-376 | `last_moves` | The slot index of the last selected moves for each side |
352
+ | 373-376 | 384 | `rng` | The RNG state |
347
353
 
348
354
  - the current `turn` is 2 bytes, written in native-endianness
349
- - `last_selected_indexes` layout depends on whether or not Pokémon Showdown compatibility mode is
350
- enabled (`-Dshowdown`). In either case it stores a move "slot", where 0 is used as an empty value and
351
- 1-4 represent actual moves:
352
- - if `showdown` is enabled bytes 372 and 373 are used to store the last selected move index of
353
- `side[0]` and bytes 374 and 375 store the last selected move index of `side[1]`
354
- - otherwise byte 372 stores the last selected move index of `side[0]` in its first 4 bits and
355
- `side[1]`'s in its second 4 bits
355
+ - `last_moves` layout depends on whether or not Pokémon Showdown compatibility mode is enabled
356
+ (`-Dshowdown`). In either case it stores the last selected move index and last executed move for
357
+ each player (required to detect desyncs). In the case of the move index, 0 is used as an empty
358
+ value and 1-4 represent actual moves:
359
+ - if `showdown` is enabled byte 372 is used to store the last selected move index of `side[0]` and
360
+ byte 373 is used to store whether or not the side's last executed move would have been considered
361
+ "counterable"; and bytes 374 and 375 store the same information for `side[1]`
362
+ - otherwise the first 3 bits of byte 372 stores the last selected move index of `side[0]` and the
363
+ next bit stores whether that side's last executed move would have been considered "counterable",
364
+ with the same information for `side[1]`'s being stored in the second 4 bits
356
365
  - the `rng` depends on whether or not Pokémon Showdown compatibility mode is enabled (`-Dshowdown`):
357
366
  - if `showdown` is enabled, the RNG state begins on byte 376 and consists of a 64-bit seed,
358
367
  written in native-endianness
@@ -467,7 +476,7 @@ Documentation of the wire protocol used for logging traces when `-Dtrace` is ena
467
476
 
468
477
  In addition to its alternative [RNG semantics](#rng), Pokémon Showdown's implementation of the first
469
478
  generation of Pokémon contains a number bugs, [many of which are known and have been documented on
470
- Smogon](https://www.smogon.com/forums/threads/rby-tradebacks-bug-report-thread.3524844/#post-5933177):
479
+ Smogon](https://www.smogon.com/forums/posts/5933177/show):
471
480
 
472
481
  - moves on Pokémon Showdown can do 0 damage instead of failing or causing a [division-by-zero
473
482
  freeze](https://pkmn.cc/bulba-glitch-1#Division_by_0).
@@ -476,12 +485,19 @@ Smogon](https://www.smogon.com/forums/threads/rby-tradebacks-bug-report-thread.3
476
485
  - Confusion self-hits use the wrong damage formula resulting in off-by-one errors (and also fail to
477
486
  account for an opponent's Reflect). Furthermore, the confusion self-hit damage will erroneously be
478
487
  inflicted to the confused user's substitute if the confused user had been attempting to use a
479
- self-targeting move.
488
+ self-targeting move. Finally, Pokémon Showdown erroneously considers the *uncapped* self-hit
489
+ damage for the purposes of tracking the battle's last damage.
480
490
 
481
491
  Beyond the general bugs listed above, several move effects are implemented incorrectly by Pokémon
482
492
  Showdown. Some of these moves are [too fundamentally broken to be implemented](#unimplementable) by
483
493
  the pkmn engine, but the following moves have their broken behavior preserved in `-Dshowdown` mode:
484
494
 
495
+ - **Bide**: Bide's damage can overflow if OHKO moves are involved because OHKO moves work by setting
496
+ the damage to 65535 - Pokémon Showdown doesn't implement this overflow and instead lets Bide's
497
+ damage grow unbounded. Additionally, if the opponent faints after Bide inflicts damage on Pokémon
498
+ Showdown residual damage incorrectly still gets applied to Bide's user.
499
+ - **Counter**: On Pokémon Showdown choices made while sleeping (which should not have been
500
+ registered) can erroneously cause Counter to trigger Desync Clause Mod behavior.
485
501
  - **Leech Seed**: Leech Seed fails to heal its source side if a seeded target faints due to
486
502
  recoil/crash damage on Pokémon Showdown.
487
503
  - **Pay Day**: Pay Day should still scatter coins if it hits (but doesn't break) and opponent's
@@ -490,9 +506,17 @@ the pkmn engine, but the following moves have their broken behavior preserved in
490
506
  instead cleared in Pokémon Showdown's "residual" phase, meaning the flinch status gets erroneously
491
507
  preserved across fainting (as fainting triggers Pokémon Showdown's "instaswitch" behavior which
492
508
  skips end-of-turn residuals).
509
+ - **Rage**: Rage boosts should still result in burn/paralysis [stat modification
510
+ errors](https://pkmn.cc/bulba-glitch-1#Stat_modification_errors) but don't on Pokémon Showdown.
511
+ Furthermore, Pokémon Showdown only builds Rage for Disable/Explosion (hit/miss) when attacking
512
+ into a Substitute instead of all moves. Pokémon Showdown also implements the [Rage and Thrash /
513
+ Petal Dance accuracy bug]( https://www.youtube.com/watch?v=NC5gbJeExbs) incorrectly, as the
514
+ accuracy only gets written when the volatile is present which can lead to incorrect accuracy
515
+ values on turns where Rage is used on the same turn as a move which modifies accuracy or evasion.
493
516
  - **Thrash** / **Petal Dance**: once a Pokémon is locked into a thrashing move they will lose all
494
517
  speed ties on Pokémon Showdown (due to the fact that if they win the speed tie their action will
495
- then get "changed" and inserted back into the queue after their opponent's action).
518
+ then get "changed" and inserted back into the queue after their opponent's action). Pokémon
519
+ Showdown also implements accuracy incorrectly, as covered above.
496
520
  - **Freeze** / **Sleep**: Pokémon Showdown requires a move to be selected when a Pokémon is frozen
497
521
  or sleeping and uses that in the event that the status is removed while on the cartridge no
498
522
  selection is possible and no turn exists for the thawed/woken Pokémon to act except in the case of
@@ -508,15 +532,21 @@ the pkmn engine, but the following moves have their broken behavior preserved in
508
532
  implement by Pokémon Showdown.
509
533
  - **Roar** / **Whirlwind**: these moves can miss on Pokémon Showdown (and advance the RNG when
510
534
  checking) which is incorrect (these moves should always fail, but do not check accuracy or advance
511
- the RNG).
535
+ the RNG). More importantly, these moves should *not* cause the tracked last battle damage to be
536
+ zeroed, but on Pokémon Showdown they do.
512
537
  - **Substitute**: in addition to the [Substitute + Confusion
513
538
  glitch](https://pkmn.cc/bulba-glitch-1#Substitute_.2B_Confusion_glitch) not being implemented
514
539
  correctly (covered above), the [Substitute 1/4
515
540
  glitch](https://glitchcity.wiki/Substitute_%C2%BC_HP_glitch) also fails in many cases due to
516
541
  Pokémon Showdown implementing the health check based on floating point division instead of integer
517
542
  divison like on the cartridge (meaning the Substitute 1/4 glitch will only occur if the Pokémon's
518
- maximum HP is evenly divisible by 4). Finally, Substitute also incorrectly blocks Dream Eater on
519
- Pokémon Showdown.
543
+ maximum HP is evenly divisible by 4). Substitute also incorrectly blocks Dream Eater on
544
+ Pokémon Showdown and will incorrectly still heal 1 HP for any draining moves if the attack does 0
545
+ damage. Finally, Pokémon Showdown uses a `subFainted` field to track whether a Substitute was
546
+ broken in order to know when to nullify a move's effect, only it doesn't get cleared at the end of
547
+ the turn and can result in incorrect behavior on subsequent turns with the moves Mirror Move and
548
+ Metronome that invoke `runMove` (which is where `subFainted` gets cleared) on the user but skips
549
+ calling it for the eventual true target.
520
550
 
521
551
  In addition to numerous cases where Pokémon Showdown uses the wrong type of message (e.g. `|-fail`
522
552
  vs. `|-miss|` vs. `|-immune|`, e.g. in the case of Leech Seed) which are not documented here, Pokémon
@@ -550,7 +580,7 @@ called out in the `|rule|` section at the beginning of a battle's log):
550
580
  `|rule|` section** in Generation I (or II) as the actual order of switches here does not have
551
581
  competitive implications like it does in Generation III, but it is still contrary to how the games
552
582
  work where the [host (Player 1)'s Pokemon would switch
553
- first](https://www.smogon.com/forums/threads/gen-3-on-ps-final-fixes.3527268/post-5989318).
583
+ first](https://www.smogon.com/forums/posts/5989318/show).
554
584
 
555
585
  Pokémon Showdown enforces several clauses *before* the battle: **Cleric Clause** (all Pokémon must
556
586
  have full HP and PP, and not have any status conditions prior to the battle), **Stat Tradeback
@@ -571,13 +601,12 @@ left up to a client to support.
571
601
 
572
602
  Numerous moves on Pokémon Showdown are broken not simply due to local issues in the implementation
573
603
  of their effects but instead due to **global issues** related to fundamental mechanics such as
574
- [broken move
575
- selection](https://www.smogon.com/forums/threads/rby-fight-button-simulation-improvements-fix-partial-trapping-improve-counter.3673280/#post-8655897),
576
- using move name instead of slot to determine move identity, implementing volatile statuses
577
- incorrectly or not understanding how moves which call other moves work means that it isn't possible
578
- to completely implement Pokémon Showdown's behavior for the following moves (the pkmn engine
579
- attempts to reproduce as much of the behavior that can be reproduced without making data structure
580
- changes or dramatically deviating from the correct control flow):
604
+ [broken move selection](https://www.smogon.com/forums/posts/8655897/show), using move name instead
605
+ of slot to determine move identity, implementing volatile statuses incorrectly or not understanding
606
+ how moves which call other moves work means that it isn't possible to completely implement Pokémon
607
+ Showdown's behavior for the following moves (the pkmn engine attempts to reproduce as much of the
608
+ behavior that can be reproduced without making data structure changes or dramatically deviating from
609
+ the correct control flow):
581
610
 
582
611
  - **Wrap**: Binding moves like Wrap are implemented on Pokémon Showdown with an artificial
583
612
  `partialtrappinglock` volatile as opposed to how it works on the cartridge which simply relies on
@@ -587,9 +616,9 @@ changes or dramatically deviating from the correct control flow):
587
616
  still gets a turn under the [trapping sleep
588
617
  glitch](https://glitchcity.wiki/Trapping_move_and_sleep_glitch), Wrap does 0 damage against
589
618
  Ghost-type Pokémon instead of properly respecting immunity, and binding effects are handled in the
590
- wrong order in the code.
591
- - **Counter**: On Pokémon Showdown choices made while sleeping (which should not have been
592
- registered) can erroneously cause Counter to trigger Desync Clause Mod behavior.
619
+ wrong order in the code which results in either out of order messaging or, more consequentially,
620
+ Pokémon using Rage/Bide or Thrashing/Charging moves being incorrectly forced to skip a turn when
621
+ the Pokémon using the Binding move switches.
593
622
  - **Mimic**: Pokémon Showdown checks that the user of Mimic has Mimic in one of their move slots,
594
623
  which means Mimic legally called via Metronome or Mirror Move will only work if the user also has
595
624
  Mimic (and the moved mimicked by Mimic called via Metronome / Mirror Move will erroneously
@@ -597,19 +626,27 @@ changes or dramatically deviating from the correct control flow):
597
626
  because Pokémon Showdown deducts PP based on a move's name instead of slot, if Mimic copies a move
598
627
  the Pokémon already knows, PP deduction for using either the original move of the mimicked move
599
628
  will instead deduct PP for whichever appears at the lower move slot index and the PP will be
600
- allowed to go negative (effectively allowing for infinite PP use).
601
- - **Mirror Move**: Binding moves misbehave when used via Mirror Move (though Pokémon Showdown has
602
- its own weird behavior and does not implement the [partial trapping move Mirror Move
629
+ allowed to go negative (effectively allowing for infinite PP use). Pokémon Showdown also doesn't
630
+ deduct PP from using Transform if it was copied by Mimic.
631
+ - **Mirror Move**: As covered above, both Substitute and Binding moves misbehave when used via
632
+ Mirror Move (though Pokémon Showdown has its own weird behavior and does not implement the
633
+ [partial trapping move Mirror Move
603
634
  glitch](https://glitchcity.wiki/Partial_trapping_move_Mirror_Move_link_battle_glitch) that exists
604
- on the cartridge).
605
- - **Metronome**: In addition to the issues with binding moves, Metronome and Mirror Move cannot
606
- mutually call each other more than 3 times in a row without causing the Pokémon Showdown simulator
607
- to crash due to defensive safety checks that do not exist on the cartridge.
608
- - **Transform**: Transform screws up the effect of Disable, because on Pokémon Showdown, Disable
635
+ on the cartridge). Additionally, Pokémon Showdown sets the last used move every turn a Pokémon is
636
+ Thrashing instead of just on the turn it is actually selected meaning Mirror Move will sometimes
637
+ successfully mirror a Thrashing move when it should fail. Finally, if Mirror Move copies
638
+ Struggle it should not deduct PP but on Pokémon Showdown it does.
639
+ - **Metronome**: In addition to the issues with binding moves and Substitute, Metronome and Mirror
640
+ Move cannot mutually call each other more than 3 times in a row without causing the Pokémon
641
+ Showdown simulator to crash due to defensive safety checks that do not exist on the cartridge.
642
+ - **Transform**: Transform screws up the effect of Disable, because on Pokémon Showdown, Disable
609
643
  prevents moves of a given *name* from being used (e.g. "Water Gun") as opposed to moves in a
610
644
  specific *slot* (e.g. the 2nd move slot), and a Pokémon's moves can change after Transform (this
611
- is not an issue with Disable + Mimic because Mimic happens to replace the same slot). Furthermore,
612
- transforming and then using Mirror Move / Metronome can result in [glitchy behavior and
645
+ is not an issue with Disable + Mimic because Mimic happens to replace the same slot). Transform
646
+ also has a bad interaction with Pokémon Showdown's buggy Haze implementation, as Haze on Pokémon
647
+ Showdown does not copy unmodified stats, leaving the Transformed Pokémon with incorrect stats.
648
+ Furthermore, transforming and then using Mirror Move / Metronome can result in [glitchy behavior
649
+ and
613
650
  softlocks](https://pkmn.cc/bulba/Transform_glitches#Transform_.2B_Mirror_Move.2FMetronome_PP_error)
614
651
  which Pokémon Showdown does not implement.
615
652
 
@@ -666,10 +703,10 @@ compatibility mode, the implications of these differences are outlined below:
666
703
  Finally, the **initial 10-byte seed for link battles on Pokémon Red cannot include bytes larger than
667
704
  the `SERIAL_PREAMBLE_BYTE`**, so must be in the range $\left[0, 252\right]$. This has implications
668
705
  on the first 10 random numbers generated during the battle and has [**non-trivial competitive
669
- implications**](https://www.smogon.com/forums/threads/rby-tradebacks-bug-report-thread.3524844/page-16#post-9068411)
670
- (at the start of the battle move effects become more likely, the ["1/256-miss"
671
- glitch](https://glitchcity.wiki/1/256_miss_glitch) cannot happen, Player 1 is more likely to win
672
- speed ties, etc) that Pokémon Showdown cannot replicate due to everything described above.
706
+ implications**](https://www.smogon.com/forums/posts/9068411/show) (at the start of the battle move
707
+ effects become more likely, the ["1/256-miss" glitch](https://glitchcity.wiki/1/256_miss_glitch)
708
+ cannot happen, Player 1 is more likely to win speed ties, etc) that Pokémon Showdown cannot
709
+ replicate due to everything described above.
673
710
 
674
711
  All of places in the link battle code where randomness is required are outlined below:
675
712
 
@@ -768,11 +805,8 @@ The pkmn engine attempts to adhere to certain naming conventions:
768
805
  ## Resources
769
806
 
770
807
  - [pret/pokered](https://github.com/pret/pokered/) disassembly
771
- - [Gen I Main Battle
772
- Function](https://www.smogon.com/forums/threads/past-gens-research-thread.3506992/#post-5878612) -
773
- Crystal_
808
+ - [Gen I Main Battle Function](https://www.smogon.com/forums/posts/5878612/show) - Crystal_
774
809
  - [Pokemon Showdown!](https://github.com/smogon/pokemon-showdown)
775
810
  - [List of glitches (Generation
776
811
  I)](https://bulbapedia.bulbagarden.net/wiki/List_of_glitches_(Generation_I))
777
- - [Pokémon Showdown RBY
778
- Bugs](https://www.smogon.com/forums/threads/rby-tradebacks-bug-report-thread.3524844/#post-5933177)
812
+ - [Pokémon Showdown RBY Bugs](https://www.smogon.com/forums/posts/5933177/show)
@@ -17,16 +17,16 @@ const expectEqual = std.testing.expectEqual;
17
17
  const expect = std.testing.expect;
18
18
 
19
19
  /// The minimum size in bytes required to hold all Generation I choice options.
20
- pub const MAX_OPTIONS: usize = 9; // move 1..4, switch 2..6
20
+ pub const MAX_CHOICES: usize = 9; // move 1..4, switch 2..6
21
21
  /// The optimal size in bytes required to hold all Generation I choice options.
22
- /// At least as large as MAX_OPTIONS.
22
+ /// At least as large as MAX_CHOICES.
23
23
  pub const MAX_LOGS: usize = 180;
24
24
 
25
25
  /// The maximum number of bytes possibly logged by a single Generation I update.
26
- pub const OPTIONS_SIZE = if (builtin.mode == .ReleaseSmall)
27
- MAX_OPTIONS
26
+ pub const CHOICES_SIZE = if (builtin.mode == .ReleaseSmall)
27
+ MAX_CHOICES
28
28
  else
29
- std.math.ceilPowerOfTwo(usize, MAX_OPTIONS) catch unreachable;
29
+ std.math.ceilPowerOfTwo(usize, MAX_CHOICES) catch unreachable;
30
30
  /// The optimal size in bytes required to hold the largest amount of log data possible from a
31
31
  /// single Generation I update. At least as large as MAX_LOGS.
32
32
  pub const LOGS_SIZE = if (builtin.mode == .ReleaseSmall)
@@ -55,8 +55,8 @@ pub fn Battle(comptime RNG: anytype) type {
55
55
  turn: u16 = 0,
56
56
  /// The last damage dealt by either side.
57
57
  last_damage: u16 = 0,
58
- /// The slot index of the last selected moves for each side
59
- last_selected_indexes: MoveIndexes = .{},
58
+ /// Details about the last move selected/used by each player required to detect desyncs.
59
+ last_moves: MoveDetails = .{},
60
60
  /// The pseudo random number generator.
61
61
  rng: RNG,
62
62
 
@@ -76,7 +76,7 @@ pub fn Battle(comptime RNG: anytype) type {
76
76
  }
77
77
 
78
78
  /// Returns the result of applying Player 1's choice `c1` and Player 2's choice `c2` to the
79
- /// battle, optionally writing protocol logs to `log` if `options.trace` is enabled.
79
+ /// battle, optionally writing protocol message logs to `log` if `options.log` is enabled.
80
80
  pub fn update(self: *Self, c1: Choice, c2: Choice, log: anytype) !Result {
81
81
  return mechanics.update(self, c1, c2, log);
82
82
  }
@@ -201,17 +201,19 @@ pub const MoveSlot = extern struct {
201
201
  }
202
202
  };
203
203
 
204
- const uindex = if (showdown) u16 else u4;
205
-
206
- /// Representation of the move slot indexes for each side in a Generation I Pokémon battle.
207
- pub const MoveIndexes = packed struct {
208
- /// Player 1's move index.
209
- p1: uindex = 0,
210
- /// Player 1's move index.
211
- p2: uindex = 0,
204
+ /// Details required to detect desyncs based on the move last selected/executed by players.
205
+ pub const MoveDetails = packed struct {
206
+ /// The move slot index of the last move selected in the battle menu by Player 1
207
+ p1_index: if (showdown) u8 else u3 = 0,
208
+ /// Whether the last move executed by Player 1 was counterable.
209
+ p1_counterable: if (showdown) u8 else u1 = 0,
210
+ /// The move slot index of the last move selected in the battle menu by Player 2
211
+ p2_index: if (showdown) u8 else u3 = 0,
212
+ /// Whether the last move executed by Player 2 was counterable.
213
+ p2_counterable: if (showdown) u8 else u1 = 0,
212
214
 
213
215
  comptime {
214
- assert(@sizeOf(MoveIndexes) == if (showdown) 4 else 1);
216
+ assert(@sizeOf(MoveDetails) == if (showdown) 4 else 1);
215
217
  }
216
218
  };
217
219
 
@@ -55,17 +55,12 @@ pub const Battle = struct {
55
55
  }
56
56
 
57
57
  pub fn random(rand: *PSRNG, opt: Options) data.Battle(data.PRNG) {
58
- var p1: u4 = 0;
59
- var p2: u4 = 0;
60
- var battle: data.Battle(data.PRNG) = .{
58
+ return .{
61
59
  .rng = prng(rand),
62
60
  .turn = 0,
63
61
  .last_damage = 0,
64
62
  .sides = .{ Side.random(rand, opt), Side.random(rand, opt) },
65
63
  };
66
- battle.last_selected_indexes.p1 = p1;
67
- battle.last_selected_indexes.p2 = p2;
68
- return battle;
69
64
  }
70
65
  };
71
66
 
@@ -211,16 +206,10 @@ pub const Pokemon = struct {
211
206
  }
212
207
  };
213
208
 
214
- // cat src/test/showdown/blocklist.json | jq '."1".moves'
215
209
  fn blocked(m: Move) bool {
216
- if (Move.get(m).effect == .Binding) return true;
210
+ // Binding moves are borked but only via Mirror Move / Metronome which are already blocked
217
211
  return switch (m) {
218
- .Counter,
219
- .Mimic,
220
- .Metronome,
221
- .MirrorMove,
222
- .Transform,
223
- => true,
212
+ .Mimic, .Metronome, .MirrorMove, .Transform => true,
224
213
  else => false,
225
214
  };
226
215
  }