@pkmn/engine 0.1.0-dev.9a0c07c3 → 0.1.0-dev.a324c50f

package/src/lib/gen1/data.zig

@@ -1,15 +1,19 @@
 const std = @import("std");
 const builtin = @import("builtin");
 
+const pkmn = @import("../pkmn.zig");
+
 const data = @import("../common/data.zig");
-const options = @import("../common/options.zig");
 const protocol = @import("../common/protocol.zig");
 const rng = @import("../common/rng.zig");
+const util = @import("../common/util.zig");
 
 const moves = @import("data/moves.zig");
 const species = @import("data/species.zig");
 const types = @import("data/types.zig");
 
+const calc = @import("calc.zig");
+const chance = @import("chance.zig");
 const mechanics = @import("mechanics.zig");
 
 const assert = std.debug.assert;
@@ -17,16 +21,16 @@ const expectEqual = std.testing.expectEqual;
 const expect = std.testing.expect;
 
 /// The minimum size in bytes required to hold all Generation I choice options.
-pub const MAX_OPTIONS: usize = 9; // move 1..4, switch 2..6
+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_OPTIONS.
+/// At least as large as MAX_CHOICES.
 pub const MAX_LOGS: usize = 180;
 
 /// The maximum number of bytes possibly logged by a single Generation I update.
-pub const OPTIONS_SIZE = if (builtin.mode == .ReleaseSmall)
-    MAX_OPTIONS
+pub const CHOICES_SIZE = if (builtin.mode == .ReleaseSmall)
+    MAX_CHOICES
 else
-    std.math.ceilPowerOfTwo(usize, MAX_OPTIONS) catch unreachable;
+    std.math.ceilPowerOfTwo(usize, MAX_CHOICES) catch unreachable;
 /// The optimal size in bytes required to hold the largest amount of log data possible from a
 /// single Generation I update. At least as large as MAX_LOGS.
 pub const LOGS_SIZE = if (builtin.mode == .ReleaseSmall)
@@ -34,12 +38,17 @@ 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 showdown = pkmn.options.showdown;
 
 /// The pseudo random number generator used by Generation I.
 pub const PRNG = rng.PRNG(1);
@@ -55,30 +64,33 @@ pub fn Battle(comptime RNG: anytype) type {
         turn: u16 = 0,
         /// The last damage dealt by either side.
         last_damage: u16 = 0,
-        /// The slot index of the last selected moves for each side
-        last_selected_indexes: MoveIndexes = .{},
+        /// Details about the last move selected/used by each player required to detect desyncs.
+        last_moves: MoveDetails = .{},
         /// The pseudo random number generator.
         rng: RNG,
 
         /// Returns the `Side` for the given `player`.
-        pub inline fn side(self: *Self, player: Player) *Side {
-            return &self.sides[@enumToInt(player)];
+        pub inline fn side(self: anytype, player: Player) PointerType(@TypeOf(self), Side) {
+            assert(@typeInfo(@TypeOf(self)).Pointer.child == 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 {
-            return &self.sides[@enumToInt(player.foe())];
+        pub inline fn foe(self: anytype, player: Player) PointerType(@TypeOf(self), Side) {
+            assert(@typeInfo(@TypeOf(self)).Pointer.child == 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 {
-            return player.ident(@intCast(u3, self.side(player).order[0]));
+        pub inline fn active(self: *const Self, player: Player) ID {
+            return player.ident(@intCast(self.side(player).order[0]));
         }
 
         /// 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.
-        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,7 +102,7 @@ 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.
+        /// This function will always return choices > 0 if `pkmn.options.showdown` is true.
         pub fn choices(self: *Self, player: Player, request: Choice.Type, out: []Choice) u8 {
             return mechanics.choices(self, player, request, out);
         }
@@ -120,7 +132,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 inline fn get(self: anytype, slot: u8) PointerType(@TypeOf(self), Pokemon) {
+        assert(@typeInfo(@TypeOf(self)).Pointer.child == Side);
         assert(slot > 0 and slot <= 6);
         const id = self.order[slot - 1];
         assert(id > 0 and id <= 6);
@@ -128,7 +141,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 inline fn stored(self: anytype) PointerType(@TypeOf(self), Pokemon) {
+        assert(@typeInfo(@TypeOf(self)).Pointer.child == Side);
         return self.get(1);
     }
 };
@@ -153,7 +167,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 inline fn move(self: anytype, mslot: u8) PointerType(@TypeOf(self), MoveSlot) {
+        assert(@typeInfo(@TypeOf(self)).Pointer.child == ActivePokemon);
         assert(mslot > 0 and mslot <= 4);
         assert(self.moves[mslot - 1].id != .None);
         return &self.moves[mslot - 1];
@@ -182,7 +197,8 @@ 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 inline fn move(self: anytype, mslot: u8) PointerType(@TypeOf(self), MoveSlot) {
+        assert(@typeInfo(@TypeOf(self)).Pointer.child == Pokemon);
         assert(mslot > 0 and mslot <= 4);
         assert(self.moves[mslot - 1].id != .None);
         return &self.moves[mslot - 1];
@@ -201,17 +217,19 @@ pub const MoveSlot = extern struct {
     }
 };
 
-const uindex = if (showdown) u16 else u4;
-
-/// Representation of the move slot indexes for each side in a Generation I Pokémon battle.
-pub const MoveIndexes = packed struct {
-    /// Player 1's move index.
-    p1: uindex = 0,
-    /// Player 1's move index.
-    p2: uindex = 0,
+/// 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 u4 = 0,
+    /// Whether the last move executed by Player 1 was counterable.
+    p1_counterable: if (showdown) u8 else u4 = 0,
+    /// The move slot index of the last move selected in the battle menu by Player 2
+    p2_index: if (showdown) u8 else u4 = 0,
+    /// Whether the last move executed by Player 2 was counterable.
+    p2_counterable: if (showdown) u8 else u4 = 0,
 
     comptime {
-        assert(@sizeOf(MoveIndexes) == if (showdown) 4 else 1);
+        assert(@sizeOf(MoveDetails) == if (showdown) 4 else 2);
     }
 };
 
@@ -241,13 +259,13 @@ pub const Status = enum(u8) {
     /// Whether or not the status `num` is the same as `status`.
     pub inline fn is(num: u8, status: Status) bool {
         if (status == .SLP) return Status.duration(num) > 0;
-        return ((num >> @intCast(u3, @enumToInt(status))) & 1) != 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 {
         assert(status != .SLP and status != .EXT);
-        return @as(u8, 1) << @intCast(u3, @enumToInt(status));
+        return @as(u8, 1) << @intCast(@intFromEnum(status));
     }
 
     /// Initializes a non self-inflicted sleep status with duration `dur`.
@@ -264,7 +282,7 @@ pub const Status = enum(u8) {
 
     /// Returns the duration of a sleep status.
     pub inline fn duration(num: u8) u3 {
-        return @intCast(u3, num & SLP);
+        return @intCast(num & SLP);
     }
 
     /// Returns whether `num` reflects any status.
@@ -411,10 +429,11 @@ pub fn Stats(comptime T: type) type {
         /// Computes the value of `stat` given a `base`, `dv`, stat `exp` and `level`.
         pub fn calc(comptime stat: []const u8, base: T, dv: u4, exp: u16, level: u8) T {
             assert(level > 0 and level <= 100);
-            const evs = @min(255, @floatToInt(u16, @ceil(@sqrt(@intToFloat(f32, exp)))));
+            const float: f32 = @floatFromInt(exp);
+            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(T, core *% @as(u32, level) / 100 +% factor);
+            return @intCast(core *% @as(u32, level) / 100 +% factor);
         }
     };
 }
@@ -463,7 +482,7 @@ test Boosts {
 pub const Move = moves.Move;
 
 test Move {
-    try expectEqual(2, @enumToInt(Move.KarateChop));
+    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);
@@ -524,7 +543,7 @@ test Move {
 pub const Species = species.Species;
 
 test Species {
-    try expectEqual(2, @enumToInt(Species.Ivysaur));
+    try expectEqual(2, @intFromEnum(Species.Ivysaur));
     try expectEqual(@as(u8, 100), Species.get(.Mew).stats.def);
 }
 
@@ -541,9 +560,11 @@ pub const Effectiveness = enum(u8) {
     Super = 20,
 
     /// Used to determine the effectiness of a neutral damage hit.
-    pub const neutral: u16 = @enumToInt(Effectiveness.Neutral) * @enumToInt(Effectiveness.Neutral);
+    pub const neutral: u16 =
+        @intFromEnum(Effectiveness.Neutral) * @intFromEnum(Effectiveness.Neutral);
     /// Used to detect whether there is a mismatch in type effectivness (relevant for precedence).
-    pub const mismatch: u16 = @enumToInt(Effectiveness.Resisted) + @enumToInt(Effectiveness.Super);
+    pub const mismatch: u16 =
+        @intFromEnum(Effectiveness.Resisted) + @intFromEnum(Effectiveness.Super);
 
     comptime {
         assert(@sizeOf(Effectiveness) == 1);
@@ -551,8 +572,8 @@ pub const Effectiveness = enum(u8) {
 };
 
 test Types {
-    try expectEqual(14, @enumToInt(Type.Dragon));
-    try expectEqual(20, @enumToInt(Effectiveness.Super));
+    try expectEqual(14, @intFromEnum(Type.Dragon));
+    try expectEqual(20, @intFromEnum(Effectiveness.Super));
 
     try expect(!Type.Ghost.special());
     try expect(Type.Dragon.special());