@pkmn/engine 0.1.0-dev.84cc1a02 → 0.1.0-dev.8b83af6b

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.
Files changed (46) hide show
  1. package/README.md +52 -24
  2. package/build/pkg/addon.d.ts +7 -0
  3. package/build/pkg/addon.js +111 -0
  4. package/build/pkg/addon.js.map +1 -0
  5. package/build/pkg/data/layout.json +1 -1
  6. package/build/pkg/data.d.ts +1 -2
  7. package/build/pkg/data.js +3 -5
  8. package/build/pkg/data.js.map +1 -1
  9. package/build/pkg/gen1.d.ts +5 -4
  10. package/build/pkg/gen1.js +43 -24
  11. package/build/pkg/gen1.js.map +1 -1
  12. package/build/pkg/index.d.ts +15 -12
  13. package/build/pkg/index.js.map +1 -1
  14. package/build/pkg/protocol.d.ts +4 -2
  15. package/build/pkg/protocol.js +4 -2
  16. package/build/pkg/protocol.js.map +1 -1
  17. package/build/test/display.js +400 -0
  18. package/build/test/display.js.map +1 -0
  19. package/build/tools/debug.js +133 -0
  20. package/build/tools/debug.js.map +1 -0
  21. package/build.zig +30 -39
  22. package/package.json +45 -34
  23. package/src/bin/install-pkmn-engine +47 -28
  24. package/src/bin/pkmn-debug +62 -0
  25. package/src/lib/binding/node.zig +20 -23
  26. package/src/lib/binding/wasm.zig +4 -4
  27. package/src/lib/common/data.zig +11 -11
  28. package/src/lib/common/debug.zig +1 -0
  29. package/src/lib/common/options.zig +3 -3
  30. package/src/lib/common/protocol.zig +194 -178
  31. package/src/lib/common/rng.zig +5 -5
  32. package/src/lib/gen1/README.md +106 -70
  33. package/src/lib/gen1/data/moves.zig +10 -10
  34. package/src/lib/gen1/data/species.zig +2 -2
  35. package/src/lib/gen1/data/types.zig +3 -3
  36. package/src/lib/gen1/data.zig +36 -31
  37. package/src/lib/gen1/helpers.zig +11 -22
  38. package/src/lib/gen1/mechanics.zig +460 -365
  39. package/src/lib/gen2/data/items.zig +3 -3
  40. package/src/lib/gen2/data/moves.zig +1 -1
  41. package/src/lib/gen2/data/species.zig +1 -1
  42. package/src/lib/gen2/data/types.zig +3 -3
  43. package/src/lib/gen2/data.zig +16 -15
  44. package/src/lib/gen2/helpers.zig +6 -6
  45. package/src/lib/pkmn.zig +7 -7
  46. package/src/test/display/pkmn.html.tmpl +368 -0
@@ -47,7 +47,7 @@ pub const PSRNG = extern struct {
47
47
  }
48
48
 
49
49
  pub fn range(self: *PSRNG, comptime T: type, from: T, to: Bound(T)) T {
50
- return @intCast(T, @as(u64, self.src.next()) * (to - from) / divisor + from);
50
+ return @intCast(@as(u64, self.src.next()) * (to - from) / divisor + from);
51
51
  }
52
52
 
53
53
  pub fn chance(self: *PSRNG, comptime T: type, numerator: T, denominator: Bound(T)) bool {
@@ -80,7 +80,7 @@ pub const Gen12 = extern struct {
80
80
  }
81
81
 
82
82
  pub fn percent(p: u8) u8 {
83
- return @intCast(u8, (@as(u16, p) * 0xFF) / 100);
83
+ return @intCast((@as(u16, p) * 0xFF) / 100);
84
84
  }
85
85
 
86
86
  pub fn next(self: *Gen12) u8 {
@@ -114,7 +114,7 @@ pub const Gen34 = extern struct {
114
114
 
115
115
  pub fn next(self: *Gen34) u16 {
116
116
  self.advance();
117
- return @intCast(u16, self.seed >> 16);
117
+ return @intCast(self.seed >> 16);
118
118
  }
119
119
 
120
120
  pub fn advance(self: *Gen34) void {
@@ -144,7 +144,7 @@ pub const Gen56 = extern struct {
144
144
 
145
145
  pub fn next(self: *Gen56) u32 {
146
146
  self.advance();
147
- return @intCast(u32, self.seed >> 32);
147
+ return @intCast(self.seed >> 32);
148
148
  }
149
149
 
150
150
  pub fn advance(self: *Gen56) void {
@@ -190,7 +190,7 @@ pub fn FixedRNG(comptime gen: comptime_int, comptime len: usize) type {
190
190
 
191
191
  pub fn range(self: *Self, comptime T: type, from: T, to: Bound(T)) T {
192
192
  assert(showdown);
193
- return @intCast(T, @as(u64, self.next()) * (to - from) / divisor + from);
193
+ return @intCast(@as(u64, self.next()) * (to - from) / divisor + from);
194
194
  }
195
195
 
196
196
  pub fn chance(
@@ -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
@@ -476,26 +485,40 @@ Smogon](https://www.smogon.com/forums/posts/5933177/show):
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
 
485
- - **Bide**: If the opponent faints after Bide inflicts damage on Pokémon Showdown residual damage
486
- incorrectly still gets applied to Bide's user.
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. Additionally,
501
+ because Pokémon Showdown neglects to zero the last battle damage if a move misses due to immunity
502
+ or invulnerability Counter will occasionally work on Pokémon Showdown when it should fail.
487
503
  - **Leech Seed**: Leech Seed fails to heal its source side if a seeded target faints due to
488
- recoil/crash damage on Pokémon Showdown. Pokémon Showdown also updates the battle's last damage
489
- field with the uncapped Leech Seed damage which has consequences for Bide and Counter.
504
+ recoil/crash damage on Pokémon Showdown.
490
505
  - **Pay Day**: Pay Day should still scatter coins if it hits (but doesn't break) and opponent's
491
506
  Substitute but doesn't on Pokémon Showdown.
492
507
  - **Flinch**: Flinching does not get cleared during move selection on Pokémon Showdown and is
493
508
  instead cleared in Pokémon Showdown's "residual" phase, meaning the flinch status gets erroneously
494
509
  preserved across fainting (as fainting triggers Pokémon Showdown's "instaswitch" behavior which
495
510
  skips end-of-turn residuals).
511
+ - **Rage**: Rage boosts should still result in burn/paralysis [stat modification
512
+ errors](https://pkmn.cc/bulba-glitch-1#Stat_modification_errors) but don't on Pokémon Showdown.
513
+ Furthermore, Pokémon Showdown only builds Rage for Disable/Explosion (hit/miss) when attacking
514
+ into a Substitute instead of all moves. Pokémon Showdown also implements the [Rage and Thrash /
515
+ Petal Dance accuracy bug]( https://www.youtube.com/watch?v=NC5gbJeExbs) incorrectly, as the
516
+ accuracy only gets written when the volatile is present which can lead to incorrect accuracy
517
+ values on turns where Rage is used on the same turn as a move which modifies accuracy or evasion.
496
518
  - **Thrash** / **Petal Dance**: once a Pokémon is locked into a thrashing move they will lose all
497
519
  speed ties on Pokémon Showdown (due to the fact that if they win the speed tie their action will
498
- then get "changed" and inserted back into the queue after their opponent's action).
520
+ then get "changed" and inserted back into the queue after their opponent's action). Pokémon
521
+ Showdown also implements accuracy incorrectly, as covered above.
499
522
  - **Freeze** / **Sleep**: Pokémon Showdown requires a move to be selected when a Pokémon is frozen
500
523
  or sleeping and uses that in the event that the status is removed while on the cartridge no
501
524
  selection is possible and no turn exists for the thawed/woken Pokémon to act except in the case of
@@ -519,8 +542,13 @@ the pkmn engine, but the following moves have their broken behavior preserved in
519
542
  glitch](https://glitchcity.wiki/Substitute_%C2%BC_HP_glitch) also fails in many cases due to
520
543
  Pokémon Showdown implementing the health check based on floating point division instead of integer
521
544
  divison like on the cartridge (meaning the Substitute 1/4 glitch will only occur if the Pokémon's
522
- maximum HP is evenly divisible by 4). Finally, Substitute also incorrectly blocks Dream Eater on
523
- Pokémon Showdown.
545
+ maximum HP is evenly divisible by 4). Substitute also incorrectly blocks Dream Eater on
546
+ Pokémon Showdown and will incorrectly still heal 1 HP for any draining moves if the attack does 0
547
+ damage. Finally, Pokémon Showdown uses a `subFainted` field to track whether a Substitute was
548
+ broken in order to know when to nullify a move's effect, only it doesn't get cleared at the end of
549
+ the turn and can result in incorrect behavior on subsequent turns with the moves Mirror Move and
550
+ Metronome that invoke `runMove` (which is where `subFainted` gets cleared) on the user but skips
551
+ calling it for the eventual true target.
524
552
 
525
553
  In addition to numerous cases where Pokémon Showdown uses the wrong type of message (e.g. `|-fail`
526
554
  vs. `|-miss|` vs. `|-immune|`, e.g. in the case of Leech Seed) which are not documented here, Pokémon
@@ -590,9 +618,9 @@ the correct control flow):
590
618
  still gets a turn under the [trapping sleep
591
619
  glitch](https://glitchcity.wiki/Trapping_move_and_sleep_glitch), Wrap does 0 damage against
592
620
  Ghost-type Pokémon instead of properly respecting immunity, and binding effects are handled in the
593
- wrong order in the code.
594
- - **Counter**: On Pokémon Showdown choices made while sleeping (which should not have been
595
- registered) can erroneously cause Counter to trigger Desync Clause Mod behavior.
621
+ wrong order in the code which results in either out of order messaging or, more consequentially,
622
+ Pokémon using Rage/Bide or Thrashing/Charging moves being incorrectly forced to skip a turn when
623
+ the Pokémon using the Binding move switches.
596
624
  - **Mimic**: Pokémon Showdown checks that the user of Mimic has Mimic in one of their move slots,
597
625
  which means Mimic legally called via Metronome or Mirror Move will only work if the user also has
598
626
  Mimic (and the moved mimicked by Mimic called via Metronome / Mirror Move will erroneously
@@ -600,19 +628,27 @@ the correct control flow):
600
628
  because Pokémon Showdown deducts PP based on a move's name instead of slot, if Mimic copies a move
601
629
  the Pokémon already knows, PP deduction for using either the original move of the mimicked move
602
630
  will instead deduct PP for whichever appears at the lower move slot index and the PP will be
603
- allowed to go negative (effectively allowing for infinite PP use).
604
- - **Mirror Move**: Binding moves misbehave when used via Mirror Move (though Pokémon Showdown has
605
- its own weird behavior and does not implement the [partial trapping move Mirror Move
631
+ allowed to go negative (effectively allowing for infinite PP use). Pokémon Showdown also doesn't
632
+ deduct PP from using Transform if it was copied by Mimic.
633
+ - **Mirror Move**: As covered above, both Substitute and Binding moves misbehave when used via
634
+ Mirror Move (though Pokémon Showdown has its own weird behavior and does not implement the
635
+ [partial trapping move Mirror Move
606
636
  glitch](https://glitchcity.wiki/Partial_trapping_move_Mirror_Move_link_battle_glitch) that exists
607
- on the cartridge).
608
- - **Metronome**: In addition to the issues with binding moves, Metronome and Mirror Move cannot
609
- mutually call each other more than 3 times in a row without causing the Pokémon Showdown simulator
610
- to crash due to defensive safety checks that do not exist on the cartridge.
611
- - **Transform**: Transform screws up the effect of Disable, because on Pokémon Showdown, Disable
637
+ on the cartridge). Additionally, Pokémon Showdown sets the last used move every turn a Pokémon is
638
+ Thrashing instead of just on the turn it is actually selected meaning Mirror Move will sometimes
639
+ successfully mirror a Thrashing move when it should fail. Finally, if Mirror Move copies
640
+ Struggle it should not deduct PP but on Pokémon Showdown it does.
641
+ - **Metronome**: In addition to the issues with binding moves and Substitute, Metronome and Mirror
642
+ Move cannot mutually call each other more than 3 times in a row without causing the Pokémon
643
+ Showdown simulator to crash due to defensive safety checks that do not exist on the cartridge.
644
+ - **Transform**: Transform screws up the effect of Disable, because on Pokémon Showdown, Disable
612
645
  prevents moves of a given *name* from being used (e.g. "Water Gun") as opposed to moves in a
613
646
  specific *slot* (e.g. the 2nd move slot), and a Pokémon's moves can change after Transform (this
614
- is not an issue with Disable + Mimic because Mimic happens to replace the same slot). Furthermore,
615
- transforming and then using Mirror Move / Metronome can result in [glitchy behavior and
647
+ is not an issue with Disable + Mimic because Mimic happens to replace the same slot). Transform
648
+ also has a bad interaction with Pokémon Showdown's buggy Haze implementation, as Haze on Pokémon
649
+ Showdown does not copy unmodified stats, leaving the Transformed Pokémon with incorrect stats.
650
+ Furthermore, transforming and then using Mirror Move / Metronome can result in [glitchy behavior
651
+ and
616
652
  softlocks](https://pkmn.cc/bulba/Transform_glitches#Transform_.2B_Mirror_Move.2FMetronome_PP_error)
617
653
  which Pokémon Showdown does not implement.
618
654
 
@@ -1602,44 +1602,44 @@ pub const Move = enum(u8) {
1602
1602
 
1603
1603
  /// Whether this effect activates during the "begin" step of move execution.
1604
1604
  pub inline fn onBegin(effect: Effect) bool {
1605
- return @enumToInt(effect) > 0 and @enumToInt(effect) <= 16;
1605
+ return @intFromEnum(effect) > 0 and @intFromEnum(effect) <= 16;
1606
1606
  }
1607
1607
 
1608
1608
  /// Whether this effect lowers stats.
1609
1609
  pub inline fn isStatDown(effect: Effect) bool {
1610
- return @enumToInt(effect) > 16 and @enumToInt(effect) <= 21;
1610
+ return @intFromEnum(effect) > 16 and @intFromEnum(effect) <= 21;
1611
1611
  }
1612
1612
 
1613
1613
  /// Whether this effect activates during the "end" step of move execution.
1614
1614
  pub inline fn onEnd(effect: Effect) bool {
1615
- return @enumToInt(effect) > 16 and @enumToInt(effect) <= 31;
1615
+ return @intFromEnum(effect) > 16 and @intFromEnum(effect) <= 31;
1616
1616
  }
1617
1617
 
1618
1618
  /// Whether this effect is considered to "always happen".
1619
1619
  pub inline fn alwaysHappens(effect: Effect) bool {
1620
- return @enumToInt(effect) > 31 and @enumToInt(effect) <= 38;
1620
+ return @intFromEnum(effect) > 31 and @intFromEnum(effect) <= 38;
1621
1621
  }
1622
1622
 
1623
1623
  /// Whether this effect is handled specially by the engine.
1624
1624
  pub inline fn isSpecial(effect: Effect) bool {
1625
1625
  // NB: isSpecial includes isMulti up to Twineedle
1626
- return @enumToInt(effect) > 31 and @enumToInt(effect) <= 46;
1626
+ return @intFromEnum(effect) > 31 and @intFromEnum(effect) <= 46;
1627
1627
  }
1628
1628
 
1629
1629
  /// Whether this effect is a multi-hit effect.
1630
1630
  pub inline fn isMulti(effect: Effect) bool {
1631
- return @enumToInt(effect) > 44 and @enumToInt(effect) <= 47;
1631
+ return @intFromEnum(effect) > 44 and @intFromEnum(effect) <= 47;
1632
1632
  }
1633
1633
 
1634
1634
  /// Whether this effect is has chance of lowering stats.
1635
1635
  pub inline fn isStatDownChance(effect: Effect) bool {
1636
- return @enumToInt(effect) > 47 and @enumToInt(effect) <= 51;
1636
+ return @intFromEnum(effect) > 47 and @intFromEnum(effect) <= 51;
1637
1637
  }
1638
1638
 
1639
1639
  /// Whether this effect has a secondary chance.
1640
1640
  pub inline fn isSecondaryChance(effect: Effect) bool {
1641
1641
  // NB: isSecondaryChance includes isStatDownChance as well as Twineedle
1642
- return (@enumToInt(effect) > 46 and @enumToInt(effect) <= 61);
1642
+ return (@intFromEnum(effect) > 46 and @intFromEnum(effect) <= 61);
1643
1643
  }
1644
1644
  };
1645
1645
 
@@ -1843,12 +1843,12 @@ pub const Move = enum(u8) {
1843
1843
  /// Returns the `Data` corresponding to the move.
1844
1844
  pub inline fn get(id: Move) Data {
1845
1845
  assert(id != .None and id != .SKIP_TURN);
1846
- return DATA[@enumToInt(id) - 1];
1846
+ return DATA[@intFromEnum(id) - 1];
1847
1847
  }
1848
1848
 
1849
1849
  /// Returns the base PP of the move.
1850
1850
  pub fn pp(id: Move) u8 {
1851
1851
  assert(id != .None);
1852
- return PP[@enumToInt(id) - 1];
1852
+ return PP[@intFromEnum(id) - 1];
1853
1853
  }
1854
1854
  };
@@ -1094,12 +1094,12 @@ pub const Species = enum(u8) {
1094
1094
  /// The Pokémon's critical hit rate=io out of 256.
1095
1095
  pub inline fn chance(id: Species) u8 {
1096
1096
  assert(id != .None);
1097
- return CHANCES[@enumToInt(id) - 1];
1097
+ return CHANCES[@intFromEnum(id) - 1];
1098
1098
  }
1099
1099
 
1100
1100
  /// Returns the `Data` corresponding to the species.
1101
1101
  pub fn get(id: Species) Data {
1102
1102
  assert(id != .None);
1103
- return DATA[@enumToInt(id) - 1];
1103
+ return DATA[@intFromEnum(id) - 1];
1104
1104
  }
1105
1105
  };
@@ -91,18 +91,18 @@ pub const Type = enum(u4) {
91
91
 
92
92
  /// Whether or not this type is considered to be special as opposed to physical.
93
93
  pub inline fn special(self: Type) bool {
94
- return @enumToInt(self) >= @enumToInt(Type.Fire);
94
+ return @intFromEnum(self) >= @intFromEnum(Type.Fire);
95
95
  }
96
96
 
97
97
  /// The `Effectiveness` of type `t2` vs. type `t1`.
98
98
  pub inline fn effectiveness(t1: Type, t2: Type) Effectiveness {
99
- return CHART[@enumToInt(t1)][@enumToInt(t2)];
99
+ return CHART[@intFromEnum(t1)][@intFromEnum(t2)];
100
100
  }
101
101
 
102
102
  /// The precedence order of type `t2` vs. type `t1`.
103
103
  pub fn precedence(t1: Type, t2: Type) u8 {
104
104
  for (PRECEDENCE, 0..) |matchup, i| {
105
- if (matchup.type1 == t1 and matchup.type2 == t2) return @intCast(u8, i);
105
+ if (matchup.type1 == t1 and matchup.type2 == t2) return @intCast(i);
106
106
  }
107
107
  unreachable;
108
108
  }
@@ -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,28 +55,28 @@ 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
 
63
63
  /// Returns the `Side` for the given `player`.
64
64
  pub inline fn side(self: *Self, player: Player) *Side {
65
- return &self.sides[@enumToInt(player)];
65
+ return &self.sides[@intFromEnum(player)];
66
66
  }
67
67
 
68
68
  /// Returns the `Side` of the opponent for the given `player`
69
69
  pub inline fn foe(self: *Self, player: Player) *Side {
70
- return &self.sides[@enumToInt(player.foe())];
70
+ return &self.sides[@intFromEnum(player.foe())];
71
71
  }
72
72
 
73
73
  /// Returns an identifier for the active Pokémon of `player`.
74
74
  pub inline fn active(self: *Self, player: Player) ID {
75
- return player.ident(@intCast(u3, self.side(player).order[0]));
75
+ return player.ident(@intCast(self.side(player).order[0]));
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
 
@@ -241,13 +243,13 @@ pub const Status = enum(u8) {
241
243
  /// Whether or not the status `num` is the same as `status`.
242
244
  pub inline fn is(num: u8, status: Status) bool {
243
245
  if (status == .SLP) return Status.duration(num) > 0;
244
- return ((num >> @intCast(u3, @enumToInt(status))) & 1) != 0;
246
+ return ((num >> @intCast(@intFromEnum(status))) & 1) != 0;
245
247
  }
246
248
 
247
249
  /// Initializes a non-sleep `status`. Use `slp` or `slf` to initialize a sleep status.
248
250
  pub inline fn init(status: Status) u8 {
249
251
  assert(status != .SLP and status != .EXT);
250
- return @as(u8, 1) << @intCast(u3, @enumToInt(status));
252
+ return @as(u8, 1) << @intCast(@intFromEnum(status));
251
253
  }
252
254
 
253
255
  /// Initializes a non self-inflicted sleep status with duration `dur`.
@@ -264,7 +266,7 @@ pub const Status = enum(u8) {
264
266
 
265
267
  /// Returns the duration of a sleep status.
266
268
  pub inline fn duration(num: u8) u3 {
267
- return @intCast(u3, num & SLP);
269
+ return @intCast(num & SLP);
268
270
  }
269
271
 
270
272
  /// Returns whether `num` reflects any status.
@@ -411,10 +413,11 @@ pub fn Stats(comptime T: type) type {
411
413
  /// Computes the value of `stat` given a `base`, `dv`, stat `exp` and `level`.
412
414
  pub fn calc(comptime stat: []const u8, base: T, dv: u4, exp: u16, level: u8) T {
413
415
  assert(level > 0 and level <= 100);
414
- const evs = @min(255, @floatToInt(u16, @ceil(@sqrt(@intToFloat(f32, exp)))));
416
+ const float: f32 = @floatFromInt(exp);
417
+ const evs = @min(255, @as(u16, @intFromFloat(@ceil(@sqrt(float)))));
415
418
  const core: u32 = (2 *% (@as(u32, base) +% dv)) +% (evs / 4);
416
419
  const factor: u32 = if (std.mem.eql(u8, stat, "hp")) level + 10 else 5;
417
- return @intCast(T, core *% @as(u32, level) / 100 +% factor);
420
+ return @intCast(core *% @as(u32, level) / 100 +% factor);
418
421
  }
419
422
  };
420
423
  }
@@ -463,7 +466,7 @@ test Boosts {
463
466
  pub const Move = moves.Move;
464
467
 
465
468
  test Move {
466
- try expectEqual(2, @enumToInt(Move.KarateChop));
469
+ try expectEqual(2, @intFromEnum(Move.KarateChop));
467
470
  const move = Move.get(.Fissure);
468
471
  try expectEqual(Move.Effect.OHKO, move.effect);
469
472
  try expectEqual(@as(u8, 30), move.accuracy);
@@ -524,7 +527,7 @@ test Move {
524
527
  pub const Species = species.Species;
525
528
 
526
529
  test Species {
527
- try expectEqual(2, @enumToInt(Species.Ivysaur));
530
+ try expectEqual(2, @intFromEnum(Species.Ivysaur));
528
531
  try expectEqual(@as(u8, 100), Species.get(.Mew).stats.def);
529
532
  }
530
533
 
@@ -541,9 +544,11 @@ pub const Effectiveness = enum(u8) {
541
544
  Super = 20,
542
545
 
543
546
  /// Used to determine the effectiness of a neutral damage hit.
544
- pub const neutral: u16 = @enumToInt(Effectiveness.Neutral) * @enumToInt(Effectiveness.Neutral);
547
+ pub const neutral: u16 =
548
+ @intFromEnum(Effectiveness.Neutral) * @intFromEnum(Effectiveness.Neutral);
545
549
  /// Used to detect whether there is a mismatch in type effectivness (relevant for precedence).
546
- pub const mismatch: u16 = @enumToInt(Effectiveness.Resisted) + @enumToInt(Effectiveness.Super);
550
+ pub const mismatch: u16 =
551
+ @intFromEnum(Effectiveness.Resisted) + @intFromEnum(Effectiveness.Super);
547
552
 
548
553
  comptime {
549
554
  assert(@sizeOf(Effectiveness) == 1);
@@ -551,8 +556,8 @@ pub const Effectiveness = enum(u8) {
551
556
  };
552
557
 
553
558
  test Types {
554
- try expectEqual(14, @enumToInt(Type.Dragon));
555
- try expectEqual(20, @enumToInt(Effectiveness.Super));
559
+ try expectEqual(14, @intFromEnum(Type.Dragon));
560
+ try expectEqual(20, @intFromEnum(Effectiveness.Super));
556
561
 
557
562
  try expect(!Type.Ghost.special());
558
563
  try expect(Type.Dragon.special());