@pkmn/sim 0.8.4 → 0.8.5

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

@@ -1,169 +0,0 @@
-import { AnyObject, EffectData, EffectType, ID, ModdedDex, NatureData, Nonstandard, SparseStatsTable, StatID, StatIDExceptHP, TypeData } from './exported-global-types';
-/**
-* Converts anything to an ID. An ID must have only lowercase alphanumeric
-* characters.
-*
-* If a string is passed, it will be converted to lowercase and
-* non-alphanumeric characters will be stripped.
-*
-* If an object with an ID is passed, its ID will be returned.
-* Otherwise, an empty string will be returned.
-*
-* Generally assigned to the global toID, because of how
-* commonly it's used.
-*/
-export declare function toID(text: any): ID;
-export declare class BasicEffect implements EffectData {
-    /**
-     * ID. This will be a lowercase version of the name with all the
-     * non-alphanumeric characters removed. So, for instance, "Mr. Mime"
-     * becomes "mrmime", and "Basculin-Blue-Striped" becomes
-     * "basculinbluestriped".
-     */
-    id: ID;
-    /**
-     * Name. Currently does not support Unicode letters, so "Flabébé"
-     * is "Flabebe" and "Nidoran♀" is "Nidoran-F".
-     */
-    name: string;
-    /**
-     * Full name. Prefixes the name with the effect type. For instance,
-     * Leftovers would be "item: Leftovers", confusion the status
-     * condition would be "confusion", etc.
-     */
-    fullname: string;
-    /** Effect type. */
-    effectType: EffectType;
-    /**
-     * Does it exist? For historical reasons, when you use an accessor
-     * for an effect that doesn't exist, you get a dummy effect that
-     * doesn't do anything, and this field set to false.
-     */
-    exists: boolean;
-    /**
-     * Dex number? For a Pokemon, this is the National Dex number. For
-     * other effects, this is often an internal ID (e.g. a move
-     * number). Not all effects have numbers, this will be 0 if it
-     * doesn't. Nonstandard effects (e.g. CAP effects) will have
-     * negative numbers.
-     */
-    num: number;
-    /**
-     * The generation of Pokemon game this was INTRODUCED (NOT
-     * necessarily the current gen being simulated.) Not all effects
-     * track generation; this will be 0 if not known.
-     */
-    gen: number;
-    /**
-     * A shortened form of the description of this effect.
-     * Not all effects have this.
-     */
-    shortDesc: string;
-    /** The full description for this effect. */
-    desc: string;
-    /**
-     * Is this item/move/ability/pokemon nonstandard? Specified for effects
-     * that have no use in standard formats: made-up pokemon (CAP),
-     * glitches (MissingNo etc), Pokestar pokemon, etc.
-     */
-    isNonstandard: Nonstandard | null;
-    /** The duration of the condition - only for pure conditions. */
-    duration?: number;
-    /** Whether or not the condition is ignored by Baton Pass - only for pure conditions. */
-    noCopy: boolean;
-    /** Whether or not the condition affects fainted Pokemon. */
-    affectsFainted: boolean;
-    /** Moves only: what status does it set? */
-    status?: ID;
-    /** Moves only: what weather does it set? */
-    weather?: ID;
-    /** ??? */
-    sourceEffect: string;
-    constructor(data: AnyObject);
-    toString(): string;
-}
-export declare class Nature extends BasicEffect implements Readonly<BasicEffect & NatureData> {
-    readonly effectType: 'Nature';
-    readonly plus?: StatIDExceptHP;
-    readonly minus?: StatIDExceptHP;
-    constructor(data: AnyObject);
-}
-export declare class DexNatures {
-    readonly dex: ModdedDex;
-    readonly natureCache: Map<ID, Nature>;
-    allCache: readonly Nature[] | null;
-    constructor(dex: ModdedDex);
-    get(name: string | Nature): Nature;
-    getByID(id: ID): Nature;
-    all(): readonly Nature[];
-}
-type TypeInfoEffectType = 'Type' | 'EffectType';
-export declare class TypeInfo implements Readonly<TypeData> {
-    /**
-     * ID. This will be a lowercase version of the name with all the
-     * non-alphanumeric characters removed. e.g. 'flying'
-     */
-    readonly id: ID;
-    /** Name. e.g. 'Flying' */
-    readonly name: string;
-    /** Effect type. */
-    readonly effectType: TypeInfoEffectType;
-    /**
-     * Does it exist? For historical reasons, when you use an accessor
-     * for an effect that doesn't exist, you get a dummy effect that
-     * doesn't do anything, and this field set to false.
-     */
-    readonly exists: boolean;
-    /**
-     * The generation of Pokemon game this was INTRODUCED (NOT
-     * necessarily the current gen being simulated.) Not all effects
-     * track generation; this will be 0 if not known.
-     */
-    readonly gen: number;
-    /**
-     * Set to 'Future' for types before they're released (like Fairy
-     * in Gen 5 or Dark in Gen 1).
-     */
-    readonly isNonstandard: Nonstandard | null;
-    /**
-     * Type chart, attackingTypeName:result, effectid:result
-     * result is: 0 = normal, 1 = weakness, 2 = resistance, 3 = immunity
-     */
-    readonly damageTaken: {
-        [attackingTypeNameOrEffectid: string]: number;
-    };
-    /** The IVs to get this Type Hidden Power (in gen 3 and later) */
-    readonly HPivs: SparseStatsTable;
-    /** The DVs to get this Type Hidden Power (in gen 2). */
-    readonly HPdvs: SparseStatsTable;
-    constructor(data: AnyObject);
-    toString(): string;
-}
-export declare class DexTypes {
-    readonly dex: ModdedDex;
-    readonly typeCache: Map<ID, TypeInfo>;
-    allCache: readonly TypeInfo[] | null;
-    namesCache: readonly string[] | null;
-    constructor(dex: ModdedDex);
-    get(name: string | TypeInfo): TypeInfo;
-    getByID(id: ID): TypeInfo;
-    names(): readonly string[];
-    isName(name: string): boolean;
-    all(): readonly TypeInfo[];
-}
-declare const idsCache: readonly StatID[];
-export declare class DexStats {
-    readonly shortNames: {
-        readonly [k in StatID]: string;
-    };
-    readonly mediumNames: {
-        readonly [k in StatID]: string;
-    };
-    readonly names: {
-        readonly [k in StatID]: string;
-    };
-    constructor(dex: ModdedDex);
-    getID(name: string): StatID | null;
-    ids(): typeof idsCache;
-}
-export {};

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

@@ -1,170 +0,0 @@
-import { AnyObject, Battle, Effect, GameTimerSettings, GameType, ID, ModdedBattleActions, ModdedBattlePokemon, ModdedBattleQueue, ModdedBattleScriptsData, ModdedDex, ModdedField, Move, Pokemon, PokemonSet, PokemonSources, Species, TeamValidator } from './exported-global-types';
-import { BasicEffect } from './dex-data';
-import { EventMethods } from './dex-conditions';
-export interface FormatData extends Partial<Format>, EventMethods {
-    name: string;
-}
-export type FormatList = (FormatData | {
-    section: string;
-    column?: number;
-})[];
-export type ModdedFormatData = FormatData | Omit<FormatData, 'name'> & {
-    inherit: true;
-};
-type FormatEffectType = 'Format' | 'Ruleset' | 'Rule' | 'ValidatorRule';
-/** rule, source, limit, bans */
-export type ComplexBan = [string, string, number, string[]];
-export type ComplexTeamBan = ComplexBan;
-/**
- * A RuleTable keeps track of the rules that a format has. The key can be:
- * - '[ruleid]' the ID of a rule in effect
- * - '-[thing]' or '-[category]:[thing]' ban a thing
- * - '+[thing]' or '+[category]:[thing]' allow a thing (override a ban)
- * [category] is one of: item, move, ability, species, basespecies
- *
- * The value is the name of the parent rule (blank for the active format).
- */
-export declare class RuleTable extends Map<string, string> {
-    complexBans: ComplexBan[];
-    complexTeamBans: ComplexTeamBan[];
-    checkCanLearn: [TeamValidator['checkCanLearn'], string] | null;
-    timer: [Partial<GameTimerSettings>, string] | null;
-    tagRules: string[];
-    valueRules: Map<string, string>;
-    minTeamSize: number;
-    maxTeamSize: number;
-    pickedTeamSize: number | null;
-    maxTotalLevel: number | null;
-    maxMoveCount: number;
-    minSourceGen: number;
-    minLevel: number;
-    maxLevel: number;
-    defaultLevel: number;
-    adjustLevel: number | null;
-    adjustLevelDown: number | null;
-    evLimit: number | null;
-    constructor();
-    isBanned(thing: string): boolean;
-    isBannedSpecies(species: Species): boolean;
-    isRestricted(thing: string): boolean;
-    isRestrictedSpecies(species: Species): boolean;
-    getTagRules(): string[];
-    /**
-     * - non-empty string: banned, string is the reason
-     * - '': whitelisted
-     * - null: neither whitelisted nor banned
-     */
-    check(thing: string, setHas?: {
-        [id: string]: true;
-    } | null): string | null;
-    getReason(key: string): string | null;
-    blame(key: string): string;
-    getComplexBanIndex(complexBans: ComplexBan[], rule: string): number;
-    addComplexBan(rule: string, source: string, limit: number, bans: string[]): void;
-    addComplexTeamBan(rule: string, source: string, limit: number, bans: string[]): void;
-    /** After a RuleTable has been filled out, resolve its hardcoded numeric properties */
-    resolveNumbers(format: Format, dex: ModdedDex): void;
-    hasComplexBans(): boolean;
-}
-export declare class Format extends BasicEffect implements Readonly<BasicEffect> {
-    readonly mod: string;
-    /**
-     * Name of the team generator algorithm, if this format uses
-     * random/fixed teams. null if players can bring teams.
-     */
-    readonly team?: string;
-    readonly effectType: FormatEffectType;
-    readonly debug: boolean;
-    /**
-     * Whether or not a format will update ladder points if searched
-     * for using the "Battle!" button.
-     * (Challenge and tournament games will never update ladder points.)
-     * (Defaults to `true`.)
-     */
-    readonly rated: boolean | string;
-    /** Game type. */
-    readonly gameType: GameType;
-    /** List of rule names. */
-    readonly ruleset: string[];
-    /**
-     * Base list of rule names as specified in "./config/formats.ts".
-     * Used in a custom format to correctly display the altered ruleset.
-     */
-    readonly baseRuleset: string[];
-    /** List of banned effects. */
-    readonly banlist: string[];
-    /** List of effects that aren't completely banned. */
-    readonly restricted: string[];
-    /** List of inherited banned effects to override. */
-    readonly unbanlist: string[];
-    /** List of ruleset and banlist changes in a custom format. */
-    readonly customRules: string[] | null;
-    /** Table of rule names and banned effects. */
-    ruleTable: RuleTable | null;
-    /** An optional function that runs at the start of a battle. */
-    readonly onBegin?: (this: Battle) => void;
-    readonly noLog: boolean;
-    /**
-     * Only applies to rules, not formats
-     */
-    readonly hasValue?: boolean | 'integer' | 'positive-integer';
-    readonly onValidateRule?: (this: {
-        format: Format;
-        ruleTable: RuleTable;
-        dex: ModdedDex;
-    }, value: string) => string | void;
-    /** ID of rule that can't be combined with this rule */
-    readonly mutuallyExclusiveWith?: string;
-    readonly battle?: ModdedBattleScriptsData;
-    readonly pokemon?: ModdedBattlePokemon;
-    readonly queue?: ModdedBattleQueue;
-    readonly field?: ModdedField;
-    readonly actions?: ModdedBattleActions;
-    readonly challengeShow?: boolean;
-    readonly searchShow?: boolean;
-    readonly bestOfDefault?: boolean;
-    readonly threads?: string[];
-    readonly timer?: Partial<GameTimerSettings>;
-    readonly tournamentShow?: boolean;
-    readonly checkCanLearn?: (this: TeamValidator, move: Move, species: Species, setSources: PokemonSources, set: PokemonSet) => string | null;
-    readonly getEvoFamily?: (this: Format, speciesid: string) => ID;
-    readonly getSharedPower?: (this: Format, pokemon: Pokemon) => Set<string>;
-    readonly getSharedItems?: (this: Format, pokemon: Pokemon) => Set<string>;
-    readonly onChangeSet?: (this: TeamValidator, set: PokemonSet, format: Format, setHas?: AnyObject, teamHas?: AnyObject) => string[] | void;
-    readonly onModifySpeciesPriority?: number;
-    readonly onModifySpecies?: (this: Battle, species: Species, target?: Pokemon, source?: Pokemon, effect?: Effect) => Species | void;
-    readonly onBattleStart?: (this: Battle) => void;
-    readonly onTeamPreview?: (this: Battle) => void;
-    readonly onValidateSet?: (this: TeamValidator, set: PokemonSet, format: Format, setHas: AnyObject, teamHas: AnyObject) => string[] | void;
-    readonly onValidateTeam?: (this: TeamValidator, team: PokemonSet[], format: Format, teamHas: AnyObject) => string[] | void;
-    readonly validateSet?: (this: TeamValidator, set: PokemonSet, teamHas: AnyObject) => string[] | null;
-    readonly validateTeam?: (this: TeamValidator, team: PokemonSet[], options?: {
-        removeNicknames?: boolean;
-        skipSets?: {
-            [name: string]: {
-                [key: string]: boolean;
-            };
-        };
-    }) => string[] | void;
-    readonly section?: string;
-    readonly column?: number;
-    constructor(data: AnyObject);
-}
-export declare class DexFormats {
-    readonly dex: ModdedDex;
-    rulesetCache: Map<ID, Format>;
-    formatsListCache: readonly Format[] | null;
-    constructor(dex: ModdedDex);
-    load(): this;
-    /**
-     * Returns a sanitized format ID if valid, or throws if invalid.
-     */
-    validate(name: string): string;
-    get(name?: string | Format, isTrusted?: boolean): Format;
-    all(): readonly Format[];
-    getRuleTable(format: Format, depth?: number, repeals?: Map<string, number>): RuleTable;
-    validateRule(rule: string, format?: Format | null): string | (string | number | string[])[];
-    validPokemonTag(tagid: ID): boolean;
-    validateBanRule(rule: string): string;
-}
-export {};

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

@@ -1,110 +0,0 @@
-import { AnyObject, Battle, CommonHandlers, ConditionData, ID, ModdedDex, Pokemon, SparseBoostsTable } from './exported-global-types';
-import { PokemonEventMethods } from './dex-conditions';
-import { BasicEffect } from './dex-data';
-interface FlingData {
-    basePower: number;
-    status?: string;
-    volatileStatus?: string;
-    effect?: CommonHandlers['ResultMove'];
-}
-export interface ItemData extends Partial<Item>, PokemonEventMethods {
-    name: string;
-}
-export type ModdedItemData = ItemData | (Partial<Omit<ItemData, 'name'>> & {
-    inherit: true;
-    onCustap?: (this: Battle, pokemon: Pokemon) => void;
-});
-export declare class Item extends BasicEffect implements Readonly<BasicEffect> {
-    readonly effectType: 'Item';
-    /** just controls location on the item spritesheet */
-    readonly num: number;
-    /**
-     * A Move-like object depicting what happens when Fling is used on
-     * this item.
-     */
-    readonly fling?: FlingData;
-    /**
-     * If this is a Drive: The type it turns Techno Blast into.
-     * undefined, if not a Drive.
-     */
-    readonly onDrive?: string;
-    /**
-     * If this is a Memory: The type it turns Multi-Attack into.
-     * undefined, if not a Memory.
-     */
-    readonly onMemory?: string;
-    /**
-     * If this is a mega stone: The name (e.g. Charizard-Mega-X) of the
-     * forme this allows transformation into.
-     * undefined, if not a mega stone.
-     */
-    readonly megaStone?: string;
-    /**
-     * If this is a mega stone: The name (e.g. Charizard) of the
-     * forme this allows transformation from.
-     * undefined, if not a mega stone.
-     */
-    readonly megaEvolves?: string;
-    /**
-     * If this is a Z crystal: true if the Z Crystal is generic
-     * (e.g. Firium Z). If species-specific, the name
-     * (e.g. Inferno Overdrive) of the Z Move this crystal allows
-     * the use of.
-     * undefined, if not a Z crystal.
-     */
-    readonly zMove?: true | string;
-    /**
-     * If this is a generic Z crystal: The type (e.g. Fire) of the
-     * Z Move this crystal allows the use of (e.g. Fire)
-     * undefined, if not a generic Z crystal
-     */
-    readonly zMoveType?: string;
-    /**
-     * If this is a species-specific Z crystal: The name
-     * (e.g. Play Rough) of the move this crystal requires its
-     * holder to know to use its Z move.
-     * undefined, if not a species-specific Z crystal
-     */
-    readonly zMoveFrom?: string;
-    /**
-     * If this is a species-specific Z crystal: An array of the
-     * species of Pokemon that can use this crystal's Z move.
-     * Note that these are the full names, e.g. 'Mimikyu-Busted'
-     * undefined, if not a species-specific Z crystal
-     */
-    readonly itemUser?: string[];
-    /** Is this item a Berry? */
-    readonly isBerry: boolean;
-    /** Whether or not this item ignores the Klutz ability. */
-    readonly ignoreKlutz: boolean;
-    /** The type the holder will change into if it is an Arceus. */
-    readonly onPlate?: string;
-    /** Is this item a Gem? */
-    readonly isGem: boolean;
-    /** Is this item a Pokeball? */
-    readonly isPokeball: boolean;
-    readonly condition?: ConditionData;
-    readonly forcedForme?: string;
-    readonly isChoice?: boolean;
-    readonly naturalGift?: {
-        basePower: number;
-        type: string;
-    };
-    readonly spritenum?: number;
-    readonly boosts?: SparseBoostsTable | false;
-    readonly onEat?: ((this: Battle, pokemon: Pokemon) => void) | false;
-    readonly onPrimal?: (this: Battle, pokemon: Pokemon) => void;
-    readonly onStart?: (this: Battle, target: Pokemon) => void;
-    readonly onEnd?: (this: Battle, target: Pokemon) => void;
-    constructor(data: AnyObject);
-}
-export declare class DexItems {
-    readonly dex: ModdedDex;
-    readonly itemCache: Map<ID, Item>;
-    allCache: readonly Item[] | null;
-    constructor(dex: ModdedDex);
-    get(name?: string | Item): Item;
-    getByID(id: ID): Item;
-    all(): readonly Item[];
-}
-export {};