pokemon-showdown/server/global-variables.d.ts
Guangcong Luo 13189fdb02
Update Dex API (#8181)
This is the change that renames:

- `Dex.getMove` -> `Dex.moves.get`
- `Dex.getAbility` -> `Dex.abilities.get`
- `Dex.getItem` -> `Dex.items.get`
- `Dex.getSpecies` -> `Dex.species.get`
- `Dex.getEffect` -> `Dex.conditions.get`
- `Dex.getNature` -> `Dex.natures.get`
- `Dex.getType` -> `Dex.types.get`
- `Dex.getFormat` -> `Dex.formats.get`

In addition, some other APIs have been updated:

- `getByID` methods have also been added to every other table.
- `Dex.moves.all()` now gets an array of all moves
  - Plus equivalent methods for `abilities`, `items`, `species`, `formats`, `natures`, `types`
  - Note: there's no `Dex.conditions.all()`
- new API: `Dex.stats` for naming/iterating stats
- `Dex.getEffectByID` -> `Dex.conditions.getByID`
- `Dex.getType` -> `Dex.types.get`
- `Dex.data.Formats` -> `Dex.data.Rulesets`
- `Dex.formats` -> now an array `Dex.formats.all()`
- `Dex.getRuleTable` -> `Dex.formats.getRuleTable`
- `Dex.validateFormat` -> `Dex.formats.validate`

Team functions have been split off into a new `sim/teams` package:

- `Dex.packTeam` -> `Teams.pack`
- `Dex.fastUnpackTeam` -> `Teams.unpack`
- `Dex.generateTeam` -> `Teams.generate`
- `Dex.stringifyTeam` -> `Teams.export`

`Teams.export` has also been rewritten to better match how it works in client.

This implements #8178
2021-04-08 03:00:37 -07:00

60 lines
1.8 KiB
TypeScript

import * as ChatType from './chat';
import * as RoomsType from './rooms';
import * as SocketsType from './sockets';
import * as TeamValidatorAsyncType from './team-validator-async';
import * as UsersType from './users';
import * as VerifierType from './verifier';
import {ConfigType} from "../server/config-loader";
import {IPTools as IPToolsType} from './ip-tools';
import {Ladders as LaddersType} from './ladders';
import {LoginServer as LoginServerType} from './loginserver';
import {Monitor as MonitorType} from './monitor';
import {Punishments as PunishmentsType} from './punishments';
import {Tournaments as TournamentsType} from './tournaments';
import {Dex as DexType} from '../sim/dex';
import {Teams as TeamsType} from '../sim/teams';
declare global {
namespace NodeJS {
interface Global {
Config: any;
Chat: any;
Dex: any;
Teams: any;
IPTools: any;
Ladders: any;
LoginServer: any;
Monitor: any;
nodeOomHeapdump: any;
Punishments: any;
Rooms: any;
Sockets: any
TeamValidatorAsync: any;
Tournaments: any;
Users: any;
Verifier: any;
toID: (item: any) => ID;
__version: {head: string, origin?: string, tree?: string};
}
}
const Config: ConfigType;
const Chat: typeof ChatType.Chat;
const Dex: typeof DexType;
const Teams: typeof TeamsType;
const IPTools: typeof IPToolsType;
const Ladders: typeof LaddersType;
const LoginServer: typeof LoginServerType;
const Monitor: typeof MonitorType;
const Punishments: typeof PunishmentsType;
const Rooms: typeof RoomsType.Rooms;
const Sockets: typeof SocketsType.Sockets;
const TeamValidatorAsync: typeof TeamValidatorAsyncType;
const Tournaments: typeof TournamentsType;
const Users: typeof UsersType.Users;
const Verifier: typeof VerifierType;
const toID: typeof DexType.toID;
}