@pkmn/engine 0.1.0-dev.d716e940 → 0.1.0-dev.dd5b9081

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. package/README.md +55 -44
  2. package/build/pkg/addon.js +3 -2
  3. package/build/pkg/addon.js.map +1 -1
  4. package/build/pkg/data/layout.json +24 -2
  5. package/build/pkg/gen1.js +13 -16
  6. package/build/pkg/gen1.js.map +1 -1
  7. package/build/pkg/index.js.map +1 -1
  8. package/build.zig +86 -62
  9. package/package.json +25 -16
  10. package/src/bin/install-pkmn-engine +10 -5
  11. package/src/lib/binding/node.zig +45 -140
  12. package/src/lib/binding/wasm.zig +4 -2
  13. package/src/lib/common/battle.zig +17 -0
  14. package/src/lib/common/data.zig +14 -26
  15. package/src/lib/common/debug.zig +20 -11
  16. package/src/lib/common/js.zig +118 -0
  17. package/src/lib/common/optional.zig +60 -0
  18. package/src/lib/common/options.zig +9 -0
  19. package/src/lib/common/protocol.zig +277 -159
  20. package/src/lib/common/rational.zig +353 -0
  21. package/src/lib/common/rng.zig +11 -11
  22. package/src/lib/common/util.zig +12 -0
  23. package/src/lib/gen1/README.md +259 -177
  24. package/src/lib/gen1/calc.zig +426 -0
  25. package/src/lib/gen1/chance.zig +1036 -0
  26. package/src/lib/gen1/data/moves.zig +178 -180
  27. package/src/lib/gen1/data/species.zig +2 -2
  28. package/src/lib/gen1/data/types.zig +3 -3
  29. package/src/lib/gen1/data.zig +66 -54
  30. package/src/lib/gen1/helpers.zig +589 -18
  31. package/src/lib/gen1/mechanics.zig +791 -508
  32. package/src/lib/gen2/README.md +87 -13
  33. package/src/lib/gen2/data/items.zig +3 -3
  34. package/src/lib/gen2/data/moves.zig +624 -563
  35. package/src/lib/gen2/data/species.zig +1 -1
  36. package/src/lib/gen2/data/types.zig +3 -3
  37. package/src/lib/gen2/data.zig +100 -70
  38. package/src/lib/gen2/helpers.zig +16 -22
  39. package/src/lib/gen2/mechanics.zig +714 -10
  40. package/src/lib/pkmn.zig +61 -2
@@ -1094,12 +1094,12 @@ pub const Species = enum(u8) {
1094
1094
  /// The Pokémon's critical hit rate=io out of 256.
1095
1095
  pub inline fn chance(id: Species) u8 {
1096
1096
  assert(id != .None);
1097
- return CHANCES[@enumToInt(id) - 1];
1097
+ return CHANCES[@intFromEnum(id) - 1];
1098
1098
  }
1099
1099
 
1100
1100
  /// Returns the `Data` corresponding to the species.
1101
1101
  pub fn get(id: Species) Data {
1102
1102
  assert(id != .None);
1103
- return DATA[@enumToInt(id) - 1];
1103
+ return DATA[@intFromEnum(id) - 1];
1104
1104
  }
1105
1105
  };
@@ -91,18 +91,18 @@ pub const Type = enum(u4) {
91
91
 
92
92
  /// Whether or not this type is considered to be special as opposed to physical.
93
93
  pub inline fn special(self: Type) bool {
94
- return @enumToInt(self) >= @enumToInt(Type.Fire);
94
+ return @intFromEnum(self) >= @intFromEnum(Type.Fire);
95
95
  }
96
96
 
97
97
  /// The `Effectiveness` of type `t2` vs. type `t1`.
98
98
  pub inline fn effectiveness(t1: Type, t2: Type) Effectiveness {
99
- return CHART[@enumToInt(t1)][@enumToInt(t2)];
99
+ return CHART[@intFromEnum(t1)][@intFromEnum(t2)];
100
100
  }
101
101
 
102
102
  /// The precedence order of type `t2` vs. type `t1`.
103
103
  pub fn precedence(t1: Type, t2: Type) u8 {
104
104
  for (PRECEDENCE, 0..) |matchup, i| {
105
- if (matchup.type1 == t1 and matchup.type2 == t2) return @intCast(u8, i);
105
+ if (matchup.type1 == t1 and matchup.type2 == t2) return @intCast(i);
106
106
  }
107
107
  unreachable;
108
108
  }
@@ -1,15 +1,19 @@
1
1
  const std = @import("std");
2
2
  const builtin = @import("builtin");
3
3
 
4
+ const pkmn = @import("../pkmn.zig");
5
+
4
6
  const data = @import("../common/data.zig");
5
- const options = @import("../common/options.zig");
6
7
  const protocol = @import("../common/protocol.zig");
7
8
  const rng = @import("../common/rng.zig");
9
+ const util = @import("../common/util.zig");
8
10
 
9
11
  const moves = @import("data/moves.zig");
10
12
  const species = @import("data/species.zig");
11
13
  const types = @import("data/types.zig");
12
14
 
15
+ const calc = @import("calc.zig");
16
+ const chance = @import("chance.zig");
13
17
  const mechanics = @import("mechanics.zig");
14
18
 
15
19
  const assert = std.debug.assert;
@@ -34,12 +38,17 @@ pub const LOGS_SIZE = if (builtin.mode == .ReleaseSmall)
34
38
  else
35
39
  std.math.ceilPowerOfTwo(usize, MAX_LOGS) catch unreachable;
36
40
 
41
+ /// Null object pattern implementation of pkmn.battle.Options for Generation I.
42
+ pub const NULL = pkmn.battle.options(protocol.NULL, chance.NULL, calc.NULL);
43
+
37
44
  const Choice = data.Choice;
38
45
  const ID = data.ID;
39
46
  const Player = data.Player;
40
47
  const Result = data.Result;
41
48
 
42
- const showdown = options.showdown;
49
+ const PointerType = util.PointerType;
50
+
51
+ const showdown = pkmn.options.showdown;
43
52
 
44
53
  /// The pseudo random number generator used by Generation I.
45
54
  pub const PRNG = rng.PRNG(1);
@@ -56,29 +65,41 @@ pub fn Battle(comptime RNG: anytype) type {
56
65
  /// The last damage dealt by either side.
57
66
  last_damage: u16 = 0,
58
67
  /// Details about the last move selected/used by each player required to detect desyncs.
59
- last_moves: MoveDetails = .{},
68
+ last_moves: [2]MoveDetails = [_]MoveDetails{.{}} ** 2,
60
69
  /// The pseudo random number generator.
61
70
  rng: RNG,
62
71
 
63
72
  /// Returns the `Side` for the given `player`.
64
- pub inline fn side(self: *Self, player: Player) *Side {
65
- return &self.sides[@enumToInt(player)];
73
+ pub inline fn side(self: anytype, player: Player) PointerType(@TypeOf(self), Side) {
74
+ assert(@typeInfo(@TypeOf(self)).Pointer.child == Self);
75
+ return &self.sides[@intFromEnum(player)];
66
76
  }
67
77
 
68
78
  /// Returns the `Side` of the opponent for the given `player`
69
- pub inline fn foe(self: *Self, player: Player) *Side {
70
- return &self.sides[@enumToInt(player.foe())];
79
+ pub inline fn foe(self: anytype, player: Player) PointerType(@TypeOf(self), Side) {
80
+ assert(@typeInfo(@TypeOf(self)).Pointer.child == Self);
81
+ return &self.sides[@intFromEnum(player.foe())];
71
82
  }
72
83
 
73
84
  /// Returns an identifier for the active Pokémon of `player`.
74
- pub inline fn active(self: *Self, player: Player) ID {
75
- return player.ident(@intCast(u3, self.side(player).order[0]));
85
+ pub inline fn active(self: *const Self, player: Player) ID {
86
+ return player.ident(@intCast(self.side(player).order[0]));
87
+ }
88
+
89
+ /// Returns the `MoveDetails` for the given `player`.
90
+ pub inline fn lastMove(
91
+ self: anytype,
92
+ player: Player,
93
+ ) PointerType(@TypeOf(self), MoveDetails) {
94
+ assert(@typeInfo(@TypeOf(self)).Pointer.child == Self);
95
+ return &self.last_moves[@intFromEnum(player)];
76
96
  }
77
97
 
78
98
  /// Returns the result of applying Player 1's choice `c1` and Player 2's choice `c2` to the
79
- /// battle, optionally writing protocol message logs to `log` if `options.log` is enabled.
80
- pub fn update(self: *Self, c1: Choice, c2: Choice, log: anytype) !Result {
81
- return mechanics.update(self, c1, c2, log);
99
+ /// battle, optionally writing protocol message logs to `options.log` if `pkmn.options.log`
100
+ /// is enabled.
101
+ pub fn update(self: *Self, c1: Choice, c2: Choice, options: anytype) !Result {
102
+ return mechanics.update(self, c1, c2, options);
82
103
  }
83
104
 
84
105
  /// Fills in at most `out.len` possible choices for the `player` given the previous `result`
@@ -90,7 +111,7 @@ pub fn Battle(comptime RNG: anytype) type {
90
111
  /// interacts with Disable, in which case there are no possible choices for the player to
91
112
  /// make (i.e. on the cartridge a soft-lock occurs).
92
113
  ///
93
- /// This function will always return a number of choices > 0 if options.showdown is true.
114
+ /// This function will always return choices > 0 if `pkmn.options.showdown` is true.
94
115
  pub fn choices(self: *Self, player: Player, request: Choice.Type, out: []Choice) u8 {
95
116
  return mechanics.choices(self, player, request, out);
96
117
  }
@@ -120,7 +141,8 @@ pub const Side = extern struct {
120
141
  }
121
142
 
122
143
  /// Returns the stored `Pokemon` corresponding to the one-indexed party `slot`.
123
- pub inline fn get(self: *Side, slot: u8) *Pokemon {
144
+ pub inline fn get(self: anytype, slot: u8) PointerType(@TypeOf(self), Pokemon) {
145
+ assert(@typeInfo(@TypeOf(self)).Pointer.child == Side);
124
146
  assert(slot > 0 and slot <= 6);
125
147
  const id = self.order[slot - 1];
126
148
  assert(id > 0 and id <= 6);
@@ -128,7 +150,8 @@ pub const Side = extern struct {
128
150
  }
129
151
 
130
152
  /// Returns the stored `Pokemon` corresponding to the `active` Pokémon (slot 1).
131
- pub inline fn stored(self: *Side) *Pokemon {
153
+ pub inline fn stored(self: anytype) PointerType(@TypeOf(self), Pokemon) {
154
+ assert(@typeInfo(@TypeOf(self)).Pointer.child == Side);
132
155
  return self.get(1);
133
156
  }
134
157
  };
@@ -153,7 +176,8 @@ pub const ActivePokemon = extern struct {
153
176
  }
154
177
 
155
178
  /// Returns the active Pokémon's current move slot located at the one-indexed `mslot`.
156
- pub inline fn move(self: *ActivePokemon, mslot: u8) *MoveSlot {
179
+ pub inline fn move(self: anytype, mslot: u8) PointerType(@TypeOf(self), MoveSlot) {
180
+ assert(@typeInfo(@TypeOf(self)).Pointer.child == ActivePokemon);
157
181
  assert(mslot > 0 and mslot <= 4);
158
182
  assert(self.moves[mslot - 1].id != .None);
159
183
  return &self.moves[mslot - 1];
@@ -182,14 +206,15 @@ pub const Pokemon = extern struct {
182
206
  }
183
207
 
184
208
  /// Returns the Pokémon's original move slot located at the one-indexed `mslot`.
185
- pub inline fn move(self: *Pokemon, mslot: u8) *MoveSlot {
209
+ pub inline fn move(self: anytype, mslot: u8) PointerType(@TypeOf(self), MoveSlot) {
210
+ assert(@typeInfo(@TypeOf(self)).Pointer.child == Pokemon);
186
211
  assert(mslot > 0 and mslot <= 4);
187
212
  assert(self.moves[mslot - 1].id != .None);
188
213
  return &self.moves[mslot - 1];
189
214
  }
190
215
  };
191
216
 
192
- /// Representation of a Generation I & II Pokémon's move slot in a battle.
217
+ /// Representation of a Generation I Pokémon's move slot in a battle.
193
218
  pub const MoveSlot = extern struct {
194
219
  /// The identifier for the move.
195
220
  id: Move = .None,
@@ -197,24 +222,16 @@ pub const MoveSlot = extern struct {
197
222
  pp: u8 = 0,
198
223
 
199
224
  comptime {
200
- assert(@sizeOf(MoveSlot) == @sizeOf(u16));
225
+ assert(@sizeOf(MoveSlot) == 2);
201
226
  }
202
227
  };
203
228
 
204
229
  /// Details required to detect desyncs based on the move last selected/executed by players.
205
- pub const MoveDetails = packed struct {
206
- /// The move slot index of the last move selected in the battle menu by Player 1
207
- p1_index: if (showdown) u8 else u3 = 0,
208
- /// Whether the last move executed by Player 1 was counterable.
209
- p1_counterable: if (showdown) u8 else u1 = 0,
210
- /// The move slot index of the last move selected in the battle menu by Player 2
211
- p2_index: if (showdown) u8 else u3 = 0,
212
- /// Whether the last move executed by Player 2 was counterable.
213
- p2_counterable: if (showdown) u8 else u1 = 0,
214
-
215
- comptime {
216
- assert(@sizeOf(MoveDetails) == if (showdown) 4 else 1);
217
- }
230
+ pub const MoveDetails = packed struct(if (showdown) u16 else u8) {
231
+ /// The move slot index of the last move selected in the battle menu.
232
+ index: if (showdown) u8 else u4 = 0,
233
+ /// Whether the last move executed was counterable.
234
+ counterable: if (showdown) u8 else u4 = 0,
218
235
  };
219
236
 
220
237
  /// Bitfield representation of a Generation I & II Pokémon's major status condition.
@@ -243,13 +260,13 @@ pub const Status = enum(u8) {
243
260
  /// Whether or not the status `num` is the same as `status`.
244
261
  pub inline fn is(num: u8, status: Status) bool {
245
262
  if (status == .SLP) return Status.duration(num) > 0;
246
- return ((num >> @intCast(u3, @enumToInt(status))) & 1) != 0;
263
+ return ((num >> @intCast(@intFromEnum(status))) & 1) != 0;
247
264
  }
248
265
 
249
266
  /// Initializes a non-sleep `status`. Use `slp` or `slf` to initialize a sleep status.
250
267
  pub inline fn init(status: Status) u8 {
251
268
  assert(status != .SLP and status != .EXT);
252
- return @as(u8, 1) << @intCast(u3, @enumToInt(status));
269
+ return @as(u8, 1) << @intCast(@intFromEnum(status));
253
270
  }
254
271
 
255
272
  /// Initializes a non self-inflicted sleep status with duration `dur`.
@@ -266,7 +283,7 @@ pub const Status = enum(u8) {
266
283
 
267
284
  /// Returns the duration of a sleep status.
268
285
  pub inline fn duration(num: u8) u3 {
269
- return @intCast(u3, num & SLP);
286
+ return @intCast(num & SLP);
270
287
  }
271
288
 
272
289
  /// Returns whether `num` reflects any status.
@@ -308,7 +325,7 @@ test Status {
308
325
  }
309
326
 
310
327
  /// Bitfield representation of volatile statuses and associated data in Generation I.
311
- pub const Volatiles = packed struct {
328
+ pub const Volatiles = packed struct(u64) {
312
329
  /// Whether the "Bide" volatile status is present.
313
330
  Bide: bool = false,
314
331
  /// Whether the "Thrashing" volatile status is present.
@@ -366,10 +383,6 @@ pub const Volatiles = packed struct {
366
383
  disabled_move: u3 = 0,
367
384
  /// The number of turns toxic damage has been accumulating.
368
385
  toxic: u5 = 0,
369
-
370
- comptime {
371
- assert(@sizeOf(Volatiles) == 8);
372
- }
373
386
  };
374
387
 
375
388
  test Volatiles {
@@ -413,10 +426,11 @@ pub fn Stats(comptime T: type) type {
413
426
  /// Computes the value of `stat` given a `base`, `dv`, stat `exp` and `level`.
414
427
  pub fn calc(comptime stat: []const u8, base: T, dv: u4, exp: u16, level: u8) T {
415
428
  assert(level > 0 and level <= 100);
416
- const evs = @min(255, @floatToInt(u16, @ceil(@sqrt(@intToFloat(f32, exp)))));
429
+ const float: f32 = @floatFromInt(exp);
430
+ const evs: u16 = @min(255, @as(u16, @intFromFloat(@ceil(@sqrt(float)))));
417
431
  const core: u32 = (2 *% (@as(u32, base) +% dv)) +% (evs / 4);
418
432
  const factor: u32 = if (std.mem.eql(u8, stat, "hp")) level + 10 else 5;
419
- return @intCast(T, core *% @as(u32, level) / 100 +% factor);
433
+ return @intCast(core *% @as(u32, level) / 100 +% factor);
420
434
  }
421
435
  };
422
436
  }
@@ -434,7 +448,7 @@ test Stats {
434
448
  }
435
449
 
436
450
  /// Representation of a Pokémon's boosts in Generation I.
437
- pub const Boosts = packed struct {
451
+ pub const Boosts = packed struct(u32) {
438
452
  /// A Pokémon's Attack boosts.
439
453
  atk: i4 = 0,
440
454
  /// A Pokémon's Defense boosts.
@@ -449,10 +463,6 @@ pub const Boosts = packed struct {
449
463
  evasion: i4 = 0,
450
464
 
451
465
  _: u8 = 0,
452
-
453
- comptime {
454
- assert(@sizeOf(Boosts) == 4);
455
- }
456
466
  };
457
467
 
458
468
  test Boosts {
@@ -465,10 +475,10 @@ test Boosts {
465
475
  pub const Move = moves.Move;
466
476
 
467
477
  test Move {
468
- try expectEqual(2, @enumToInt(Move.KarateChop));
478
+ try expectEqual(2, @intFromEnum(Move.KarateChop));
469
479
  const move = Move.get(.Fissure);
470
480
  try expectEqual(Move.Effect.OHKO, move.effect);
471
- try expectEqual(@as(u8, 30), move.accuracy);
481
+ try expectEqual(rng.Gen12.percent(30), move.accuracy);
472
482
  try expectEqual(Type.Ground, move.type);
473
483
 
474
484
  try expect(!Move.Effect.onBegin(.None));
@@ -526,7 +536,7 @@ test Move {
526
536
  pub const Species = species.Species;
527
537
 
528
538
  test Species {
529
- try expectEqual(2, @enumToInt(Species.Ivysaur));
539
+ try expectEqual(2, @intFromEnum(Species.Ivysaur));
530
540
  try expectEqual(@as(u8, 100), Species.get(.Mew).stats.def);
531
541
  }
532
542
 
@@ -543,9 +553,11 @@ pub const Effectiveness = enum(u8) {
543
553
  Super = 20,
544
554
 
545
555
  /// Used to determine the effectiness of a neutral damage hit.
546
- pub const neutral: u16 = @enumToInt(Effectiveness.Neutral) * @enumToInt(Effectiveness.Neutral);
556
+ pub const neutral: u16 =
557
+ @intFromEnum(Effectiveness.Neutral) * @intFromEnum(Effectiveness.Neutral);
547
558
  /// Used to detect whether there is a mismatch in type effectivness (relevant for precedence).
548
- pub const mismatch: u16 = @enumToInt(Effectiveness.Resisted) + @enumToInt(Effectiveness.Super);
559
+ pub const mismatch: u16 =
560
+ @intFromEnum(Effectiveness.Resisted) + @intFromEnum(Effectiveness.Super);
549
561
 
550
562
  comptime {
551
563
  assert(@sizeOf(Effectiveness) == 1);
@@ -553,8 +565,8 @@ pub const Effectiveness = enum(u8) {
553
565
  };
554
566
 
555
567
  test Types {
556
- try expectEqual(14, @enumToInt(Type.Dragon));
557
- try expectEqual(20, @enumToInt(Effectiveness.Super));
568
+ try expectEqual(14, @intFromEnum(Type.Dragon));
569
+ try expectEqual(20, @intFromEnum(Effectiveness.Super));
558
570
 
559
571
  try expect(!Type.Ghost.special());
560
572
  try expect(Type.Dragon.special());