@pkmn/engine 0.1.0-dev.8b83af6b → 0.1.0-dev.8cf7e679

package/src/lib/gen1/data/species.zig

@@ -1,11 +1,9 @@
-//! Code generated by `tools/generate` - manual edits will be overwritten
-
-const std = @import("std");
+//! Code generated by `tools/generate` - manual edits will be overwritten.
 
 const gen1 = @import("../../gen1/data.zig");
+const std = @import("std");
 
 const assert = std.debug.assert;
-
 const Stats = gen1.Stats;
 const Types = gen1.Types;
 
@@ -1091,8 +1089,8 @@ pub const Species = enum(u8) {
     /// The number of Pokémon species in this generation.
     pub const size = 151;
 
-    /// The Pokémon's critical hit rate=io out of 256.
-    pub inline fn chance(id: Species) u8 {
+    /// The Pokémon's critical hit ratio out of 256.
+    pub fn chance(id: Species) u8 {
         assert(id != .None);
         return CHANCES[@intFromEnum(id) - 1];
     }

package/src/lib/gen1/data/types.zig

@@ -1,8 +1,7 @@
-//! Code generated by `tools/generate` - manual edits will be overwritten
-
-const std = @import("std");
+//! Code generated by `tools/generate` - manual edits will be overwritten.
 
 const gen1 = @import("../../gen1/data.zig");
+const std = @import("std");
 
 const assert = std.debug.assert;
 const Effectiveness = gen1.Effectiveness;
@@ -30,7 +29,7 @@ pub const Type = enum(u4) {
     Ice,
     Dragon,
 
-    const CHART = [15][15]Effectiveness{
+    const CHART: [15][15]Effectiveness = .{
         [_]Effectiveness{ N, N, N, N, N, R, N, I, N, N, N, N, N, N, N }, // Normal
         [_]Effectiveness{ S, N, R, R, N, S, R, I, N, N, N, N, R, S, N }, // Fighting
         [_]Effectiveness{ N, S, N, N, N, R, S, N, N, N, S, R, N, N, N }, // Flying
@@ -90,16 +89,16 @@ pub const Type = enum(u4) {
     pub const size = 15;
 
     /// Whether or not this type is considered to be special as opposed to physical.
-    pub inline fn special(self: Type) bool {
+    pub fn special(self: Type) bool {
         return @intFromEnum(self) >= @intFromEnum(Type.Fire);
     }
 
     /// The `Effectiveness` of type `t2` vs. type `t1`.
-    pub inline fn effectiveness(t1: Type, t2: Type) Effectiveness {
+    pub fn effectiveness(t1: Type, t2: Type) Effectiveness {
         return CHART[@intFromEnum(t1)][@intFromEnum(t2)];
     }
 
-    /// The precedence order of type `t2` vs. type  `t1`.
+    /// The precedence order of Type `t2` vs. Type `t1`.
     pub fn precedence(t1: Type, t2: Type) u8 {
         for (PRECEDENCE, 0..) |matchup, i| {
             if (matchup.type1 == t1 and matchup.type2 == t2) return @intCast(i);
@@ -120,12 +119,12 @@ pub const Types = packed struct {
     }
 
     /// Whether this typing is immune to type `t`.
-    pub inline fn immune(self: Types, t: Type) bool {
+    pub fn immune(self: Types, t: Type) bool {
         return t.effectiveness(self.type1) == I or t.effectiveness(self.type2) == I;
     }
 
     /// Whether this typing includes type `t`.
-    pub inline fn includes(self: Types, t: Type) bool {
+    pub fn includes(self: Types, t: Type) bool {
         return self.type1 == t or self.type2 == t;
     }
 };

package/src/lib/gen1/data.zig

@@ -1,16 +1,16 @@
-const std = @import("std");
 const builtin = @import("builtin");
-
+const calc = @import("calc.zig");
+const chance = @import("chance.zig");
 const data = @import("../common/data.zig");
-const options = @import("../common/options.zig");
+const mechanics = @import("mechanics.zig");
+const moves = @import("data/moves.zig");
+const pkmn = @import("../pkmn.zig");
 const protocol = @import("../common/protocol.zig");
 const rng = @import("../common/rng.zig");
-
-const moves = @import("data/moves.zig");
 const species = @import("data/species.zig");
+const std = @import("std");
 const types = @import("data/types.zig");
-
-const mechanics = @import("mechanics.zig");
+const util = @import("../common/util.zig");
 
 const assert = std.debug.assert;
 const expectEqual = std.testing.expectEqual;
@@ -18,11 +18,11 @@ const expect = std.testing.expect;
 
 /// The minimum size in bytes required to hold all Generation I choice options.
 pub const MAX_CHOICES: usize = 9; // move 1..4, switch 2..6
-/// The optimal size in bytes required to hold all Generation I choice options.
-/// At least as large as MAX_CHOICES.
+/// The maximum number of bytes possibly logged by a single Generation I update.
 pub const MAX_LOGS: usize = 180;
 
-/// The maximum number of bytes possibly logged by a single Generation I update.
+/// The optimal size in bytes required to hold all Generation I choice options.
+/// At least as large as MAX_CHOICES.
 pub const CHOICES_SIZE = if (builtin.mode == .ReleaseSmall)
     MAX_CHOICES
 else
@@ -34,12 +34,18 @@ pub const LOGS_SIZE = if (builtin.mode == .ReleaseSmall)
 else
     std.math.ceilPowerOfTwo(usize, MAX_LOGS) catch unreachable;
 
+///  Null object pattern implementation of pkmn.battle.Options for Generation I.
+pub const NULL = pkmn.battle.options(protocol.NULL, chance.NULL, calc.NULL);
+
 const Choice = data.Choice;
 const ID = data.ID;
 const Player = data.Player;
 const Result = data.Result;
 
-const showdown = options.showdown;
+const PointerType = util.PointerType;
+const isPointerTo = util.isPointerTo;
+
+const showdown = pkmn.options.showdown;
 
 /// The pseudo random number generator used by Generation I.
 pub const PRNG = rng.PRNG(1);
@@ -56,29 +62,41 @@ pub fn Battle(comptime RNG: anytype) type {
         /// The last damage dealt by either side.
         last_damage: u16 = 0,
         /// Details about the last move selected/used by each player required to detect desyncs.
-        last_moves: MoveDetails = .{},
+        last_moves: [2]MoveDetails = [_]MoveDetails{.{}} ** 2,
         /// The pseudo random number generator.
         rng: RNG,
 
         /// Returns the `Side` for the given `player`.
-        pub inline fn side(self: *Self, player: Player) *Side {
+        pub fn side(self: anytype, player: Player) PointerType(@TypeOf(self), Side) {
+            assert(isPointerTo(self, Self));
             return &self.sides[@intFromEnum(player)];
         }
 
         /// Returns the `Side` of the opponent for the given `player`
-        pub inline fn foe(self: *Self, player: Player) *Side {
+        pub fn foe(self: anytype, player: Player) PointerType(@TypeOf(self), Side) {
+            assert(isPointerTo(self, Self));
             return &self.sides[@intFromEnum(player.foe())];
         }
 
         /// Returns an identifier for the active Pokémon of `player`.
-        pub inline fn active(self: *Self, player: Player) ID {
+        pub fn active(self: *const Self, player: Player) ID {
             return player.ident(@intCast(self.side(player).order[0]));
         }
 
+        /// Returns the `MoveDetails` for the given `player`.
+        pub fn lastMove(
+            self: anytype,
+            player: Player,
+        ) PointerType(@TypeOf(self), MoveDetails) {
+            assert(isPointerTo(self, Self));
+            return &self.last_moves[@intFromEnum(player)];
+        }
+
         /// Returns the result of applying Player 1's choice `c1` and Player 2's choice `c2` to the
-        /// 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);
+        /// battle, optionally writing protocol message logs to `options.log` if `pkmn.options.log`
+        /// is enabled.
+        pub fn update(self: *Self, c1: Choice, c2: Choice, options: anytype) !Result {
+            return mechanics.update(self, c1, c2, options);
         }
 
         /// Fills in at most `out.len` possible choices for the `player` given the previous `result`
@@ -90,8 +108,8 @@ pub fn Battle(comptime RNG: anytype) type {
         /// interacts with Disable, in which case there are no possible choices for the player to
         /// make (i.e. on the cartridge a soft-lock occurs).
         ///
-        /// This function will always return a number of choices > 0 if options.showdown is true.
-        pub fn choices(self: *Self, player: Player, request: Choice.Type, out: []Choice) u8 {
+        /// This function will always return choices > 0 if `pkmn.options.showdown` is true.
+        pub fn choices(self: *const Self, player: Player, request: Choice.Type, out: []Choice) u8 {
             return mechanics.choices(self, player, request, out);
         }
     };
@@ -120,7 +138,8 @@ pub const Side = extern struct {
     }
 
     /// Returns the stored `Pokemon` corresponding to the one-indexed party `slot`.
-    pub inline fn get(self: *Side, slot: u8) *Pokemon {
+    pub fn get(self: anytype, slot: u8) PointerType(@TypeOf(self), Pokemon) {
+        assert(isPointerTo(self, Side));
         assert(slot > 0 and slot <= 6);
         const id = self.order[slot - 1];
         assert(id > 0 and id <= 6);
@@ -128,7 +147,8 @@ pub const Side = extern struct {
     }
 
     /// Returns the stored `Pokemon` corresponding to the `active` Pokémon (slot 1).
-    pub inline fn stored(self: *Side) *Pokemon {
+    pub fn stored(self: anytype) PointerType(@TypeOf(self), Pokemon) {
+        assert(isPointerTo(self, Side));
         return self.get(1);
     }
 };
@@ -153,7 +173,8 @@ pub const ActivePokemon = extern struct {
     }
 
     /// Returns the active Pokémon's current move slot located at the one-indexed `mslot`.
-    pub inline fn move(self: *ActivePokemon, mslot: u8) *MoveSlot {
+    pub fn move(self: anytype, mslot: u8) PointerType(@TypeOf(self), MoveSlot) {
+        assert(isPointerTo(self, ActivePokemon));
         assert(mslot > 0 and mslot <= 4);
         assert(self.moves[mslot - 1].id != .None);
         return &self.moves[mslot - 1];
@@ -182,14 +203,15 @@ pub const Pokemon = extern struct {
     }
 
     /// Returns the Pokémon's original move slot located at the one-indexed `mslot`.
-    pub inline fn move(self: *Pokemon, mslot: u8) *MoveSlot {
+    pub fn move(self: anytype, mslot: u8) PointerType(@TypeOf(self), MoveSlot) {
+        assert(isPointerTo(self, Pokemon));
         assert(mslot > 0 and mslot <= 4);
         assert(self.moves[mslot - 1].id != .None);
         return &self.moves[mslot - 1];
     }
 };
 
-/// Representation of a Generation I & II Pokémon's move slot in a battle.
+/// Representation of a Generation I Pokémon's move slot in a battle.
 pub const MoveSlot = extern struct {
     /// The identifier for the move.
     id: Move = .None,
@@ -197,24 +219,16 @@ pub const MoveSlot = extern struct {
     pp: u8 = 0,
 
     comptime {
-        assert(@sizeOf(MoveSlot) == @sizeOf(u16));
+        assert(@sizeOf(MoveSlot) == 2);
     }
 };
 
 /// Details required to detect desyncs based on the move last selected/executed by players.
-pub const MoveDetails = packed struct {
-    /// The move slot index of the last move selected in the battle menu by Player 1
-    p1_index: if (showdown) u8 else u3 = 0,
-    /// Whether the last move executed by Player 1 was counterable.
-    p1_counterable: if (showdown) u8 else u1 = 0,
-    /// The move slot index of the last move selected in the battle menu by Player 2
-    p2_index: if (showdown) u8 else u3 = 0,
-    /// Whether the last move executed by Player 2 was counterable.
-    p2_counterable: if (showdown) u8 else u1 = 0,
-
-    comptime {
-        assert(@sizeOf(MoveDetails) == if (showdown) 4 else 1);
-    }
+pub const MoveDetails = packed struct(if (showdown) u16 else u8) {
+    /// The move slot index of the last move selected in the battle menu.
+    index: if (showdown) u8 else u4 = 0,
+    /// Whether the last move executed was counterable.
+    counterable: if (showdown) u8 else u4 = 0,
 };
 
 /// Bitfield representation of a Generation I & II Pokémon's major status condition.
@@ -238,39 +252,39 @@ pub const Status = enum(u8) {
 
     pub const TOX = 0b10001000;
 
-    const SLP = 0b111;
+    const SLEEP = 0b111;
 
     /// Whether or not the status `num` is the same as `status`.
-    pub inline fn is(num: u8, status: Status) bool {
+    pub fn is(num: u8, status: Status) bool {
         if (status == .SLP) return Status.duration(num) > 0;
         return ((num >> @intCast(@intFromEnum(status))) & 1) != 0;
     }
 
     /// Initializes a non-sleep `status`. Use `slp` or `slf` to initialize a sleep status.
-    pub inline fn init(status: Status) u8 {
+    pub fn init(status: Status) u8 {
         assert(status != .SLP and status != .EXT);
         return @as(u8, 1) << @intCast(@intFromEnum(status));
     }
 
     /// Initializes a non self-inflicted sleep status with duration `dur`.
-    pub inline fn slp(dur: u3) u8 {
+    pub fn slp(dur: u3) u8 {
         assert(dur > 0);
         return @as(u8, dur);
     }
 
     /// Initializes a self-inflicted sleep status with duration `dur`.
-    pub inline fn slf(dur: u3) u8 {
+    pub fn slf(dur: u3) u8 {
         assert(dur > 0);
         return 0x80 | slp(dur);
     }
 
     /// Returns the duration of a sleep status.
-    pub inline fn duration(num: u8) u3 {
-        return @intCast(num & SLP);
+    pub fn duration(num: u8) u3 {
+        return @intCast(num & SLEEP);
     }
 
     /// Returns whether `num` reflects any status.
-    pub inline fn any(num: u8) bool {
+    pub fn any(num: u8) bool {
         return num > 0;
     }
 
@@ -308,7 +322,7 @@ test Status {
 }
 
 /// Bitfield representation of volatile statuses and associated data in Generation I.
-pub const Volatiles = packed struct {
+pub const Volatiles = packed struct(u64) {
     /// Whether the "Bide" volatile status is present.
     Bide: bool = false,
     /// Whether the "Thrashing" volatile status is present.
@@ -361,19 +375,15 @@ pub const Volatiles = packed struct {
     /// The identity of whom the active Pokémon is transformed into.
     transform: u4 = 0,
     /// The remaining turns the move is disabled.
-    disabled_duration: u4 = 0,
+    disable_duration: u4 = 0,
     /// The move slot (1-4) that is disabled.
-    disabled_move: u3 = 0,
+    disable_move: u3 = 0,
     /// The number of turns toxic damage has been accumulating.
     toxic: u5 = 0,
-
-    comptime {
-        assert(@sizeOf(Volatiles) == 8);
-    }
 };
 
 test Volatiles {
-    var volatiles = Volatiles{};
+    var volatiles: Volatiles = .{};
     volatiles.Confusion = true;
     volatiles.confusion = 2;
     volatiles.Thrashing = true;
@@ -382,8 +392,8 @@ test Volatiles {
     volatiles.Substitute = true;
     volatiles.substitute = 42;
     volatiles.toxic = 4;
-    volatiles.disabled_move = 2;
-    volatiles.disabled_duration = 4;
+    volatiles.disable_move = 2;
+    volatiles.disable_duration = 4;
 
     try expect(volatiles.Confusion);
     try expect(volatiles.Thrashing);
@@ -394,14 +404,14 @@ test Volatiles {
 
     try expectEqual(@as(u16, 235), volatiles.state);
     try expectEqual(@as(u8, 42), volatiles.substitute);
-    try expectEqual(@as(u4, 2), volatiles.disabled_move);
-    try expectEqual(@as(u4, 4), volatiles.disabled_duration);
-    try expectEqual(@as(u4, 2), volatiles.confusion);
+    try expectEqual(@as(u4, 2), volatiles.disable_move);
+    try expectEqual(@as(u4, 4), volatiles.disable_duration);
+    try expectEqual(@as(u3, 2), volatiles.confusion);
     try expectEqual(@as(u5, 4), volatiles.toxic);
-    try expectEqual(@as(u4, 3), volatiles.attacks);
+    try expectEqual(@as(u3, 3), volatiles.attacks);
 }
 
-/// Representaiton of a Pokémon's stats in Generation I.
+/// Representation of a Pokémon's stats in Generation I.
 pub fn Stats(comptime T: type) type {
     return extern struct {
         hp: T = 0,
@@ -414,7 +424,7 @@ pub fn Stats(comptime T: type) type {
         pub fn calc(comptime stat: []const u8, base: T, dv: u4, exp: u16, level: u8) T {
             assert(level > 0 and level <= 100);
             const float: f32 = @floatFromInt(exp);
-            const evs = @min(255, @as(u16, @intFromFloat(@ceil(@sqrt(float)))));
+            const evs: u16 = @min(255, @as(u16, @intFromFloat(@ceil(@sqrt(float)))));
             const core: u32 = (2 *% (@as(u32, base) +% dv)) +% (evs / 4);
             const factor: u32 = if (std.mem.eql(u8, stat, "hp")) level + 10 else 5;
             return @intCast(core *% @as(u32, level) / 100 +% factor);
@@ -435,7 +445,7 @@ test Stats {
 }
 
 /// Representation of a Pokémon's boosts in Generation I.
-pub const Boosts = packed struct {
+pub const Boosts = packed struct(u32) {
     /// A Pokémon's Attack boosts.
     atk: i4 = 0,
     /// A Pokémon's Defense boosts.
@@ -450,14 +460,10 @@ pub const Boosts = packed struct {
     evasion: i4 = 0,
 
     _: u8 = 0,
-
-    comptime {
-        assert(@sizeOf(Boosts) == 4);
-    }
 };
 
 test Boosts {
-    const boosts = Boosts{ .spc = -6 };
+    const boosts: Boosts = .{ .spc = -6 };
     try expectEqual(0, boosts.atk);
     try expectEqual(-6, boosts.spc);
 }
@@ -469,7 +475,7 @@ test Move {
     try expectEqual(2, @intFromEnum(Move.KarateChop));
     const move = Move.get(.Fissure);
     try expectEqual(Move.Effect.OHKO, move.effect);
-    try expectEqual(@as(u8, 30), move.accuracy);
+    try expectEqual(rng.Gen12.percent(30), move.accuracy);
     try expectEqual(Type.Ground, move.type);
 
     try expect(!Move.Effect.onBegin(.None));
@@ -607,16 +613,16 @@ pub const DVs = struct {
 };
 
 test DVs {
-    var dvs = DVs{ .spc = 15, .spe = 15 };
+    var dvs: DVs = .{ .spc = 15, .spe = 15 };
     try expectEqual(@as(u4, 15), dvs.hp());
-    dvs = DVs{
+    dvs = .{
         .atk = 5,
         .def = 15,
         .spe = 13,
         .spc = 13,
     };
     try expectEqual(@as(u4, 15), dvs.hp());
-    dvs = DVs{
+    dvs = .{
         .def = 3,
         .spe = 10,
         .spc = 11,