Class default

Hierarchy (view full)

PokemonSpeciesForm
- default

Implements

Localizable

Index

Constructors

Accessors

formIndex generation

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

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`canChangeForm

canChangeForm: boolean

`Readonly`catchRate

catchRate: number

`Readonly`forms

forms: PokemonForm[]

`Readonly`genderDiffs

genderDiffs: boolean

`Readonly`growthRate

growthRate: GrowthRate

`Readonly`height

height: number

`Readonly`isStarterSelectable

isStarterSelectable: boolean

`Readonly`legendary

legendary: boolean

`Readonly`malePercent

malePercent: null | number

`Readonly`mythical

mythical: boolean

name

name: string

`Readonly`species

species: string

speciesId

speciesId: Species

`Readonly`subLegendary

subLegendary: boolean

`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:228
set formIndex(formIndex): void
Parameters
- formIndex: number
Returns void
Inherited from PokemonSpeciesForm.formIndex
- Defined in src/data/pokemon-species.ts:232

generation

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

Methods

cry

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

generateCandyColors

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

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

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

getBaseExp

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

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

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

getCompatibleFusionSpeciesFilter

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

getCryKey

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

getEvolutionLevels

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

getExpandedSpeciesName

getExpandedSpeciesName(): string
Find the name of species with proper attachments for regionals and separate starter forms (Floette, Ursaluna)

Returns string
a string with the region name or other form name attached
- Defined in src/data/pokemon-species.ts:728

getFormNameToDisplay

getFormNameToDisplay(formIndex?, append?): string
Find the form name for species with just one form (regional variants, Floette, Ursaluna)
Parameters
- formIndex: number = 0
  The form index to check (defaults to 0)
- append: boolean = false
  Whether to append the species name to the end (defaults to false)
Returns string
the pokemon-form locale key for the single form name ("Alolan Form", "Eternal Flower" etc)
- Defined in src/data/pokemon-species.ts:742

getFormSpriteKey

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

getFullUnlocksData

getFullUnlocksData(): bigint
Generates a bigint corresponding to the maximum unlocks possible for this species, taking into account if the species has a male/female gender, and which variants are implemented.

Returns bigint
bigint Maximum unlocks, can be compared with DexEntry.caughtAttr.
- Defined in src/data/pokemon-species.ts:1041

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

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

getLevelMoves

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

getName

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

getPassiveAbility

getPassiveAbility(formIndex?): Abilities
Method to get the passive ability of a Pokemon species
Parameters
- OptionalformIndex: number
  The form index to use, defaults to form for this species instance
Returns Abilities
The id of the ability
Inherited from PokemonSpeciesForm.getPassiveAbility
- Defined in src/data/pokemon-species.ts:270

getPrevolutionLevels

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

getRegion

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

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

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

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

getSpriteAtlasPath

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

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

getSpriteKey

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

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

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

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

hasVariants

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

isCatchable

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

isObtainable

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

isOfType

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

isRareRegional

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

isRegional

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

isTrainerForbidden

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

loadAssets

loadAssets(female, formIndex?, shiny?, variant?, startLoad?, back?): Promise<void>
Parameters
- female: boolean
- OptionalformIndex: number
- Optionalshiny: boolean
- Optionalvariant: Variant
- OptionalstartLoad: boolean
- Optionalback: boolean
Returns Promise<void>
Inherited from PokemonSpeciesForm.loadAssets
- Defined in src/data/pokemon-species.ts:554

localize

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

validateStarterMoveset

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