Leahnaya/pokemon-showdown
1
0
Fork 0
mirror of https://github.com/smogon/pokemon-showdown.git synced 2026-04-24 23:09:10 -05:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Fix documentation

Browse Source
This commit is contained in:
Guangcong Luo 2021-06-09 19:19:43 -07:00
parent a813a55679
commit 5d3b758564
2 changed files with 21 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
sim/DEX.md
View File

@ -56,7 +56,7 @@ console.log(pikachu.isNonstandard); // prints null
const tackle = Dex.mod('gen1').moves.get('Tackle');
console.log(tackle.basePower); // returns 35
console.log(tackle.basePower); // prints 35
```
@ -71,37 +71,35 @@ Return values have not been stabilized yet. Use the TypeScript definitions if yo
`dex.moves.get(moveName: string): Move`
* Gets information about a move. `moveName` can have any capitalization or whitespace.
[This includes nonstandard information.](#Nonstandard-information).
* Gets information about a move. `moveName` can have any capitalization or whitespace. [This includes nonstandard information](#nonstandard-information).
`dex.moves.all(): Move[]`
* Lists all moves we have information for. [This includes nonstandard information.](#Nonstandard-information).
* Lists all moves we have information for. [This includes nonstandard information](#nonstandard-information).
`dex.species.get(speciesName: string): Species`
* Gets information about a Pokémon species or forme. `speciesName` can have any capitalization or whitespace. [This includes nonstandard information.](#Nonstandard-information).
* Gets information about a Pokémon species or forme. `speciesName` can have any capitalization or whitespace. [This includes nonstandard information](#nonstandard-information).
Forme information is documented here: https://github.com/smogon/pokemon-showdown/blob/master/data/FORMES.md
`dex.species.all(): Species[]`
* Lists all Pokémon species we have information for. [This includes nonstandard information.](#Nonstandard-information).
* Lists all Pokémon species we have information for. [This includes nonstandard information](#nonstandard-information).
`dex.abilities.get(abilitysName: string): Ability`
* Gets information about an ability. `abilitysName` can have any capitalization or whitespace. [This includes nonstandard information.](#Nonstandard-information).
* Gets information about an ability. `abilitysName` can have any capitalization or whitespace. [This includes nonstandard information](#nonstandard-information).
`dex.abilities.all(): Ability[]`
* Lists all abilities we have information for. [This includes nonstandard information.](#Nonstandard-information).
* Lists all abilities we have information for. [This includes nonstandard information](#nonstandard-information).
`dex.items.get(itemName: string): Item`
* Gets information about an item. `itemName` can have any capitalization or whitespace. [This includes nonstandard information.](#Nonstandard-information).
* Gets information about an item. `itemName` can have any capitalization or whitespace. [This includes nonstandard information](#nonstandard-information).
`dex.items.all(): Item[]`
* Lists all items we have information for. [This includes nonstandard information.](#Nonstandard-information).
* Lists all items we have information for. [This includes nonstandard information](#nonstandard-information).

20
sim/TEAMS.md
View File

@ -165,26 +165,22 @@ Converting between formats
API:
`Sim.Teams.unpack(packedTeam: string): PokemonSet[]`
`Teams.unpack(packedTeam: string): PokemonSet[]`
- Converts a packed team to a JSON team
`Sim.Teams.pack(team: PokemonSet[]): string`
`Teams.pack(team: PokemonSet[]): string`
- Converts a JSON team to a packed team
`Sim.Teams.export(team: PokemonSet[]): string`
`Teams.export(team: PokemonSet[]): string`
- Converts a JSON team to an export team
`Sim.Teams.exportSet(set: PokemonSet): string`
`Teams.exportSet(set: PokemonSet): string`
- Converts a JSON set to export format
`Sim.Teams.generate(format: Format | string, options?: {seed: number[4]}): PokemonSet`
- Generate a team for a random format
(Import is not available in this version; we'll add it to a future version.)
Example use:
@ -201,6 +197,14 @@ console.log(JSON.stringify(Teams.unpack(
```
Random team generator
---------------------
`Teams.generate(format: Format | string, options?: {seed: number[4]}): PokemonSet[]`
- Generate a team for a random format
Team validator
--------------