@pkmn/engine 0.1.0-dev.7f2014fa → 0.1.0-dev.7f37a47c

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,36 +28,35 @@ 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_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}` |
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}` |
61
60
 
62
61
  - Pokémon Showdown [does not implement the correct Generation I RNG](#rng) and as such its `seed` is
63
62
  different
@@ -69,9 +68,6 @@ The following information is required to simulate a Generation I Pokémon battle
69
68
  Counter and is not set and cleared in the correct locations. `Pokemon.lastMove` matches
70
69
  `PlayerUsedMove` more often so is what the engine attempts to model, despite the implications for
71
70
  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.
75
71
  - Pokémon Showdown does not implement the [partial-trapping move Mirror Move
76
72
  glitch](https://glitchcity.wiki/Partial_trapping_move_Mirror_Move_link_battle_glitch) and as such
77
73
  does not need to keep track of a player's last selected move index (`PlayerMoveListIndex`)
@@ -102,8 +98,8 @@ The following information is required to simulate a Generation I Pokémon battle
102
98
  store general information about the battle. Unlike in Pokémon Showdown there is a distinction
103
99
  between the data structure for the "active" Pokémon and its party members (see below).
104
100
 
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`.
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`.
107
103
 
108
104
  ### `Pokemon` / `ActivePokemon`
109
105
 
@@ -202,7 +198,7 @@ above, PP information isn't strictly necessary in Generation I so is dropped. `M
202
198
  a special sentinel value to indicate `null`. Move PP data is only included for testing and is not
203
199
  necessary for the actual engine implementation.
204
200
 
205
- In order to workaround various [Pokémon Showdown bugs](#bugs) and to support its protocol in logs,
201
+ In order to workaround various [Pokémon Showdown bugs](#bugs) and to support its protocol in traces,
206
202
  additional information is stored in `Move.Data` (`targets`) about what Pokémon Showdown believes the
207
203
  `Move.Target` to be (despite the concept of targeting not existing until Generation III when Double
208
204
  battles were introduced). More specifically, a move's "targeting" status is required in various
@@ -335,24 +331,22 @@ does not produce an equivalent to Pokémon Showdown's `|request|` protocol messa
335
331
  must be gleaned through the `Battle` state). Useful size and offset information can be found in
336
332
  the [`layout.json`](../../data/layout.json) which exists to simplify writing driver code.
337
333
 
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.
334
+ Documentation of the wire protocol used for logging traces when `-Dtrace` is enabled can be found in
335
+ [PROTOCOL.md](../../../docs/PROTOCOL.md).
342
336
 
343
337
  ### `Battle`
344
338
 
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 |
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 |
353
347
 
354
348
  - the current `turn` is 2 bytes, written in native-endianness
355
- - `last_moves` layout depends on whether or not Pokémon Showdown compatibility mode is
349
+ - `last_selected_indexes` layout depends on whether or not Pokémon Showdown compatibility mode is
356
350
  enabled (`-Dshowdown`). In either case it stores a move "slot", where 0 is used as an empty value and
357
351
  1-4 represent actual moves:
358
352
  - if `showdown` is enabled bytes 372 and 373 are used to store the last selected move index of
@@ -473,7 +467,7 @@ data in the browser for ease of debugging.
473
467
 
474
468
  In addition to its alternative [RNG semantics](#rng), Pokémon Showdown's implementation of the first
475
469
  generation of Pokémon contains a number bugs, [many of which are known and have been documented on
476
- Smogon](https://www.smogon.com/forums/posts/5933177/show):
470
+ Smogon](https://www.smogon.com/forums/threads/rby-tradebacks-bug-report-thread.3524844/#post-5933177):
477
471
 
478
472
  - moves on Pokémon Showdown can do 0 damage instead of failing or causing a [division-by-zero
479
473
  freeze](https://pkmn.cc/bulba-glitch-1#Division_by_0).
@@ -482,15 +476,12 @@ Smogon](https://www.smogon.com/forums/posts/5933177/show):
482
476
  - Confusion self-hits use the wrong damage formula resulting in off-by-one errors (and also fail to
483
477
  account for an opponent's Reflect). Furthermore, the confusion self-hit damage will erroneously be
484
478
  inflicted to the confused user's substitute if the confused user had been attempting to use a
485
- self-targeting move. Finally, Pokémon Showdown erroneously considers the *uncapped* self-hit
486
- damage for the purposes of tracking the battle's last damage.
479
+ self-targeting move.
487
480
 
488
481
  Beyond the general bugs listed above, several move effects are implemented incorrectly by Pokémon
489
482
  Showdown. Some of these moves are [too fundamentally broken to be implemented](#unimplementable) by
490
483
  the pkmn engine, but the following moves have their broken behavior preserved in `-Dshowdown` mode:
491
484
 
492
- - **Counter**: On Pokémon Showdown choices made while sleeping (which should not have been
493
- registered) can erroneously cause Counter to trigger Desync Clause Mod behavior.
494
485
  - **Leech Seed**: Leech Seed fails to heal its source side if a seeded target faints due to
495
486
  recoil/crash damage on Pokémon Showdown.
496
487
  - **Pay Day**: Pay Day should still scatter coins if it hits (but doesn't break) and opponent's
@@ -499,17 +490,9 @@ the pkmn engine, but the following moves have their broken behavior preserved in
499
490
  instead cleared in Pokémon Showdown's "residual" phase, meaning the flinch status gets erroneously
500
491
  preserved across fainting (as fainting triggers Pokémon Showdown's "instaswitch" behavior which
501
492
  skips end-of-turn residuals).
502
- - **Rage**: Rage boosts should still result in burn/paralysis [stat modification
503
- errors](https://pkmn.cc/bulba-glitch-1#Stat_modification_errors) but don't on Pokémon Showdown.
504
- Furthermore, Pokémon Showdown only builds Rage for Disable/Explosion (hit/miss) when attacking
505
- into a Substitute instead of all moves. Pokémon Showdown also implements the [Rage and Thrash /
506
- Petal Dance accuracy bug]( https://www.youtube.com/watch?v=NC5gbJeExbs) incorrectly, as the
507
- accuracy only gets written when the volatile is present which can lead to incorrect accuracy
508
- values on turns where Rage is used on the same turn as a move which modifies accuracy or evasion.
509
493
  - **Thrash** / **Petal Dance**: once a Pokémon is locked into a thrashing move they will lose all
510
494
  speed ties on Pokémon Showdown (due to the fact that if they win the speed tie their action will
511
- then get "changed" and inserted back into the queue after their opponent's action). Pokémon
512
- Showdown also implements accuracy incorrectly, as covered above.
495
+ then get "changed" and inserted back into the queue after their opponent's action).
513
496
  - **Freeze** / **Sleep**: Pokémon Showdown requires a move to be selected when a Pokémon is frozen
514
497
  or sleeping and uses that in the event that the status is removed while on the cartridge no
515
498
  selection is possible and no turn exists for the thawed/woken Pokémon to act except in the case of
@@ -525,21 +508,14 @@ the pkmn engine, but the following moves have their broken behavior preserved in
525
508
  implement by Pokémon Showdown.
526
509
  - **Roar** / **Whirlwind**: these moves can miss on Pokémon Showdown (and advance the RNG when
527
510
  checking) which is incorrect (these moves should always fail, but do not check accuracy or advance
528
- the RNG). More importantly, these moves should *not* cause the tracked last battle damage to be
529
- zeroed, but on Pokémon Showdown they do.
511
+ the RNG).
530
512
  - **Substitute**: in addition to the [Substitute + Confusion
531
513
  glitch](https://pkmn.cc/bulba-glitch-1#Substitute_.2B_Confusion_glitch) not being implemented
532
514
  correctly (covered above), the [Substitute 1/4
533
515
  glitch](https://glitchcity.wiki/Substitute_%C2%BC_HP_glitch) also fails in many cases due to
534
516
  Pokémon Showdown implementing the health check based on floating point division instead of integer
535
517
  divison like on the cartridge (meaning the Substitute 1/4 glitch will only occur if the Pokémon's
536
- maximum HP is evenly divisible by 4). Substitute also incorrectly blocks Dream Eater on
537
- Pokémon Showdown and will incorrectly still heal 1 HP for any draining moves if the attack does 0
538
- damage. Finally, Pokémon Showdown uses a `subFainted` field to track whether a Substitute was
539
- broken in order to know when to nullify a move's effect, only it doesn't get cleared at the end of
540
- the turn and can result in incorrect behavior on subsequent turns with the moves Mirror Move and
541
- Metronome that invoke `runMove` (which is where `subFainted` gets cleared) on the user but skips
542
- calling it for the eventual true target.
518
+ maximum HP is evenly divisible by 4).
543
519
 
544
520
  In addition to numerous cases where Pokémon Showdown uses the wrong type of message (e.g. `|-fail`
545
521
  vs. `|-miss|` vs. `|-immune|`, e.g. in the case of Leech Seed) which are not documented here, Pokémon
@@ -573,7 +549,7 @@ called out in the `|rule|` section at the beginning of a battle's log):
573
549
  `|rule|` section** in Generation I (or II) as the actual order of switches here does not have
574
550
  competitive implications like it does in Generation III, but it is still contrary to how the games
575
551
  work where the [host (Player 1)'s Pokemon would switch
576
- first](https://www.smogon.com/forums/posts/5989318/show).
552
+ first](https://www.smogon.com/forums/threads/gen-3-on-ps-final-fixes.3527268/post-5989318).
577
553
 
578
554
  Pokémon Showdown enforces several clauses *before* the battle: **Cleric Clause** (all Pokémon must
579
555
  have full HP and PP, and not have any status conditions prior to the battle), **Stat Tradeback
@@ -594,17 +570,14 @@ left up to a client to support.
594
570
 
595
571
  Numerous moves on Pokémon Showdown are broken not simply due to local issues in the implementation
596
572
  of their effects but instead due to **global issues** related to fundamental mechanics such as
597
- [broken move selection](https://www.smogon.com/forums/posts/8655897/show), using move name instead
598
- of slot to determine move identity, implementing volatile statuses incorrectly or not understanding
599
- how moves which call other moves work means that it isn't possible to completely implement Pokémon
600
- Showdown's behavior for the following moves (the pkmn engine attempts to reproduce as much of the
601
- behavior that can be reproduced without making data structure changes or dramatically deviating from
602
- the correct control flow):
603
-
604
- - **Bide**: Bide's damage can overflow if OHKO moves are involved because OHKO moves work by setting
605
- the damage to 65535 - Pokémon Showdown doesn't implement this overflow and instead lets Bide's
606
- damage grow unbounded. Additionally, if the opponent faints after Bide inflicts damage on Pokémon
607
- Showdown residual damage incorrectly still gets applied to Bide's user.
573
+ [broken move
574
+ selection](https://www.smogon.com/forums/threads/rby-fight-button-simulation-improvements-fix-partial-trapping-improve-counter.3673280/#post-8655897),
575
+ using move name instead of slot to determine move identity, implementing volatile statuses
576
+ incorrectly or not understanding how moves which call other moves work means that it isn't possible
577
+ to completely implement Pokémon Showdown's behavior for the following moves (the pkmn engine
578
+ attempts to reproduce as much of the behavior that can be reproduced without making data structure
579
+ changes or dramatically deviating from the correct control flow):
580
+
608
581
  - **Wrap**: Binding moves like Wrap are implemented on Pokémon Showdown with an artificial
609
582
  `partialtrappinglock` volatile as opposed to how it works on the cartridge which simply relies on
610
583
  the `Binding` volatile of the opponent. This mistake results in choice locking not being reported
@@ -613,9 +586,9 @@ the correct control flow):
613
586
  still gets a turn under the [trapping sleep
614
587
  glitch](https://glitchcity.wiki/Trapping_move_and_sleep_glitch), Wrap does 0 damage against
615
588
  Ghost-type Pokémon instead of properly respecting immunity, and binding effects are handled in the
616
- wrong order in the code which results in either out of order messaging or, more consequentially,
617
- Pokémon using Rage/Bide or Thrashing/Charging moves being incorrectly forced to skip a turn when
618
- the Pokémon using the Binding move switches.
589
+ wrong order in the code.
590
+ - **Counter**: On Pokémon Showdown choices made while sleeping (which should not have been
591
+ registered) can erroneously cause Counter to trigger Desync Clause Mod behavior.
619
592
  - **Mimic**: Pokémon Showdown checks that the user of Mimic has Mimic in one of their move slots,
620
593
  which means Mimic legally called via Metronome or Mirror Move will only work if the user also has
621
594
  Mimic (and the moved mimicked by Mimic called via Metronome / Mirror Move will erroneously
@@ -624,25 +597,18 @@ the correct control flow):
624
597
  the Pokémon already knows, PP deduction for using either the original move of the mimicked move
625
598
  will instead deduct PP for whichever appears at the lower move slot index and the PP will be
626
599
  allowed to go negative (effectively allowing for infinite PP use).
627
- - **Mirror Move**: As covered above, both Substitute and Binding moves misbehave when used via
628
- Mirror Move (though Pokémon Showdown has its own weird behavior and does not implement the
629
- [partial trapping move Mirror Move
600
+ - **Mirror Move**: Binding moves misbehave when used via Mirror Move (though Pokémon Showdown has
601
+ its own weird behavior and does not implement the [partial trapping move Mirror Move
630
602
  glitch](https://glitchcity.wiki/Partial_trapping_move_Mirror_Move_link_battle_glitch) that exists
631
- on the cartridge). Additionally, Pokémon Showdown sets the last used move every turn a Pokémon is
632
- Thrashing instead of just on the turn it is actually selected meaning Mirror Move will sometimes
633
- successfully mirror a Thrashing move when it should fail. Finally, if Mirror Move copies
634
- Struggle it should not deduct PP but on Pokémon Showdown it does.
635
- - **Metronome**: In addition to the issues with binding moves and Substitute, Metronome and Mirror
636
- Move cannot mutually call each other more than 3 times in a row without causing the Pokémon
637
- Showdown simulator to crash due to defensive safety checks that do not exist on the cartridge.
638
- - **Transform**: Transform screws up the effect of Disable, because on Pokémon Showdown, Disable
603
+ on the cartridge).
604
+ - **Metronome**: In addition to the issues with binding moves, Metronome and Mirror Move cannot
605
+ mutually call each other more than 3 times in a row without causing the Pokémon Showdown simulator
606
+ to crash due to defensive safety checks that do not exist on the cartridge.
607
+ - **Transform**: Transform screws up the effect of Disable, because on Pokémon Showdown, Disable
639
608
  prevents moves of a given *name* from being used (e.g. "Water Gun") as opposed to moves in a
640
609
  specific *slot* (e.g. the 2nd move slot), and a Pokémon's moves can change after Transform (this
641
- is not an issue with Disable + Mimic because Mimic happens to replace the same slot). Transform
642
- also has a bad interaction with Pokémon Showdown's buggy Haze implementation, as Haze on Pokémon
643
- Showdown does not copy unmodified stats, leaving the Transformed Pokémon with inccorect stats.
644
- Furthermore, transforming and then using Mirror Move / Metronome can result in [glitchy behavior
645
- and
610
+ is not an issue with Disable + Mimic because Mimic happens to replace the same slot). Furthermore,
611
+ transforming and then using Mirror Move / Metronome can result in [glitchy behavior and
646
612
  softlocks](https://pkmn.cc/bulba/Transform_glitches#Transform_.2B_Mirror_Move.2FMetronome_PP_error)
647
613
  which Pokémon Showdown does not implement.
648
614
 
@@ -699,10 +665,10 @@ compatibility mode, the implications of these differences are outlined below:
699
665
  Finally, the **initial 10-byte seed for link battles on Pokémon Red cannot include bytes larger than
700
666
  the `SERIAL_PREAMBLE_BYTE`**, so must be in the range $\left[0, 252\right]$. This has implications
701
667
  on the first 10 random numbers generated during the battle and has [**non-trivial competitive
702
- implications**](https://www.smogon.com/forums/posts/9068411/show) (at the start of the battle move
703
- effects become more likely, the ["1/256-miss" glitch](https://glitchcity.wiki/1/256_miss_glitch)
704
- cannot happen, Player 1 is more likely to win speed ties, etc) that Pokémon Showdown cannot
705
- replicate due to everything described above.
668
+ implications**](https://www.smogon.com/forums/threads/rby-tradebacks-bug-report-thread.3524844/page-16#post-9068411)
669
+ (at the start of the battle move effects become more likely, the ["1/256-miss"
670
+ glitch](https://glitchcity.wiki/1/256_miss_glitch) cannot happen, Player 1 is more likely to win
671
+ speed ties, etc) that Pokémon Showdown cannot replicate due to everything described above.
706
672
 
707
673
  All of places in the link battle code where randomness is required are outlined below:
708
674
 
@@ -801,8 +767,11 @@ The pkmn engine attempts to adhere to certain naming conventions:
801
767
  ## Resources
802
768
 
803
769
  - [pret/pokered](https://github.com/pret/pokered/) disassembly
804
- - [Gen I Main Battle Function](https://www.smogon.com/forums/posts/5878612/show) - Crystal_
770
+ - [Gen I Main Battle
771
+ Function](https://www.smogon.com/forums/threads/past-gens-research-thread.3506992/#post-5878612) -
772
+ Crystal_
805
773
  - [Pokemon Showdown!](https://github.com/smogon/pokemon-showdown)
806
774
  - [List of glitches (Generation
807
775
  I)](https://bulbapedia.bulbagarden.net/wiki/List_of_glitches_(Generation_I))
808
- - [Pokémon Showdown RBY Bugs](https://www.smogon.com/forums/posts/5933177/show)
776
+ - [Pokémon Showdown RBY
777
+ Bugs](https://www.smogon.com/forums/threads/rby-tradebacks-bug-report-thread.3524844/#post-5933177)
@@ -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_CHOICES: usize = 9; // move 1..4, switch 2..6
20
+ pub const MAX_OPTIONS: 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_CHOICES.
22
+ /// At least as large as MAX_OPTIONS.
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 CHOICES_SIZE = if (builtin.mode == .ReleaseSmall)
27
- MAX_CHOICES
26
+ pub const OPTIONS_SIZE = if (builtin.mode == .ReleaseSmall)
27
+ MAX_OPTIONS
28
28
  else
29
- std.math.ceilPowerOfTwo(usize, MAX_CHOICES) catch unreachable;
29
+ std.math.ceilPowerOfTwo(usize, MAX_OPTIONS) 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
- /// TODO
59
- last_moves: MoveDetails = .{},
58
+ /// The slot index of the last selected moves for each side
59
+ last_selected_indexes: MoveIndexes = .{},
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 message logs to `log` if `options.log` is enabled.
79
+ /// battle, optionally writing protocol logs to `log` if `options.trace` 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,19 +201,17 @@ pub const MoveSlot = extern struct {
201
201
  }
202
202
  };
203
203
 
204
- /// TODO
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,
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,
214
212
 
215
213
  comptime {
216
- assert(@sizeOf(MoveDetails) == if (showdown) 4 else 1);
214
+ assert(@sizeOf(MoveIndexes) == if (showdown) 4 else 1);
217
215
  }
218
216
  };
219
217
 
@@ -274,7 +272,7 @@ pub const Status = enum(u8) {
274
272
  return num > 0;
275
273
  }
276
274
 
277
- /// Returns a human-readable representation of the status `num`.
275
+ /// Retunrns a human-readable representation of the status `num`.
278
276
  pub fn name(num: u8) []const u8 {
279
277
  if (Status.is(num, .EXT)) return if (num == Status.TOX) "TOX" else "SLF";
280
278
  if (Status.is(num, .SLP)) return "SLP";
@@ -55,12 +55,17 @@ pub const Battle = struct {
55
55
  }
56
56
 
57
57
  pub fn random(rand: *PSRNG, opt: Options) data.Battle(data.PRNG) {
58
- return .{
58
+ var p1: u4 = 0;
59
+ var p2: u4 = 0;
60
+ var battle: data.Battle(data.PRNG) = .{
59
61
  .rng = prng(rand),
60
62
  .turn = 0,
61
63
  .last_damage = 0,
62
64
  .sides = .{ Side.random(rand, opt), Side.random(rand, opt) },
63
65
  };
66
+ battle.last_selected_indexes.p1 = p1;
67
+ battle.last_selected_indexes.p2 = p2;
68
+ return battle;
64
69
  }
65
70
  };
66
71
 
@@ -206,19 +211,20 @@ pub const Pokemon = struct {
206
211
  }
207
212
  };
208
213
 
209
- // TODO: uncomment once integration tests pass
210
- // fn blocked(m: Move) bool {
211
- // // Binding moves are borked but only via Mirror Move / Metronome which are already blocked
212
- // return switch (m) {
213
- // .Mimic, .Metronome, .MirrorMove, .Transform => true,
214
- // else => false,
215
- // };
216
- // }
217
-
214
+ // cat src/test/showdown/blocklist.json | jq '."1".moves'
218
215
  fn blocked(m: Move) bool {
219
216
  if (Move.get(m).effect == .Binding) return true;
220
217
  return switch (m) {
221
- .Counter, .Mimic, .Bide, .Metronome, .MirrorMove, .Transform => true,
218
+ .Counter,
219
+ // FIXME: test and see if this can be removed or document
220
+ .Rage,
221
+ .Mimic,
222
+ // FIXME: test and see if this can be removed or document
223
+ .Bide,
224
+ .Metronome,
225
+ .MirrorMove,
226
+ .Transform,
227
+ => true,
222
228
  else => false,
223
229
  };
224
230
  }