Class PokemonForm

ability1

ability2

abilityHidden

baseExp

baseFriendship

baseStats

baseTotal

catchRate

formIndex

genderDiffs

generation

height

isStarterSelectable

speciesId

type1

type2

weight

cry

• cry(scene, soundConfig?, ignorePlay?): AnySound

• Parameters

  • scene: default
  • OptionalsoundConfig: SoundConfig
  • OptionalignorePlay: boolean

  Returns AnySound

generateCandyColors

• generateCandyColors(scene): number[][]

• Parameters

  • scene: default

  Returns number[][]

getAbility

• getAbility(abilityIndex): Abilities

• Method to get the ability of a Pokemon species.

  Parameters

  • abilityIndex: number

    Which ability to get (should only be 0-2)

  Returns Abilities

  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

getBaseStat

• getBaseStat(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.

getCryKey

• getCryKey(formIndex?): string

• Parameters

  • OptionalformIndex: number

  Returns string

getIconAtlasKey

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

• Parameters

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

  Returns string

getIconId

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

• Parameters

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

  Returns string

getLevelMoves

• getLevelMoves(): LevelMoves

• Returns LevelMoves

getRegion

• getRegion(): Region

• Returns Region

getRootSpeciesId

• getRootSpeciesId(forStarter?): Species

• 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 Species

  The species

getSpriteAtlasPath

• getSpriteAtlasPath(female, formIndex?, shiny?, variant?): string

• Parameters

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

  Returns string

getSpriteId

• getSpriteId(female, formIndex?, shiny?, variant?, back?): string

• Parameters

  • female: boolean
  • OptionalformIndex: number
  • Optionalshiny: boolean
  • variant: number = 0
  • Optionalback: boolean

  Returns string

getSpriteKey

• getSpriteKey(female, formIndex?, shiny?, variant?): string

• Parameters

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

  Returns string

getVariantDataIndex

• getVariantDataIndex(formIndex?): 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

isObtainable

• isObtainable(): boolean

• Returns boolean

isOfType

• isOfType(type): boolean

• Parameters

  • type: number

  Returns boolean

isRareRegional

• isRareRegional(): boolean

• Returns boolean

isRegional

• isRegional(): boolean

• Returns boolean

isTrainerForbidden

• isTrainerForbidden(): boolean

• Returns boolean

loadAssets

• loadAssets(scene, female, formIndex?, shiny?, variant?, startLoad?): Promise<void>

• Parameters

  • scene: default
  • female: boolean
  • OptionalformIndex: number
  • Optionalshiny: boolean
  • Optionalvariant: Variant
  • OptionalstartLoad: boolean

  Returns Promise<void>

validateStarterMoveset

• validateStarterMoveset(moveset, eggMoves): boolean

• Parameters

  • moveset: StarterMoveset
  • eggMoves: number

  Returns boolean