@pkmn/engine 0.1.0-dev.96b6c8fa → 0.1.0-dev.979a393a

package/src/lib/gen2/data.zig

@@ -19,13 +19,13 @@ const assert = std.debug.assert;
 const expectEqual = std.testing.expectEqual;
 const expect = std.testing.expect;
 
-pub const MAX_CHOICES: usize = 9; // move 1..4, switch 2..6
+pub const MAX_OPTIONS: usize = 9; // move 1..4, switch 2..6
 pub const MAX_LOGS: usize = 180; // TODO
 
-pub const CHOICES_SIZE = if (builtin.mode == .ReleaseSmall)
-    MAX_CHOICES
+pub const OPTIONS_SIZE = if (builtin.mode == .ReleaseSmall)
+    MAX_OPTIONS
 else
-    std.math.ceilPowerOfTwo(usize, MAX_CHOICES) catch unreachable;
+    std.math.ceilPowerOfTwo(usize, MAX_OPTIONS) catch unreachable;
 pub const LOGS_SIZE = if (builtin.mode == .ReleaseSmall)
     MAX_LOGS
 else

package/src/lib/pkmn.zig

@@ -4,10 +4,10 @@ pub const options = @import("common/options.zig");
 pub const Options = options.Options;
 
 /// The minimum size in bytes required to hold all choice options.
-pub const MAX_CHOICES = gen1.MAX_CHOICES;
+pub const MAX_OPTIONS = gen1.MAX_OPTIONS;
 /// The optimal size in bytes required to hold all choice options.
-/// At least as large as `MAX_CHOICES`.
-pub const CHOICES_SIZE = gen1.CHOICES_SIZE;
+/// At least as large as `MAX_OPTIONS`.
+pub const OPTIONS_SIZE = gen1.OPTIONS_SIZE;
 /// The maximum number of bytes possibly logged by a single update.
 pub const MAX_LOGS = gen1.MAX_LOGS;
 /// The optimal size in bytes required to hold the largest amount of log data
@@ -25,12 +25,12 @@ pub const Result = @import("common/data.zig").Result;
 /// Pokémon Showdown's RNG (backed by a Generation V & VI RNG).
 pub const PSRNG = @import("common/rng.zig").PSRNG;
 
-/// Namespace for helpers related to protocol message logging.
+/// Namespace for helpers related to protocol trace logging.
 pub const protocol = if (options.internal) struct {
     pub usingnamespace @import("common/protocol.zig");
 } else struct {
     /// Logs protocol information to its `Writer` during a battle update when
-    /// `options.log` is enabled.
+    /// `options.trace` is enabled.
     pub const Log = @import("common/protocol.zig").Log;
     /// Stripped down version of `std.io.FixedBufferStream` optimized for
     /// efficiently writing the individual protocol bytes. Note that the
@@ -41,8 +41,8 @@ pub const protocol = if (options.internal) struct {
     /// intialized with a `LOGS_SIZE`-sized buffer.
     pub const FixedLog = @import("common/protocol.zig").FixedLog;
     /// Null object pattern implementation of `Log` backed by a
-    /// `std.io.null_writer`. Ignores anything sent to it, though protocol
-    /// logging should additionally be turned off entirely with `options.log`.
+    /// `std.io.null_writer`. Ignores anything sent to it, though trace logging
+    /// should addtionally be turned off entirely by using `options.trace`.
     pub const NULL = @import("common/protocol.zig").NULL;
 };
 

package/build/pkg/addon.d.ts

@@ -1,7 +0,0 @@
-import { Choice, Player, Result } from '.';
-export declare function check(showdown: boolean): void;
-export declare function supports(showdown: boolean, log?: boolean): boolean;
-export declare function update(index: number, showdown: boolean, battle: ArrayBuffer, c1?: Choice, c2?: Choice, log?: ArrayBuffer): Result;
-export declare function choices(index: number, showdown: boolean, battle: ArrayBuffer, player: Player, choice: Choice['type'], buf: ArrayBuffer): Choice[];
-export declare function choose(index: number, showdown: boolean, battle: ArrayBuffer, player: Player, choice: Choice['type'], buf: ArrayBuffer, fn: (n: number) => number): Choice;
-export declare function size(index: number, type: 'choices' | 'log'): number;

package/build/pkg/addon.js

@@ -1,111 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.size = exports.choose = exports.choices = exports.update = exports.supports = exports.check = void 0;
-const path = __importStar(require("path"));
-const _1 = require(".");
-const ROOT = path.join(__dirname, '..', '..');
-let ADDON = undefined;
-function load() {
-    if (ADDON)
-        return ADDON;
-    let pkmn = undefined;
-    let showdown = undefined;
-    try {
-        pkmn = require(path.join(ROOT, 'build', 'lib', 'pkmn.node'));
-    }
-    catch { }
-    try {
-        showdown = require(path.join(ROOT, 'build', 'lib', 'pkmn-showdown.node'));
-    }
-    catch { }
-    if (!pkmn && !showdown) {
-        throw new Error('Could not find native addons - did you run `npx install-pkmn-engine`?');
-    }
-    return (ADDON = [pkmn, showdown]);
-}
-function check(showdown) {
-    if (!load()[+showdown]) {
-        const opts = ADDON[+!showdown].options.log ? ['-log'] : [];
-        if (showdown)
-            opts.push('-Dshowdown');
-        throw new Error(`@pkmn/engine has ${showdown ? 'not' : 'only'} been configured to support Pokémon Showdown.` +
-            `\n(running \`npx install-pkmn-engine --options='${opts.join(' ')}'\` can fix this issue).`);
-    }
-}
-exports.check = check;
-function supports(showdown, log) {
-    if (!load()[+showdown])
-        return false;
-    if (log === undefined)
-        return true;
-    return ADDON[+showdown].options.log === log;
-}
-exports.supports = supports;
-function update(index, showdown, battle, c1, c2, log) {
-    return _1.Result.decode(ADDON[+showdown].bindings[index]
-        .update(battle, _1.Choice.encode(c1), _1.Choice.encode(c2), log));
-}
-exports.update = update;
-function choices(index, showdown, battle, player, choice, buf) {
-    const request = choice[0] === 'p' ? 0 : choice[0] === 'm' ? 1 : 2;
-    const n = ADDON[+showdown].bindings[index].choices(battle, +(player !== 'p1'), request, buf);
-    // The top-level API signature means our hands our tied with respect to
-    // writing really fast bindings here. The simplest approach would be to return
-    // the ArrayBuffer the bindings populate as well as its size and only decode a
-    // Choice after the selection. However, given that we need to return
-    // `Choices[]` we need to decode all of them even if they're not all being
-    // used which is wasteful. This shouldn't be *that* bad as its a very small
-    // list, but its still wasted work. Switching the top-level API to return an
-    // Iterable<Choice> doesn't help as we need both the length and the ability to
-    // randomly access it, so the best way to make the current API fast would be
-    // to have the Zig bindings create Choice objects directly, only that won't
-    // scale well as it would require us to basically rewrite the low-level
-    // choices function for each generation within node.zig. We could do something
-    // really galaxy-brained and return some sort of frankenstein subclass of
-    // Array backed by ArrayBuffer which would lazily decode the Choice on access,
-    // but thats ultimately not worth the effort. You can't have both a high-level
-    // idiomatic API and performance here, hence why the choose function below
-    // exists.
-    const options = new Array(n);
-    const data = new Uint8Array(buf);
-    for (let i = 0; i < n; i++)
-        options[i] = _1.Choice.decode(data[i]);
-    return options;
-}
-exports.choices = choices;
-function choose(index, showdown, battle, player, choice, buf, fn) {
-    const request = choice[0] === 'p' ? 0 : choice[0] === 'm' ? 1 : 2;
-    const n = ADDON[+showdown].bindings[index].choices(battle, +(player !== 'p1'), request, buf);
-    const data = new Uint8Array(buf);
-    return _1.Choice.decode(data[fn(n)]);
-}
-exports.choose = choose;
-function size(index, type) {
-    const bindings = (ADDON[1] ?? ADDON[0]).bindings[index];
-    return type[0] === 'c' ? bindings.CHOICES_SIZE : bindings.LOGS_SIZE;
-}
-exports.size = size;
-//# sourceMappingURL=addon.js.map

package/build/pkg/addon.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"addon.js","sourceRoot":"","sources":["../../src/pkg/addon.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2CAA6B;AAE7B,wBAAyC;AAEzC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;AAE9C,IAAI,KAAK,GAAoD,SAAS,CAAC;AAcvE,SAAS,IAAI;IACX,IAAI,KAAK;QAAE,OAAO,KAAK,CAAC;IACxB,IAAI,IAAI,GAAgC,SAAS,CAAC;IAClD,IAAI,QAAQ,GAA+B,SAAS,CAAC;IACrD,IAAI;QACF,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,CAAC,CAAoB,CAAC;KACjF;IAAC,MAAM,GAAG;IACX,IAAI;QACF,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,oBAAoB,CAAC,CAAmB,CAAC;KAC7F;IAAC,MAAM,GAAG;IACX,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE;QACtB,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAC;KAC1F;IACD,OAAO,CAAC,KAAK,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC;AACpC,CAAC;AAED,SAAgB,KAAK,CAAC,QAAiB;IACrC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,EAAE;QACtB,MAAM,IAAI,GAAG,KAAM,CAAC,CAAC,CAAC,QAAQ,CAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7D,IAAI,QAAQ;YAAE,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACtC,MAAM,IAAI,KAAK,CACb,oBAAoB,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,+CAA+C;YAC5F,mDAAmD,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,0BAA0B,CAC5F,CAAC;KACH;AACH,CAAC;AATD,sBASC;AAED,SAAgB,QAAQ,CAAC,QAAiB,EAAE,GAAa;IACvD,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC;QAAE,OAAO,KAAK,CAAC;IACrC,IAAI,GAAG,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IACnC,OAAO,KAAM,CAAC,CAAC,QAAQ,CAAE,CAAC,OAAO,CAAC,GAAG,KAAK,GAAG,CAAC;AAChD,CAAC;AAJD,4BAIC;AAED,SAAgB,MAAM,CACpB,KAAa,EACb,QAAiB,EACjB,MAAmB,EACnB,EAAW,EACX,EAAW,EACX,GAAiB;IAEjB,OAAO,SAAM,CAAC,MAAM,CAAC,KAAM,CAAC,CAAC,QAAQ,CAAE,CAAC,QAAQ,CAAC,KAAK,CAAC;SACpD,MAAM,CAAC,MAAM,EAAE,SAAM,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,SAAM,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;AAChE,CAAC;AAVD,wBAUC;AAED,SAAgB,OAAO,CACrB,KAAa,EACb,QAAiB,EACjB,MAAmB,EACnB,MAAc,EACd,MAAsB,EACtB,GAAgB;IAEhB,MAAM,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAClE,MAAM,CAAC,GAAG,KAAM,CAAC,CAAC,QAAQ,CAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,KAAK,IAAI,CAAC,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC;IAC/F,uEAAuE;IACvE,8EAA8E;IAC9E,8EAA8E;IAC9E,oEAAoE;IACpE,0EAA0E;IAC1E,2EAA2E;IAC3E,4EAA4E;IAC5E,8EAA8E;IAC9E,4EAA4E;IAC5E,2EAA2E;IAC3E,uEAAuE;IACvE,8EAA8E;IAC9E,yEAAyE;IACzE,8EAA8E;IAC9E,8EAA8E;IAC9E,0EAA0E;IAC1E,UAAU;IACV,MAAM,OAAO,GAAG,IAAI,KAAK,CAAS,CAAC,CAAC,CAAC;IACrC,MAAM,IAAI,GAAG,IAAI,UAAU,CAAC,GAAG,CAAC,CAAC;IACjC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE;QAAE,OAAO,CAAC,CAAC,CAAC,GAAG,SAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAChE,OAAO,OAAO,CAAC;AACjB,CAAC;AA/BD,0BA+BC;AAED,SAAgB,MAAM,CACpB,KAAa,EACb,QAAiB,EACjB,MAAmB,EACnB,MAAc,EACd,MAAsB,EACtB,GAAgB,EAChB,EAAyB;IAEzB,MAAM,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAClE,MAAM,CAAC,GAAG,KAAM,CAAC,CAAC,QAAQ,CAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,KAAK,IAAI,CAAC,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC;IAC/F,MAAM,IAAI,GAAG,IAAI,UAAU,CAAC,GAAG,CAAC,CAAC;IACjC,OAAO,SAAM,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACpC,CAAC;AAbD,wBAaC;AAED,SAAgB,IAAI,CAAC,KAAa,EAAE,IAAuB;IACzD,MAAM,QAAQ,GAAG,CAAC,KAAM,CAAC,CAAC,CAAC,IAAI,KAAM,CAAC,CAAC,CAAC,CAAE,CAAC,QAAQ,CAAC,KAAK,CAAE,CAAC;IAC5D,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC;AACtE,CAAC;AAHD,oBAGC"}