ogamejs 3.0.0 → 4.0.1

package/types/types.d.ts

@@ -0,0 +1,449 @@
+/**
+ * Shared type definitions.
+ *
+ * This module holds no runtime code: it only exists so the JSDoc of the rest of
+ * the library — and the generated `.d.ts` files — can point at named types
+ * instead of a bare `object`.
+ *
+ * @module types
+ */
+export type Lang = 'en' | 'fr';
+export type Names = {
+    /**
+     * The English name
+     */
+    en: string;
+    /**
+     * The French name
+     */
+    fr: string;
+};
+export type BuildingBase = {
+    /**
+     * Metal paid to build it
+     */
+    metal: number;
+    /**
+     * Crystal paid to build it
+     */
+    crystal: number;
+    /**
+     * Deuterium paid to build it
+     */
+    deuterium: number;
+    /**
+     * Energy paid to build it
+     */
+    energyCost: number;
+    /**
+     * Energy it consumes once built
+     */
+    energyConsumption: number;
+    /**
+     * Deuterium it burns once built
+     */
+    deuteriumConsumption: number;
+    /**
+     * What it produces, resources or energy
+     */
+    production: number;
+};
+export type BuildingEntry = {
+    /**
+     * The id OGame itself uses
+     */
+    ogameId: number;
+    /**
+     * The localised labels
+     */
+    names: Names;
+    /**
+     * `resources`, `facilities` or `moon`
+     */
+    category: string;
+    /**
+     * The per-level cost multiplier
+     */
+    factor: number;
+    /**
+     * The level 1 values
+     */
+    base: BuildingBase;
+    /**
+     * A separate multiplier for the energy cost
+     */
+    energyFactor?: number;
+    /**
+     * The resource it stores, on storage buildings only
+     */
+    storage?: string;
+};
+export type ResearchBase = {
+    /**
+     * Metal cost
+     */
+    metal: number;
+    /**
+     * Crystal cost
+     */
+    crystal: number;
+    /**
+     * Deuterium cost
+     */
+    deuterium: number;
+    /**
+     * Energy cost, Graviton technology only
+     */
+    energyCost: number;
+};
+export type ResearchEntry = {
+    /**
+     * The id OGame itself uses
+     */
+    ogameId: number;
+    /**
+     * The localised labels
+     */
+    names: Names;
+    /**
+     * `basic`, `drive`, `advanced` or `combat`
+     */
+    category: string;
+    /**
+     * The per-level cost multiplier
+     */
+    factor: number;
+    /**
+     * The level 1 cost
+     */
+    base: ResearchBase;
+    /**
+     * Rounding step, Astrophysics only
+     */
+    roundTo?: number;
+};
+export type Cost = {
+    /**
+     * Metal cost
+     */
+    metal: number;
+    /**
+     * Crystal cost
+     */
+    crystal: number;
+    /**
+     * Deuterium cost
+     */
+    deuterium: number;
+    /**
+     * Energy cost
+     */
+    energyCost: number;
+};
+export type BuildingInfo = {
+    /**
+     * Metal paid to reach that level
+     */
+    metal: number;
+    /**
+     * Crystal paid to reach that level
+     */
+    crystal: number;
+    /**
+     * Deuterium paid to reach that level
+     */
+    deuterium: number;
+    /**
+     * Energy paid to reach that level
+     */
+    energyCost: number;
+    /**
+     * Energy consumed at that level
+     */
+    energyConsumption: number;
+    /**
+     * Deuterium burned at that level
+     */
+    deuteriumConsumption: number;
+    /**
+     * Resources, or energy, produced at that level
+     */
+    production: number;
+};
+export type RapidFire = {
+    /**
+     * The library id of the unit it applies to
+     */
+    target: number;
+    /**
+     * How many shots it can chain
+     */
+    fire: number;
+};
+export type DriveUpgrade = {
+    /**
+     * The drive it moves to
+     */
+    drive: string;
+    /**
+     * The drive level that unlocks it
+     */
+    minLevel: number;
+    /**
+     * The new base speed
+     */
+    speed: number;
+    /**
+     * The new base fuel consumption
+     */
+    fuelConsumption: number;
+};
+export type DestroyableEntry = {
+    /**
+     * The id OGame itself uses
+     */
+    ogameId: number;
+    /**
+     * The localised labels
+     */
+    names: Names;
+    /**
+     * The metal plus crystal cost, hull is a tenth of it
+     */
+    structure: number;
+    /**
+     * The base shield
+     */
+    shield: number;
+    /**
+     * The base attack
+     */
+    attack: number;
+    /**
+     * The base speed, before any drive bonus
+     */
+    speed: number;
+    /**
+     * The cargo capacity
+     */
+    cargo: number;
+    /**
+     * The base deuterium burned
+     */
+    fuelConsumption: number;
+    /**
+     * The drive powering it
+     */
+    drive: string;
+    /**
+     * `attack`, `civil` or `defense`
+     */
+    type: string;
+    /**
+     * `ships`, `defenses` or `missiles`
+     */
+    category: string;
+    /**
+     * Its rapid-fire table
+     */
+    rapidFire: RapidFire[];
+    /**
+     * What it costs to build
+     */
+    cost: {
+        metal: number;
+        crystal: number;
+        deuterium: number;
+    };
+    /**
+     * The drives it can switch to
+     */
+    driveUpgrades?: DriveUpgrade[];
+};
+export type Coordinates = {
+    /**
+     * The galaxy
+     */
+    galaxy: number;
+    /**
+     * The system
+     */
+    system: number;
+    /**
+     * The position in the system
+     */
+    position: number;
+};
+export type FleetEntry = {
+    /**
+     * The ship
+     */
+    ship: DestroyableEntry;
+    /**
+     * How many of them
+     */
+    count: number;
+};
+export type Drives = {
+    /**
+     * The Combustion Drive level
+     */
+    combustion?: number;
+    /**
+     * The Impulse Drive level
+     */
+    impulse?: number;
+    /**
+     * The Hyperspace Drive level
+     */
+    hyperspace?: number;
+};
+export type CombatTechs = {
+    /**
+     * The Weapons Technology level
+     */
+    weapons?: number;
+    /**
+     * The Shielding Technology level
+     */
+    shielding?: number;
+    /**
+     * The Armour Technology level
+     */
+    armour?: number;
+};
+export type Resources = {
+    /**
+     * Metal
+     */
+    metal: number;
+    /**
+     * Crystal
+     */
+    crystal: number;
+    /**
+     * Deuterium
+     */
+    deuterium: number;
+};
+/**
+ * @typedef {'en' | 'fr'} Lang A supported language
+ */
+/**
+ * @typedef {object} Names
+ * @property {string} en The English name
+ * @property {string} fr The French name
+ */
+/**
+ * @typedef {object} BuildingBase The level 1 values of a building
+ * @property {number} metal Metal paid to build it
+ * @property {number} crystal Crystal paid to build it
+ * @property {number} deuterium Deuterium paid to build it
+ * @property {number} energyCost Energy paid to build it
+ * @property {number} energyConsumption Energy it consumes once built
+ * @property {number} deuteriumConsumption Deuterium it burns once built
+ * @property {number} production What it produces, resources or energy
+ */
+/**
+ * @typedef {object} BuildingEntry An entry of `models/buildings.js`
+ * @property {number} ogameId The id OGame itself uses
+ * @property {Names} names The localised labels
+ * @property {string} category `resources`, `facilities` or `moon`
+ * @property {number} factor The per-level cost multiplier
+ * @property {BuildingBase} base The level 1 values
+ * @property {number} [energyFactor] A separate multiplier for the energy cost
+ * @property {string} [storage] The resource it stores, on storage buildings only
+ */
+/**
+ * @typedef {object} ResearchBase The level 1 cost of a technology
+ * @property {number} metal Metal cost
+ * @property {number} crystal Crystal cost
+ * @property {number} deuterium Deuterium cost
+ * @property {number} energyCost Energy cost, Graviton technology only
+ */
+/**
+ * @typedef {object} ResearchEntry An entry of `models/research.js`
+ * @property {number} ogameId The id OGame itself uses
+ * @property {Names} names The localised labels
+ * @property {string} category `basic`, `drive`, `advanced` or `combat`
+ * @property {number} factor The per-level cost multiplier
+ * @property {ResearchBase} base The level 1 cost
+ * @property {number} [roundTo] Rounding step, Astrophysics only
+ */
+/**
+ * @typedef {object} Cost The resources a level costs
+ * @property {number} metal Metal cost
+ * @property {number} crystal Crystal cost
+ * @property {number} deuterium Deuterium cost
+ * @property {number} energyCost Energy cost
+ */
+/**
+ * @typedef {object} BuildingInfo Everything about a building at a given level
+ * @property {number} metal Metal paid to reach that level
+ * @property {number} crystal Crystal paid to reach that level
+ * @property {number} deuterium Deuterium paid to reach that level
+ * @property {number} energyCost Energy paid to reach that level
+ * @property {number} energyConsumption Energy consumed at that level
+ * @property {number} deuteriumConsumption Deuterium burned at that level
+ * @property {number} production Resources, or energy, produced at that level
+ */
+/**
+ * @typedef {object} RapidFire A rapid-fire bonus against another unit
+ * @property {number} target The library id of the unit it applies to
+ * @property {number} fire How many shots it can chain
+ */
+/**
+ * @typedef {object} DriveUpgrade A better drive a ship switches to
+ * @property {string} drive The drive it moves to
+ * @property {number} minLevel The drive level that unlocks it
+ * @property {number} speed The new base speed
+ * @property {number} fuelConsumption The new base fuel consumption
+ */
+/**
+ * @typedef {object} DestroyableEntry An entry of `models/destroyable.js`
+ * @property {number} ogameId The id OGame itself uses
+ * @property {Names} names The localised labels
+ * @property {number} structure The metal plus crystal cost, hull is a tenth of it
+ * @property {number} shield The base shield
+ * @property {number} attack The base attack
+ * @property {number} speed The base speed, before any drive bonus
+ * @property {number} cargo The cargo capacity
+ * @property {number} fuelConsumption The base deuterium burned
+ * @property {string} drive The drive powering it
+ * @property {string} type `attack`, `civil` or `defense`
+ * @property {string} category `ships`, `defenses` or `missiles`
+ * @property {RapidFire[]} rapidFire Its rapid-fire table
+ * @property {{metal: number, crystal: number, deuterium: number}} cost What it costs to build
+ * @property {DriveUpgrade[]} [driveUpgrades] The drives it can switch to
+ */
+/**
+ * @typedef {object} Coordinates A place in the universe
+ * @property {number} galaxy The galaxy
+ * @property {number} system The system
+ * @property {number} position The position in the system
+ */
+/**
+ * @typedef {object} FleetEntry A group of identical ships
+ * @property {DestroyableEntry} ship The ship
+ * @property {number} count How many of them
+ */
+/**
+ * @typedef {object} Drives The drive technology levels
+ * @property {number} [combustion] The Combustion Drive level
+ * @property {number} [impulse] The Impulse Drive level
+ * @property {number} [hyperspace] The Hyperspace Drive level
+ */
+/**
+ * @typedef {object} CombatTechs The combat technology levels
+ * @property {number} [weapons] The Weapons Technology level
+ * @property {number} [shielding] The Shielding Technology level
+ * @property {number} [armour] The Armour Technology level
+ */
+/**
+ * @typedef {object} Resources An amount of each resource
+ * @property {number} metal Metal
+ * @property {number} crystal Crystal
+ * @property {number} deuterium Deuterium
+ */
+export {};
+//# sourceMappingURL=types.d.ts.map

package/types/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.js"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAGA,YAAuB,IAAI,GAAjB,IAAI,GAAG,IAAI,CACvB;AAGE,YAAkB,KAAK,GACvB;;;;IAAmB,EAAE,EAAV,MAAM,CACjB;;;;IAAmB,EAAE,EAAV,MAAM,CACnB;CAAA,CAAA;AAGE,YAAkB,YAAY,GAC9B;;;;IAAmB,KAAK,EAAb,MAAM,CACjB;;;;IAAmB,OAAO,EAAf,MAAM,CACjB;;;;IAAmB,SAAS,EAAjB,MAAM,CACjB;;;;IAAmB,UAAU,EAAlB,MAAM,CACjB;;;;IAAmB,iBAAiB,EAAzB,MAAM,CACjB;;;;IAAmB,oBAAoB,EAA5B,MAAM,CACjB;;;;IAAmB,UAAU,EAAlB,MAAM,CACnB;CAAA,CAAA;AAGE,YAAkB,aAAa,GAC/B;;;;IAAmB,OAAO,EAAf,MAAM,CACjB;;;;IAAkB,KAAK,EAAZ,KAAK,CAChB;;;;IAAmB,QAAQ,EAAhB,MAAM,CACjB;;;;IAAmB,MAAM,EAAd,MAAM,CACjB;;;;IAAyB,IAAI,EAAlB,YAAY,CACvB;;;;IAAoB,YAAY,AAAhC,CACA,EADW,MAAM,CACjB;;;;IAAoB,OAAO,AAA3B,CACF,EADa,MAAM,CACnB;CAAA,CAAA;AAGE,YAAkB,YAAY,GAC9B;;;;IAAmB,KAAK,EAAb,MAAM,CACjB;;;;IAAmB,OAAO,EAAf,MAAM,CACjB;;;;IAAmB,SAAS,EAAjB,MAAM,CACjB;;;;IAAmB,UAAU,EAAlB,MAAM,CACnB;CAAA,CAAA;AAGE,YAAkB,aAAa,GAC/B;;;;IAAmB,OAAO,EAAf,MAAM,CACjB;;;;IAAkB,KAAK,EAAZ,KAAK,CAChB;;;;IAAmB,QAAQ,EAAhB,MAAM,CACjB;;;;IAAmB,MAAM,EAAd,MAAM,CACjB;;;;IAAyB,IAAI,EAAlB,YAAY,CACvB;;;;IAAoB,OAAO,AAA3B,CACF,EADa,MAAM,CACnB;CAAA,CAAA;AAGE,YAAkB,IAAI,GACtB;;;;IAAmB,KAAK,EAAb,MAAM,CACjB;;;;IAAmB,OAAO,EAAf,MAAM,CACjB;;;;IAAmB,SAAS,EAAjB,MAAM,CACjB;;;;IAAmB,UAAU,EAAlB,MAAM,CACnB;CAAA,CAAA;AAGE,YAAkB,YAAY,GAC9B;;;;IAAmB,KAAK,EAAb,MAAM,CACjB;;;;IAAmB,OAAO,EAAf,MAAM,CACjB;;;;IAAmB,SAAS,EAAjB,MAAM,CACjB;;;;IAAmB,UAAU,EAAlB,MAAM,CACjB;;;;IAAmB,iBAAiB,EAAzB,MAAM,CACjB;;;;IAAmB,oBAAoB,EAA5B,MAAM,CACjB;;;;IAAmB,UAAU,EAAlB,MAAM,CACnB;CAAA,CAAA;AAGE,YAAkB,SAAS,GAC3B;;;;IAAmB,MAAM,EAAd,MAAM,CACjB;;;;IAAmB,IAAI,EAAZ,MAAM,CACnB;CAAA,CAAA;AAGE,YAAkB,YAAY,GAC9B;;;;IAAmB,KAAK,EAAb,MAAM,CACjB;;;;IAAmB,QAAQ,EAAhB,MAAM,CACjB;;;;IAAmB,KAAK,EAAb,MAAM,CACjB;;;;IAAmB,eAAe,EAAvB,MAAM,CACnB;CAAA,CAAA;AAGE,YAAkB,gBAAgB,GAClC;;;;IAAmB,OAAO,EAAf,MAAM,CACjB;;;;IAAkB,KAAK,EAAZ,KAAK,CAChB;;;;IAAmB,SAAS,EAAjB,MAAM,CACjB;;;;IAAmB,MAAM,EAAd,MAAM,CACjB;;;;IAAmB,MAAM,EAAd,MAAM,CACjB;;;;IAAmB,KAAK,EAAb,MAAM,CACjB;;;;IAAmB,KAAK,EAAb,MAAM,CACjB;;;;IAAmB,eAAe,EAAvB,MAAM,CACjB;;;;IAAmB,KAAK,EAAb,MAAM,CACjB;;;;IAAmB,IAAI,EAAZ,MAAM,CACjB;;;;IAAmB,QAAQ,EAAhB,MAAM,CACjB;;;;IAAwB,SAAS,EAAtB,SAAS,EAAE,CACtB;;;;IAAgE,IAAI,EAAzD;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAC,CAC9D;;;;IAA4B,aAAa,AAAzC,CACF,EADa,YAAY,EAAE,CAC3B;CAAA,CAAA;AAGE,YAAkB,WAAW,GAC7B;;;;IAAmB,MAAM,EAAd,MAAM,CACjB;;;;IAAmB,MAAM,EAAd,MAAM,CACjB;;;;IAAmB,QAAQ,EAAhB,MAAM,CACnB;CAAA,CAAA;AAGE,YAAkB,UAAU,GAC5B;;;;IAA6B,IAAI,EAAtB,gBAAgB,CAC3B;;;;IAAmB,KAAK,EAAb,MAAM,CACnB;CAAA,CAAA;AAGE,YAAkB,MAAM,GACxB;;;;IAAoB,UAAU,AAA9B,CACA,EADW,MAAM,CACjB;;;;IAAoB,OAAO,AAA3B,CACA,EADW,MAAM,CACjB;;;;IAAoB,UAAU,AAA9B,CACF,EADa,MAAM,CACnB;CAAA,CAAA;AAGE,YAAkB,WAAW,GAC7B;;;;IAAoB,OAAO,AAA3B,CACA,EADW,MAAM,CACjB;;;;IAAoB,SAAS,AAA7B,CACA,EADW,MAAM,CACjB;;;;IAAoB,MAAM,AAA1B,CACF,EADa,MAAM,CACnB;CAAA,CAAA;AAGE,YAAkB,SAAS,GAC3B;;;;IAAmB,KAAK,EAAb,MAAM,CACjB;;;;IAAmB,OAAO,EAAf,MAAM,CACjB;;;;IAAmB,SAAS,EAAjB,MAAM,CACnB;CAAA,CAAA;AArID;;GAEG;AAEH;;;;GAIG;AAEH;;;;;;;;;GASG;AAEH;;;;;;;;;GASG;AAEH;;;;;;GAMG;AAEH;;;;;;;;GAQG;AAEH;;;;;;GAMG;AAEH;;;;;;;;;GASG;AAEH;;;;GAIG;AAEH;;;;;;GAMG;AAEH;;;;;;;;;;;;;;;;GAgBG;AAEH;;;;;GAKG;AAEH;;;;GAIG;AAEH;;;;;GAKG;AAEH;;;;;GAKG;AAEH;;;;;GAKG;AAEH,OAAO,EAAE,CAAC"}