Class default

Hierarchy (view full)

PokemonSpeciesForm
- default

Implements

Localizable

Index

Constructors

Constructors

constructor

new default(id, generation, subLegendary, legendary, mythical, species, type1, type2, height, weight, ability1, ability2, abilityHidden, baseTotal, baseHp, baseAtk, baseDef, baseSpatk, baseSpdef, baseSpd, catchRate, baseFriendship, baseExp, growthRate, malePercent, genderDiffs, canChangeForm?, ...forms): default
Parameters
- id: Species
- generation: number
- subLegendary: boolean
- legendary: boolean
- mythical: boolean
- species: 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
- growthRate: GrowthRate
- malePercent: null | number
- genderDiffs: boolean
- OptionalcanChangeForm: boolean
- Rest...forms: PokemonForm[]
Returns default
Overrides PokemonSpeciesForm.constructor
- Defined in src/data/pokemon-species.ts:592

Properties

ability1

ability1: Abilities

ability2

ability2: Abilities

abilityHidden

abilityHidden: Abilities

baseExp

baseExp: number

baseFriendship

baseFriendship: number

baseStats

baseStats: number[]

baseTotal

baseTotal: number

canChangeForm

canChangeForm: boolean

catchRate

catchRate: number

formIndex

formIndex: number

forms

forms: PokemonForm[]

genderDiffs

genderDiffs: boolean

generation

generation: number

growthRate

growthRate: GrowthRate

height

height: number

isStarterSelectable

isStarterSelectable: boolean

legendary

legendary: boolean

malePercent

malePercent: null | number

mythical

mythical: boolean

name

name: string

species

species: string

speciesId

speciesId: Species

subLegendary

subLegendary: boolean

type1

type1: Type

type2

type2: null | Type

weight

weight: number

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

generateCandyColors

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

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

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

getBaseExp

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

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

getCompatibleFusionSpeciesFilter

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

getCryKey

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

getEvolutionLevels

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

getFormSpriteKey

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

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

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

getLevelMoves

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

getName

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

getPrevolutionLevels

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

getRegion

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

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

getSimulatedEvolutionChain

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

getSpeciesForLevel

getSpeciesForLevel(level, allowEvolving?, forTrainer?, strength?, currentWave?): Species
Parameters
- level: number
- allowEvolving: boolean = false
- forTrainer: boolean = false
- strength: PartyMemberStrength = PartyMemberStrength.WEAKER
- currentWave: number = 0
Returns Species
- Defined in src/data/pokemon-species.ts:677

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

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

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

getTrainerSpeciesForLevel

getTrainerSpeciesForLevel(level, allowEvolving?, strength, currentWave?): Species
Parameters
- level: number
- allowEvolving: boolean = false
- strength: PartyMemberStrength
- currentWave: number = 0
Returns Species
- Defined in src/data/pokemon-species.ts:656

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

getWildSpeciesForLevel

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

hasVariants

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

isCatchable

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

isObtainable

isObtainable(): boolean
Returns boolean
Overrides PokemonSpeciesForm.isObtainable
- Defined in src/data/pokemon-species.ts:854

isOfType

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

isRareRegional

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

isRegional

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

isTrainerForbidden

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

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

localize

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

validateStarterMoveset

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