@pkmn/engine 0.1.0-dev.eaae4aa6 → 0.1.0-dev.f3aab252

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

@@ -1091,7 +1091,7 @@ 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.
+    /// 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.zig

@@ -22,11 +22,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
@@ -47,6 +47,7 @@ const Player = data.Player;
 const Result = data.Result;
 
 const PointerType = util.PointerType;
+const isPointerTo = util.isPointerTo;
 
 const showdown = pkmn.options.showdown;
 
@@ -71,13 +72,13 @@ pub fn Battle(comptime RNG: anytype) type {
 
         /// Returns the `Side` for the given `player`.
         pub fn side(self: anytype, player: Player) PointerType(@TypeOf(self), Side) {
-            assert(@typeInfo(@TypeOf(self)).Pointer.child == Self);
+            assert(isPointerTo(self, Self));
             return &self.sides[@intFromEnum(player)];
         }
 
         /// Returns the `Side` of the opponent for the given `player`
         pub fn foe(self: anytype, player: Player) PointerType(@TypeOf(self), Side) {
-            assert(@typeInfo(@TypeOf(self)).Pointer.child == Self);
+            assert(isPointerTo(self, Self));
             return &self.sides[@intFromEnum(player.foe())];
         }
 
@@ -91,7 +92,7 @@ pub fn Battle(comptime RNG: anytype) type {
             self: anytype,
             player: Player,
         ) PointerType(@TypeOf(self), MoveDetails) {
-            assert(@typeInfo(@TypeOf(self)).Pointer.child == Self);
+            assert(isPointerTo(self, Self));
             return &self.last_moves[@intFromEnum(player)];
         }
 
@@ -142,7 +143,7 @@ pub const Side = extern struct {
 
     /// Returns the stored `Pokemon` corresponding to the one-indexed party `slot`.
     pub fn get(self: anytype, slot: u8) PointerType(@TypeOf(self), Pokemon) {
-        assert(@typeInfo(@TypeOf(self)).Pointer.child == Side);
+        assert(isPointerTo(self, Side));
         assert(slot > 0 and slot <= 6);
         const id = self.order[slot - 1];
         assert(id > 0 and id <= 6);
@@ -151,7 +152,7 @@ pub const Side = extern struct {
 
     /// Returns the stored `Pokemon` corresponding to the `active` Pokémon (slot 1).
     pub fn stored(self: anytype) PointerType(@TypeOf(self), Pokemon) {
-        assert(@typeInfo(@TypeOf(self)).Pointer.child == Side);
+        assert(isPointerTo(self, Side));
         return self.get(1);
     }
 };
@@ -177,7 +178,7 @@ pub const ActivePokemon = extern struct {
 
     /// Returns the active Pokémon's current move slot located at the one-indexed `mslot`.
     pub fn move(self: anytype, mslot: u8) PointerType(@TypeOf(self), MoveSlot) {
-        assert(@typeInfo(@TypeOf(self)).Pointer.child == ActivePokemon);
+        assert(isPointerTo(self, ActivePokemon));
         assert(mslot > 0 and mslot <= 4);
         assert(self.moves[mslot - 1].id != .None);
         return &self.moves[mslot - 1];
@@ -207,7 +208,7 @@ pub const Pokemon = extern struct {
 
     /// Returns the Pokémon's original move slot located at the one-indexed `mslot`.
     pub fn move(self: anytype, mslot: u8) PointerType(@TypeOf(self), MoveSlot) {
-        assert(@typeInfo(@TypeOf(self)).Pointer.child == Pokemon);
+        assert(isPointerTo(self, Pokemon));
         assert(mslot > 0 and mslot <= 4);
         assert(self.moves[mslot - 1].id != .None);
         return &self.moves[mslot - 1];
@@ -255,7 +256,7 @@ 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 fn is(num: u8, status: Status) bool {
@@ -283,7 +284,7 @@ pub const Status = enum(u8) {
 
     /// Returns the duration of a sleep status.
     pub fn duration(num: u8) u3 {
-        return @intCast(num & SLP);
+        return @intCast(num & SLEEP);
     }
 
     /// Returns whether `num` reflects any status.
@@ -316,12 +317,12 @@ test Status {
     try expect(Status.is(Status.slp(5), .SLP));
     try expect(!Status.is(Status.slp(5), .EXT));
     try expect(!Status.is(Status.slp(7), .PSN));
-    try expectEqual(5, Status.duration(Status.slp(5)));
+    try expectEqual(@as(u3, 5), Status.duration(Status.slp(5)));
     try expect(Status.is(Status.slf(2), .SLP));
     try expect(Status.is(Status.slf(2), .EXT));
     try expect(Status.is(Status.TOX, .PSN));
     try expect(Status.is(Status.TOX, .EXT));
-    try expectEqual(1, Status.duration(Status.slp(1)));
+    try expectEqual(@as(u3, 1), Status.duration(Status.slp(1)));
 }
 
 /// Bitfield representation of volatile statuses and associated data in Generation I.
@@ -405,16 +406,16 @@ test Volatiles {
     try expect(!volatiles.Transform);
     try expect(!volatiles.MultiHit);
 
-    try expectEqual(235, volatiles.state);
-    try expectEqual(42, volatiles.substitute);
-    try expectEqual(2, volatiles.disable_move);
-    try expectEqual(4, volatiles.disable_duration);
-    try expectEqual(2, volatiles.confusion);
-    try expectEqual(4, volatiles.toxic);
-    try expectEqual(3, volatiles.attacks);
+    try expectEqual(@as(u16, 235), volatiles.state);
+    try expectEqual(@as(u8, 42), volatiles.substitute);
+    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(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,
@@ -442,9 +443,9 @@ test Stats {
     try expectEqual(0, stats.def);
 
     var base = Species.get(.Gyarados).stats;
-    try expectEqual(127, Stats(u16).calc("hp", base.hp, 0, 5120, 38));
+    try expectEqual(@as(u16, 127), Stats(u16).calc("hp", base.hp, 0, 5120, 38));
     base = Species.get(.Pidgeot).stats;
-    try expectEqual(279, Stats(u16).calc("spe", base.spe, 15, 63001, 100));
+    try expectEqual(@as(u16, 279), Stats(u16).calc("spe", base.spe, 15, 63001, 100));
 }
 
 /// Representation of a Pokémon's boosts in Generation I.
@@ -537,7 +538,7 @@ pub const Species = species.Species;
 
 test Species {
     try expectEqual(2, @intFromEnum(Species.Ivysaur));
-    try expectEqual(100, Species.get(.Mew).stats.def);
+    try expectEqual(@as(u8, 100), Species.get(.Mew).stats.def);
 }
 
 /// Representation of a Generation I type in Pokémon.
@@ -576,8 +577,8 @@ test Types {
     try expectEqual(Effectiveness.Resisted, Type.effectiveness(.Fire, .Water));
     try expectEqual(Effectiveness.Neutral, Type.effectiveness(.Normal, .Grass));
 
-    try expectEqual(3, Type.precedence(.Water, .Water));
-    try expectEqual(26, Type.precedence(.Bug, .Ghost));
+    try expectEqual(@as(u8, 3), Type.precedence(.Water, .Water));
+    try expectEqual(@as(u8, 26), Type.precedence(.Bug, .Ghost));
     try expect(Type.precedence(.Poison, .Bug) > Type.precedence(.Poison, .Poison));
 
     const t: Types = .{ .type1 = .Rock, .type2 = .Ground };
@@ -617,18 +618,18 @@ pub const DVs = struct {
 
 test DVs {
     var dvs: DVs = .{ .spc = 15, .spe = 15 };
-    try expectEqual(15, dvs.hp());
+    try expectEqual(@as(u4, 15), dvs.hp());
     dvs = .{
         .atk = 5,
         .def = 15,
         .spe = 13,
         .spc = 13,
     };
-    try expectEqual(15, dvs.hp());
+    try expectEqual(@as(u4, 15), dvs.hp());
     dvs = .{
         .def = 3,
         .spe = 10,
         .spc = 11,
     };
-    try expectEqual(13, dvs.hp());
+    try expectEqual(@as(u4, 13), dvs.hp());
 }