@pkmn/engine 0.1.0-dev.3a273268 → 0.1.0-dev.47feedd9

package/src/lib/common/protocol.zig

@@ -7,7 +7,7 @@ const options = @import("./options.zig");
 const assert = std.debug.assert;
 const print = std.debug.print;
 
-const trace = options.trace;
+const enabled = options.log;
 
 const Player = data.Player;
 const ID = data.ID;
@@ -230,7 +230,7 @@ pub fn Log(comptime Writer: type) type {
         pub const Error = Writer.Error;
 
         pub fn move(self: Self, source: ID, m: anytype, target: ID, from: anytype) Error!void {
-            if (!trace) return;
+            if (!enabled) return;
             assert(m != .None);
             try self.writer.writeAll(&.{
                 @enumToInt(ArgType.Move),
@@ -253,7 +253,7 @@ pub fn Log(comptime Writer: type) type {
         }
 
         pub fn switched(self: Self, ident: ID, pokemon: anytype) Error!void {
-            if (!trace) return;
+            if (!enabled) return;
             try self.writer.writeAll(&.{ @enumToInt(ArgType.Switch), @bitCast(u8, ident) });
             try self.writer.writeAll(&.{ @enumToInt(pokemon.species), pokemon.level });
             try self.writer.writeIntNative(u16, pokemon.hp);
@@ -262,7 +262,7 @@ pub fn Log(comptime Writer: type) type {
         }
 
         pub fn cant(self: Self, ident: ID, reason: Cant) Error!void {
-            if (!trace) return;
+            if (!enabled) return;
             assert(reason != .Disable);
             try self.writer.writeAll(&.{
                 @enumToInt(ArgType.Cant),
@@ -272,7 +272,7 @@ pub fn Log(comptime Writer: type) type {
         }
 
         pub fn disabled(self: Self, ident: ID, m: anytype) Error!void {
-            if (!trace) return;
+            if (!enabled) return;
             try self.writer.writeAll(&.{
                 @enumToInt(ArgType.Cant),
                 @bitCast(u8, ident),
@@ -282,20 +282,20 @@ pub fn Log(comptime Writer: type) type {
         }
 
         pub fn faint(self: Self, ident: ID, done: bool) Error!void {
-            if (!trace) return;
+            if (!enabled) return;
             try self.writer.writeAll(&.{ @enumToInt(ArgType.Faint), @bitCast(u8, ident) });
             if (done) try self.writer.writeByte(@enumToInt(ArgType.None));
         }
 
         pub fn turn(self: Self, num: u16) Error!void {
-            if (!trace) return;
+            if (!enabled) return;
             try self.writer.writeByte(@enumToInt(ArgType.Turn));
             try self.writer.writeIntNative(u16, num);
             try self.writer.writeByte(@enumToInt(ArgType.None));
         }
 
         pub fn win(self: Self, player: Player) Error!void {
-            if (!trace) return;
+            if (!enabled) return;
             try self.writer.writeAll(&.{
                 @enumToInt(ArgType.Win),
                 @enumToInt(player),
@@ -304,12 +304,12 @@ pub fn Log(comptime Writer: type) type {
         }
 
         pub fn tie(self: Self) Error!void {
-            if (!trace) return;
+            if (!enabled) return;
             try self.writer.writeAll(&.{ @enumToInt(ArgType.Tie), @enumToInt(ArgType.None) });
         }
 
         pub fn damage(self: Self, ident: ID, pokemon: anytype, reason: Damage) Error!void {
-            if (!trace) return;
+            if (!enabled) return;
             assert(@enumToInt(reason) <= @enumToInt(Damage.LeechSeed));
             try self.writer.writeAll(&.{ @enumToInt(ArgType.Damage), @bitCast(u8, ident) });
             try self.writer.writeIntNative(u16, pokemon.hp);
@@ -324,7 +324,7 @@ pub fn Log(comptime Writer: type) type {
             reason: Damage,
             source: ID,
         ) Error!void {
-            if (!trace) return;
+            if (!enabled) return;
             assert(@enumToInt(reason) == @enumToInt(Damage.RecoilOf));
             try self.writer.writeAll(&.{ @enumToInt(ArgType.Damage), @bitCast(u8, ident) });
             try self.writer.writeIntNative(u16, pokemon.hp);
@@ -337,7 +337,7 @@ pub fn Log(comptime Writer: type) type {
         }
 
         pub fn heal(self: Self, ident: ID, pokemon: anytype, reason: Heal) Error!void {
-            if (!trace) return;
+            if (!enabled) return;
             assert(reason != .Drain);
             try self.writer.writeAll(&.{ @enumToInt(ArgType.Heal), @bitCast(u8, ident) });
             try self.writer.writeIntNative(u16, pokemon.hp);
@@ -346,7 +346,7 @@ pub fn Log(comptime Writer: type) type {
         }
 
         pub fn drain(self: Self, source: ID, pokemon: anytype, target: ID) Error!void {
-            if (!trace) return;
+            if (!enabled) return;
             try self.writer.writeAll(&.{ @enumToInt(ArgType.Heal), @bitCast(u8, source) });
             try self.writer.writeIntNative(u16, pokemon.hp);
             try self.writer.writeIntNative(u16, pokemon.stats.hp);
@@ -358,7 +358,7 @@ pub fn Log(comptime Writer: type) type {
         }
 
         pub fn status(self: Self, ident: ID, value: u8, reason: Status) Error!void {
-            if (!trace) return;
+            if (!enabled) return;
             assert(reason != .From);
             try self.writer.writeAll(&.{
                 @enumToInt(ArgType.Status),
@@ -369,7 +369,7 @@ pub fn Log(comptime Writer: type) type {
         }
 
         pub fn statusFrom(self: Self, ident: ID, value: u8, m: anytype) Error!void {
-            if (!trace) return;
+            if (!enabled) return;
             try self.writer.writeAll(&.{
                 @enumToInt(ArgType.Status),
                 @bitCast(u8, ident),
@@ -380,7 +380,7 @@ pub fn Log(comptime Writer: type) type {
         }
 
         pub fn curestatus(self: Self, ident: ID, value: u8, reason: CureStatus) Error!void {
-            if (!trace) return;
+            if (!enabled) return;
             try self.writer.writeAll(&.{
                 @enumToInt(ArgType.CureStatus),
                 @bitCast(u8, ident),
@@ -390,7 +390,7 @@ pub fn Log(comptime Writer: type) type {
         }
 
         pub fn boost(self: Self, ident: ID, reason: Boost, num: i8) Error!void {
-            if (!trace) return;
+            if (!enabled) return;
             assert(num != 0 and (reason != .Rage or num > 0));
             try self.writer.writeAll(&.{
                 @enumToInt(ArgType.Boost),
@@ -401,12 +401,12 @@ pub fn Log(comptime Writer: type) type {
         }
 
         pub fn clearallboost(self: Self) Error!void {
-            if (!trace) return;
+            if (!enabled) return;
             try self.writer.writeAll(&.{@enumToInt(ArgType.ClearAllBoost)});
         }
 
         pub fn fail(self: Self, ident: ID, reason: Fail) Error!void {
-            if (!trace) return;
+            if (!enabled) return;
             try self.writer.writeAll(&.{
                 @enumToInt(ArgType.Fail),
                 @bitCast(u8, ident),
@@ -415,17 +415,17 @@ pub fn Log(comptime Writer: type) type {
         }
 
         pub fn miss(self: Self, source: ID) Error!void {
-            if (!trace) return;
+            if (!enabled) return;
             try self.writer.writeAll(&.{ @enumToInt(ArgType.Miss), @bitCast(u8, source) });
         }
 
         pub fn hitcount(self: Self, ident: ID, num: u8) Error!void {
-            if (!trace) return;
+            if (!enabled) return;
             try self.writer.writeAll(&.{ @enumToInt(ArgType.HitCount), @bitCast(u8, ident), num });
         }
 
         pub fn prepare(self: Self, source: ID, m: anytype) Error!void {
-            if (!trace) return;
+            if (!enabled) return;
             try self.writer.writeAll(&.{
                 @enumToInt(ArgType.Prepare),
                 @bitCast(u8, source),
@@ -434,12 +434,12 @@ pub fn Log(comptime Writer: type) type {
         }
 
         pub fn mustrecharge(self: Self, ident: ID) Error!void {
-            if (!trace) return;
+            if (!enabled) return;
             try self.writer.writeAll(&.{ @enumToInt(ArgType.MustRecharge), @bitCast(u8, ident) });
         }
 
         pub fn activate(self: Self, ident: ID, reason: Activate) Error!void {
-            if (!trace) return;
+            if (!enabled) return;
             try self.writer.writeAll(&.{
                 @enumToInt(ArgType.Activate),
                 @bitCast(u8, ident),
@@ -448,12 +448,12 @@ pub fn Log(comptime Writer: type) type {
         }
 
         pub fn fieldactivate(self: Self) Error!void {
-            if (!trace) return;
+            if (!enabled) return;
             try self.writer.writeAll(&.{@enumToInt(ArgType.FieldActivate)});
         }
 
         pub fn start(self: Self, ident: ID, reason: Start) Error!void {
-            if (!trace) return;
+            if (!enabled) return;
             assert(@enumToInt(reason) < @enumToInt(Start.TypeChange));
             try self.writer.writeAll(&.{
                 @enumToInt(ArgType.Start),
@@ -463,7 +463,7 @@ pub fn Log(comptime Writer: type) type {
         }
 
         pub fn typechange(self: Self, source: ID, types: anytype, target: ID) Error!void {
-            if (!trace) return;
+            if (!enabled) return;
             try self.writer.writeAll(&.{
                 @enumToInt(ArgType.Start),
                 @bitCast(u8, source),
@@ -474,7 +474,7 @@ pub fn Log(comptime Writer: type) type {
         }
 
         pub fn startEffect(self: Self, ident: ID, reason: Start, m: anytype) Error!void {
-            if (!trace) return;
+            if (!enabled) return;
             assert(@enumToInt(reason) > @enumToInt(Start.TypeChange));
             try self.writer.writeAll(&.{
                 @enumToInt(ArgType.Start),
@@ -485,7 +485,7 @@ pub fn Log(comptime Writer: type) type {
         }
 
         pub fn end(self: Self, ident: ID, reason: End) Error!void {
-            if (!trace) return;
+            if (!enabled) return;
             try self.writer.writeAll(&.{
                 @enumToInt(ArgType.End),
                 @bitCast(u8, ident),
@@ -494,27 +494,27 @@ pub fn Log(comptime Writer: type) type {
         }
 
         pub fn ohko(self: Self) Error!void {
-            if (!trace) return;
+            if (!enabled) return;
             try self.writer.writeAll(&.{@enumToInt(ArgType.OHKO)});
         }
 
         pub fn crit(self: Self, ident: ID) Error!void {
-            if (!trace) return;
+            if (!enabled) return;
             try self.writer.writeAll(&.{ @enumToInt(ArgType.Crit), @bitCast(u8, ident) });
         }
 
         pub fn supereffective(self: Self, ident: ID) Error!void {
-            if (!trace) return;
+            if (!enabled) return;
             try self.writer.writeAll(&.{ @enumToInt(ArgType.SuperEffective), @bitCast(u8, ident) });
         }
 
         pub fn resisted(self: Self, ident: ID) Error!void {
-            if (!trace) return;
+            if (!enabled) return;
             try self.writer.writeAll(&.{ @enumToInt(ArgType.Resisted), @bitCast(u8, ident) });
         }
 
         pub fn immune(self: Self, ident: ID, reason: Immune) Error!void {
-            if (!trace) return;
+            if (!enabled) return;
             try self.writer.writeAll(&.{
                 @enumToInt(ArgType.Immune),
                 @bitCast(u8, ident),
@@ -523,7 +523,7 @@ pub fn Log(comptime Writer: type) type {
         }
 
         pub fn transform(self: Self, source: ID, target: ID) Error!void {
-            if (!trace) return;
+            if (!enabled) return;
             try self.writer.writeAll(&.{
                 @enumToInt(ArgType.Transform),
                 @bitCast(u8, source),
@@ -532,12 +532,12 @@ pub fn Log(comptime Writer: type) type {
         }
 
         pub fn laststill(self: Self) Error!void {
-            if (!trace) return;
+            if (!enabled) return;
             try self.writer.writeAll(&.{@enumToInt(ArgType.LastStill)});
         }
 
         pub fn lastmiss(self: Self) Error!void {
-            if (!trace) return;
+            if (!enabled) return;
             try self.writer.writeAll(&.{@enumToInt(ArgType.LastMiss)});
         }
     };
@@ -838,7 +838,7 @@ pub fn expectLog(
     actual: []const u8,
     offset: usize,
 ) !void {
-    if (!trace) return;
+    if (!enabled) return;
     const color = color: {
         if (std.process.hasEnvVarConstant("ZIG_DEBUG_COLOR")) {
             break :color true;

package/src/lib/gen1/README.md

@@ -198,7 +198,7 @@ above, PP information isn't strictly necessary in Generation I so is dropped. `M
 a special sentinel value to indicate `null`. Move PP data is only included for testing and is not
 necessary for the actual engine implementation.
 
-In order to workaround various [Pokémon Showdown bugs](#bugs) and to support its protocol in traces,
+In order to workaround various [Pokémon Showdown bugs](#bugs) and to support its protocol in logs,
 additional information is stored in `Move.Data` (`targets`) about what Pokémon Showdown believes the
 `Move.Target` to be (despite the concept of targeting not existing until Generation III when Double
 battles were introduced). More specifically, a move's "targeting" status is required in various
@@ -331,8 +331,8 @@ does not produce an equivalent to Pokémon Showdown's `|request|` protocol messa
 must be gleaned through the `Battle` state). Useful size and offset information can be found in
 the [`layout.json`](../../data/layout.json) which exists to simplify writing driver code.
 
-Documentation of the wire protocol used for logging traces when `-Dtrace` is enabled can be found in
-[PROTOCOL.md](../../../docs/PROTOCOL.md). Note that the
+Documentation of the wire protocol used for protocol message logging when `-Dlog` is enabled can be
+found in [PROTOCOL.md](../../../docs/PROTOCOL.md). Note that the
 [`pkmn-debug`](../../../README.md#pkmn-debug) tool exists to display the binary protocol and battle
 data in the browser for ease of debugging.
 
@@ -487,10 +487,10 @@ the pkmn engine, but the following moves have their broken behavior preserved in
 
 - **Bide**: If the opponent faints after Bide inflicts damage on Pokémon Showdown residual damage
   incorrectly still gets applied to Bide's user.
+- **Counter**: On Pokémon Showdown choices made while sleeping (which should not have been
+  registered) can erroneously cause Counter to trigger Desync Clause Mod behavior.
 - **Leech Seed**: Leech Seed fails to heal its source side if a seeded target faints due to
-  recoil/crash damage on Pokémon Showdown. Pokémon Showdown also updates the battle's last damage
-  field with the uncapped Leech Seed damage if the residual damage is applied which has consequences
-  for Bide and Counter.
+  recoil/crash damage on Pokémon Showdown.
 - **Pay Day**: Pay Day should still scatter coins if it hits (but doesn't break) and opponent's
   Substitute but doesn't on Pokémon Showdown.
 - **Flinch**: Flinching does not get cleared during move selection on Pokémon Showdown and is
@@ -603,9 +603,9 @@ the correct control flow):
   still gets a turn under the [trapping sleep
   glitch](https://glitchcity.wiki/Trapping_move_and_sleep_glitch), Wrap does 0 damage against
   Ghost-type Pokémon instead of properly respecting immunity, and binding effects are handled in the
-  wrong order in the code.
-- **Counter**: On Pokémon Showdown choices made while sleeping (which should not have been
-  registered) can erroneously cause Counter to trigger Desync Clause Mod behavior.
+  wrong order in the code which results in either out of order messaging or, more consequentially,
+  Pokémon using Rage/Bide or Thrashing/Charging moves being incorrectly forced to skip a turn when
+  the Pokémon using the Binding move switches.
 - **Mimic**: Pokémon Showdown checks that the user of Mimic has Mimic in one of their move slots,
   which means Mimic legally called via Metronome or Mirror Move will only work if the user also has
   Mimic (and the moved mimicked by Mimic called via Metronome / Mirror Move will erroneously
@@ -617,15 +617,21 @@ the correct control flow):
 - **Mirror Move**: Binding moves misbehave when used via Mirror Move (though Pokémon Showdown has
   its own weird behavior and does not implement the [partial trapping move Mirror Move
   glitch](https://glitchcity.wiki/Partial_trapping_move_Mirror_Move_link_battle_glitch) that exists
-  on the cartridge).
+  on the cartridge). Additionally, Pokémon Showdown sets the last used move every turn a Pokémon
+  is Thrashing instead of just on the turn it is actually selected meaning Mirror Move will
+  sometimes successfully mirror a Thrashing move when it should fail. Finally, if Mirror Move copies
+  Struggle it should not deduct PP but on Pokémon Showdown it does.
 - **Metronome**: In addition to the issues with binding moves, Metronome and Mirror Move cannot
   mutually call each other more than 3 times in a row without causing the Pokémon Showdown simulator
   to crash due to defensive safety checks that do not exist on the cartridge.
-- **Transform**:  Transform screws up the effect of Disable, because on Pokémon Showdown, Disable
+- **Transform**: Transform screws up the effect of Disable, because on Pokémon Showdown, Disable
   prevents moves of a given *name* from being used (e.g. "Water Gun") as opposed to moves in a
   specific *slot* (e.g. the 2nd move slot), and a Pokémon's moves can change after Transform (this
-  is not an issue with Disable + Mimic because Mimic happens to replace the same slot). Furthermore,
-  transforming and then using Mirror Move / Metronome can result in [glitchy behavior and
+  is not an issue with Disable + Mimic because Mimic happens to replace the same slot). Transform
+  also has a bad interaction with Pokémon Showdown's buggy Haze implementation, as Haze on Pokémon
+  Showdown does not copy unmodified stats, leaving the Transformed Pokémon with inccorect stats.
+  Furthermore, transforming and then using Mirror Move / Metronome can result in [glitchy behavior
+  and
   softlocks](https://pkmn.cc/bulba/Transform_glitches#Transform_.2B_Mirror_Move.2FMetronome_PP_error)
   which Pokémon Showdown does not implement.
 

package/src/lib/gen1/data.zig

@@ -76,7 +76,7 @@ pub fn Battle(comptime RNG: anytype) type {
         }
 
         /// Returns the result of applying Player 1's choice `c1` and Player 2's choice `c2` to the
-        /// battle, optionally writing protocol logs to `log` if `options.trace` is enabled.
+        /// battle, optionally writing protocol message logs to `log` if `options.log` is enabled.
         pub fn update(self: *Self, c1: Choice, c2: Choice, log: anytype) !Result {
             return mechanics.update(self, c1, c2, log);
         }

package/src/lib/gen1/helpers.zig

@@ -211,16 +211,19 @@ pub const Pokemon = struct {
     }
 };
 
-// cat src/test/showdown/blocklist.json | jq '."1".moves'
+// TODO: uncomment once integration tests pass
+// fn blocked(m: Move) bool {
+//     // Binding moves are borked but only via Mirror Move / Metronome which are already blocked
+//     return switch (m) {
+//         .Mimic, .Metronome, .MirrorMove, .Transform => true,
+//         else => false,
+//     };
+// }
+
 fn blocked(m: Move) bool {
     if (Move.get(m).effect == .Binding) return true;
     return switch (m) {
-        .Counter,
-        .Mimic,
-        .Metronome,
-        .MirrorMove,
-        .Transform,
-        => true,
+        .Counter, .Mimic, .Metronome, .MirrorMove, .Transform => true,
         else => false,
     };
 }