ogamejs 3.0.0 → 4.0.0

package/src/models/destroyable.js

@@ -9,17 +9,40 @@ const ATTRIBUTES = Object.freeze({
     DEFENSES: 'defenses',
     MISSILE: 'missiles',
   },
+  DRIVES: {
+    COMBUSTION: 'combustion',
+    IMPULSE: 'impulse',
+    HYPERSPACE: 'hyperspace',
+    NONE: 'none',
+  },
 });
 
+/**
+ * Every ship, defense and missile of the game, keyed by the id used by this
+ * library. `ogameId` holds the official OGame id (204 for the light fighter,
+ * 401 for the rocket launcher, ...) and is the field to rely on when talking
+ * to the game.
+ *
+ * - `names` holds the localised labels.
+ * - `structure` is the metal plus crystal cost; hull points are a tenth of it.
+ * - `speed` is the base speed, before any drive technology bonus.
+ * - `cargo` is the cargo capacity, `fuelConsumption` the base deuterium burned.
+ * - `drive` is the technology powering the ship, `driveUpgrades` the drives it
+ *   switches to once the matching technology is high enough.
+ * - `rapidFire` lists the rapid-fire bonuses against other entries of this model,
+ *   `target` being a library id.
+ */
 const DESTROYABLE = Object.freeze({
   1: {
-    name: 'chasseur léger',
+    ogameId: 204,
+    names: { en: 'Light Fighter', fr: 'Chasseur léger' },
     structure: 4000,
     shield: 10,
     attack: 50,
     speed: 12500,
-    fret: 50,
-    deutCost: 10,
+    cargo: 50,
+    fuelConsumption: 20,
+    drive: ATTRIBUTES.DRIVES.COMBUSTION,
     type: ATTRIBUTES.TYPES.ATTACK,
     category: ATTRIBUTES.CATEGORIES.SHIPS,
     rapidFire: [
@@ -39,17 +62,19 @@ const DESTROYABLE = Object.freeze({
     cost: {
       metal: 3000,
       crystal: 1000,
-      deut: 0,
+      deuterium: 0,
     },
   },
   2: {
-    name: 'chasseur lourd',
+    ogameId: 205,
+    names: { en: 'Heavy Fighter', fr: 'Chasseur lourd' },
     structure: 10000,
     shield: 25,
     attack: 150,
     speed: 10000,
-    fret: 100,
-    deutCost: 37.5,
+    cargo: 100,
+    fuelConsumption: 75,
+    drive: ATTRIBUTES.DRIVES.IMPULSE,
     type: ATTRIBUTES.TYPES.ATTACK,
     category: ATTRIBUTES.CATEGORIES.SHIPS,
     rapidFire: [
@@ -73,17 +98,19 @@ const DESTROYABLE = Object.freeze({
     cost: {
       metal: 6000,
       crystal: 4000,
-      deut: 0,
+      deuterium: 0,
     },
   },
   3: {
-    name: 'Croiseurs',
+    ogameId: 206,
+    names: { en: 'Cruiser', fr: 'Croiseur' },
     structure: 27000,
     shield: 50,
     attack: 400,
     speed: 15000,
-    fret: 800,
-    deutCost: 150,
+    cargo: 800,
+    fuelConsumption: 300,
+    drive: ATTRIBUTES.DRIVES.IMPULSE,
     type: ATTRIBUTES.TYPES.ATTACK,
     category: ATTRIBUTES.CATEGORIES.SHIPS,
     rapidFire: [
@@ -111,17 +138,19 @@ const DESTROYABLE = Object.freeze({
     cost: {
       metal: 20000,
       crystal: 7000,
-      deut: 2000,
+      deuterium: 2000,
     },
   },
   4: {
-    name: 'Vaisseau de bataille',
+    ogameId: 207,
+    names: { en: 'Battleship', fr: 'Vaisseau de bataille' },
     structure: 60000,
     shield: 200,
     attack: 1000,
     speed: 10000,
-    fret: 1500,
-    deutCost: 250,
+    cargo: 1500,
+    fuelConsumption: 500,
+    drive: ATTRIBUTES.DRIVES.HYPERSPACE,
     type: ATTRIBUTES.TYPES.ATTACK,
     category: ATTRIBUTES.CATEGORIES.SHIPS,
     rapidFire: [
@@ -141,17 +170,19 @@ const DESTROYABLE = Object.freeze({
     cost: {
       metal: 45000,
       crystal: 15000,
-      deut: 0,
+      deuterium: 0,
     },
   },
   5: {
-    name: 'Traqueur',
+    ogameId: 215,
+    names: { en: 'Battlecruiser', fr: 'Traqueur' },
     structure: 70000,
     shield: 400,
     attack: 700,
     speed: 10000,
-    fret: 750,
-    deutCost: 125,
+    cargo: 750,
+    fuelConsumption: 250,
+    drive: ATTRIBUTES.DRIVES.HYPERSPACE,
     type: ATTRIBUTES.TYPES.ATTACK,
     category: ATTRIBUTES.CATEGORIES.SHIPS,
     rapidFire: [
@@ -191,17 +222,27 @@ const DESTROYABLE = Object.freeze({
     cost: {
       metal: 30000,
       crystal: 40000,
-      deut: 15000,
+      deuterium: 15000,
     },
   },
   6: {
-    name: 'Bombardier',
+    ogameId: 211,
+    names: { en: 'Bomber', fr: 'Bombardier' },
     structure: 75000,
     shield: 500,
     attack: 1000,
     speed: 4000,
-    fret: 500,
-    deutCost: 350,
+    cargo: 500,
+    fuelConsumption: 700,
+    drive: ATTRIBUTES.DRIVES.IMPULSE,
+    driveUpgrades: [
+      {
+        drive: ATTRIBUTES.DRIVES.HYPERSPACE,
+        minLevel: 8,
+        speed: 5000,
+        fuelConsumption: 1000,
+      },
+    ],
     type: ATTRIBUTES.TYPES.ATTACK,
     category: ATTRIBUTES.CATEGORIES.SHIPS,
     rapidFire: [
@@ -245,17 +286,19 @@ const DESTROYABLE = Object.freeze({
     cost: {
       metal: 50000,
       crystal: 25000,
-      deut: 15000,
+      deuterium: 15000,
     },
   },
   7: {
-    name: 'Destructeur',
+    ogameId: 213,
+    names: { en: 'Destroyer', fr: 'Destructeur' },
     structure: 110000,
     shield: 500,
     attack: 2000,
     speed: 5000,
-    fret: 2000,
-    deutCost: 500,
+    cargo: 2000,
+    fuelConsumption: 1000,
+    drive: ATTRIBUTES.DRIVES.HYPERSPACE,
     type: ATTRIBUTES.TYPES.ATTACK,
     category: ATTRIBUTES.CATEGORIES.SHIPS,
     rapidFire: [
@@ -283,17 +326,19 @@ const DESTROYABLE = Object.freeze({
     cost: {
       metal: 60000,
       crystal: 50000,
-      deut: 15000,
+      deuterium: 15000,
     },
   },
   8: {
-    name: 'Étoile de la mort',
+    ogameId: 214,
+    names: { en: 'Deathstar', fr: 'Étoile de la mort' },
     structure: 9000000,
     shield: 50000,
     attack: 200000,
     speed: 100,
-    fret: 1000000,
-    deutCost: 0.5,
+    cargo: 1000000,
+    fuelConsumption: 1,
+    drive: ATTRIBUTES.DRIVES.HYPERSPACE,
     type: ATTRIBUTES.TYPES.ATTACK,
     category: ATTRIBUTES.CATEGORIES.SHIPS,
     rapidFire: [
@@ -385,17 +430,19 @@ const DESTROYABLE = Object.freeze({
     cost: {
       metal: 5000000,
       crystal: 4000000,
-      deut: 1000000,
+      deuterium: 1000000,
     },
   },
   9: {
-    name: 'Faucheur',
+    ogameId: 218,
+    names: { en: 'Reaper', fr: 'Faucheur' },
     structure: 140000,
     shield: 700,
     attack: 2800,
     speed: 7000,
-    fret: 10000,
-    deutCost: 550,
+    cargo: 10000,
+    fuelConsumption: 1100,
+    drive: ATTRIBUTES.DRIVES.HYPERSPACE,
     type: ATTRIBUTES.TYPES.ATTACK,
     category: ATTRIBUTES.CATEGORIES.SHIPS,
     rapidFire: [
@@ -427,17 +474,19 @@ const DESTROYABLE = Object.freeze({
     cost: {
       metal: 85000,
       crystal: 55000,
-      deut: 20000,
+      deuterium: 20000,
     },
   },
   10: {
-    name: 'Éclaireur',
+    ogameId: 219,
+    names: { en: 'Pathfinder', fr: 'Éclaireur' },
     structure: 23000,
     shield: 100,
     attack: 200,
     speed: 12000,
-    fret: 10000,
-    deutCost: 150,
+    cargo: 10000,
+    fuelConsumption: 300,
+    drive: ATTRIBUTES.DRIVES.HYPERSPACE,
     type: ATTRIBUTES.TYPES.ATTACK,
     category: ATTRIBUTES.CATEGORIES.SHIPS,
     rapidFire: [
@@ -469,17 +518,27 @@ const DESTROYABLE = Object.freeze({
     cost: {
       metal: 8000,
       crystal: 15000,
-      deut: 8000,
+      deuterium: 8000,
     },
   },
   11: {
-    name: 'Petit transporteur',
+    ogameId: 202,
+    names: { en: 'Small Cargo', fr: 'Petit transporteur' },
     structure: 4000,
     shield: 10,
     attack: 5,
     speed: 5000,
-    fret: 5000,
-    deutCost: 5,
+    cargo: 5000,
+    fuelConsumption: 10,
+    drive: ATTRIBUTES.DRIVES.COMBUSTION,
+    driveUpgrades: [
+      {
+        drive: ATTRIBUTES.DRIVES.IMPULSE,
+        minLevel: 5,
+        speed: 10000,
+        fuelConsumption: 20,
+      },
+    ],
     type: ATTRIBUTES.TYPES.CIVIL,
     category: ATTRIBUTES.CATEGORIES.SHIPS,
     rapidFire: [
@@ -499,17 +558,19 @@ const DESTROYABLE = Object.freeze({
     cost: {
       metal: 2000,
       crystal: 2000,
-      deut: 0,
+      deuterium: 0,
     },
   },
   12: {
-    name: 'Grand transporteur',
+    ogameId: 203,
+    names: { en: 'Large Cargo', fr: 'Grand transporteur' },
     structure: 12000,
     shield: 25,
     attack: 5,
     speed: 7500,
-    fret: 25000,
-    deutCost: 25,
+    cargo: 25000,
+    fuelConsumption: 50,
+    drive: ATTRIBUTES.DRIVES.COMBUSTION,
     type: ATTRIBUTES.TYPES.CIVIL,
     category: ATTRIBUTES.CATEGORIES.SHIPS,
     rapidFire: [
@@ -529,17 +590,19 @@ const DESTROYABLE = Object.freeze({
     cost: {
       metal: 6000,
       crystal: 6000,
-      deut: 0,
+      deuterium: 0,
     },
   },
   13: {
-    name: 'Vaisseaux de colonisation',
+    ogameId: 208,
+    names: { en: 'Colony Ship', fr: 'Vaisseau de colonisation' },
     structure: 30000,
     shield: 100,
     attack: 50,
     speed: 2500,
-    fret: 7500,
-    deutCost: 500,
+    cargo: 7500,
+    fuelConsumption: 1000,
+    drive: ATTRIBUTES.DRIVES.IMPULSE,
     type: ATTRIBUTES.TYPES.CIVIL,
     category: ATTRIBUTES.CATEGORIES.SHIPS,
     rapidFire: [
@@ -559,17 +622,33 @@ const DESTROYABLE = Object.freeze({
     cost: {
       metal: 10000,
       crystal: 20000,
-      deut: 10000,
+      deuterium: 10000,
     },
   },
   14: {
-    name: 'Recycleur',
+    ogameId: 209,
+    names: { en: 'Recycler', fr: 'Recycleur' },
     structure: 16000,
     shield: 10,
     attack: 1,
     speed: 2000,
-    fret: 20000,
-    deutCost: 150,
+    cargo: 20000,
+    fuelConsumption: 300,
+    drive: ATTRIBUTES.DRIVES.COMBUSTION,
+    driveUpgrades: [
+      {
+        drive: ATTRIBUTES.DRIVES.IMPULSE,
+        minLevel: 17,
+        speed: 4000,
+        fuelConsumption: 600,
+      },
+      {
+        drive: ATTRIBUTES.DRIVES.HYPERSPACE,
+        minLevel: 15,
+        speed: 6000,
+        fuelConsumption: 900,
+      },
+    ],
     type: ATTRIBUTES.TYPES.CIVIL,
     category: ATTRIBUTES.CATEGORIES.SHIPS,
     rapidFire: [
@@ -589,136 +668,152 @@ const DESTROYABLE = Object.freeze({
     cost: {
       metal: 10000,
       crystal: 6000,
-      deut: 2000,
+      deuterium: 2000,
     },
   },
   15: {
-    name: 'Sonde espionnage',
+    ogameId: 210,
+    names: { en: 'Espionage Probe', fr: "Sonde d'espionnage" },
     structure: 1000,
     shield: 0,
     attack: 0,
     speed: 100000000,
-    fret: 5,
-    deutCost: 0.5,
+    cargo: 5,
+    fuelConsumption: 1,
+    drive: ATTRIBUTES.DRIVES.COMBUSTION,
     type: ATTRIBUTES.TYPES.CIVIL,
     category: ATTRIBUTES.CATEGORIES.SHIPS,
     rapidFire: [],
     cost: {
       metal: 0,
       crystal: 1000,
-      deut: 0,
+      deuterium: 0,
     },
   },
   16: {
-    name: 'Satellite solaire',
+    ogameId: 212,
+    names: { en: 'Solar Satellite', fr: 'Satellite solaire' },
     structure: 2000,
     shield: 1,
     attack: 1,
     speed: 0,
-    fret: 0,
-    deutCost: 0,
+    cargo: 0,
+    fuelConsumption: 0,
+    drive: ATTRIBUTES.DRIVES.NONE,
     type: ATTRIBUTES.TYPES.CIVIL,
     category: ATTRIBUTES.CATEGORIES.SHIPS,
     rapidFire: [],
     cost: {
       metal: 0,
       crystal: 2000,
-      deut: 500,
+      deuterium: 500,
     },
   },
   17: {
-    name: 'Foreuse',
+    ogameId: 217,
+    names: { en: 'Crawler', fr: 'Foreuse' },
     structure: 4000,
     shield: 1,
     attack: 1,
     speed: 0,
-    fret: 0,
-    deutCost: 0,
+    cargo: 0,
+    fuelConsumption: 0,
+    drive: ATTRIBUTES.DRIVES.NONE,
     type: ATTRIBUTES.TYPES.CIVIL,
     category: ATTRIBUTES.CATEGORIES.SHIPS,
     rapidFire: [],
     cost: {
       metal: 2000,
       crystal: 2000,
-      deut: 1000,
+      deuterium: 1000,
     },
   },
   201: {
-    name: 'Lanceur missile',
+    ogameId: 401,
+    names: { en: 'Rocket Launcher', fr: 'Lanceur de missiles' },
     structure: 2000,
     shield: 20,
     attack: 80,
     speed: 0,
-    fret: 0,
-    deutCost: 0,
+    cargo: 0,
+    fuelConsumption: 0,
+    drive: ATTRIBUTES.DRIVES.NONE,
     type: ATTRIBUTES.TYPES.DEFENSE,
     category: ATTRIBUTES.CATEGORIES.DEFENSES,
     rapidFire: [],
     cost: {
       metal: 2000,
       crystal: 0,
-      deut: 0,
+      deuterium: 0,
     },
   },
   202: {
-    name: 'Artillerie laser légère',
+    ogameId: 402,
+    names: { en: 'Light Laser', fr: 'Artillerie laser légère' },
     structure: 2000,
     shield: 25,
     attack: 100,
     speed: 0,
-    fret: 0,
-    deutCost: 0,
+    cargo: 0,
+    fuelConsumption: 0,
+    drive: ATTRIBUTES.DRIVES.NONE,
     type: ATTRIBUTES.TYPES.DEFENSE,
     category: ATTRIBUTES.CATEGORIES.DEFENSES,
     rapidFire: [],
     cost: {
       metal: 1500,
       crystal: 500,
-      deut: 0,
+      deuterium: 0,
     },
   },
   203: {
-    name: 'Artillerie laser lourde',
+    ogameId: 403,
+    names: { en: 'Heavy Laser', fr: 'Artillerie laser lourde' },
     structure: 8000,
     shield: 100,
     attack: 250,
     speed: 0,
-    fret: 0,
-    deutCost: 0,
+    cargo: 0,
+    fuelConsumption: 0,
+    drive: ATTRIBUTES.DRIVES.NONE,
     type: ATTRIBUTES.TYPES.DEFENSE,
     category: ATTRIBUTES.CATEGORIES.DEFENSES,
     rapidFire: [],
     cost: {
       metal: 6000,
       crystal: 2000,
-      deut: 0,
+      deuterium: 0,
     },
   },
   204: {
-    name: 'Canon de gauss',
+    ogameId: 404,
+    names: { en: 'Gauss Cannon', fr: 'Canon de Gauss' },
     structure: 35000,
     shield: 200,
     attack: 1100,
     speed: 0,
-    fret: 0,
-    deutCost: 0,
+    cargo: 0,
+    fuelConsumption: 0,
+    drive: ATTRIBUTES.DRIVES.NONE,
     type: ATTRIBUTES.TYPES.DEFENSE,
     category: ATTRIBUTES.CATEGORIES.DEFENSES,
     rapidFire: [],
     cost: {
       metal: 20000,
       crystal: 15000,
-      deut: 2000,
+      deuterium: 2000,
     },
   },
   205: {
-    name: 'Artillerie à ion',
+    ogameId: 405,
+    names: { en: 'Ion Cannon', fr: 'Artillerie à ions' },
     structure: 8000,
     shield: 500,
     attack: 150,
     speed: 0,
-    fret: 0,
-    deutCost: 0,
+    cargo: 0,
+    fuelConsumption: 0,
+    drive: ATTRIBUTES.DRIVES.NONE,
     type: ATTRIBUTES.TYPES.DEFENSE,
     category: ATTRIBUTES.CATEGORIES.DEFENSES,
     rapidFire: [
@@ -730,94 +825,105 @@ const DESTROYABLE = Object.freeze({
     cost: {
       metal: 5000,
       crystal: 3000,
-      deut: 0,
+      deuterium: 0,
     },
   },
   206: {
-    name: 'Lanceur plasma',
+    ogameId: 406,
+    names: { en: 'Plasma Turret', fr: 'Lanceur de plasma' },
     structure: 100000,
     shield: 300,
     attack: 3000,
     speed: 0,
-    fret: 0,
-    deutCost: 0,
+    cargo: 0,
+    fuelConsumption: 0,
+    drive: ATTRIBUTES.DRIVES.NONE,
     type: ATTRIBUTES.TYPES.DEFENSE,
     category: ATTRIBUTES.CATEGORIES.DEFENSES,
     rapidFire: [],
     cost: {
       metal: 50000,
       crystal: 50000,
-      deut: 30000,
+      deuterium: 30000,
     },
   },
   207: {
-    name: 'Petit bouclier',
+    ogameId: 407,
+    names: { en: 'Small Shield Dome', fr: 'Petit bouclier' },
     structure: 20000,
     shield: 2000,
     attack: 1,
     speed: 0,
-    fret: 0,
-    deutCost: 0,
+    cargo: 0,
+    fuelConsumption: 0,
+    drive: ATTRIBUTES.DRIVES.NONE,
     type: ATTRIBUTES.TYPES.DEFENSE,
     category: ATTRIBUTES.CATEGORIES.DEFENSES,
     rapidFire: [],
     cost: {
       metal: 10000,
       crystal: 10000,
-      deut: 0,
+      deuterium: 0,
     },
   },
   208: {
-    name: 'Grand bouclier',
+    ogameId: 408,
+    names: { en: 'Large Shield Dome', fr: 'Grand bouclier' },
     structure: 100000,
     shield: 10000,
     attack: 1,
     speed: 0,
-    fret: 0,
-    deutCost: 0,
+    cargo: 0,
+    fuelConsumption: 0,
+    drive: ATTRIBUTES.DRIVES.NONE,
     type: ATTRIBUTES.TYPES.DEFENSE,
     category: ATTRIBUTES.CATEGORIES.DEFENSES,
     rapidFire: [],
     cost: {
       metal: 50000,
       crystal: 50000,
-      deut: 0,
+      deuterium: 0,
     },
   },
   301: {
-    name: "Missile d'interception",
+    ogameId: 502,
+    names: { en: 'Anti-Ballistic Missile', fr: "Missile d'interception" },
     structure: 8000,
     shield: 1,
     attack: 1,
     speed: 0,
-    fret: 0,
-    deutCost: 0,
+    cargo: 0,
+    fuelConsumption: 0,
+    drive: ATTRIBUTES.DRIVES.NONE,
     type: ATTRIBUTES.TYPES.DEFENSE,
-    category: ATTRIBUTES.CATEGORIES.DEFENSES,
+    category: ATTRIBUTES.CATEGORIES.MISSILE,
     rapidFire: [],
     cost: {
       metal: 8000,
       crystal: 0,
-      deut: 2000,
+      deuterium: 2000,
     },
   },
   302: {
-    name: 'Missile interplanétaire',
+    ogameId: 503,
+    names: { en: 'Interplanetary Missile', fr: 'Missile interplanétaire' },
     structure: 15000,
     shield: 1,
     attack: 12000,
     speed: 0,
-    fret: 0,
-    deutCost: 0,
+    cargo: 0,
+    fuelConsumption: 0,
+    drive: ATTRIBUTES.DRIVES.NONE,
     type: ATTRIBUTES.TYPES.DEFENSE,
-    category: ATTRIBUTES.CATEGORIES.DEFENSES,
+    category: ATTRIBUTES.CATEGORIES.MISSILE,
     rapidFire: [],
     cost: {
       metal: 12500,
       crystal: 2500,
-      deut: 10000,
+      deuterium: 10000,
     },
   },
 });
 
+export { ATTRIBUTES };
 export default DESTROYABLE;