Class PokemonSpecies

Hierarchy (View Summary)

PokemonSpeciesForm
- PokemonSpecies

Implements

Localizable

Index

Constructors

constructor

Accessors

formIndex generation

Constructors

constructor

new PokemonSpecies(
    id: SpeciesId,
    generation: number,
    subLegendary: boolean,
    legendary: boolean,
    mythical: boolean,
    category: string,
    type1: PokemonType,
    type2: null | PokemonType,
    height: number,
    weight: number,
    ability1: AbilityId,
    ability2: AbilityId,
    abilityHidden: AbilityId,
    baseTotal: number,
    baseHp: number,
    baseAtk: number,
    baseDef: number,
    baseSpatk: number,
    baseSpdef: number,
    baseSpd: number,
    catchRate: number,
    baseFriendship: number,
    baseExp: number,
    growthRate: GrowthRate,
    malePercent: null | number,
    genderDiffs: boolean,
    canChangeForm?: boolean,
    ...forms: PokemonForm[],
): PokemonSpecies
Parameters
- id: SpeciesId
- generation: number
- subLegendary: boolean
- legendary: boolean
- mythical: boolean
- category: string
- type1: PokemonType
- type2: null | PokemonType
- height: number
- weight: number
- ability1: AbilityId
- ability2: AbilityId
- abilityHidden: AbilityId
- baseTotal: number
- baseHp: number
- baseAtk: number
- baseDef: number
- baseSpatk: number
- baseSpdef: number
- baseSpd: number
- catchRate: number
- baseFriendship: number
- baseExp: number
- growthRate: GrowthRate
- malePercent: null | number
- genderDiffs: boolean
- OptionalcanChangeForm: boolean
- ...forms: PokemonForm[]
Returns PokemonSpecies
Overrides PokemonSpeciesForm.constructor
- Defined in src/data/pokemon-species.ts:689

Properties

`Protected`_formIndex

_formIndex: number

`Protected`_generation

_generation: number

`Readonly`ability1

ability1: AbilityId

`Readonly`ability2

ability2: AbilityId

`Readonly`abilityHidden

abilityHidden: AbilityId

`Readonly`baseExp

baseExp: number

`Readonly`baseFriendship

baseFriendship: number

`Readonly`baseStats

baseStats: number[]

`Readonly`baseTotal

baseTotal: number

`Readonly`canChangeForm

canChangeForm: boolean

`Readonly`catchRate

catchRate: number

`Readonly`forms

forms: PokemonForm[]

`Readonly`genderDiffs

genderDiffs: boolean

`Readonly`growthRate

growthRate: GrowthRate

`Readonly`height

height: number

`Readonly`isStarterSelectable

isStarterSelectable: boolean

`Readonly`legendary

legendary: boolean

`Readonly`malePercent

malePercent: null | number

The chance (as a decimal) for this Species to be male, or null for genderless species

`Readonly`mythical

mythical: boolean

name

name: string

speciesId

speciesId: SpeciesId

`Readonly`subLegendary

subLegendary: boolean

`Readonly`type1

type1: PokemonType

`Readonly`type2

type2: null | PokemonType

`Readonly`weight

weight: number

Accessors

formIndex

get formIndex(): number
Returns number
Inherited from PokemonSpeciesForm.formIndex
- Defined in src/data/pokemon-species.ts:159
set formIndex(formIndex: number): void
Parameters
- formIndex: number
Returns void
Inherited from PokemonSpeciesForm.formIndex
- Defined in src/data/pokemon-species.ts:163

generation

get generation(): number
Returns number
Inherited from PokemonSpeciesForm.generation
- Defined in src/data/pokemon-species.ts:151
set generation(generation: number): void
Parameters
- generation: number
Returns void
Inherited from PokemonSpeciesForm.generation
- Defined in src/data/pokemon-species.ts:155

Methods

cry

cry(soundConfig?: SoundConfig, ignorePlay?: boolean): null | AnySound
Parameters
- OptionalsoundConfig: SoundConfig
- OptionalignorePlay: boolean
Returns null | AnySound
Inherited from PokemonSpeciesForm.cry
- Defined in src/data/pokemon-species.ts:598

generateCandyColors

generateCandyColors(): number[][]
Returns number[][]
Inherited from PokemonSpeciesForm.generateCandyColors
- Defined in src/data/pokemon-species.ts:611

generateGender

generateGender(): Gender
Pick and return a random Gender for a Pokemon.

Returns Gender
A randomly rolled gender based on this Species' malePercent.
- Defined in src/data/pokemon-species.ts:795

getAbility

getAbility(abilityIndex: number): AbilityId
Method to get the ability of a Pokemon species.
Parameters
- abilityIndex: number
  Which ability to get (should only be 0-2)
Returns AbilityId
The id of the Ability
Inherited from PokemonSpeciesForm.getAbility
- Defined in src/data/pokemon-species.ts:184

getAbilityCount

getAbilityCount(): number
Method to get the total number of abilities a Pokemon species has.

Returns number
Number of abilities
Inherited from PokemonSpeciesForm.getAbilityCount
- Defined in src/data/pokemon-species.ts:175

getBaseExp

getBaseExp(): number
Returns number
Inherited from PokemonSpeciesForm.getBaseExp
- Defined in src/data/pokemon-species.ts:280

getBaseSpriteKey

getBaseSpriteKey(female: boolean, formIndex?: number): string
Parameters
- female: boolean
- OptionalformIndex: number
Returns string
Inherited from PokemonSpeciesForm.getBaseSpriteKey
- Defined in src/data/pokemon-species.ts:300

getBaseStat

getBaseStat(stat: Stat): number
Gets the species' base stat amount for the given stat.
Parameters
- stat: Stat
  The desired stat.
Returns number
The species' base stat amount.
Inherited from PokemonSpeciesForm.getBaseStat
- Defined in src/data/pokemon-species.ts:276

getBaseStatTotal

getBaseStatTotal(): number
Gets the BST for the species

Returns number
The species' BST.
Inherited from PokemonSpeciesForm.getBaseStatTotal
- Defined in src/data/pokemon-species.ts:267

getCompatibleFusionSpeciesFilter

getCompatibleFusionSpeciesFilter(): PokemonSpeciesFilter
Returns PokemonSpeciesFilter
- Defined in src/data/pokemon-species.ts:1051

getCryKey

getCryKey(formIndex?: number): string
Parameters
- OptionalformIndex: number
Returns string
Inherited from PokemonSpeciesForm.getCryKey
- Defined in src/data/pokemon-species.ts:413

getEvolutionLevels

getEvolutionLevels(): EvolutionLevel[]
Returns EvolutionLevel[]
- Defined in src/data/pokemon-species.ts:928

getExpandedSpeciesName

getExpandedSpeciesName(): string
Find the name of species with proper attachments for regionals and separate starter forms (Floette, Ursaluna)

Returns string
a string with the region name or other form name attached
- Defined in src/data/pokemon-species.ts:810

getFormNameToDisplay

getFormNameToDisplay(formIndex?: number, append?: boolean): string
Find the form name for species with just one form (regional variants, Floette, Ursaluna)
Parameters
- formIndex: number = 0
  The form index to check (defaults to 0)
- append: boolean = false
  Whether to append the species name to the end (defaults to false)
Returns string
the pokemon-form locale key for the single form name ("Alolan Form", "Eternal Flower" etc)
- Defined in src/data/pokemon-species.ts:826

getFormSpriteKey

getFormSpriteKey(formIndex?: number): string
Parameters
- OptionalformIndex: number
Returns string
Overrides PokemonSpeciesForm.getFormSpriteKey
- Defined in src/data/pokemon-species.ts:1084

getFullUnlocksData

getFullUnlocksData(): bigint
Generates a BigInt corresponding to the maximum unlocks possible for this species, taking into account if the species has a male/female gender, and which variants are implemented.

Returns bigint
The maximum unlocks for the species as a BigInt; can be compared with DexEntry.caughtAttr.
- Defined in src/data/pokemon-species.ts:1099

getIconAtlasKey

getIconAtlasKey(formIndex?: number, shiny?: boolean, variant?: number): string
Parameters
- OptionalformIndex: number
- Optionalshiny: boolean
- Optionalvariant: number
Returns string
Inherited from PokemonSpeciesForm.getIconAtlasKey
- Defined in src/data/pokemon-species.ts:349

getIconId

getIconId(
    female: boolean,
    formIndex?: number,
    shiny?: boolean,
    variant?: number,
): string
Parameters
- female: boolean
- OptionalformIndex: number
- Optionalshiny: boolean
- Optionalvariant: number
Returns string
Inherited from PokemonSpeciesForm.getIconId
- Defined in src/data/pokemon-species.ts:356

getLevelMoves

getLevelMoves(): LevelMoves
Returns LevelMoves
Inherited from PokemonSpeciesForm.getLevelMoves
- Defined in src/data/pokemon-species.ts:224

getName

getName(formIndex?: number): string
Parameters
- OptionalformIndex: number
Returns string
- Defined in src/data/pokemon-species.ts:762

getPassiveAbility

getPassiveAbility(formIndex?: number): AbilityId
Method to get the passive ability of a Pokemon species
Parameters
- OptionalformIndex: number
  The form index to use, defaults to form for this species instance
Returns AbilityId
The id of the ability
Inherited from PokemonSpeciesForm.getPassiveAbility
- Defined in src/data/pokemon-species.ts:201

getPrevolutionLevels

getPrevolutionLevels(withThresholds: true): EvolutionLevelWithThreshold[]
Get all prevolution levels for this species
Parameters
- withThresholds: true
  Whether to include evolution level thresholds in the returned data; default false
Returns EvolutionLevelWithThreshold[]
Remarks
withThresholds is used to return the evolution level thresholds for the species, to be used when generating
- Defined in src/data/pokemon-species.ts:958
getPrevolutionLevels(withThresholds: false): EvolutionLevel[]
Get all prevolution levels for this species
Parameters
- withThresholds: false
  Whether to include evolution level thresholds in the returned data; default false
Returns EvolutionLevel[]
Remarks
withThresholds is used to return the evolution level thresholds for the species, to be used when generating
- Defined in src/data/pokemon-species.ts:959
getPrevolutionLevels(withThresholds?: boolean): EvolutionLevelWithThreshold[]
Get all prevolution levels for this species
Parameters
- OptionalwithThresholds: boolean
  Whether to include evolution level thresholds in the returned data; default false
Returns EvolutionLevelWithThreshold[]
Remarks
withThresholds is used to return the evolution level thresholds for the species, to be used when generating
- Defined in src/data/pokemon-species.ts:960

getRegion

getRegion(): Region
Returns Region
Inherited from PokemonSpeciesForm.getRegion
- Defined in src/data/pokemon-species.ts:234

getRootSpeciesId

getRootSpeciesId(forStarter?: boolean): SpeciesId
Method to get the root species id of a Pokemon. Magmortar.getRootSpeciesId(true) => Magmar Magmortar.getRootSpeciesId(false) => Magby
Parameters
- forStarter: boolean = false
  boolean to get the nonbaby form of a starter
Returns SpeciesId
The species
Inherited from PokemonSpeciesForm.getRootSpeciesId
- Defined in src/data/pokemon-species.ts:143

getSimulatedEvolutionChain

getSimulatedEvolutionChain(
    currentLevel: number,
    forTrainer?: boolean,
    isBoss?: boolean,
    player?: boolean,
): EvolutionLevel[]
Parameters
- currentLevel: number
- forTrainer: boolean = false
- isBoss: boolean = false
- player: boolean = false
Returns EvolutionLevel[]
- Defined in src/data/pokemon-species.ts:993

getSpeciesForLevel

getSpeciesForLevel(
    level: number,
    allowEvolving?: boolean,
    forTrainer?: boolean,
    strength?: PartyMemberStrength,
    encounterKind?: EvoLevelThresholdKind,
): SpeciesId
Determine which species of Pokémon to use for a given level
Parameters
- level: number
- allowEvolving: boolean = false
- forTrainer: boolean = false
- strength: PartyMemberStrength = PartyMemberStrength.WEAKER
- encounterKind: EvoLevelThresholdKind = EvoLevelThresholdKind.NORMAL
Returns SpeciesId
See
determineEnemySpecies
- Defined in src/data/pokemon-species.ts:918

getSpriteAtlasPath

getSpriteAtlasPath(
    female: boolean,
    formIndex?: number,
    shiny?: boolean,
    variant?: number,
    back?: boolean,
): string
Parameters
- female: boolean
- OptionalformIndex: number
- Optionalshiny: boolean
- Optionalvariant: number
- Optionalback: boolean
Returns string
Inherited from PokemonSpeciesForm.getSpriteAtlasPath
- Defined in src/data/pokemon-species.ts:295

getSpriteId

getSpriteId(
    female: boolean,
    formIndex?: number,
    shiny?: boolean,
    variant?: number,
    back?: boolean,
): string
Compute the sprite ID of the pokemon form.
Parameters
- female: boolean
- OptionalformIndex: number
- Optionalshiny: boolean
- variant: number = 0
- back: boolean = false
Returns string
Inherited from PokemonSpeciesForm.getSpriteId
- Defined in src/data/pokemon-species.ts:315

getSpriteKey

getSpriteKey(
    female: boolean,
    formIndex?: number,
    shiny?: boolean,
    variant?: number,
    back?: boolean,
): string
Parameters
- female: boolean
- OptionalformIndex: number
- Optionalshiny: boolean
- Optionalvariant: number
- Optionalback: boolean
Returns string
Inherited from PokemonSpeciesForm.getSpriteKey
- Defined in src/data/pokemon-species.ts:325

getTrainerSpeciesForLevel

getTrainerSpeciesForLevel(
    level: number,
    allowEvolving?: boolean,
    strength?: PartyMemberStrength,
    encounterKind?: EvoLevelThresholdKind,
): SpeciesId
Determine which species of Pokémon to use for a given level in a trainer battle.
Parameters
- level: number
- allowEvolving: boolean = false
- strength: PartyMemberStrength = PartyMemberStrength.WEAKER
- encounterKind: EvoLevelThresholdKind = EvoLevelThresholdKind.NORMAL
Returns SpeciesId
See
getSpeciesForLevel
- Defined in src/data/pokemon-species.ts:905

getVariantDataIndex

getVariantDataIndex(formIndex?: number): string | number
Variant Data key/index is either species id or species id followed by -formkey
Parameters
- OptionalformIndex: number
  optional form index for pokemon with different forms
Returns string | number
species id if no additional forms, index with formkey if a pokemon with a form
Inherited from PokemonSpeciesForm.getVariantDataIndex
- Defined in src/data/pokemon-species.ts:336

getWildSpeciesForLevel

getWildSpeciesForLevel(
    level: number,
    allowEvolving: boolean,
    isBoss: boolean,
    gameMode: GameMode,
): SpeciesId
Parameters
- level: number
- allowEvolving: boolean
- isBoss: boolean
- gameMode: GameMode
Returns SpeciesId
- Defined in src/data/pokemon-species.ts:890

hasVariants

hasVariants(): any
Returns any
- Defined in src/data/pokemon-species.ts:1073

isCatchable

isCatchable(): boolean
Returns boolean
Inherited from PokemonSpeciesForm.isCatchable
- Defined in src/data/pokemon-species.ts:242

isObtainable

isObtainable(): boolean
Returns boolean
Inherited from PokemonSpeciesForm.isObtainable
- Defined in src/data/pokemon-species.ts:238

isOfType

isOfType(type: number): boolean
Parameters
- type: number
Returns boolean
Inherited from PokemonSpeciesForm.isOfType
- Defined in src/data/pokemon-species.ts:167

isRareRegional

isRareRegional(): boolean
Returns boolean
Inherited from PokemonSpeciesForm.isRareRegional
- Defined in src/data/pokemon-species.ts:254

isRegional

isRegional(): boolean
Returns boolean
Inherited from PokemonSpeciesForm.isRegional
- Defined in src/data/pokemon-species.ts:246

isTrainerForbidden

isTrainerForbidden(): boolean
Returns boolean
Inherited from PokemonSpeciesForm.isTrainerForbidden
- Defined in src/data/pokemon-species.ts:250

loadAssets

loadAssets(
    female: boolean,
    formIndex?: number,
    shiny?: boolean,
    variant?: Variant,
    startLoad?: boolean,
    back?: boolean,
): Promise<void>
Parameters
- female: boolean
- OptionalformIndex: number
- shiny: boolean = false
- Optionalvariant: Variant
- startLoad: boolean = false
- back: boolean = false
Returns Promise<void>
Inherited from PokemonSpeciesForm.loadAssets
- Defined in src/data/pokemon-species.ts:544

loadVariantColors

loadVariantColors(
    spriteKey: string,
    female: boolean,
    variant: Variant,
    back?: boolean,
    formIndex?: number,
): Promise<void>
Load the variant colors for the species into the variant color cache
Parameters
- spriteKey: string
  The sprite key to use
- female: boolean
  Whether to load female instead of male
- variant: Variant
- back: boolean = false
  Whether the back sprite is being loaded
- OptionalformIndex: number
Returns Promise<void>
Inherited from PokemonSpeciesForm.loadVariantColors
- Defined in src/data/pokemon-species.ts:514

localize

localize(): void
Returns void
Implementation of Localizable.localize
- Defined in src/data/pokemon-species.ts:885

validateStarterMoveset

validateStarterMoveset(moveset: StarterMoveset, eggMoves: number): boolean
Parameters
- moveset: StarterMoveset
- eggMoves: number
Returns boolean
Inherited from PokemonSpeciesForm.validateStarterMoveset
- Defined in src/data/pokemon-species.ts:482

Class PokemonSpecies

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns PokemonSpecies

Properties

Protected_formIndex

Protected_generation

Readonlyability1

Readonlyability2

ReadonlyabilityHidden

ReadonlybaseExp

ReadonlybaseFriendship

ReadonlybaseStats

ReadonlybaseTotal

ReadonlycanChangeForm

ReadonlycatchRate

category

Readonlyforms

ReadonlygenderDiffs

ReadonlygrowthRate

Readonlyheight

ReadonlyisStarterSelectable

Readonlylegendary

ReadonlymalePercent

Readonlymythical

name

speciesId

ReadonlysubLegendary

Readonlytype1

Readonlytype2

Readonlyweight

Accessors

formIndex

Returns number

Parameters

Returns void

generation

Returns number

Parameters

Returns void

Methods

cry

Parameters

Returns null | AnySound

generateCandyColors

Returns number[][]

generateGender

Returns Gender

getAbility

Parameters

Returns AbilityId

getAbilityCount

Returns number

getBaseExp

Returns number

getBaseSpriteKey

Parameters

Returns string

getBaseStat

Parameters

Returns number

getBaseStatTotal

Returns number

getCompatibleFusionSpeciesFilter

Returns PokemonSpeciesFilter

getCryKey

Parameters

Returns string

getEvolutionLevels

Returns EvolutionLevel[]

getExpandedSpeciesName

Returns string

`Protected`_formIndex

`Protected`_generation

`Readonly`ability1

`Readonly`ability2

`Readonly`abilityHidden

`Readonly`baseExp

`Readonly`baseFriendship

`Readonly`baseStats

`Readonly`baseTotal

`Readonly`canChangeForm

`Readonly`catchRate

`Readonly`forms

`Readonly`genderDiffs

`Readonly`growthRate

`Readonly`height

`Readonly`isStarterSelectable

`Readonly`legendary

`Readonly`malePercent

`Readonly`mythical

`Readonly`subLegendary

`Readonly`type1

`Readonly`type2

`Readonly`weight