@pkmn/engine 0.1.0-dev.dc33f678 → 0.1.0-dev.dfd46bbb

package/src/lib/gen1/mechanics.zig

@@ -1440,9 +1440,8 @@ fn checkFaint(
     const foe_fainted = foe.stored().hp == 0;
 
     const player_out = findFirstAlive(side) == 0;
-    const foe_out = findFirstAlive(foe) == 0;
-    const tie = player_out and foe_out;
-    const more = tie or player_out or foe_out;
+    const foe_out = foe_fainted and findFirstAlive(foe) == 0;
+    const more = player_out or foe_out;
 
     if (try faint(battle, player, !(more or foe_fainted), options)) |r| return r;
     if (foe_fainted) if (try faint(battle, player.foe(), !more, options)) |r| return r;
@@ -1450,7 +1449,7 @@ fn checkFaint(
     assert(!side.active.volatiles.MultiHit);
     assert(!foe.active.volatiles.MultiHit);
 
-    if (tie) {
+    if (player_out and foe_out) {
         try options.log.tie();
         return Result.Tie;
     } else if (player_out) {
@@ -1653,7 +1652,7 @@ fn disabled(side: *Side, ident: ID, options: anytype) !bool {
     return false;
 }
 
-inline fn buildRage(battle: anytype, who: Player, options: anytype) !void {
+fn buildRage(battle: anytype, who: Player, options: anytype) !void {
     const side = battle.side(who);
     if (side.active.volatiles.Rage and side.active.boosts.atk < 6) {
         try Effects.boost(battle, who, Move.get(.Rage), options);
@@ -1671,7 +1670,7 @@ fn handleThrashing(battle: anytype, active: *ActivePokemon, player: Player, opti
     return true;
 }
 
-inline fn onBegin(
+fn onBegin(
     battle: anytype,
     player: Player,
     move: Move.Data,
@@ -1701,7 +1700,7 @@ inline fn onBegin(
     };
 }
 
-inline fn onEnd(battle: anytype, player: Player, move: Move.Data, options: anytype) !void {
+fn onEnd(battle: anytype, player: Player, move: Move.Data, options: anytype) !void {
     assert(move.effect.onEnd());
     return switch (move.effect) {
         .Bide => Effects.bide(battle, player, options),
@@ -1717,7 +1716,7 @@ inline fn onEnd(battle: anytype, player: Player, move: Move.Data, options: anyty
     };
 }
 
-inline fn alwaysHappens(
+fn alwaysHappens(
     battle: anytype,
     player: Player,
     move: Move.Data,
@@ -1736,7 +1735,7 @@ inline fn alwaysHappens(
     };
 }
 
-inline fn moveEffect(battle: anytype, player: Player, move: Move.Data, options: anytype) !void {
+fn moveEffect(battle: anytype, player: Player, move: Move.Data, options: anytype) !void {
     return switch (move.effect) {
         .BurnChance1, .BurnChance2 => Effects.burnChance(battle, player, move, options),
         .ConfusionChance => Effects.confusion(battle, player, move, options),
@@ -1901,8 +1900,7 @@ pub const Effects = struct {
     }
 
     fn drainHP(battle: anytype, player: Player, options: anytype) !void {
-        var side = battle.side(player);
-        var stored = side.stored();
+        var stored = battle.side(player).stored();
 
         if (battle.last_damage == 0) {
             assert(showdown);
@@ -2027,7 +2025,7 @@ pub const Effects = struct {
         // GLITCH: HP recovery move failure glitches
         const delta = stored.stats.hp - stored.hp;
         if (delta == 0 or (delta & 255 == 255 and stored.hp % 256 != 0)) {
-            return try options.log.fail(ident, .None);
+            return options.log.fail(ident, .None);
         }
 
         const rest = side.last_selected_move == .Rest;
@@ -2109,7 +2107,7 @@ pub const Effects = struct {
                 // Invulnerable foes or 1/256 miss can trigger |-miss| instead of |-fail|
                 if (!try checkHit(battle, player, move, options)) return;
                 try options.chance.commit(player, .hit);
-                return try options.log.fail(battle.active(player.foe()), .None);
+                return options.log.fail(battle.active(player.foe()), .None);
             }
         }
         if (!try checkHit(battle, player, move, options)) return;
@@ -2327,8 +2325,7 @@ pub const Effects = struct {
     fn substitute(battle: anytype, player: Player, residual: *bool, options: anytype) !void {
         var side = battle.side(player);
         if (side.active.volatiles.Substitute) {
-            try options.log.fail(battle.active(player), .Substitute);
-            return;
+            return options.log.fail(battle.active(player), .Substitute);
         }
 
         assert(side.stored().stats.hp <= 1023);
@@ -2339,10 +2336,7 @@ pub const Effects = struct {
         // the target's HP is exactly divisible by 4 (here we're using an inlined divCeil routine to
         // avoid having to convert to floating point)
         const required_hp = if (showdown) @divFloor(side.stored().stats.hp - 1, 4) + 1 else hp;
-        if (side.stored().hp < required_hp) {
-            try options.log.fail(battle.active(player), .Weak);
-            return;
-        }
+        if (side.stored().hp < required_hp) return options.log.fail(battle.active(player), .Weak);
 
         // GLITCH: can leave the user with 0 HP (faints later) because didn't check '<=' above
         side.stored().hp -= hp;
@@ -2434,7 +2428,7 @@ pub const Effects = struct {
         switch (move.effect) {
             .AttackUp1, .AttackUp2, .Rage => {
                 assert(boosts.atk >= -6 and boosts.atk <= 6);
-                if (boosts.atk == 6) return try log.fail(ident, .None);
+                if (boosts.atk == 6) return log.fail(ident, .None);
                 const n: u2 = if (move.effect == .AttackUp2) 2 else 1;
                 boosts.atk = @as(i4, @intCast(@min(6, @as(i8, boosts.atk) + n)));
                 const reason = if (move.effect == .Rage) Boost.Rage else Boost.Attack;
@@ -2445,7 +2439,7 @@ pub const Effects = struct {
                         try log.boost(ident, Boost.Attack, -1);
                         if (move.effect == .Rage) return;
                     }
-                    return try log.fail(ident, .None);
+                    return log.fail(ident, .None);
                 }
                 var mod = BOOSTS[@as(u4, @intCast(@as(i8, boosts.atk) + 6))];
                 const stat = unmodifiedStats(battle, side).atk;
@@ -2456,7 +2450,7 @@ pub const Effects = struct {
             },
             .DefenseUp1, .DefenseUp2 => {
                 assert(boosts.def >= -6 and boosts.def <= 6);
-                if (boosts.def == 6) return try log.fail(ident, .None);
+                if (boosts.def == 6) return log.fail(ident, .None);
                 const n: u2 = if (move.effect == .DefenseUp2) 2 else 1;
                 boosts.def = @intCast(@min(6, @as(i8, boosts.def) + n));
                 if (stats.def == MAX_STAT_VALUE) {
@@ -2465,7 +2459,7 @@ pub const Effects = struct {
                         try log.boost(ident, .Defense, n);
                         try log.boost(ident, .Defense, -1);
                     }
-                    return try log.fail(ident, .None);
+                    return log.fail(ident, .None);
                 }
                 var mod = BOOSTS[@as(u4, @intCast(@as(i8, boosts.def) + 6))];
                 const stat = unmodifiedStats(battle, side).def;
@@ -2474,7 +2468,7 @@ pub const Effects = struct {
             },
             .SpeedUp2 => {
                 assert(boosts.spe >= -6 and boosts.spe <= 6);
-                if (boosts.spe == 6) return try log.fail(ident, .None);
+                if (boosts.spe == 6) return log.fail(ident, .None);
                 boosts.spe = @intCast(@min(6, @as(i8, boosts.spe) + 2));
                 if (stats.spe == MAX_STAT_VALUE) {
                     boosts.spe -= 1;
@@ -2482,7 +2476,7 @@ pub const Effects = struct {
                         try log.boost(ident, .Speed, 2);
                         try log.boost(ident, .Speed, -1);
                     }
-                    return try log.fail(ident, .None);
+                    return log.fail(ident, .None);
                 }
                 var mod = BOOSTS[@as(u4, @intCast(@as(i8, boosts.spe) + 6))];
                 const stat = unmodifiedStats(battle, side).spe;
@@ -2491,7 +2485,7 @@ pub const Effects = struct {
             },
             .SpecialUp1, .SpecialUp2 => {
                 assert(boosts.spc >= -6 and boosts.spc <= 6);
-                if (boosts.spc == 6) return try log.fail(ident, .None);
+                if (boosts.spc == 6) return log.fail(ident, .None);
                 const n: u2 = if (move.effect == .SpecialUp2) 2 else 1;
                 boosts.spc = @intCast(@min(6, @as(i8, boosts.spc) + n));
                 if (stats.spc == MAX_STAT_VALUE) {
@@ -2502,7 +2496,7 @@ pub const Effects = struct {
                         try log.boost(ident, .SpecialDefense, n);
                         try log.boost(ident, .SpecialDefense, -1);
                     }
-                    return try log.fail(ident, .None);
+                    return log.fail(ident, .None);
                 }
                 var mod = BOOSTS[@as(u4, @intCast(@as(i8, boosts.spc) + 6))];
                 const stat = unmodifiedStats(battle, side).spc;
@@ -2512,7 +2506,7 @@ pub const Effects = struct {
             },
             .EvasionUp1 => {
                 assert(boosts.evasion >= -6 and boosts.evasion <= 6);
-                if (boosts.evasion == 6) return try log.fail(ident, .None);
+                if (boosts.evasion == 6) return log.fail(ident, .None);
                 boosts.evasion = @intCast(@min(6, @as(i8, boosts.evasion) + 1));
                 try log.boost(ident, .Evasion, 1);
             },
@@ -2555,7 +2549,7 @@ pub const Effects = struct {
                         try log.boost(foe_ident, .Attack, -1);
                         try log.boost(foe_ident, .Attack, 1);
                     }
-                    return try log.fail(foe_ident, .None);
+                    return log.fail(foe_ident, .None);
                 }
                 var mod = BOOSTS[@as(u4, @intCast(@as(i8, boosts.atk) + 6))];
                 const stat = unmodifiedStats(battle, foe).atk;
@@ -2573,7 +2567,7 @@ pub const Effects = struct {
                         try log.boost(foe_ident, .Defense, -@as(i8, n));
                         try log.boost(foe_ident, .Defense, 1);
                     }
-                    return try log.fail(foe_ident, .None);
+                    return log.fail(foe_ident, .None);
                 }
                 var mod = BOOSTS[@as(u4, @intCast(@as(i8, boosts.def) + 6))];
                 const stat = unmodifiedStats(battle, foe).def;
@@ -2590,7 +2584,7 @@ pub const Effects = struct {
                         try log.boost(foe_ident, .Speed, -1);
                         try log.boost(foe_ident, .Speed, 1);
                     }
-                    return try log.fail(foe_ident, .None);
+                    return log.fail(foe_ident, .None);
                 }
                 var mod = BOOSTS[@as(u4, @intCast(@as(i8, boosts.spe) + 6))];
                 const stat = unmodifiedStats(battle, foe).spe;
@@ -2610,7 +2604,7 @@ pub const Effects = struct {
                         try log.boost(foe_ident, .SpecialDefense, -1);
                         try log.boost(foe_ident, .SpecialDefense, 1);
                     }
-                    return try log.fail(foe_ident, .None);
+                    return log.fail(foe_ident, .None);
                 }
                 var mod = BOOSTS[@as(u4, @intCast(@as(i8, boosts.spc) + 6))];
                 const stat = unmodifiedStats(battle, foe).spc;
@@ -2646,7 +2640,7 @@ fn statusModify(status: u8, stats: *Stats(u16)) void {
     }
 }
 
-inline fn isForced(active: anytype) bool {
+fn isForced(active: anytype) bool {
     return active.volatiles.Recharging or active.volatiles.Rage or
         active.volatiles.Thrashing or active.volatiles.Charging;
 }
@@ -2702,7 +2696,7 @@ fn clearVolatiles(battle: anytype, who: Player, clear: bool, options: anytype) !
 }
 
 pub const Rolls = struct {
-    inline fn speedTie(battle: anytype, options: anytype) !bool {
+    fn speedTie(battle: anytype, options: anytype) !bool {
         const p1 = if (options.calc.overridden(.P1, .speed_tie)) |player|
             player == .P1
         else if (showdown)
@@ -2714,7 +2708,7 @@ pub const Rolls = struct {
         return p1;
     }
 
-    inline fn criticalHit(battle: anytype, player: Player, rate: u8, options: anytype) !bool {
+    fn criticalHit(battle: anytype, player: Player, rate: u8, options: anytype) !bool {
         const crit = if (options.calc.overridden(player, .critical_hit)) |val|
             val == .true
         else if (showdown)
@@ -2726,7 +2720,7 @@ pub const Rolls = struct {
         return crit;
     }
 
-    inline fn damage(battle: anytype, player: anytype, options: anytype) !u8 {
+    fn damage(battle: anytype, player: Player, options: anytype) !u8 {
         const roll = if (options.calc.overridden(player, .damage)) |val|
             val
         else roll: {
@@ -2742,7 +2736,7 @@ pub const Rolls = struct {
         return roll;
     }
 
-    inline fn hit(battle: anytype, player: Player, accuracy: u8, options: anytype) bool {
+    fn hit(battle: anytype, player: Player, accuracy: u8, options: anytype) bool {
         const ok = if (options.calc.overridden(player, .hit)) |val|
             val == .true
         else if (showdown)
@@ -2754,7 +2748,7 @@ pub const Rolls = struct {
         return ok;
     }
 
-    inline fn confused(battle: anytype, player: Player, options: anytype) !bool {
+    fn confused(battle: anytype, player: Player, options: anytype) !bool {
         const cfz = if (options.calc.overridden(player, .confused)) |val|
             val == .true
         else if (showdown)
@@ -2766,7 +2760,7 @@ pub const Rolls = struct {
         return cfz;
     }
 
-    inline fn paralyzed(battle: anytype, player: Player, options: anytype) !bool {
+    fn paralyzed(battle: anytype, player: Player, options: anytype) !bool {
         const par = if (options.calc.overridden(player, .paralyzed)) |val|
             val == .true
         else if (showdown)
@@ -2778,7 +2772,7 @@ pub const Rolls = struct {
         return par;
     }
 
-    inline fn confusionChance(battle: anytype, player: Player, options: anytype) !bool {
+    fn confusionChance(battle: anytype, player: Player, options: anytype) !bool {
         const proc = if (options.calc.overridden(player, .secondary_chance)) |val|
             val == .true
         else if (showdown)
@@ -2790,7 +2784,7 @@ pub const Rolls = struct {
         return proc;
     }
 
-    inline fn secondaryChance(battle: anytype, player: Player, low: bool, options: anytype) !bool {
+    fn secondaryChance(battle: anytype, player: Player, low: bool, options: anytype) !bool {
         const rate: u8 = if (low) 26 else 77;
 
         const proc = if (options.calc.overridden(player, .secondary_chance)) |val|
@@ -2804,7 +2798,7 @@ pub const Rolls = struct {
         return proc;
     }
 
-    inline fn poisonChance(battle: anytype, player: Player, low: bool, options: anytype) !bool {
+    fn poisonChance(battle: anytype, player: Player, low: bool, options: anytype) !bool {
         const rate: u8 = if (low) 52 else 103;
 
         const proc = if (options.calc.overridden(player, .secondary_chance)) |val|
@@ -2818,7 +2812,7 @@ pub const Rolls = struct {
         return proc;
     }
 
-    inline fn unboost(battle: anytype, player: Player, options: anytype) !bool {
+    fn unboost(battle: anytype, player: Player, options: anytype) !bool {
         const proc = if (options.calc.overridden(player, .secondary_chance)) |val|
             val == .true
         else if (showdown)
@@ -2830,7 +2824,7 @@ pub const Rolls = struct {
         return proc;
     }
 
-    inline fn metronome(battle: anytype, player: Player, options: anytype) !Move {
+    fn metronome(battle: anytype, player: Player, options: anytype) !Move {
         const move: Move = if (options.calc.overridden(player, .metronome)) |val|
             val
         else if (showdown)
@@ -2848,7 +2842,7 @@ pub const Rolls = struct {
         return move;
     }
 
-    inline fn psywave(battle: anytype, player: Player, max: u8, options: anytype) !u8 {
+    fn psywave(battle: anytype, player: Player, max: u8, options: anytype) !u8 {
         const power = if (options.calc.overridden(player, .psywave)) |val|
             val - 1
         else if (showdown)
@@ -2865,7 +2859,7 @@ pub const Rolls = struct {
         return power;
     }
 
-    inline fn sleepDuration(battle: anytype, player: Player, options: anytype) u3 {
+    fn sleepDuration(battle: anytype, player: Player, options: anytype) u3 {
         const duration: u3 = if (options.calc.overridden(player, .duration)) |val|
             @intCast(val)
         else if (showdown)
@@ -2882,7 +2876,7 @@ pub const Rolls = struct {
         return duration;
     }
 
-    inline fn disableDuration(battle: anytype, player: Player, options: anytype) u4 {
+    fn disableDuration(battle: anytype, player: Player, options: anytype) u4 {
         const duration: u4 = if (options.calc.overridden(player, .duration)) |val|
             val
         else if (showdown)
@@ -2895,7 +2889,7 @@ pub const Rolls = struct {
         return duration;
     }
 
-    inline fn confusionDuration(battle: anytype, player: Player, self: bool, options: anytype) u3 {
+    fn confusionDuration(battle: anytype, player: Player, self: bool, options: anytype) u3 {
         const duration: u3 = if (options.calc.overridden(player, .duration)) |val|
             @intCast(val)
         else if (showdown)
@@ -2908,7 +2902,7 @@ pub const Rolls = struct {
         return duration;
     }
 
-    inline fn attackingDuration(battle: anytype, player: Player, options: anytype) u3 {
+    fn attackingDuration(battle: anytype, player: Player, options: anytype) u3 {
         const duration: u3 = if (options.calc.overridden(player, .duration)) |val|
             @intCast(val)
         else if (showdown)
@@ -2923,7 +2917,7 @@ pub const Rolls = struct {
 
     const DISTRIBUTION = [_]u3{ 2, 2, 2, 3, 3, 3, 4, 5 };
 
-    inline fn distribution(
+    fn distribution(
         battle: anytype,
         comptime effect: Move.Effect,
         player: Player,

package/src/lib/gen2/calc.zig

@@ -0,0 +1,143 @@
+const std = @import("std");
+
+const pkmn = @import("../pkmn.zig");
+
+const common = @import("../common/data.zig");
+const util = @import("../common/util.zig");
+
+const chance = @import("chance.zig");
+
+const assert = std.debug.assert;
+
+const enabled = pkmn.options.calc;
+
+const Player = common.Player;
+
+const PointerType = util.PointerType;
+
+const Actions = chance.Actions;
+const Action = chance.Action;
+
+/// Information relevant to damage calculation that occured during a Generation II battle `update`.
+pub const Summaries = extern struct {
+    /// Relevant information for Player 1.
+    p1: Summary = .{},
+    /// Relevant information for Player 2.
+    p2: Summary = .{},
+
+    comptime {
+        assert(@sizeOf(Summaries) == 12);
+    }
+
+    /// Returns the `Summary` for the given `player`.
+    pub fn get(self: anytype, player: Player) PointerType(@TypeOf(self), Summary) {
+        assert(@typeInfo(@TypeOf(self)).Pointer.child == Summaries);
+        return if (player == .P1) &self.p1 else &self.p2;
+    }
+};
+
+/// Information relevant to damage calculation that occured during a Generation II battle `update`
+/// for a single player.
+pub const Summary = extern struct {
+    /// The computed raw damage values.
+    damage: Damage = .{},
+
+    /// Intermediate raw damage values computed during a calculation.
+    pub const Damage = extern struct {
+        /// The base computed damage before the damage roll is applied.
+        base: u16 = 0,
+        /// The final computed damage that gets applied to the Pokémon. May exceed the target's HP
+        // (to determine the *actual* damage done compare the target's stored HP before and after).
+        final: u16 = 0,
+        /// Whether higher damage will saturate / result in the same outcome (e.g. additional damage
+        /// gets ignored due to it already breaking a Substitute or causing the target to faint).
+        capped: bool = false,
+
+        // NOTE: 15 bits padding
+
+        comptime {
+            assert(@sizeOf(Damage) == 6);
+        }
+    };
+
+    comptime {
+        assert(@sizeOf(Summary) == 6);
+    }
+};
+
+/// TODO
+pub const Overrides = extern struct {
+    /// TODO
+    actions: Actions = .{},
+};
+
+/// Allows for forcing the value of specific RNG events during a Generation II battle `update` via
+/// `overrides` and tracks `summaries` of information relevant to damage calculation.
+pub const Calc = struct {
+    /// Overrides the normal behavior of the RNG during an `update` to force specific outcomes.
+    overrides: Overrides = .{},
+    /// Information relevant to damage calculation.
+    summaries: Summaries = .{},
+
+    pub fn overridden(
+        self: Calc,
+        player: Player,
+        comptime field: Action.Field,
+    ) ?std.meta.FieldType(Action, field) {
+        if (!enabled) return null;
+
+        const overrides =
+            if (player == .P1) self.overrides.actions.p1 else self.overrides.actions.p2;
+        const val = @field(overrides, @tagName(field));
+        return if (switch (@typeInfo(@TypeOf(val))) {
+            .Enum => val != .None,
+            .Int => val != 0,
+            else => unreachable,
+        }) val else null;
+    }
+
+    pub fn base(self: *Calc, player: Player, val: u16) void {
+        if (!enabled) return;
+
+        self.summaries.get(player).damage.base = val;
+    }
+
+    pub fn final(self: *Calc, player: Player, val: u16) void {
+        if (!enabled) return;
+
+        self.summaries.get(player).damage.final = val;
+    }
+
+    pub fn capped(self: *Calc, player: Player) void {
+        if (!enabled) return;
+
+        self.summaries.get(player).damage.capped = true;
+    }
+};
+
+/// Null object pattern implementation of Generation II `Calc` which does nothing, though damage
+/// calculator support should additionally be turned off entirely via `options.calc`.
+pub const NULL: Null = .{};
+
+const Null = struct {
+    pub fn overridden(
+        self: Null,
+        player: Player,
+        comptime field: Action.Field,
+    ) ?std.meta.FieldType(Action, field) {
+        _ = .{ self, player };
+        return null;
+    }
+
+    pub fn base(self: Null, player: Player, val: u16) void {
+        _ = .{ self, player, val };
+    }
+
+    pub fn final(self: Null, player: Player, val: u16) void {
+        _ = .{ self, player, val };
+    }
+
+    pub fn capped(self: Null, player: Player) void {
+        _ = .{ self, player };
+    }
+};