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

package/build/pkg/index.d.ts

@@ -1,6 +1,5 @@
-import { BoostsTable, Generation, ID, PokemonSet, StatsTable, StatusName, TypeName } from '@pkmn/data';
-/** Representation of one of a battle's participants. */
-export type Player = 'p1' | 'p2';
+import { BoostID, BoostsTable, Generation, ID, PokemonSet, StatID, StatsTable, StatusName, TypeName } from '@pkmn/data';
+import { Choice, Player, Result } from './common';
 /** The one-indexed location of a player's Pokémon in battle. */
 export type Slot = 1 | 2 | 3 | 4 | 5 | 6;
 /** Representation of the entire state of a Pokémon battle. */
@@ -34,31 +33,25 @@ export interface API {
      * soft-lock occurs).
      */
     choices(player: Player, result: Result): Choice[];
-    /**
-     * Determines all possible choices for the `player` given the previous
-     * `result` of an {@link update} and calls a selection function `fn` with the
-     * number of possible choices `n`, returning the choice corresponding with the
-     * index it returns. `fn` must return an index in the range `[0, n)`.
-     *
-     * This function helps speed up MCTS-based agents which wish to avoid
-     * decoding/allocating `Choice` objects which they ignore. Most other use
-     * cases will likely be better served by the choices method.
-     *
-     * Note that the number of possible choices n passed to `fn` may be 0 as
-     * outlined above in {@link choices}.
-     */
-    choose(player: Player, result: Result, fn: (n: number) => number): Choice;
     /** Returns a copy of the Battle data. */
     toJSON(): Data<Battle>;
 }
-/** Helper type removing API methods from a data type `T`. */
-export type Data<T extends API> = Omit<T, keyof API>;
+/** Helper type removing function types from a data type `T`. */
+export type Data<T> = T extends readonly any[] ? {
+    [K in keyof T]: Data<T[K]>;
+} : T extends Iterable<infer U> ? (U extends object ? Iterable<Data<U>> : T) : T extends object ? {
+    [K in keyof T as T[K] extends Function ? never : K]: Data<T[K]>;
+} : T;
 /** Type definitions for Generation I Pokémon data relevant in a battle. */
 export declare namespace Gen1 {
     /** Representation of the entire state of a Generation I Pokémon battle. */
     interface Battle extends API {
         /** The sides involved in the battle. */
         sides: Iterable<Side>;
+        /** Returns the side of the `player`. */
+        side(player: Player): Side;
+        /** Returns the opposing side to `player`. */
+        foe(player: Player): Side;
         /** The battle's current turn number. */
         turn: number;
         /** The last damage dealt by either side. */
@@ -84,6 +77,16 @@ export declare namespace Gen1 {
          * the effect switching would have on its original order).
          */
         pokemon: Iterable<Pokemon>;
+        /**
+         * Returns the current slot of the Pokémon that started the battle at index
+         * `id`, or undefined if the index is invalid.
+         */
+        slot(id: number): Slot | undefined;
+        /**
+         * Returns the Pokémon currently at the provided `slot`, or undefined if
+         * nothing occupies the slot.
+         */
+        get(slot: Slot): Pokemon | undefined;
         /** The last move the player used. */
         lastUsedMove: ID | undefined;
         /** The last move the player selected. */
@@ -127,13 +130,19 @@ export declare namespace Gen1 {
          * boosts/status/etc (and which may differ from its original stored stats).
          */
         stats: StatsTable;
+        /** Returns the value Pokémon's current `stat`. */
+        stat(stat: StatID | 'spc'): number;
         /** The Pokémon's current boosts. */
         boosts: BoostsTable;
+        /** Returns the value Pokémon's current `boost`. */
+        boost(boost: BoostID): number;
         /**
          * The Pokémon's move slots (which may differ from its original stored
          * moves).
          */
         moves: Iterable<MoveSlot>;
+        /** The Pokémon's current move at `slot`, or undefined if absent. */
+        move(slot: 1 | 2 | 3 | 4): MoveSlot | undefined;
         /** The Pokémon's volatiles statuses. */
         volatiles: Volatiles;
         stored: {
@@ -143,8 +152,12 @@ export declare namespace Gen1 {
             types: readonly [TypeName, TypeName];
             /** The Pokémon original unmodified stats.  */
             stats: StatsTable;
+            /** Returns the value Pokémon's original `stat`. */
+            stat(stat: StatID | 'spc'): number;
             /** The Pokémon's original move slots.  */
             moves: Iterable<Omit<MoveSlot, 'disabled'>>;
+            /** The Pokémon's original move at `slot`, or undefined if absent. */
+            move(slot: 1 | 2 | 3 | 4): Omit<MoveSlot, 'disabled'> | undefined;
         };
         /** The current one-indexed position of this Pokémon in the party. */
         position: Slot;
@@ -242,6 +255,8 @@ export type CreateOptions = {
      * that the engine be built in a specific compatibility mode).
      */
     showdown?: boolean;
+    /** Whether the battle should be initialized without functionality afforded by native code. */
+    inert?: true;
 } & ({
     /** Player 1's options. */
     p1: PlayerOptions;
@@ -302,40 +317,6 @@ export interface PlayerOptions {
     /** The player's team. */
     team: Partial<PokemonSet>[];
 }
-/** A choice made by a player during battle. */
-export interface Choice {
-    /** The choice type. */
-    type: 'pass' | 'move' | 'switch';
-    /**
-     * The choice data:
-     *
-     *    - 0 for 'pass'
-     *    - 0-4 for 'move'
-     *    - 2-6 for 'switch'
-     */
-    data: number;
-}
-/**
- * The result of the battle - all defined results should be considered terminal.
- */
-export interface Result {
-    /**
-     * The type of result from the perspective of Player 1:
-     *
-     *   - undefined: no result, battle is non-terminal
-     *   - win: Player 1 wins
-     *   - lose: Player 2 wins
-     *   - tie: Player 1 & 2 tie
-     *   - error: the battle has terminated in error (e.g. due to a desync)
-     *
-     * 'error' is not possible when in Pokémon Showdown compatibility mode.
-     */
-    type: undefined | 'win' | 'lose' | 'tie' | 'error';
-    /** The choice type of the result for Player 1. */
-    p1: Choice['type'];
-    /** The choice type of the result for Player 2. */
-    p2: Choice['type'];
-}
 /** Factory for creating Battle objects. */
 export declare const Battle: {
     /** Create a `Battle` in the given generation with the provided options. */
@@ -344,43 +325,11 @@ export declare const Battle: {
      * Restore a (possibly in-progress) `Battle` in the given generation with the
      * provided options.
      */
-    restore(gen: Generation, battle: Battle, options: RestoreOptions): Battle;
+    restore(gen: Generation, battle: Data<Battle>, options: RestoreOptions): Battle;
 };
-/** Utilities for working with `Choice` objects. */
-export declare class Choice {
-    /** All valid choices types. */
-    static Types: readonly ["pass", "move", "switch"];
-    protected static PASS: {
-        readonly type: "pass";
-        readonly data: 0;
-    };
-    protected static MATCH: RegExp;
-    private constructor();
-    /** Decode a choice from its binary representation. */
-    static decode(byte: number): Choice;
-    /** Encode a choice to its binary representation. */
-    static encode(choice?: Choice): number;
-    /**
-     * Parse a Pokémon Showdown choice string into a `Choice`.
-     * Only numeric choice data is supported.
-     */
-    static parse(choice: string): Choice;
-    /** Formats a `Choice` into a Pokémon Showdown compatible choice string. */
-    static format(choice: Choice): string;
-    /** Returns the "pass" `Choice`. */
-    static pass(): Choice;
-    /** Returns a "move" `Choice` with the provided data. */
-    static move(data: 0 | 1 | 2 | 3 | 4): Choice;
-    /** Returns a "switch" `Choice` with the provided data. */
-    static switch(data: 2 | 3 | 4 | 5 | 6): Choice;
-}
-/** Utilities for working with `Result` objects */
-export declare class Result {
-    /** All valid result types. */
-    static Types: readonly [undefined, "win", "lose", "tie", "error"];
-    private constructor();
-    /** Decode a `Result` from its binary representation. */
-    static decode(byte: number): Result;
-}
-export { ParsedLine, Info, SideInfo, PokemonInfo, Log } from './protocol';
+export { initialize } from './addon';
+export { Choice, Result } from './common';
+export type { Player } from './common';
+export type { ParsedLine, PokemonInfo } from './protocol';
+export { Info, SideInfo, Log } from './protocol';
 export { Lookup } from './data';

package/build/pkg/index.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Lookup = exports.Log = exports.SideInfo = exports.Info = exports.Result = exports.Choice = exports.Battle = void 0;
+exports.Lookup = exports.Log = exports.SideInfo = exports.Info = exports.Result = exports.Choice = exports.initialize = exports.Battle = void 0;
 const addon = __importStar(require("./addon"));
 const data_1 = require("./data");
 const gen1 = __importStar(require("./gen1"));
@@ -51,68 +51,11 @@ exports.Battle = new class {
         }
     }
 };
-/** Utilities for working with `Choice` objects. */
-class Choice {
-    /** All valid choices types. */
-    static Types = ['pass', 'move', 'switch'];
-    static PASS = { type: 'pass', data: 0 };
-    static MATCH = /^(?:(pass)|((move) ([0-4]))|((switch) ([2-6])))$/;
-    constructor() { }
-    /** Decode a choice from its binary representation. */
-    static decode(byte) {
-        return { type: Choice.Types[byte & 0b11], data: byte >> 2 };
-    }
-    /** Encode a choice to its binary representation. */
-    static encode(choice) {
-        return (choice
-            ? (choice.data << 2 | (choice.type === 'pass' ? 0 : choice.type === 'move' ? 1 : 2))
-            : 0);
-    }
-    /**
-     * Parse a Pokémon Showdown choice string into a `Choice`.
-     * Only numeric choice data is supported.
-     */
-    static parse(choice) {
-        const m = Choice.MATCH.exec(choice);
-        if (!m)
-            throw new Error(`Invalid choice: '${choice}'`);
-        const type = (m[1] ?? m[3] ?? m[6]);
-        const data = +(m[4] ?? m[7] ?? 0);
-        return { type, data };
-    }
-    /** Formats a `Choice` into a Pokémon Showdown compatible choice string. */
-    static format(choice) {
-        return choice.type === 'pass' ? choice.type : `${choice.type} ${choice.data}`;
-    }
-    /** Returns the "pass" `Choice`. */
-    static pass() {
-        return Choice.PASS;
-    }
-    /** Returns a "move" `Choice` with the provided data. */
-    static move(data) {
-        return { type: 'move', data };
-    }
-    /** Returns a "switch" `Choice` with the provided data. */
-    static switch(data) {
-        return { type: 'switch', data };
-    }
-}
-exports.Choice = Choice;
-/** Utilities for working with `Result` objects */
-class Result {
-    /** All valid result types. */
-    static Types = [undefined, 'win', 'lose', 'tie', 'error'];
-    constructor() { }
-    /** Decode a `Result` from its binary representation. */
-    static decode(byte) {
-        return {
-            type: Result.Types[byte & 0b1111],
-            p1: Choice.Types[(byte >> 4) & 0b11],
-            p2: Choice.Types[byte >> 6],
-        };
-    }
-}
-exports.Result = Result;
+var addon_1 = require("./addon");
+Object.defineProperty(exports, "initialize", { enumerable: true, get: function () { return addon_1.initialize; } });
+var common_1 = require("./common");
+Object.defineProperty(exports, "Choice", { enumerable: true, get: function () { return common_1.Choice; } });
+Object.defineProperty(exports, "Result", { enumerable: true, get: function () { return common_1.Result; } });
 var protocol_1 = require("./protocol");
 Object.defineProperty(exports, "Info", { enumerable: true, get: function () { return protocol_1.Info; } });
 Object.defineProperty(exports, "SideInfo", { enumerable: true, get: function () { return protocol_1.SideInfo; } });

package/build/pkg/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/pkg/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAIA,+CAAiC;AACjC,iCAA8B;AAC9B,6CAA+B;AAiW/B,2CAA2C;AAC9B,QAAA,MAAM,GAAG,IAAI;IACxB,2EAA2E;IAC3E,MAAM,CAAC,GAAe,EAAE,OAAsB;QAC5C,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAChC,MAAM,MAAM,GAAG,aAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC/B,QAAQ,GAAG,CAAC,GAAG,EAAE;YACjB,KAAK,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;YACxD,OAAO,CAAC,CAAC,MAAM,IAAI,KAAK,CAAC,mBAAmB,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC;SACtD;IACH,CAAC;IAED;;;OAGG;IACH,OAAO,CAAC,GAAe,EAAE,MAAc,EAAE,OAAuB;QAC9D,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAChC,MAAM,MAAM,GAAG,aAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC/B,QAAQ,GAAG,CAAC,GAAG,EAAE;YACjB,KAAK,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;YACjE,OAAO,CAAC,CAAC,MAAM,IAAI,KAAK,CAAC,mBAAmB,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC;SACtD;IACH,CAAC;CACF,CAAC;AAEF,mDAAmD;AACnD,MAAa,MAAM;IACjB,+BAA+B;IAC/B,MAAM,CAAC,KAAK,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAU,CAAC;IAEzC,MAAM,CAAC,IAAI,GAAG,EAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAU,CAAC;IAC/C,MAAM,CAAC,KAAK,GAAG,kDAAkD,CAAC;IAE5E,gBAAuB,CAAC;IAExB,sDAAsD;IACtD,MAAM,CAAC,MAAM,CAAC,IAAY;QACxB,OAAO,EAAC,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,IAAI,CAAC,EAAC,CAAC;IAC5D,CAAC;IAED,oDAAoD;IACpD,MAAM,CAAC,MAAM,CAAC,MAAe;QAC3B,OAAO,CAAC,MAAM;YACZ,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACpF,CAAC,CAAC,CAAC,CAAC,CAAC;IACT,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,KAAK,CAAC,MAAc;QACzB,MAAM,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACpC,IAAI,CAAC,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,oBAAoB,MAAM,GAAG,CAAC,CAAC;QACvD,MAAM,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAmB,CAAC;QACtD,MAAM,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QAClC,OAAO,EAAC,IAAI,EAAE,IAAI,EAAC,CAAC;IACtB,CAAC;IAED,2EAA2E;IAC3E,MAAM,CAAC,MAAM,CAAC,MAAc;QAC1B,OAAO,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;IAChF,CAAC;IAED,mCAAmC;IACnC,MAAM,CAAC,IAAI;QACT,OAAO,MAAM,CAAC,IAAI,CAAC;IACrB,CAAC;IAED,wDAAwD;IACxD,MAAM,CAAC,IAAI,CAAC,IAAuB;QACjC,OAAO,EAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAC,CAAC;IAC9B,CAAC;IAED,0DAA0D;IAC1D,MAAM,CAAC,MAAM,CAAC,IAAuB;QACnC,OAAO,EAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAC,CAAC;IAChC,CAAC;;AAnDH,wBAoDC;AAED,kDAAkD;AAClD,MAAa,MAAM;IACjB,8BAA8B;IAC9B,MAAM,CAAC,KAAK,GAAG,CAAC,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,CAAU,CAAC;IAEnE,gBAAuB,CAAC;IAExB,wDAAwD;IACxD,MAAM,CAAC,MAAM,CAAC,IAAY;QACxB,OAAO;YACL,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,GAAG,MAAM,CAAC;YACjC,EAAE,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC;YACpC,EAAE,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,CAAC;SAC5B,CAAC;IACJ,CAAC;;AAbH,wBAcC;AAED,uCAAwE;AAApD,gGAAA,IAAI,OAAA;AAAE,oGAAA,QAAQ,OAAA;AAAe,+FAAA,GAAG,OAAA;AACpD,+BAA8B;AAAtB,8FAAA,MAAM,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/pkg/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAIA,+CAAiC;AAEjC,iCAA8B;AAC9B,6CAA+B;AA2U/B,2CAA2C;AAC9B,QAAA,MAAM,GAAG,IAAI;IACxB,2EAA2E;IAC3E,MAAM,CAAC,GAAe,EAAE,OAAsB;QAC5C,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAChC,MAAM,MAAM,GAAG,aAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC/B,QAAQ,GAAG,CAAC,GAAG,EAAE,CAAC;YAChB,KAAK,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;YACxD,OAAO,CAAC,CAAC,MAAM,IAAI,KAAK,CAAC,mBAAmB,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC;QACzD,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,OAAO,CAAC,GAAe,EAAE,MAAoB,EAAE,OAAuB;QACpE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAChC,MAAM,MAAM,GAAG,aAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC/B,QAAQ,GAAG,CAAC,GAAG,EAAE,CAAC;YAChB,KAAK,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;YACjE,OAAO,CAAC,CAAC,MAAM,IAAI,KAAK,CAAC,mBAAmB,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC;QACzD,CAAC;IACH,CAAC;CACF,CAAC;AAEF,iCAAmC;AAA3B,mGAAA,UAAU,OAAA;AAClB,mCAAwC;AAAhC,gGAAA,MAAM,OAAA;AAAE,gGAAA,MAAM,OAAA;AAGtB,uCAA+C;AAAvC,gGAAA,IAAI,OAAA;AAAE,oGAAA,QAAQ,OAAA;AAAE,+FAAA,GAAG,OAAA;AAC3B,+BAA8B;AAAtB,8FAAA,MAAM,OAAA"}

package/build/pkg/protocol.d.ts

@@ -1,7 +1,25 @@
-import { Generation, StatusName, TypeName } from '@pkmn/data';
+import { GenderName, GenerationNum, ID, MoveName, SpeciesName, StatusName, TypeName } from '@pkmn/data';
 import { Protocol } from '@pkmn/protocol';
 import { Lookup } from './data';
 import { PlayerOptions } from '.';
+interface Generation {
+    num: GenerationNum;
+    species: {
+        get(id: ID): {
+            name: SpeciesName;
+            genderRatio: {
+                M: number;
+                F: number;
+            };
+            gender?: GenderName;
+        } | undefined;
+    };
+    moves: {
+        get(id: ID): {
+            name: MoveName;
+        } | undefined;
+    };
+}
 /** A message logged by the engine parsed into Pokémon Showdown's protocol. */
 export interface ParsedLine {
     /** Positional protocol arguments. */
@@ -71,3 +89,4 @@ export declare function decodeIdentRaw(byte: number): {
 };
 export declare function decodeStatus(val: number): StatusName | undefined;
 export declare function decodeTypes(lookup: Lookup, val: number): readonly [TypeName, TypeName];
+export {};