Class PokemonForm

Hierarchy (view full)

PokemonSpeciesForm
- PokemonForm

Constructors

constructor

new PokemonForm(formName, formKey, type1, type2, height, weight, ability1, ability2, abilityHidden, baseTotal, baseHp, baseAtk, baseDef, baseSpatk, baseSpdef, baseSpd, catchRate, baseFriendship, baseExp, genderDiffs?, formSpriteKey?, isStarterSelectable?): PokemonForm
Parameters
- formName: string
- formKey: string
- type1: Type
- type2: null | Type
- height: number
- weight: number
- ability1: Abilities
- ability2: Abilities
- abilityHidden: Abilities
- baseTotal: number
- baseHp: number
- baseAtk: number
- baseDef: number
- baseSpatk: number
- baseSpdef: number
- baseSpd: number
- catchRate: number
- baseFriendship: number
- baseExp: number
- genderDiffs: boolean = false
- formSpriteKey: null | string = null
- isStarterSelectable: boolean = false
Returns PokemonForm
Overrides PokemonSpeciesForm.constructor
- Defined in src/data/pokemon-species.ts:952

Properties

`Protected`_formIndex

_formIndex: number

`Protected`_generation

_generation: number

`Readonly`ability1

ability1: Abilities

`Readonly`ability2

ability2: Abilities

`Readonly`abilityHidden

abilityHidden: Abilities

`Readonly`baseExp

baseExp: number

`Readonly`baseFriendship

baseFriendship: number

`Readonly`baseStats

baseStats: number[]

`Readonly`baseTotal

baseTotal: number

`Readonly`catchRate

catchRate: number

formKey

formKey: string

formName

formName: string

formSpriteKey

formSpriteKey: null | string

`Readonly`genderDiffs

genderDiffs: boolean

`Readonly`height

height: number

`Readonly`isStarterSelectable

isStarterSelectable: boolean

speciesId

speciesId: Species

`Readonly`type1

type1: Type

`Readonly`type2

type2: null | Type

`Readonly`weight

weight: number

Accessors

formIndex

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

generation

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

Methods

cry

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

generateCandyColors

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

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
Inherited from PokemonSpeciesForm.getAbility
- Defined in src/data/pokemon-species.ts:217

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:208

getBaseExp

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

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.
Inherited from PokemonSpeciesForm.getBaseStat
- Defined in src/data/pokemon-species.ts:278

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:269

getCryKey

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

getFormSpriteKey

getFormSpriteKey(_formIndex?): string
Parameters
- Optional_formIndex: number
Returns string
Overrides PokemonSpeciesForm.getFormSpriteKey
- Defined in src/data/pokemon-species.ts:963

getIconAtlasKey

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

getIconId

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

getLevelMoves

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

getRegion

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

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
Inherited from PokemonSpeciesForm.getRootSpeciesId
- Defined in src/data/pokemon-species.ts:176

getSpriteAtlasPath

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

getSpriteId

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

getSpriteKey

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

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
Inherited from PokemonSpeciesForm.getVariantDataIndex
- Defined in src/data/pokemon-species.ts:331

isCatchable

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

isObtainable

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

isOfType

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

isRareRegional

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

isRegional

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

isTrainerForbidden

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

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>
Inherited from PokemonSpeciesForm.loadAssets
- Defined in src/data/pokemon-species.ts:493

validateStarterMoveset

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