@pkmn/engine 0.1.0-dev.fb5bf955 → 0.1.0-dev.fb6653d6

package/src/lib/gen2/data.zig

@@ -1,46 +1,54 @@
-const std = @import("std");
-const builtin = @import("builtin");
-
-const data = @import("../common/data.zig");
 const DEBUG = @import("../common/debug.zig").print;
-const options = @import("../common/options.zig");
-const rng = @import("../common/rng.zig");
 
+const builtin = @import("builtin");
+const calc = @import("calc.zig");
+const chance = @import("chance.zig");
+const data = @import("../common/data.zig");
+const gen1 = @import("../gen1/data.zig");
 const items = @import("data/items.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 species = @import("data/species.zig");
+const std = @import("std");
 const types = @import("data/types.zig");
-
-const gen1 = @import("../gen1/data.zig");
-
-const mechanics = @import("mechanics.zig");
+const util = @import("../common/util.zig");
 
 const assert = std.debug.assert;
 const expectEqual = std.testing.expectEqual;
 const expect = std.testing.expect;
 
-pub const MAX_OPTIONS: usize = 9; // move 1..4, switch 2..6
+pub const MAX_CHOICES: usize = 9; // move 1..4, switch 2..6
 pub const MAX_LOGS: usize = 180; // TODO
 
-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;
 pub const LOGS_SIZE = if (builtin.mode == .ReleaseSmall)
     MAX_LOGS
 else
     std.math.ceilPowerOfTwo(usize, MAX_LOGS) catch unreachable;
 
+///  Null object pattern implementation of pkmn.battle.Options for Generation II.
+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;
 
 pub const PRNG = rng.PRNG(2);
 
 pub fn Battle(comptime RNG: anytype) type {
+    const padding = if (!showdown) 3 else 5;
     return extern struct {
         const Self = @This();
 
@@ -49,20 +57,24 @@ pub fn Battle(comptime RNG: anytype) type {
         turn: u16 = 0,
         field: Field = .{},
 
-        pub inline fn side(self: *Self, player: Player) *Side {
-            return &self.sides[@enumToInt(player)];
+        _: [padding]u8 = .{0} ** padding,
+
+        pub fn side(self: anytype, player: Player) PointerType(@TypeOf(self), Side) {
+            assert(isPointerTo(self, Self));
+            return &self.sides[@intFromEnum(player)];
         }
 
-        pub inline fn foe(self: *Self, player: Player) *Side {
-            return &self.sides[@enumToInt(player.foe())];
+        pub fn foe(self: anytype, player: Player) PointerType(@TypeOf(self), Side) {
+            assert(isPointerTo(self, Self));
+            return &self.sides[@intFromEnum(player.foe())];
         }
 
-        pub inline fn active(self: *Self, player: Player) ID {
-            return player.ident(@intCast(u3, self.side(player).pokemon[0].position));
+        pub fn active(self: *const Self, player: Player) ID {
+            return player.ident(@intCast(self.side(player).pokemon[0].position));
         }
 
-        pub fn update(self: *Self, c1: Choice, c2: Choice, log: anytype) !Result {
-            return mechanics.update(self, c1, c2, log);
+        pub fn update(self: *Self, c1: Choice, c2: Choice, options: anytype) !Result {
+            return mechanics.update(self, c1, c2, options);
         }
 
         pub fn choices(self: *Self, player: Player, request: Choice.Type, out: []Choice) u8 {
@@ -71,35 +83,32 @@ pub fn Battle(comptime RNG: anytype) type {
     };
 }
 
-// TODO
 test Battle {
-    try expectEqual(496, @sizeOf(Battle(PRNG)));
+    try expectEqual(512, @sizeOf(Battle(PRNG)));
 }
 
-const Field = packed struct {
+pub const Field = packed struct(u8) {
     weather: Weather = .None,
     weather_duration: u4 = 0,
-
-    comptime {
-        assert(@sizeOf(Field) == 1);
-    }
 };
 
-const Weather = enum(u4) {
+pub const Weather = enum(u4) {
     None,
     Rain,
     Sun,
     Sandstorm,
 };
 
-const Side = extern struct {
+pub const Side = extern struct {
     pokemon: [6]Pokemon = [_]Pokemon{.{}} ** 6,
-    active: ActivePokemon = .{},
-    conditions: Conditions,
+    active: ActivePokemon align(8) = .{},
+    conditions: Conditions = .{},
+    // NB: wLastPlayerCounterMove / wLastEnemyCounterMove (wLastPlayerMove / wLastEnemyMove)
     last_used_move: Move = .None,
-    _: u8 = 0,
 
-    const Conditions = packed struct {
+    _: [7]u8 = .{0} ** 7,
+
+    const Conditions = packed struct(u32) {
         Spikes: bool = false,
         Safeguard: bool = false,
         LightScreen: bool = false,
@@ -109,50 +118,69 @@ const Side = extern struct {
         light_screen: u4 = 0,
         reflect: u4 = 0,
 
-        comptime {
-            assert(@sizeOf(Conditions) == 2);
-        }
+        future_sight: FutureSight = .{},
+
+        const FutureSight = packed struct(u16) {
+            damage: u12 = 0,
+            count: u4 = 0,
+        };
     };
 
     comptime {
-        assert(@sizeOf(Side) == 240);
+        assert(@sizeOf(Side) == 248);
     }
 
-    pub inline fn get(self: *const 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.pokemon[slot - 1].position;
         assert(id > 0 and id <= 6);
         return &self.pokemon[id - 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);
     }
+
+    pub fn lastMove(self: anytype, encore: bool) Move {
+        assert(self.last_used_move != .None or !self.active.volatiles.dirty);
+        if (encore) return self.last_used_move;
+        return if (self.active.volatiles.dirty) .None else self.last_used_move;
+    }
+
+    // TODO
+    // pub fn useMove(self: anytype) void {
+    //     assert(side.last_selected_move != .None);
+    //     self.last_used_move = side.last_selected_move;
+    //     self.active.volatiles.dirty = false;
+    // }
 };
 
 // NOTE: DVs (Gender & Hidden Power) and Happiness are stored only in Pokemon
-const ActivePokemon = extern struct {
-    volatiles: Volatile align(4) = .{},
+pub const ActivePokemon = extern struct {
+    volatiles: Volatiles align(4) = .{},
     stats: Stats(u16) = .{},
     moves: [4]MoveSlot = [_]MoveSlot{.{}} ** 4,
     boosts: Boosts = .{},
+    types: Types = .{},
     species: Species = .None,
-    item: Item = .None,
-    last_move: Move = .None,
+
     _: u8 = 0,
 
     comptime {
         assert(@sizeOf(ActivePokemon) == 44);
     }
 
-    pub inline fn move(self: *ActivePokemon, 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];
     }
 };
 
-const Pokemon = extern struct {
+pub const Pokemon = extern struct {
     stats: Stats(u16) = .{},
     moves: [4]MoveSlot = [_]MoveSlot{.{}} ** 4,
     types: Types = .{},
@@ -169,7 +197,8 @@ const Pokemon = extern struct {
         assert(@sizeOf(Pokemon) == 32);
     }
 
-    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];
@@ -182,7 +211,7 @@ pub const Gender = enum(u2) {
     Unknown,
 };
 
-const DVs = packed struct {
+pub const DVs = packed struct(u16) {
     gender: Gender = .Male,
     pow: u6 = 40,
     type: Type = .Dark,
@@ -190,10 +219,10 @@ const DVs = packed struct {
     pub fn init(g: Gender, p: u6, t: Type) DVs {
         assert(p >= 1 and p <= 40);
         assert(t != .Normal and t != .@"???");
-        return DVs{ .gender = g, .pow = p, .type = t };
+        return .{ .gender = g, .pow = p, .type = t };
     }
 
-    pub inline fn power(dvs: DVs) u8 {
+    pub fn power(dvs: DVs) u8 {
         return @as(u8, dvs.pow) + 30;
     }
 
@@ -205,15 +234,10 @@ const DVs = packed struct {
             0xFF => .Unknown,
             else => if ((@as(u8, dvs.atk) << 4 | dvs.spe) < ratio) Gender.Female else Gender.Male,
         };
-        const p = @intCast(u6, 1 + ((5 * @as(u8, (dvs.atk & 0b1000) | ((dvs.def & 0b1000)) >> 1 |
+        const p: u6 = @intCast(1 + ((5 * @as(u8, (dvs.atk & 0b1000) | ((dvs.def & 0b1000)) >> 1 |
             ((dvs.spe & 0b1000)) >> 2 | ((dvs.spc & 0b1000)) >> 3) + (dvs.spc & 0b0011)) >> 1));
-        var t = @as(u8, dvs.def & 0b0011) + (@as(u8, dvs.atk & 0b0011) << 2) + 1;
-        if (t >= @enumToInt(Type.@"???")) t = t + 1;
-        return DVs{ .gender = g, .pow = p, .type = @intToEnum(Type, t) };
-    }
-
-    comptime {
-        assert(@sizeOf(DVs) == 2);
+        const t = @as(u8, dvs.def & 0b0011) + (@as(u8, dvs.atk & 0b0011) << 2);
+        return .{ .gender = g, .pow = p, .type = Type.hiddenPower(t) };
     }
 };
 
@@ -238,10 +262,12 @@ test DVs {
     try expectEqual(Gender.Female, dvs.gender);
 }
 
-const MoveSlot = packed struct {
+/// Representation of a Generation II Pokémon's move slot in a battle.
+pub const MoveSlot = extern struct {
+    /// The identifier for the move.
     id: Move = .None,
-    pp_ups: u2 = 3,
-    pp: u6 = 0,
+    /// The remaining PP of the move.
+    pp: u8 = 0,
 
     comptime {
         assert(@sizeOf(MoveSlot) == 2);
@@ -250,14 +276,19 @@ const MoveSlot = packed struct {
 
 pub const Status = gen1.Status;
 
-const Volatile = packed struct {
+/// TODO
+pub const TriAttack = enum(u2) { PAR, FRZ, BRN };
+
+pub const Volatiles = packed struct(u128) {
     Bide: bool = false,
     Thrashing: bool = false,
+    BeatUp: bool = false,
     Flinch: bool = false,
     Charging: bool = false,
     Underground: bool = false,
     Flying: bool = false,
     Confusion: bool = false,
+
     Mist: bool = false,
     FocusEnergy: bool = false,
     Substitute: bool = false,
@@ -268,52 +299,55 @@ const Volatile = packed struct {
     Transform: bool = false,
 
     Nightmare: bool = false,
-    Cure: bool = false,
+    Curse: bool = false,
     Protect: bool = false,
     Foresight: bool = false,
     PerishSong: bool = false,
     Endure: bool = false,
     Rollout: bool = false,
     Attract: bool = false,
+
     DefenseCurl: bool = false,
     Encore: bool = false,
     LockOn: bool = false,
     DestinyBond: bool = false,
-    BeatUp: bool = false,
+    Trapped: bool = false,
 
-    trapped: bool = false,
     switched: bool = false,
+    // TODO: replace with simply looking at Choice on Battle
     switching: bool = false,
+    // TODO: simply store both last moves on side
+    dirty: bool = false,
 
-    _: u5 = 0,
+    frozen: bool = false,
+    minimized: bool = false,
+    _: u10 = 0,
+    // TODO: is this needed for unmodified stats?
+    transform: u4 = 0,
 
-    bind: u4 = 0,
-    future_sight: FutureSight = .{},
     bide: u16 = 0,
-    disabled: Disabled = .{},
+    bind: Bind = .{},
+    disable: Disable = .{},
     rage: u8 = 0,
     substitute: u8 = 0,
     toxic: u8 = 0,
     confusion: u4 = 0,
     encore: u4 = 0,
+    // TODO merge with attacks (ie rollout/thrashing)? need to be zeroed at same time
     fury_cutter: u4 = 0,
     perish_song: u4 = 0,
     protect: u4 = 0,
-    rollout: u4 = 0,
+    attacks: u4 = 0, // bide/thrashing/rollout turns
 
-    const Disabled = packed struct {
-        move: u4 = 0,
+    const Bind = packed struct(u8) {
         duration: u4 = 0,
+        reason: u4 = 0,
     };
 
-    const FutureSight = packed struct {
-        damage: u12 = 0,
-        count: u4 = 0,
+    const Disable = packed struct(u8) {
+        move: u4 = 0,
+        duration: u4 = 0,
     };
-
-    comptime {
-        assert(@sizeOf(Volatile) == 16);
-    }
 };
 
 pub fn Stats(comptime T: type) type {
@@ -327,10 +361,11 @@ 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 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);
         }
     };
 }
@@ -347,7 +382,7 @@ test Stats {
     try expectEqual(@as(u16, 279), Stats(u16).calc("spe", base.spe, 15, 63001, 100));
 }
 
-pub const Boosts = packed struct {
+pub const Boosts = packed struct(u32) {
     atk: i4 = 0,
     def: i4 = 0,
     spe: i4 = 0,
@@ -363,7 +398,7 @@ pub const Boosts = packed struct {
 };
 
 test Boosts {
-    const boosts = Boosts{ .spd = -6 };
+    const boosts: Boosts = .{ .spd = -6 };
     try expectEqual(0, boosts.atk);
     try expectEqual(-6, boosts.spd);
 }
@@ -376,31 +411,31 @@ test Item {
     try expectEqual(Type.Normal, Item.boost(.PolkadotBow).?);
     try expectEqual(Type.Dark, Item.boost(.BlackGlasses).?);
 
-    try expect(!Item.mail(.UpGrade));
-    try expect(Item.mail(.FlowerMail));
-    try expect(Item.mail(.MirageMail));
-    try expect(!Item.mail(.TownMap));
-
-    try expect(!Item.berry(.LightBall));
-    try expect(Item.berry(.PSNCureBerry));
-    try expect(Item.berry(.GoldBerry));
-    try expect(!Item.berry(.MasterBall));
+    try expect(!Item.isMail(.UpGrade));
+    try expect(Item.isMail(.FlowerMail));
+    try expect(Item.isMail(.MirageMail));
+    try expect(!Item.isMail(.TownMap));
 }
 
 pub const Move = moves.Move;
 
 test Move {
-    try expectEqual(251, @enumToInt(Move.BeatUp));
+    try expectEqual(251, @intFromEnum(Move.BeatUp));
     const move = Move.get(.DynamicPunch);
     try expectEqual(Move.Effect.ConfusionChance, move.effect);
-    try expectEqual(@as(u8, 50), move.accuracy);
-    try expectEqual(@as(u8, 5), move.pp);
+    try expectEqual(rng.Gen12.percent(50), move.accuracy);
+    try expectEqual(rng.Gen12.percent(100), move.chance);
+    try expectEqual(@as(u8, 5), Move.pp(.DynamicPunch));
+    try expectEqual(@as(i8, -1), Move.get(.Counter).priority);
+    try expect(!move.effect.isHighCritical());
+    try expect(Move.get(.KarateChop).effect.isHighCritical());
+    try expect(Move.get(.RazorWind).effect.isHighCritical());
 }
 
 pub const Species = species.Species;
 
 test Species {
-    try expectEqual(152, @enumToInt(Species.Chikorita));
+    try expectEqual(152, @intFromEnum(Species.Chikorita));
     try expectEqual(@as(u8, 100), Species.get(.Celebi).stats.spd);
 }
 
@@ -409,7 +444,7 @@ pub const Types = types.Types;
 pub const Effectiveness = gen1.Effectiveness;
 
 test Types {
-    try expectEqual(13, @enumToInt(Type.Electric));
+    try expectEqual(13, @intFromEnum(Type.Electric));
 
     try expect(!Type.Steel.special());
     try expect(Type.Dark.special());