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: 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: number
- genderDiffs: boolean
- Optional canChangeForm: boolean
- Rest ...forms: PokemonForm[]
Returns default
Overrides PokemonSpeciesForm.constructor
- Defined in src/data/pokemon-species.ts:567

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

mythical

mythical: boolean

name

name: string

species

species: string

speciesId

speciesId: Species

subLegendary

subLegendary: boolean

type1

type1: Type

type2

type2: Type

weight

weight: number

Methods

cry

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

generateCandyColors

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

getAbility

getAbility(abilityIndex): Abilities
Parameters
- abilityIndex: number
Returns Abilities
Inherited from PokemonSpeciesForm.getAbility
- Defined in src/data/pokemon-species.ts:184

getAbilityCount

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

getBaseExp

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

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

getCompatibleFusionSpeciesFilter

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

getCryKey

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

getEvolutionLevels

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

getFormSpriteKey

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

getIconAtlasKey

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

getIconId

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

getLevelMoves

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

getName

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

getPrevolutionLevels

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

getRegion

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

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

getSimulatedEvolutionChain

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

getSpeciesForLevel

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

getSpriteAtlasPath

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

getSpriteId

getSpriteId(female, formIndex?, shiny?, variant?, back?): string
Parameters
- female: boolean
- Optional formIndex: number
- Optional shiny: boolean
- Optional variant: number
- Optional back: boolean
Returns string
Inherited from PokemonSpeciesForm.getSpriteId
- Defined in src/data/pokemon-species.ts:253

getSpriteKey

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

`Private` getStrengthLevelDiff

getStrengthLevelDiff(strength): number
Parameters
- strength: PartyMemberStrength
Returns number
- Defined in src/data/pokemon-species.ts:629

getTrainerSpeciesForLevel

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

getVariantDataIndex

getVariantDataIndex(formIndex?): string | number
Variant Data key/index is either species id or species id followed by -formkey
Parameters
- Optional formIndex: 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:282

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

isCatchable

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

isObtainable

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

isOfType

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

isRareRegional

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

isRegional

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

isTrainerForbidden

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

loadAssets

loadAssets(scene, female, formIndex?, shiny?, variant?, startLoad?): Promise<void>
Parameters
- scene: default
- female: boolean
- Optional formIndex: number
- Optional shiny: boolean
- Optional variant: Variant
- Optional startLoad: boolean
Returns Promise<void>
Inherited from PokemonSpeciesForm.loadAssets
- Defined in src/data/pokemon-species.ts:436

localize

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

validateStarterMoveset

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