Class SpeciesDataRegistry

The SpeciesDataRegistry is a singleton class responsible for managing and querying species-related information.

Constructors

constructor

new SpeciesDataRegistry(): SpeciesDataRegistry
Returns SpeciesDataRegistry
- Defined in src/data/species-data-registry.ts:35

Properties

`Private` `Readonly`_data

_data: SpeciesDataMap

Accessors

data

get data(): SpeciesDataMap
Returns SpeciesDataMap
- Defined in src/data/species-data-registry.ts:31

Methods

getAllSpecies

getAllSpecies(): PokemonSpecies[]
Get all pokemon species in the registry.

Returns PokemonSpecies[]
An array of all PokemonSpecies
- Defined in src/data/species-data-registry.ts:132

getAllStarters

getAllStarters(getSpecies?: false): SpeciesId[]
Get all starters.
Parameters
- OptionalgetSpecies: false
  (Default false) Whether to return PokemonSpecies instead of SpeciesId.
Returns SpeciesId[]
An array of all starter SpeciesIds or PokemonSpeciess
- Defined in src/data/species-data-registry.ts:261
getAllStarters(getSpecies: true): PokemonSpecies[]
Get all starters.
Parameters
- getSpecies: true
  (Default false) Whether to return PokemonSpecies instead of SpeciesId.
Returns PokemonSpecies[]
An array of all starter SpeciesIds or PokemonSpeciess
- Defined in src/data/species-data-registry.ts:262

getDefaultStartersAndEvolutions

getDefaultStartersAndEvolutions(): SpeciesId[]
Get the default starters and their evolution lines (e.g. the Bulbasaur line, etc)

Returns SpeciesId[]
An array of SpeciesIds
- Defined in src/data/species-data-registry.ts:292

getEggTier

getEggTier(speciesId: SpeciesId): EggTier
Get the egg tier for a given species.
Parameters
- speciesId: SpeciesId
  The SpeciesId of the species to get the egg tier for
Returns EggTier
The EggTier of the species. Uses the "common" tier if the species doesn't have a defined egg tier (aka it isn't a starter).
- Defined in src/data/species-data-registry.ts:180

getEvolutionChain

getEvolutionChain(speciesId: SpeciesId): SpeciesId[]
Get all species in the evolution chain for a given species. Does NOT include the given species itself.
Parameters
- speciesId: SpeciesId
  The SpeciesId of the species to get the evolution chain for
Returns SpeciesId[]
An array of SpeciesIds representing the evolution chain
- Defined in src/data/species-data-registry.ts:311

getEvolutions

getEvolutions(speciesId: SpeciesId): SpeciesFormEvolution[]
Get the evolutions for a given species.
Parameters
- speciesId: SpeciesId
  The SpeciesId of the species to get evolutions for
Returns SpeciesFormEvolution[]
An array of SpeciesFormEvolutions
- Defined in src/data/species-data-registry.ts:301

getFormChanges

getFormChanges(speciesId: SpeciesId): SpeciesFormChange[]
Get the form changes for a given species.
Parameters
- speciesId: SpeciesId
  The SpeciesId of the species to get form changes for
Returns SpeciesFormChange[]
An array of SpeciesFormChanges
- Defined in src/data/species-data-registry.ts:393

`Private`getFormIndex

getFormIndex(speciesId: SpeciesId, form: string | number): number
Helper to validate a form index or retrieve the form index associated with a form key.
Parameters
- speciesId: SpeciesId
  The SpeciesId of the species to get the form index for
- form: string | number
  The formIndex or formKey of the form to get the form index for.
Returns number
The form index
- Defined in src/data/species-data-registry.ts:439

`Private`getFormKey

getFormKey(speciesId: SpeciesId, form?: string | number): string
Helper to get the form key for a given species and formIndex or formKey. Also validates that the form exists and falls back to the base form if it doesn't.
Parameters
- speciesId: SpeciesId
  The SpeciesId of the species to get the form key for
- Optionalform: string | number
  (Optional) The formIndex or formKey of the form to get the form key for. Uses the base form if not specified.
Returns string
The formKey
- Defined in src/data/species-data-registry.ts:418

getLevelMoves

getLevelMoves(speciesId: SpeciesId, form?: string | number): LevelMoves
Get all available level moves for a given species and form.
Parameters
- speciesId: SpeciesId
  The SpeciesId of the species to get level moves for
- Optionalform: string | number
  (Optional) The formIndex or formKey of the form to get level moves for. Uses the base form if not specified.
Returns LevelMoves
An array of all level moves available
- Defined in src/data/species-data-registry.ts:157

getPassive

getPassive(speciesId: SpeciesId, form: string | number): AbilityId
Get the passive ability for a given species and form.
Parameters
- speciesId: SpeciesId
  The SpeciesId of the species to get the passive for
- form: string | number
  The formIndex or formKey of the form to get the passive for.
Returns AbilityId
the passive ability of the species and form
- Defined in src/data/species-data-registry.ts:206

getPrevolution

getPrevolution(speciesId: SpeciesId): SpeciesId | null
Get the prevolution of a given species.
Parameters
- speciesId: SpeciesId
  The SpeciesId of the species to get the prevolution for
Returns SpeciesId | null
The prevolution SpeciesId or PokemonSpecies
- Defined in src/data/species-data-registry.ts:350
getPrevolution(speciesId: SpeciesId, getSpecies: false): SpeciesId | null
Get the prevolution of a given species.
Parameters
- speciesId: SpeciesId
  The SpeciesId of the species to get the prevolution for
- getSpecies: false
  (Default false) Whether to return the PokemonSpecies instead of a SpeciesId
Returns SpeciesId | null
The prevolution SpeciesId or PokemonSpecies
- Defined in src/data/species-data-registry.ts:351
getPrevolution(speciesId: SpeciesId, getSpecies: true): PokemonSpecies | null
Get the prevolution of a given species.
Parameters
- speciesId: SpeciesId
  The SpeciesId of the species to get the prevolution for
- getSpecies: true
  (Default false) Whether to return the PokemonSpecies instead of a SpeciesId
Returns PokemonSpecies | null
The prevolution SpeciesId or PokemonSpecies
- Defined in src/data/species-data-registry.ts:352

getPrevolutionChain

getPrevolutionChain(speciesId: SpeciesId): SpeciesId[]
Get all species in the prevolution chain for a given species. Does NOT include the given species itself.
Parameters
- speciesId: SpeciesId
  The SpeciesId of the species to get the prevolution chain for
Returns SpeciesId[]
An array of SpeciesIds representing the prevolution chain
- Defined in src/data/species-data-registry.ts:368

getSpecies

getSpecies(speciesId: SpeciesId): PokemonSpecies
Get the species data for a given species ID.
Parameters
- speciesId: SpeciesId
  The SpeciesId of the species to get data for
Returns PokemonSpecies
The PokemonSpecies
- Defined in src/data/species-data-registry.ts:124

getSpeciesData

getSpeciesData(speciesId: SpeciesId): PokemonSpeciesData
Get the species data for a given species.
Parameters
- speciesId: SpeciesId
  The SpeciesId of the species to get data for
Returns PokemonSpeciesData
The PokemonSpeciesData
- Defined in src/data/species-data-registry.ts:115

getSpeciesForEggTier

getSpeciesForEggTier(tier: EggTier): PokemonSpecies[]
Get all starter species that belong to a given egg tier.
Parameters
- tier: EggTier
  The EggTier to get starter species for
Returns PokemonSpecies[]
An array of all starter species that belong to the given egg tier
- Defined in src/data/species-data-registry.ts:190

getSpeciesWithEvolutions

getSpeciesWithEvolutions(): SpeciesId[]
Get all SpeciesIds that have evolutions.

Returns SpeciesId[]
An array of all SpeciesIds that have evolutions
- Defined in src/data/species-data-registry.ts:334

getStarter

getStarter(speciesId: SpeciesId, getSpecies?: false): SpeciesId
Retrieve the corresponding starter for a given species.
Parameters
- speciesId: SpeciesId
  The SpeciesId to get the starter for
- OptionalgetSpecies: false
  (Default false) Whether to return the PokemonSpecies instead of a SpeciesId.
Returns SpeciesId
The starter SpeciesId or PokemonSpecies
- Defined in src/data/species-data-registry.ts:233
getStarter(speciesId: SpeciesId, getSpecies: true): PokemonSpecies
Retrieve the corresponding starter for a given species.
Parameters
- speciesId: SpeciesId
  The SpeciesId to get the starter for
- getSpecies: true
  (Default false) Whether to return the PokemonSpecies instead of a SpeciesId.
Returns PokemonSpecies
The starter SpeciesId or PokemonSpecies
- Defined in src/data/species-data-registry.ts:234

getStarterCost

getStarterCost(speciesId: SpeciesId): 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10
Get the starter cost for a given species.
Parameters
- speciesId: SpeciesId
  The SpeciesId of the species to get the starter cost for
Returns 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10
The starter cost of the species
- Defined in src/data/species-data-registry.ts:250

getStartersForCost

getStartersForCost(starterCost: number): SpeciesId[]
Get all starters for a given starter cost.
Parameters
- starterCost: number
  The starter cost
Returns SpeciesId[]
An array of all starter species that have the given starter cost
- Defined in src/data/species-data-registry.ts:278

getTms

getTms(speciesId: SpeciesId, form?: string | number): MoveId[]
Get all available TMs for a given species and form.
Parameters
- speciesId: SpeciesId
  The SpeciesId of the species to get TMs for
- Optionalform: string | number
  (Optional) The formIndex or formKey of the form to get TMs for. Uses the base form if not specified.
Returns MoveId[]
An array of all TMs available
- Defined in src/data/species-data-registry.ts:143

hasEvolutions

hasEvolutions(speciesId: SpeciesId): boolean
Checks if a given species has any evolutions.
Parameters
- speciesId: SpeciesId
  The SpeciesId of the species to check
Returns boolean
whether the species has any evolutions
- Defined in src/data/species-data-registry.ts:326

hasFormChanges

hasFormChanges(speciesId: SpeciesId): boolean
Checks if a given species has any form changes.
Parameters
- speciesId: SpeciesId
  The SpeciesId of the species to check
Returns boolean
Whether the species has any form changes
- Defined in src/data/species-data-registry.ts:403

hasFormLevelMoves

hasFormLevelMoves(speciesId: SpeciesId): boolean
Checks if a given species has any form specific level moves.
Parameters
- speciesId: SpeciesId
  The SpeciesId of the species to check
Returns boolean
Whether the species has any form specific level moves
- Defined in src/data/species-data-registry.ts:169

hasPrevolution

hasPrevolution(speciesId: SpeciesId): boolean
Check if a given species has a prevolution.
Parameters
- speciesId: SpeciesId
  The SpeciesId of the species to check
Returns boolean
Whether the species has a prevolution
- Defined in src/data/species-data-registry.ts:384

`Private`initPreEvolutions

initPreEvolutions(): void
Initialize the prevolution field for all species.

Returns void
- Defined in src/data/species-data-registry.ts:58

`Private`initReverseFormChanges

initReverseFormChanges(): void
Initialize reverse form changes for all species.

Returns void
- Defined in src/data/species-data-registry.ts:85

isStarter

isStarter(speciesId: SpeciesId): boolean
Check if a given species is a starter.
Parameters
- speciesId: SpeciesId
  The SpeciesId of the Species to check
Returns boolean
Whether the species is a starter
- Defined in src/data/species-data-registry.ts:222

Class SpeciesDataRegistry

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns SpeciesDataRegistry

Properties

Private Readonly_data

Accessors

data

Returns SpeciesDataMap

Methods

getAllSpecies

Returns PokemonSpecies[]

getAllStarters

Parameters

Returns SpeciesId[]

Parameters

Returns PokemonSpecies[]

getDefaultStartersAndEvolutions

Returns SpeciesId[]

getEggTier

Parameters

Returns EggTier

getEvolutionChain

Parameters

Returns SpeciesId[]

getEvolutions

Parameters

Returns SpeciesFormEvolution[]

getFormChanges

Parameters

Returns SpeciesFormChange[]

PrivategetFormIndex

Parameters

Returns number

PrivategetFormKey

Parameters

Returns string

getLevelMoves

Parameters

Returns LevelMoves

getPassive

Parameters

Returns AbilityId

getPrevolution

Parameters

Returns SpeciesId | null

Parameters

Returns SpeciesId | null

Parameters

Returns PokemonSpecies | null

getPrevolutionChain

Parameters

Returns SpeciesId[]

getSpecies

Parameters

Returns PokemonSpecies

getSpeciesData

Parameters

Returns PokemonSpeciesData

getSpeciesForEggTier

Parameters

Returns PokemonSpecies[]

getSpeciesWithEvolutions

Returns SpeciesId[]

getStarter

Parameters

Returns SpeciesId

Parameters

Returns PokemonSpecies

getStarterCost

Parameters

Returns 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10

getStartersForCost

Parameters

Returns SpeciesId[]

`Private` `Readonly`_data

`Private`getFormIndex

`Private`getFormKey

`Private`initPreEvolutions

`Private`initReverseFormChanges