Class PokemonForm

Readonlyability1

Readonlyability2

ReadonlyabilityHidden

ReadonlybaseExp

ReadonlybaseFriendship

ReadonlybaseStats

ReadonlybaseTotal

ReadonlycatchRate

ReadonlygenderDiffs

Readonlyheight

ReadonlyisStarterSelectable

speciesId

Readonlytype1

Readonlytype2

Readonlyweight

formIndex

• get formIndex(): number

  Returns number

• set formIndex(formIndex: number): void

  Parameters

  • formIndex: number

  Returns void

generation

• get generation(): number

  Returns number

• set generation(generation: number): void

  Parameters

  • generation: number

  Returns void

canLearnTm

• canLearnTm(moveId: MoveId, formKey?: string): boolean

  Checks whether this species can learn a specific TM.

  Parameters

  • moveId: MoveId

    The TM to check for.

  • OptionalformKey: string

    (Optional) The key for the form to be checked. Uses the base form if not specified.

  Returns boolean

  whether this species can learn the TM

cry

• cry(soundConfig?: SoundConfig, ignorePlay?: boolean): AnySound | null

  Parameters

  • OptionalsoundConfig: SoundConfig
  • OptionalignorePlay: boolean

  Returns AnySound | null

generateCandyColors

• generateCandyColors(): number[][]

  Returns number[][]

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

getAbilityCount

• getAbilityCount(): number

  Method to get the total number of abilities a Pokemon species has.

  Returns number

  Number of abilities

getBaseExp

• getBaseExp(): number

  Returns number

getBaseSpriteKey

• getBaseSpriteKey(female: boolean, formIndex?: number): string

  Parameters

  • female: boolean
  • OptionalformIndex: number

  Returns string

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.

getBaseStatTotal

• getBaseStatTotal(): number

  Gets the BST for the species

  Returns number

  The species' BST.

getCryKey

• getCryKey(formIndex?: number): string

  Parameters

  • OptionalformIndex: number

  Returns string

getIconAtlasKey

• getIconAtlasKey(formIndex?: number, shiny?: boolean, variant?: number): string

  Parameters

  • OptionalformIndex: number
  • Optionalshiny: boolean
  • Optionalvariant: number

  Returns string

getIconId

• getIconId(
      female: boolean,
      formIndex?: number,
      shiny?: boolean,
      variant?: number,
  ): string

  Parameters

  • female: boolean
  • OptionalformIndex: number
  • Optionalshiny: boolean
  • Optionalvariant: number

  Returns string

getPassiveAbility

• getPassiveAbility(formIndex?: number): AbilityId

  Method to get the passive ability of a Pokemon species

  Parameters

  • formIndex: number = ...

    The form index to use, defaults to form for this species instance

  Returns AbilityId

  The id of the ability

getRegion

• getRegion(): Region

  Returns Region

getRootSpeciesId

• getRootSpeciesId(forStarter?: boolean): SpeciesId

  Method to get the root species id of a Pokemon. Pikachu.getRootSpeciesId(true) => Pichu Pikachu.getRootSpeciesId(false) => Pikachu

  Parameters

  • forStarter: boolean = false

    boolean to get the nonbaby form of a starter

  Returns SpeciesId

  The species

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

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

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

getTms

• getTms(form?: string | number): MoveId[]

  Get al list of all TMs that can be learned by this species.

  Parameters

  • Optionalform: string | number

    the formIndex or formKey of the form to get TMs for. (default: base form)

  Returns MoveId[]

  A list of all TM MoveIds that can be learned by this species

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

isCatchable

• isCatchable(): boolean

  Returns boolean

isOfType

• isOfType(type: number): boolean

  Parameters

  • type: number

  Returns boolean

isRareRegional

• isRareRegional(): boolean

  Returns boolean

isRegional

• isRegional(): boolean

  Returns boolean

isTrainerForbidden

• isTrainerForbidden(): boolean

  Returns boolean

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>

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>

validateStarterMoveset

• validateStarterMoveset(moveset: StarterMoveset, eggMoves: number): boolean

  Parameters

  • moveset: StarterMoveset
  • eggMoves: number

  Returns boolean