@pkmn/sim 0.8.3 → 0.8.5

package/build/types/sim/dex-species.d.ts

@@ -1,289 +0,0 @@
-import { AnyObject, GenderName, ID, ModdedDex, Nonstandard, StatsTable, TierTypes, MoveSource, EventInfo } from './exported-global-types';
-import { BasicEffect } from './dex-data';
-interface SpeciesAbility {
-    0: string;
-    1?: string;
-    H?: string;
-    S?: string;
-}
-type SpeciesTag = "Mythical" | "Restricted Legendary" | "Sub-Legendary" | "Paradox";
-export interface SpeciesData extends Partial<Species> {
-    name: string;
-    /** National Dex number */
-    num: number;
-    types: string[];
-    abilities: SpeciesAbility;
-    baseStats: StatsTable;
-    eggGroups: string[];
-    weightkg: number;
-}
-export type ModdedSpeciesData = SpeciesData | Partial<Omit<SpeciesData, 'name'>> & {
-    inherit: true;
-};
-export interface SpeciesFormatsData {
-    comboMoves?: readonly string[];
-    doublesTier?: TierTypes.Doubles | TierTypes.Other;
-    essentialMove?: string;
-    exclusiveMoves?: readonly string[];
-    gmaxUnreleased?: boolean;
-    isNonstandard?: Nonstandard | null;
-    natDexTier?: TierTypes.Singles | TierTypes.Other;
-    randomBattleMoves?: readonly string[];
-    randomBattleLevel?: number;
-    randomDoubleBattleMoves?: readonly string[];
-    randomDoubleBattleLevel?: number;
-    randomBattleNoDynamaxMoves?: readonly string[];
-    tier?: TierTypes.Singles | TierTypes.Other;
-}
-export type ModdedSpeciesFormatsData = SpeciesFormatsData & {
-    inherit?: true;
-};
-export interface LearnsetData {
-    learnset?: {
-        [moveid: string]: MoveSource[];
-    };
-    eventData?: EventInfo[];
-    eventOnly?: boolean;
-    encounters?: EventInfo[];
-    exists?: boolean;
-}
-export type ModdedLearnsetData = LearnsetData & {
-    inherit?: true;
-};
-export interface PokemonGoData {
-    encounters?: string[];
-    LGPERestrictiveMoves?: {
-        [moveid: string]: number | null;
-    };
-}
-export declare class Species extends BasicEffect implements Readonly<BasicEffect & SpeciesFormatsData> {
-    readonly effectType: 'Pokemon';
-    /**
-     * Species ID. Identical to ID. Note that this is the full ID, e.g.
-     * 'basculinbluestriped'. To get the base species ID, you need to
-     * manually read toID(species.baseSpecies).
-     */
-    readonly id: ID;
-    /**
-     * Name. Note that this is the full name with forme,
-     * e.g. 'Basculin-Blue-Striped'. To get the name without forme, see
-     * `species.baseSpecies`.
-     */
-    readonly name: string;
-    /**
-     * Base species. Species, but without the forme name.
-     *
-     * DO NOT ASSUME A POKEMON CAN TRANSFORM FROM `baseSpecies` TO
-     * `species`. USE `changesFrom` FOR THAT.
-     */
-    readonly baseSpecies: string;
-    /**
-     * Forme name. If the forme exists,
-     * `species.name === species.baseSpecies + '-' + species.forme`
-     *
-     * The games make a distinction between Forme (foorumu) (legendary Pokémon)
-     * and Form (sugata) (non-legendary Pokémon). PS does not use the same
-     * distinction – they're all "Forme" to PS, reflecting current community
-     * use of the term.
-     *
-     * This property only tracks non-cosmetic formes, and will be `''` for
-     * cosmetic formes.
-     */
-    readonly forme: string;
-    /**
-     * Base forme name (e.g. 'Altered' for Giratina).
-     */
-    readonly baseForme: string;
-    /**
-     * Other forms. List of names of cosmetic forms. These should have
-     * `aliases.js` aliases to this entry, but not have their own
-     * entry in `pokedex.js`.
-     */
-    readonly cosmeticFormes?: string[];
-    /**
-     * Other formes. List of names of formes, appears only on the base
-     * forme. Unlike forms, these have their own entry in `pokedex.js`.
-     */
-    readonly otherFormes?: string[];
-    /**
-     * List of forme speciesNames in the order they appear in the game data -
-     * the union of baseSpecies, otherFormes and cosmeticFormes. Appears only on
-     * the base species forme.
-     *
-     * A species's alternate formeindex may change from generation to generation -
-     * the forme with index N in Gen A is not guaranteed to be the same forme as the
-     * forme with index in Gen B.
-     *
-     * Gigantamaxes are not considered formes by the game (see data/FORMES.md - PS
-     * labels them as such for convenience) - Gigantamax "formes" are instead included at
-     * the end of the formeOrder list so as not to interfere with the correct index numbers.
-     */
-    readonly formeOrder?: string[];
-    /**
-     * Sprite ID. Basically the same as ID, but with a dash between
-     * species and forme.
-     */
-    readonly spriteid: string;
-    /** Abilities. */
-    readonly abilities: SpeciesAbility;
-    /** Types. */
-    readonly types: string[];
-    /** Added type (added by Trick-Or-Treat or Forest's Curse, but only listed in species by OMs). */
-    readonly addedType?: string;
-    /** Pre-evolution. '' if nothing evolves into this Pokemon. */
-    readonly prevo: string;
-    /** Evolutions. Array because many Pokemon have multiple evolutions. */
-    readonly evos: string[];
-    readonly evoType?: 'trade' | 'useItem' | 'levelMove' | 'levelExtra' | 'levelFriendship' | 'levelHold' | 'other';
-    /** Evolution condition. falsy if doesn't evolve. */
-    readonly evoCondition?: string;
-    /** Evolution item. falsy if doesn't evolve. */
-    readonly evoItem?: string;
-    /** Evolution move. falsy if doesn't evolve. */
-    readonly evoMove?: string;
-    /** Region required to be in for evolution. falsy if doesn't evolve. */
-    readonly evoRegion?: 'Alola' | 'Galar';
-    /** Evolution level. falsy if doesn't evolve. */
-    readonly evoLevel?: number;
-    /** Is NFE? True if this Pokemon can evolve (Mega evolution doesn't count). */
-    readonly nfe: boolean;
-    /** Egg groups. */
-    readonly eggGroups: string[];
-    /** True if this species can hatch from an Egg. */
-    readonly canHatch: boolean;
-    /**
-     * Gender. M = always male, F = always female, N = always
-     * genderless, '' = sometimes male sometimes female.
-     */
-    readonly gender: GenderName;
-    /** Gender ratio. Should add up to 1 unless genderless. */
-    readonly genderRatio: {
-        M: number;
-        F: number;
-    };
-    /** Base stats. */
-    readonly baseStats: StatsTable;
-    /** Max HP. Overrides usual HP calculations (for Shedinja). */
-    readonly maxHP?: number;
-    /** A Pokemon's Base Stat Total */
-    readonly bst: number;
-    /** Weight (in kg). Not valid for OMs; use weighthg / 10 instead. */
-    readonly weightkg: number;
-    /** Weight (in integer multiples of 0.1kg). */
-    readonly weighthg: number;
-    /** Height (in m). */
-    readonly heightm: number;
-    /** Color. */
-    readonly color: string;
-    /**
-     * Tags, boolean data. Currently just legendary/mythical status.
-     */
-    readonly tags: SpeciesTag[];
-    /** Does this Pokemon have an unreleased hidden ability? */
-    readonly unreleasedHidden: boolean | 'Past';
-    /**
-     * Is it only possible to get the hidden ability on a male pokemon?
-     * This is mainly relevant to Gen 5.
-     */
-    readonly maleOnlyHidden: boolean;
-    /** True if a pokemon is mega. */
-    readonly isMega?: boolean;
-    /** True if a pokemon is primal. */
-    readonly isPrimal?: boolean;
-    /** Name of its Gigantamax move, if a pokemon is capable of gigantamaxing. */
-    readonly canGigantamax?: string;
-    /** If this Pokemon can gigantamax, is its gigantamax released? */
-    readonly gmaxUnreleased?: boolean;
-    /** True if a Pokemon species is incapable of dynamaxing */
-    readonly cannotDynamax?: boolean;
-    /** The Tera Type this Pokemon is forced to use */
-    readonly forceTeraType?: string;
-    /** What it transforms from, if a pokemon is a forme that is only accessible in battle. */
-    readonly battleOnly?: string | string[];
-    /** Required item. Do not use this directly; see requiredItems. */
-    readonly requiredItem?: string;
-    /** Required move. Move required to use this forme in-battle. */
-    readonly requiredMove?: string;
-    /** Required ability. Ability required to use this forme in-battle. */
-    readonly requiredAbility?: string;
-    /**
-     * Required items. Items required to be in this forme, e.g. a mega
-     * stone, or Griseous Orb. Array because Arceus formes can hold
-     * either a Plate or a Z-Crystal.
-     */
-    readonly requiredItems?: string[];
-    /**
-     * Formes that can transform into this Pokemon, to inherit learnsets
-     * from. (Like `prevo`, but for transformations that aren't
-     * technically evolution. Includes in-battle transformations like
-     * Zen Mode and out-of-battle transformations like Rotom.)
-     *
-     * Not filled out for megas/primals - fall back to baseSpecies
-     * for in-battle formes.
-     */
-    readonly changesFrom?: string;
-    /**
-     * List of sources and other availability for a Pokemon transferred from
-     * Pokemon GO.
-     */
-    readonly pokemonGoData?: string[];
-    /**
-     * Singles Tier. The Pokemon's location in the Smogon tier system.
-     */
-    readonly tier: TierTypes.Singles | TierTypes.Other;
-    /**
-     * Doubles Tier. The Pokemon's location in the Smogon doubles tier system.
-     */
-    readonly doublesTier: TierTypes.Doubles | TierTypes.Other;
-    /**
-     * National Dex Tier. The Pokemon's location in the Smogon National Dex tier system.
-     */
-    readonly natDexTier: TierTypes.Singles | TierTypes.Other;
-    readonly randomBattleMoves?: readonly ID[];
-    readonly randomBattleLevel?: number;
-    readonly randomDoubleBattleMoves?: readonly ID[];
-    readonly randomDoubleBattleLevel?: number;
-    readonly randomBattleNoDynamaxMoves?: readonly ID[];
-    readonly exclusiveMoves?: readonly ID[];
-    readonly comboMoves?: readonly ID[];
-    readonly essentialMove?: ID;
-    constructor(data: AnyObject);
-}
-export declare class Learnset {
-    readonly effectType: 'Learnset';
-    /**
-     * Keeps track of exactly how a pokemon might learn a move, in the
-     * form moveid:sources[].
-     */
-    readonly learnset?: {
-        [moveid: string]: MoveSource[];
-    };
-    /** True if the only way to get this Pokemon is from events. */
-    readonly eventOnly: boolean;
-    /** List of event data for each event. */
-    readonly eventData?: EventInfo[];
-    readonly encounters?: EventInfo[];
-    readonly exists: boolean;
-    constructor(data: AnyObject);
-}
-export declare class DexSpecies {
-    readonly dex: ModdedDex;
-    readonly speciesCache: Map<ID, Species>;
-    allCache: readonly Species[] | null;
-    constructor(dex: ModdedDex);
-    get(name?: string | Species): Species;
-    getByID(id: ID): Species;
-    getLearnset(id: ID): Learnset['learnset'];
-    getLearnsetData(id: ID): Learnset;
-    getPokemonGoData(id: ID): PokemonGoData;
-    all(): readonly Species[];
-}
-export declare class DexLearnsets {
-    readonly dex: ModdedDex;
-    readonly learnsetCache: Map<ID, Learnset>;
-    constructor(dex: ModdedDex);
-    get(name: string): Promise<Learnset>;
-    getByID(id: ID): Promise<Learnset>;
-    getInternal(id: ID): Learnset;
-}
-export {};

package/build/types/sim/dex.d.ts

@@ -1,162 +0,0 @@
-import { Condition, DexConditions } from './dex-conditions';
-import { DataMove, DexMoves } from './dex-moves';
-import { Item, DexItems } from './dex-items';
-import { Ability, DexAbilities } from './dex-abilities';
-import { Species, DexSpecies, DexLearnsets, PokemonGoData } from './dex-species';
-import { Format, DexFormats, RuleTable } from './dex-formats';
-import { AbilityData, AbilityText, ActiveMove, AnyObject, EffectData, FormatData, ID, ItemData, ItemText, LearnsetData, ModdedBattleScriptsData, Move, MoveData, MoveText, NatureData, SpeciesData, TypeData } from './exported-global-types';
-import * as Data from './dex-data';
-type DataType = 'Abilities' | 'Rulesets' | 'FormatsData' | 'Items' | 'Learnsets' | 'Moves' | 'Natures' | 'Pokedex' | 'Scripts' | 'Conditions' | 'TypeChart' | 'PokemonGoData';
-interface DexTable<T> {
-    [key: string]: T;
-}
-interface DexTableData {
-    Abilities: DexTable<AbilityData>;
-    Conditions: DexTable<EffectData>;
-    Rulesets: DexTable<FormatData>;
-    FormatsData: DexTable<import('./dex-species').ModdedSpeciesFormatsData>;
-    Items: DexTable<ItemData>;
-    Learnsets: DexTable<LearnsetData>;
-    Moves: DexTable<MoveData>;
-    Natures: DexTable<NatureData>;
-    Pokedex: DexTable<SpeciesData>;
-    PokemonGoData: DexTable<PokemonGoData>;
-    TypeChart: DexTable<TypeData>;
-    Aliases: {
-        [id: string]: string;
-    };
-    Scripts: ModdedBattleScriptsData;
-    Species: DexTable<SpeciesData>;
-    Types: DexTable<TypeData>;
-}
-declare const TEXT: {
-    Abilities: DexTable<AbilityText>;
-    Items: DexTable<ItemText>;
-    Moves: DexTable<MoveText>;
-    Default: DexTable<AnyObject>;
-};
-type DeepPartial<T> = {
-    [P in keyof T]?: T[P] extends Array<infer U> ? Array<DeepPartial<U>> : T[P] extends ReadonlyArray<infer V> ? ReadonlyArray<DeepPartial<V>> : DeepPartial<T[P]>;
-};
-export type ModData = DeepPartial<ModdedDex['data']>;
-export declare const toID: typeof Data.toID;
-export declare class ModdedDex {
-    readonly Data: typeof Data;
-    readonly Condition: typeof Condition;
-    readonly Ability: typeof Ability;
-    readonly Item: typeof Item;
-    readonly Move: typeof DataMove;
-    readonly Species: typeof Species;
-    readonly Format: typeof Format;
-    readonly ModdedDex: typeof ModdedDex;
-    readonly name = "[ModdedDex]";
-    readonly isBase: boolean;
-    readonly currentMod: string;
-    readonly toID: typeof Data.toID;
-    readonly formats: DexFormats;
-    readonly abilities: DexAbilities;
-    readonly items: DexItems;
-    readonly moves: DexMoves;
-    readonly species: DexSpecies;
-    readonly learnsets: DexLearnsets;
-    readonly conditions: DexConditions;
-    readonly natures: Data.DexNatures;
-    readonly types: Data.DexTypes;
-    readonly stats: Data.DexStats;
-    gen: number;
-    parentMod: string;
-    modsLoaded: boolean;
-    dataCache: DexTableData | null;
-    deepClone: typeof import("../lib/utils").deepClone;
-    constructor(mod?: string);
-    get modid(): ID;
-    get data(): DexTableData;
-    get dexes(): {
-        [mod: string]: ModdedDex;
-    };
-    mod(mod: string | undefined, modData?: DeepPartial<ModdedDex['data']>): ModdedDex;
-    forGen(gen: number): ModdedDex;
-    forFormat(format: Format | string): ModdedDex;
-    modData(dataType: DataType, id: string): any;
-    effectToString(): string;
-    /**
-     * Sanitizes a username or Pokemon nickname
-     *
-     * Returns the passed name, sanitized for safe use as a name in the PS
-     * protocol.
-     *
-     * Such a string must uphold these guarantees:
-     * - must not contain any ASCII whitespace character other than a space
-     * - must not start or end with a space character
-     * - must not contain any of: | , [ ]
-     * - must not be the empty string
-     * - must not contain Unicode RTL control characters
-     *
-     * If no such string can be found, returns the empty string. Calling
-     * functions are expected to check for that condition and deal with it
-     * accordingly.
-     *
-     * getName also enforces that there are not multiple consecutive space
-     * characters in the name, although this is not strictly necessary for
-     * safety.
-     */
-    getName(name: any): string;
-    /**
-     * Returns false if the target is immune; true otherwise.
-     * Also checks immunity to some statuses.
-     */
-    getImmunity(source: {
-        type: string;
-    } | string, target: {
-        getTypes: () => string[];
-    } | {
-        types: string[];
-    } | string[] | string): boolean;
-    getEffectiveness(source: {
-        type: string;
-    } | string, target: {
-        getTypes: () => string[];
-    } | {
-        types: string[];
-    } | string[] | string): number;
-    getDescs(table: keyof typeof TEXT, id: ID, dataEntry: AnyObject): {
-        desc: any;
-        shortDesc: any;
-    } | null;
-    /**
-     * Ensure we're working on a copy of a move (and make a copy if we aren't)
-     *
-     * Remember: "ensure" - by default, it won't make a copy of a copy:
-     *     moveCopy === Dex.getActiveMove(moveCopy)
-     *
-     * If you really want to, use:
-     *     moveCopyCopy = Dex.getActiveMove(moveCopy.id)
-     */
-    getActiveMove(move: Move | string): ActiveMove;
-    getHiddenPower(ivs: AnyObject): {
-        type: string;
-        power: number;
-    };
-    /**
-     * Truncate a number into an unsigned 32-bit integer, for
-     * compatibility with the cartridge games' math systems.
-     */
-    trunc(num: number, bits?: number): number;
-    loadDataFile(mod: string, dataType: DataType | 'Aliases', modData?: DeepPartial<ModdedDex['data']>): AnyObject;
-    includeMods(): this;
-    includeModData(): this;
-    includeData(): this;
-    loadData(modData?: DeepPartial<ModdedDex['data']>): DexTableData;
-    includeFormats(): this;
-}
-export declare const Dex: ModdedDex;
-export declare namespace Dex {
-    type Species = import('./dex-species').Species;
-    type Item = import('./dex-items').Item;
-    type Move = import('./dex-moves').Move;
-    type Ability = import('./dex-abilities').Ability;
-    type HitEffect = import('./dex-moves').HitEffect;
-    type SecondaryEffect = import('./dex-moves').SecondaryEffect;
-    type RuleTable = import('./dex-formats').RuleTable;
-}
-export { RuleTable };