@elite-dangerous-almanac/core 0.1.8 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/PROVENANCE/i18n/SOURCES.md +2 -2
- package/PROVENANCE/ships/SOURCES.md +11 -9
- package/README.md +54 -40
- package/dist/astro/galaxy-grid.js +1 -1
- package/dist/astro/index.d.ts +1 -1
- package/dist/astro/index.js +1 -1
- package/dist/astro/naming-region-origins.d.ts +1 -1
- package/dist/astro/naming-region-origins.js +1 -1
- package/dist/astro/nebulae.d.ts +2 -2
- package/dist/astro/permit-locks.d.ts +2 -1
- package/dist/astro/permit-locks.js +1 -1
- package/dist/astro/procedural-system.d.ts +2 -1
- package/dist/astro/procedural-system.js +1 -1
- package/dist/astro/sector-name.d.ts +2 -1
- package/dist/astro/sector-name.js +1 -1
- package/dist/astro/system-address.d.ts +1 -1
- package/dist/astro/system-name.d.ts +14 -9
- package/dist/astro/system-name.js +1 -1
- package/dist/chunk-2W5MW376.js +1 -0
- package/dist/chunk-2W5MW376.js.map +1 -0
- package/dist/{chunk-VZZUNSDF.js → chunk-4KJ7CR74.js} +1 -1
- package/dist/{chunk-VZZUNSDF.js.map → chunk-4KJ7CR74.js.map} +1 -1
- package/dist/{chunk-6EUVIZAS.js → chunk-4QYTVSNR.js} +1 -1
- package/dist/{chunk-EKQCVCMK.js → chunk-5ZVYRX6Z.js} +1 -1
- package/dist/{chunk-EKQCVCMK.js.map → chunk-5ZVYRX6Z.js.map} +1 -1
- package/dist/chunk-6GJHUWMO.js +1 -0
- package/dist/chunk-6GJHUWMO.js.map +1 -0
- package/dist/chunk-6L56LWTT.js +1 -0
- package/dist/chunk-6L56LWTT.js.map +1 -0
- package/dist/{chunk-GQ5GX5TB.js → chunk-6O4NRRSB.js} +1 -1
- package/dist/chunk-6O4NRRSB.js.map +1 -0
- package/dist/{chunk-WNGQ3IAM.js → chunk-6UNAD74Z.js} +1 -1
- package/dist/{chunk-WNGQ3IAM.js.map → chunk-6UNAD74Z.js.map} +1 -1
- package/dist/{chunk-JPBMRJFC.js → chunk-77I24V6B.js} +1 -1
- package/dist/chunk-77I24V6B.js.map +1 -0
- package/dist/chunk-7ATBEOVC.js +1 -0
- package/dist/chunk-7ATBEOVC.js.map +1 -0
- package/dist/chunk-7TQ2X6Q3.js +1 -0
- package/dist/chunk-7TQ2X6Q3.js.map +1 -0
- package/dist/{chunk-6EPYVBAX.js → chunk-A6OINYNP.js} +1 -1
- package/dist/{chunk-Q3QCLNVG.js → chunk-AYAKU4YA.js} +1 -1
- package/dist/chunk-AYAKU4YA.js.map +1 -0
- package/dist/chunk-B7EYTZRK.js +1 -0
- package/dist/chunk-B7EYTZRK.js.map +1 -0
- package/dist/{chunk-EBAHNZ36.js → chunk-CIULJH3G.js} +1 -1
- package/dist/{chunk-EBAHNZ36.js.map → chunk-CIULJH3G.js.map} +1 -1
- package/dist/{chunk-SNADUQSJ.js → chunk-CJK2IBI2.js} +1 -1
- package/dist/{chunk-SNADUQSJ.js.map → chunk-CJK2IBI2.js.map} +1 -1
- package/dist/{chunk-DYPOL3CI.js → chunk-CJQ37JII.js} +1 -1
- package/dist/chunk-CJQ37JII.js.map +1 -0
- package/dist/chunk-D6YEHR5S.js +1 -0
- package/dist/chunk-D6YEHR5S.js.map +1 -0
- package/dist/{chunk-Z6XMXMVI.js → chunk-DBDCOHI4.js} +1 -1
- package/dist/chunk-DBDCOHI4.js.map +1 -0
- package/dist/{chunk-AFVYCQWL.js → chunk-DCB4COCL.js} +1 -1
- package/dist/{chunk-AFVYCQWL.js.map → chunk-DCB4COCL.js.map} +1 -1
- package/dist/{chunk-CJWFY6OX.js → chunk-DSMLYA2M.js} +1 -1
- package/dist/{chunk-CJWFY6OX.js.map → chunk-DSMLYA2M.js.map} +1 -1
- package/dist/{chunk-UXBCLFGU.js → chunk-DWRNXUAX.js} +1 -1
- package/dist/{chunk-UXBCLFGU.js.map → chunk-DWRNXUAX.js.map} +1 -1
- package/dist/chunk-EVW4Z4CB.js +1 -0
- package/dist/chunk-EVW4Z4CB.js.map +1 -0
- package/dist/{chunk-4S6WB7QR.js → chunk-FF2X4K5P.js} +1 -1
- package/dist/chunk-FF2X4K5P.js.map +1 -0
- package/dist/chunk-FYVPZBXN.js +1 -0
- package/dist/chunk-FYVPZBXN.js.map +1 -0
- package/dist/{chunk-QTZPA2FR.js → chunk-GLWPSVFV.js} +1 -1
- package/dist/chunk-GLWPSVFV.js.map +1 -0
- package/dist/chunk-GZYPQIO2.js +1 -0
- package/dist/chunk-GZYPQIO2.js.map +1 -0
- package/dist/chunk-H47K3UWG.js +1 -0
- package/dist/chunk-H47K3UWG.js.map +1 -0
- package/dist/chunk-JGOAQLYW.js +1 -0
- package/dist/chunk-JGOAQLYW.js.map +1 -0
- package/dist/{chunk-JWWYAMGD.js → chunk-MGRDB2BZ.js} +1 -1
- package/dist/{chunk-JWWYAMGD.js.map → chunk-MGRDB2BZ.js.map} +1 -1
- package/dist/{chunk-MKGJPVPS.js → chunk-MRTTQYT5.js} +1 -1
- package/dist/{chunk-MKGJPVPS.js.map → chunk-MRTTQYT5.js.map} +1 -1
- package/dist/chunk-MTJ4MS7W.js +1 -0
- package/dist/chunk-MTJ4MS7W.js.map +1 -0
- package/dist/chunk-NIURLW2F.js +1 -0
- package/dist/chunk-NIURLW2F.js.map +1 -0
- package/dist/chunk-OLKNYGGT.js +1 -0
- package/dist/chunk-OLKNYGGT.js.map +1 -0
- package/dist/chunk-OYFMHDYT.js +1 -0
- package/dist/chunk-OYFMHDYT.js.map +1 -0
- package/dist/chunk-OYR5HUQZ.js +1 -0
- package/dist/chunk-OYR5HUQZ.js.map +1 -0
- package/dist/chunk-PL75RTA2.js +1 -0
- package/dist/{chunk-2VPVZELZ.js.map → chunk-PL75RTA2.js.map} +1 -1
- package/dist/chunk-PY5L6WC5.js +1 -0
- package/dist/chunk-PY5L6WC5.js.map +1 -0
- package/dist/{chunk-W6EPHHTS.js → chunk-Q2L75GSI.js} +1 -1
- package/dist/chunk-Q2L75GSI.js.map +1 -0
- package/dist/chunk-QJ7GB6FF.js +1 -0
- package/dist/chunk-QJ7GB6FF.js.map +1 -0
- package/dist/chunk-QTAMQ6ME.js +1 -0
- package/dist/chunk-QTAMQ6ME.js.map +1 -0
- package/dist/{chunk-FMPRCYKY.js → chunk-RRYBSAPX.js} +1 -1
- package/dist/chunk-RRYBSAPX.js.map +1 -0
- package/dist/{chunk-J42ZXLBL.js → chunk-T62GO4AA.js} +1 -1
- package/dist/chunk-T62GO4AA.js.map +1 -0
- package/dist/{chunk-E3BRVGJJ.js → chunk-TBZJIQ5P.js} +1 -1
- package/dist/{chunk-E3BRVGJJ.js.map → chunk-TBZJIQ5P.js.map} +1 -1
- package/dist/chunk-V3AEUBHV.js +1 -0
- package/dist/chunk-V3AEUBHV.js.map +1 -0
- package/dist/chunk-VYDQHPY2.js +1 -0
- package/dist/chunk-VYDQHPY2.js.map +1 -0
- package/dist/chunk-XUHAPOM6.js +1 -0
- package/dist/chunk-XUHAPOM6.js.map +1 -0
- package/dist/chunk-Y6KJJMIM.js +1 -0
- package/dist/chunk-Y6KJJMIM.js.map +1 -0
- package/dist/chunk-YXPZ7QQB.js +1 -0
- package/dist/chunk-YXPZ7QQB.js.map +1 -0
- package/dist/{chunk-Y6UZWNP4.js → chunk-ZCEAPJDH.js} +1 -1
- package/dist/{chunk-Y6UZWNP4.js.map → chunk-ZCEAPJDH.js.map} +1 -1
- package/dist/commodities/commodities.d.ts +20 -10
- package/dist/commodities/commodities.js +1 -1
- package/dist/commodities/index.d.ts +15 -4
- package/dist/commodities/index.js +1 -1
- package/dist/equipment/index.js +1 -1
- package/dist/equipment/modification-costs.d.ts +2 -1
- package/dist/equipment/modification-costs.js.map +1 -1
- package/dist/equipment/modification-journal.js +1 -1
- package/dist/equipment/modifications.d.ts +2 -1
- package/dist/equipment/modifications.js +1 -1
- package/dist/equipment/suits.d.ts +6 -3
- package/dist/equipment/suits.js +1 -1
- package/dist/equipment/upgrade-costs.d.ts +8 -4
- package/dist/equipment/upgrade-costs.js +1 -1
- package/dist/equipment/upgrade-costs.js.map +1 -1
- package/dist/equipment/weapons.d.ts +13 -5
- package/dist/equipment/weapons.js +1 -1
- package/dist/i18n/blueprints.d.ts +6 -6
- package/dist/i18n/blueprints.js +1 -1
- package/dist/i18n/diagnostics.d.ts +1 -13
- package/dist/i18n/engineering-groups.d.ts +1 -0
- package/dist/i18n/engineering-groups.js +1 -1
- package/dist/i18n/experimental-effect-descriptions.d.ts +4 -3
- package/dist/i18n/experimental-effect-descriptions.js +1 -1
- package/dist/i18n/experimental-effects.d.ts +5 -4
- package/dist/i18n/experimental-effects.js +1 -1
- package/dist/i18n/index.d.ts +1 -13
- package/dist/i18n/index.js +1 -1
- package/dist/i18n/pre-engineered.d.ts +7 -6
- package/dist/i18n/pre-engineered.js +1 -1
- package/dist/materials/index.d.ts +16 -4
- package/dist/materials/index.js +1 -1
- package/dist/materials/materials.d.ts +36 -19
- package/dist/materials/materials.js +1 -1
- package/dist/materials/micro-resources.d.ts +18 -7
- package/dist/materials/micro-resources.js +1 -1
- package/dist/ships/armour.d.ts +20 -4
- package/dist/ships/armour.js +1 -1
- package/dist/ships/blueprint-costs.d.ts +20 -17
- package/dist/ships/blueprint-costs.js +1 -1
- package/dist/ships/blueprint-journal.d.ts +9 -8
- package/dist/ships/blueprint-journal.js +1 -1
- package/dist/ships/blueprints.d.ts +14 -12
- package/dist/ships/blueprints.js +1 -1
- package/dist/ships/build-metrics.d.ts +1061 -0
- package/dist/ships/build-metrics.js +1 -0
- package/dist/ships/build-metrics.js.map +1 -0
- package/dist/ships/distributor.d.ts +10 -3
- package/dist/ships/distributor.js +1 -1
- package/dist/ships/engineering-options.d.ts +8 -6
- package/dist/ships/engineering-options.js +1 -1
- package/dist/ships/engineering.d.ts +2 -16
- package/dist/ships/engineering.js +1 -1
- package/dist/ships/experimental-effect-costs.d.ts +5 -5
- package/dist/ships/experimental-effect-costs.js +1 -1
- package/dist/ships/experimental-effects.d.ts +9 -8
- package/dist/ships/experimental-effects.js +1 -1
- package/dist/ships/heat.d.ts +7 -2
- package/dist/ships/heat.js +1 -1
- package/dist/ships/index.d.ts +34 -22
- package/dist/ships/index.js +1 -1
- package/dist/ships/jump-range.d.ts +10 -3
- package/dist/ships/jump-range.js +1 -1
- package/dist/ships/loadout-calculations.d.ts +1 -1
- package/dist/ships/loadout-calculations.js +1 -1
- package/dist/ships/mobility-capacitor.d.ts +90 -0
- package/dist/ships/mobility-capacitor.js +1 -0
- package/dist/ships/mobility-capacitor.js.map +1 -0
- package/dist/ships/mobility.d.ts +29 -17
- package/dist/ships/mobility.js +1 -1
- package/dist/ships/power.d.ts +12 -5
- package/dist/ships/power.js +1 -1
- package/dist/ships/pre-engineered-stats.d.ts +10 -8
- package/dist/ships/pre-engineered-stats.js +1 -1
- package/dist/ships/pre-engineered.d.ts +6 -6
- package/dist/ships/pre-engineered.js +1 -1
- package/dist/ships/resistances.d.ts +2 -2
- package/dist/ships/resistances.js +1 -1
- package/dist/ships/shield-capacitor.d.ts +133 -0
- package/dist/ships/shield-capacitor.js +1 -0
- package/dist/ships/shield-capacitor.js.map +1 -0
- package/dist/ships/shield-recovery.d.ts +16 -2
- package/dist/ships/shield-recovery.js +1 -1
- package/dist/ships/shields.d.ts +86 -28
- package/dist/ships/shields.js +1 -1
- package/dist/ships/ship-loadout.d.ts +91 -797
- package/dist/ships/ship-loadout.js +1 -1
- package/dist/ships/ships.d.ts +7 -6
- package/dist/ships/ships.js +1 -1
- package/dist/ships/slef.d.ts +1 -1
- package/dist/ships/source-purchase.d.ts +2 -1
- package/dist/ships/source-purchase.js +1 -1
- package/dist/ships/weapons-capacitor.d.ts +10 -3
- package/dist/ships/weapons-capacitor.js +1 -1
- package/dist/ships/weapons.d.ts +22 -6
- package/dist/ships/weapons.js +1 -1
- package/dist/{system-address-DYsN1qOT.d.ts → system-address-cyJaeZIS.d.ts} +2 -1
- package/package.json +17 -2
- package/dist/chunk-2FHHMYDC.js +0 -1
- package/dist/chunk-2FHHMYDC.js.map +0 -1
- package/dist/chunk-2TW4ZBI3.js +0 -1
- package/dist/chunk-2TW4ZBI3.js.map +0 -1
- package/dist/chunk-2VPVZELZ.js +0 -1
- package/dist/chunk-3BM5BHI3.js +0 -1
- package/dist/chunk-3BM5BHI3.js.map +0 -1
- package/dist/chunk-4S6WB7QR.js.map +0 -1
- package/dist/chunk-6BO5JJNI.js +0 -1
- package/dist/chunk-6BO5JJNI.js.map +0 -1
- package/dist/chunk-CX7B67OI.js +0 -1
- package/dist/chunk-CX7B67OI.js.map +0 -1
- package/dist/chunk-DVL5RBKX.js +0 -1
- package/dist/chunk-DVL5RBKX.js.map +0 -1
- package/dist/chunk-DYPOL3CI.js.map +0 -1
- package/dist/chunk-FGXWVFN6.js +0 -1
- package/dist/chunk-FGXWVFN6.js.map +0 -1
- package/dist/chunk-FMPRCYKY.js.map +0 -1
- package/dist/chunk-G3265B27.js +0 -1
- package/dist/chunk-G3265B27.js.map +0 -1
- package/dist/chunk-GQ5GX5TB.js.map +0 -1
- package/dist/chunk-IOJXLDJN.js +0 -1
- package/dist/chunk-IOJXLDJN.js.map +0 -1
- package/dist/chunk-IYU4WLFM.js +0 -1
- package/dist/chunk-IYU4WLFM.js.map +0 -1
- package/dist/chunk-J42ZXLBL.js.map +0 -1
- package/dist/chunk-JPBMRJFC.js.map +0 -1
- package/dist/chunk-LJI7VXJD.js +0 -1
- package/dist/chunk-LJI7VXJD.js.map +0 -1
- package/dist/chunk-OCND33TO.js +0 -1
- package/dist/chunk-OCND33TO.js.map +0 -1
- package/dist/chunk-P2QOL63K.js +0 -1
- package/dist/chunk-P2QOL63K.js.map +0 -1
- package/dist/chunk-Q3QCLNVG.js.map +0 -1
- package/dist/chunk-QTZPA2FR.js.map +0 -1
- package/dist/chunk-RLUS76LZ.js +0 -1
- package/dist/chunk-RLUS76LZ.js.map +0 -1
- package/dist/chunk-TEOJCBSG.js +0 -1
- package/dist/chunk-TEOJCBSG.js.map +0 -1
- package/dist/chunk-TMMGS6TC.js +0 -1
- package/dist/chunk-TMMGS6TC.js.map +0 -1
- package/dist/chunk-W6EPHHTS.js.map +0 -1
- package/dist/chunk-Z6XMXMVI.js.map +0 -1
- package/dist/chunk-ZNCXENNB.js +0 -1
- package/dist/chunk-ZNCXENNB.js.map +0 -1
- /package/dist/{chunk-6EUVIZAS.js.map → chunk-4QYTVSNR.js.map} +0 -0
- /package/dist/{chunk-6EPYVBAX.js.map → chunk-A6OINYNP.js.map} +0 -0
|
@@ -1,25 +1,13 @@
|
|
|
1
1
|
import { ModuleEngineering, LoadoutModule, LoadoutEvent, SlefHeader, Slef } from './slef.js';
|
|
2
|
-
import { TotalRangeDetails, FrameShiftDriveParams } from './jump-range.js';
|
|
3
2
|
import { BuildSlot, SlotKind } from './slots.js';
|
|
4
|
-
import {
|
|
5
|
-
import { OutfittingModule, ProjectileRangeBoundaries } from './modules.js';
|
|
6
|
-
import { PowerBudget } from './power.js';
|
|
7
|
-
import { HeatMetrics } from './heat.js';
|
|
8
|
-
import { ShieldMetrics } from './shields.js';
|
|
9
|
-
import { ArmourMetrics } from './armour.js';
|
|
10
|
-
import { WeaponMetrics, WeaponTotals } from './weapons.js';
|
|
11
|
-
import { AmmunitionCapacity } from './ammunition.js';
|
|
12
|
-
import { WeaponsCapacitorMetrics } from './weapons-capacitor.js';
|
|
13
|
-
import { DistributorMetrics } from './distributor.js';
|
|
14
|
-
import { ThrusterParams, MobilityMetrics } from './mobility.js';
|
|
15
|
-
import { ShieldRecovery, CellBankSummary } from './shield-recovery.js';
|
|
3
|
+
import { OutfittingModule } from './modules.js';
|
|
16
4
|
import { PreEngineeredVariant } from './pre-engineered.js';
|
|
5
|
+
import { AmmunitionCapacity } from './ammunition.js';
|
|
17
6
|
import { SourcePurchaseRecord } from './source-purchase.js';
|
|
18
|
-
import { FuelCapacity
|
|
7
|
+
import { FuelCapacity } from './loadout-calculations.js';
|
|
19
8
|
import { ModuleFitConstraint, LoadoutIssueParams, LoadoutValidation } from './loadout-validation.js';
|
|
20
9
|
import './engineering-options.js';
|
|
21
10
|
import './module-families.js';
|
|
22
|
-
import './resistances.js';
|
|
23
11
|
|
|
24
12
|
/**
|
|
25
13
|
* Immutable fitted-module snapshots returned by {@link ShipLoadout}.
|
|
@@ -209,8 +197,7 @@ type LoadoutImportOutcome = {
|
|
|
209
197
|
};
|
|
210
198
|
|
|
211
199
|
/**
|
|
212
|
-
* {@link ShipLoadout} — a mutable fitted-ship model that
|
|
213
|
-
* about a build and **edits** it.
|
|
200
|
+
* {@link ShipLoadout} — a mutable fitted-ship model that **holds and edits** a build.
|
|
214
201
|
*
|
|
215
202
|
* Load one from a SLEF export or a journal `Loadout` event, or start from a
|
|
216
203
|
* {@link ShipLoadout.default | default} or {@link ShipLoadout.empty | empty} hull, then
|
|
@@ -218,9 +205,15 @@ type LoadoutImportOutcome = {
|
|
|
218
205
|
* build in place and return `this`; everything a query returns is a deeply frozen
|
|
219
206
|
* snapshot, so query again after an edit rather than re-reading an earlier value.
|
|
220
207
|
*
|
|
221
|
-
* **
|
|
222
|
-
*
|
|
223
|
-
*
|
|
208
|
+
* **What a build *calculates* lives next door.** Jump range, mass, cost, power, heat,
|
|
209
|
+
* mobility, shields, armour and firepower are on
|
|
210
|
+
* {@link ships!BuildMetrics | BuildMetrics}, over the same build:
|
|
211
|
+
* `BuildMetrics.of(build).maxJumpRange()`.
|
|
212
|
+
*
|
|
213
|
+
* **Slot keys are matched case-insensitively, with surrounding whitespace ignored.**
|
|
214
|
+
* Frontier writes `FrameShiftDrive`, a SLEF producer may write `frameshiftdrive`, and
|
|
215
|
+
* both name the same mount. A build's own spelling is never rewritten, so re-exporting
|
|
216
|
+
* an import returns it untouched.
|
|
224
217
|
*
|
|
225
218
|
* @remarks
|
|
226
219
|
* This is the batteries-included ship facade: it carries the complete ship, module,
|
|
@@ -231,11 +224,12 @@ type LoadoutImportOutcome = {
|
|
|
231
224
|
* ```ts
|
|
232
225
|
* declare const slefJsonString: string;
|
|
233
226
|
*
|
|
227
|
+
* import { BuildMetrics } from '@elite-dangerous-almanac/core/ships/build-metrics';
|
|
234
228
|
* import { ShipLoadout } from '@elite-dangerous-almanac/core/ships/ship-loadout';
|
|
235
229
|
*
|
|
236
230
|
* // Read a build:
|
|
237
231
|
* const build = ShipLoadout.fromSlef(slefJsonString);
|
|
238
|
-
* build.maxJumpRange();
|
|
232
|
+
* BuildMetrics.of(build).maxJumpRange(); // -> 89.41 (best single jump, one jump's fuel, no cargo)
|
|
239
233
|
*
|
|
240
234
|
* // Assemble one:
|
|
241
235
|
* import { getModuleBySymbol } from '@elite-dangerous-almanac/core/ships/modules';
|
|
@@ -330,13 +324,6 @@ type FixedMountRepairResult = {
|
|
|
330
324
|
/** Stable refusal reason. */
|
|
331
325
|
readonly reason: 'notFixedMount';
|
|
332
326
|
};
|
|
333
|
-
/** Optional mass overrides for a single calculation. */
|
|
334
|
-
interface JumpOptions {
|
|
335
|
-
/** Finite non-negative fuel load, in tonnes. Defaults to the full main tank. */
|
|
336
|
-
readonly fuel?: number;
|
|
337
|
-
/** Finite non-negative cargo load, in tonnes. Defaults to `0` (unladen). */
|
|
338
|
-
readonly cargo?: number;
|
|
339
|
-
}
|
|
340
327
|
/** Options for {@link ShipLoadout.applyBlueprint}. */
|
|
341
328
|
interface ApplyBlueprintOptions {
|
|
342
329
|
/** The blueprint grade, `1`–`5`. */
|
|
@@ -347,8 +334,8 @@ interface ApplyBlueprintOptions {
|
|
|
347
334
|
* reconstructed from its single reported quality; import its stated modifiers instead.
|
|
348
335
|
*/
|
|
349
336
|
readonly quality?: number;
|
|
350
|
-
/** The experimental (special) effect's Frontier
|
|
351
|
-
readonly
|
|
337
|
+
/** The experimental (special) effect's Frontier symbol, if any. */
|
|
338
|
+
readonly experimentalEffectSymbol?: string;
|
|
352
339
|
}
|
|
353
340
|
/** Stable reason {@link ShipLoadout.setExperimentalEffect} cannot perform an edit. */
|
|
354
341
|
type ExperimentalEffectMutationCode = 'emptySlot' | 'notEngineered' | 'unknownExperimentalEffect' | 'unsupportedExperimentalEffect' | 'finalArticle' | 'unsupportedEngineering' | 'unidentifiedPreEngineeredVariant' | 'unresolvedModifiers';
|
|
@@ -356,17 +343,17 @@ type ExperimentalEffectMutationCode = 'emptySlot' | 'notEngineered' | 'unknownEx
|
|
|
356
343
|
interface ExperimentalEffectUpdated {
|
|
357
344
|
/** Discriminator for an edit that changed the fitted module. */
|
|
358
345
|
readonly kind: 'updated';
|
|
359
|
-
/** Effect
|
|
360
|
-
readonly
|
|
361
|
-
/** Effect
|
|
362
|
-
readonly
|
|
346
|
+
/** Effect symbol before the edit, or `null` when none was present. */
|
|
347
|
+
readonly previousExperimentalEffectSymbol: string | null;
|
|
348
|
+
/** Effect symbol after the edit, or `null` when it was removed. */
|
|
349
|
+
readonly experimentalEffectSymbol: string | null;
|
|
363
350
|
}
|
|
364
351
|
/** Effect-only edit that requested the fitted module's current effect. */
|
|
365
352
|
interface ExperimentalEffectUnchanged {
|
|
366
353
|
/** Discriminator for a no-op edit. */
|
|
367
354
|
readonly kind: 'unchanged';
|
|
368
|
-
/** Current effect
|
|
369
|
-
readonly
|
|
355
|
+
/** Current effect symbol, or `null` when none is present. */
|
|
356
|
+
readonly experimentalEffectSymbol: string | null;
|
|
370
357
|
}
|
|
371
358
|
/** Effect-only edit that cannot be performed losslessly. */
|
|
372
359
|
interface ExperimentalEffectUnsupported {
|
|
@@ -409,223 +396,10 @@ interface EngineeringNormalizationUnsupported {
|
|
|
409
396
|
}
|
|
410
397
|
/** Result of {@link ShipLoadout.completeEngineeringGrade}. */
|
|
411
398
|
type EngineeringNormalizationResult = EngineeringNormalizationUnchanged | EngineeringNormalized | EngineeringNormalizationUnsupported;
|
|
412
|
-
/** Options for the defence figures a build reports. */
|
|
413
|
-
interface DefenceOptions {
|
|
414
|
-
/**
|
|
415
|
-
* Pips to the systems capacitor, `0`–`4`, folded into the shield resistances.
|
|
416
|
-
* Defaults to `0` for {@link ShipLoadout.shieldMetrics} and `4` for
|
|
417
|
-
* {@link ShipLoadout.shieldRecovery}.
|
|
418
|
-
*/
|
|
419
|
-
readonly systemsPips?: number;
|
|
420
|
-
}
|
|
421
|
-
/** Optional load and ENG allocation for {@link ShipLoadout.mobilityMetrics}. */
|
|
422
|
-
interface MobilityOptions extends JumpOptions {
|
|
423
|
-
/** Pips assigned to the engines capacitor, `0`–`4`. Defaults to `4`. */
|
|
424
|
-
readonly enginesPips?: number;
|
|
425
|
-
}
|
|
426
|
-
/** A standard fuel-and-cargo condition shared by jump and mobility views. */
|
|
427
|
-
type StandardLoad = 'maximum' | 'unladen' | 'laden';
|
|
428
|
-
/** What a {@link StandardLoad} carries, and what the ship weighs carrying it. */
|
|
429
|
-
interface StandardLoadInputs {
|
|
430
|
-
/** Main-tank fuel carried, in tonnes. */
|
|
431
|
-
readonly fuel: number;
|
|
432
|
-
/** Cargo carried, in tonnes. */
|
|
433
|
-
readonly cargo: number;
|
|
434
|
-
/**
|
|
435
|
-
* What the ship weighs at this load, in tonnes: {@link ShipLoadout.unladenMass}
|
|
436
|
-
* plus `fuel` plus `cargo`.
|
|
437
|
-
*
|
|
438
|
-
* @remarks
|
|
439
|
-
* This is the mass the jump and mobility calculations run on, so it is the figure
|
|
440
|
-
* to show beside them rather than one reassembled by the caller. The reserve tank
|
|
441
|
-
* is **not** in it: the game's statistics panel counts the reserve in the current
|
|
442
|
-
* mass it displays, and neither calculation here does — see
|
|
443
|
-
* {@link ShipLoadout.mobilityMetrics}. Add {@link FuelCapacity.reserve} to match the
|
|
444
|
-
* panel.
|
|
445
|
-
*
|
|
446
|
-
* The extra `fuel` and `cargo` are the load a screen labels; the mass is what they
|
|
447
|
-
* add up to, and passing the whole value back into {@link ShipLoadout.jumpRange} or
|
|
448
|
-
* {@link ShipLoadout.mobilityMetrics} is unaffected by its presence.
|
|
449
|
-
*/
|
|
450
|
-
readonly mass: number;
|
|
451
|
-
}
|
|
452
|
-
/** Optional WEP allocation for {@link ShipLoadout.weaponsCapacitorMetrics}. */
|
|
453
|
-
interface WeaponsOptions {
|
|
454
|
-
/** Pips assigned to the weapons capacitor, `0`–`4`. Defaults to `4`. */
|
|
455
|
-
readonly weaponsPips?: number;
|
|
456
|
-
}
|
|
457
|
-
/** Optional SYS, ENG and WEP allocations for {@link ShipLoadout.distributorMetrics}. */
|
|
458
|
-
interface DistributorOptions {
|
|
459
|
-
/** Pips assigned to the systems capacitor, `0`–`4`. Defaults to `4`. */
|
|
460
|
-
readonly systemsPips?: number;
|
|
461
|
-
/** Pips assigned to the engines capacitor, `0`–`4`. Defaults to `4`. */
|
|
462
|
-
readonly enginesPips?: number;
|
|
463
|
-
/** Pips assigned to the weapons capacitor, `0`–`4`. Defaults to `4`. */
|
|
464
|
-
readonly weaponsPips?: number;
|
|
465
|
-
}
|
|
466
|
-
/**
|
|
467
|
-
* Retail catalogue credits for an assembled build, as {@link ShipLoadout.buildCost} prices it.
|
|
468
|
-
*/
|
|
469
|
-
interface BuildCredits {
|
|
470
|
-
/**
|
|
471
|
-
* Priced hull and modules together, in credits.
|
|
472
|
-
*
|
|
473
|
-
* A Mercenary article is bought with Merc Coin and has no credit price at all, but it
|
|
474
|
-
* is counted here at the catalogue list price of the stock module it is built on, and
|
|
475
|
-
* again in {@link BuildCost.mercCoins} at what it actually cost. Subtract the stock
|
|
476
|
-
* module's price to quote credits a shop would really ask.
|
|
477
|
-
*/
|
|
478
|
-
readonly total: number;
|
|
479
|
-
/** Bare hull list price in credits. */
|
|
480
|
-
readonly hull: number;
|
|
481
|
-
/** Sum of every priced fitted module, in credits. A lower bound when `unpriced` is non-empty. */
|
|
482
|
-
readonly modules: number;
|
|
483
|
-
/**
|
|
484
|
-
* Five percent of `total`, truncated to credits: what insurance bills to rebuild the
|
|
485
|
-
* fit at catalogue prices. For what a capture said its own rebuy was, read
|
|
486
|
-
* {@link ShipLoadout.rebuy}.
|
|
487
|
-
*/
|
|
488
|
-
readonly rebuy: number;
|
|
489
|
-
/** Fitted modules that could not be priced from the catalogue. */
|
|
490
|
-
readonly unpriced: readonly {
|
|
491
|
-
readonly slot: string;
|
|
492
|
-
readonly symbol: string;
|
|
493
|
-
}[];
|
|
494
|
-
}
|
|
495
|
-
/**
|
|
496
|
-
* What an assembled build costs to own, in all three currencies the game charges for it.
|
|
497
|
-
*
|
|
498
|
-
* Every figure prices the **current fit** from the catalogues rather than reporting what a
|
|
499
|
-
* capture said was paid; for the latter read {@link ShipLoadout.sourcePurchase}.
|
|
500
|
-
*/
|
|
501
|
-
interface BuildCost {
|
|
502
|
-
/** Shop credits for the hull and its fitted modules. */
|
|
503
|
-
readonly credits: BuildCredits;
|
|
504
|
-
/**
|
|
505
|
-
* Merc Coin billed by the build: every Mercenary article's shop price plus every
|
|
506
|
-
* blueprint's currency cost, including ordinary engineering-menu recipes that charge it.
|
|
507
|
-
* A Mercenary article's blueprint is charged only above the grade it was sold at.
|
|
508
|
-
*/
|
|
509
|
-
readonly mercCoins: number;
|
|
510
|
-
/**
|
|
511
|
-
* What the build's blueprints and experimental effects consume, one entry per distinct
|
|
512
|
-
* material, counts summed across modules.
|
|
513
|
-
*
|
|
514
|
-
* Pre-engineered articles arrive engineered, so only what a player still has to roll on
|
|
515
|
-
* top of one is charged. A fixed reward carries no craft recipe at all and contributes
|
|
516
|
-
* nothing, and so does a modification whose recipe the catalogues do not price — a
|
|
517
|
-
* capture may name a blueprint or effect no registry lists, and an unpriceable
|
|
518
|
-
* modification is silently absent rather than reported the way
|
|
519
|
-
* {@link BuildCredits.unpriced} reports an unpriceable module.
|
|
520
|
-
*/
|
|
521
|
-
readonly materials: readonly EngineeringMaterial[];
|
|
522
|
-
}
|
|
523
|
-
/**
|
|
524
|
-
* What an assembled build weighs, broken down the way {@link ShipLoadout.buildMass}
|
|
525
|
-
* weighs it. Every figure is in tonnes.
|
|
526
|
-
*
|
|
527
|
-
* @remarks
|
|
528
|
-
* The mass counterpart of {@link BuildCredits}, and the same split: what the bare hull
|
|
529
|
-
* contributes, what the fit adds, and the total. `fuel` and `cargo` are the chosen load
|
|
530
|
-
* on top of that, so `total` is the mass the jump and mobility calculations run on.
|
|
531
|
-
*/
|
|
532
|
-
interface BuildMass {
|
|
533
|
-
/** Bare hull mass — the {@link ships!Ship.hullMass | hullMass} of the hull being flown. */
|
|
534
|
-
readonly hull: number;
|
|
535
|
-
/**
|
|
536
|
-
* Every fitted module's post-engineering mass, summed.
|
|
537
|
-
*
|
|
538
|
-
* @remarks
|
|
539
|
-
* Lightweight blueprints are already folded in, and the cargo hatch weighs nothing.
|
|
540
|
-
* A fitted record with no mass at all contributes `0` rather than making the total
|
|
541
|
-
* unavailable — mass is the one figure no article can be missing (see
|
|
542
|
-
* {@link ShipLoadout.unladenMass}), which is why there is no `unpriced` counterpart
|
|
543
|
-
* to {@link BuildCredits.unpriced} here.
|
|
544
|
-
*/
|
|
545
|
-
readonly modules: number;
|
|
546
|
-
/**
|
|
547
|
-
* The ship with an empty tank and no cargo — {@link ShipLoadout.unladenMass}.
|
|
548
|
-
*
|
|
549
|
-
* @remarks
|
|
550
|
-
* `hull` and `modules` are always computed from the hull record and the current
|
|
551
|
-
* fit, while this is the build's own unladen mass, which for an unedited import is
|
|
552
|
-
* the figure the **capture** stated. The two agree on anything assembled here; where
|
|
553
|
-
* a capture disagrees with the catalogues, this is the one the jump and mobility
|
|
554
|
-
* calculations use and the decomposition is what the catalogues say it is made of.
|
|
555
|
-
*/
|
|
556
|
-
readonly unladen: number;
|
|
557
|
-
/** Main-tank fuel counted, in tonnes. Defaults to a full main tank. */
|
|
558
|
-
readonly fuel: number;
|
|
559
|
-
/** Cargo counted, in tonnes. Defaults to an empty hold. */
|
|
560
|
-
readonly cargo: number;
|
|
561
|
-
/** `unladen + fuel + cargo`: what the ship weighs at the chosen load. */
|
|
562
|
-
readonly total: number;
|
|
563
|
-
}
|
|
564
|
-
/** One fitted weapon and what it does, as {@link ShipLoadout.weaponMetrics} reports it. */
|
|
565
|
-
interface FittedWeaponMetrics {
|
|
566
|
-
/** The hardpoint's slot key, e.g. `"LargeHardpoint1"`. */
|
|
567
|
-
readonly slot: string;
|
|
568
|
-
/** The weapon's internal symbol. */
|
|
569
|
-
readonly symbol: string;
|
|
570
|
-
/** The weapon's display name, e.g. `"Multi-Cannon"`. */
|
|
571
|
-
readonly name: string;
|
|
572
|
-
/** Whether the weapon is switched on — a disabled weapon is excluded from the totals. */
|
|
573
|
-
readonly enabled: boolean;
|
|
574
|
-
/** What this weapon does per second, post-engineering. */
|
|
575
|
-
readonly metrics: WeaponMetrics;
|
|
576
|
-
/**
|
|
577
|
-
* How many rounds it holds when fully rearmed, post-engineering — `null` for a laser,
|
|
578
|
-
* which carries none. A capacity, not a rearm state: see {@link FittedModule.ammunition}.
|
|
579
|
-
*/
|
|
580
|
-
readonly ammunition: AmmunitionCapacity | null;
|
|
581
|
-
/** Maximum effective range in metres, absent when the fitted weapon does not state one. */
|
|
582
|
-
readonly maximumRange?: number;
|
|
583
|
-
/** Damage-falloff start in metres, absent when the fitted weapon does not state one. */
|
|
584
|
-
readonly falloffRange?: number;
|
|
585
|
-
/**
|
|
586
|
-
* Exact projectile boundary metadata, absent when unavailable. These are not
|
|
587
|
-
* effective distances and remain separate from {@link maximumRange} and
|
|
588
|
-
* {@link falloffRange}.
|
|
589
|
-
*/
|
|
590
|
-
readonly projectileRange?: ProjectileRangeBoundaries;
|
|
591
|
-
/** Armour-piercing rating, absent when unavailable. */
|
|
592
|
-
readonly armourPiercing?: number;
|
|
593
|
-
}
|
|
594
|
-
/** A build's firepower: every fitted weapon, and the totals across the enabled ones. */
|
|
595
|
-
interface BuildWeaponMetrics {
|
|
596
|
-
/**
|
|
597
|
-
* Every fitted weapon in hull slot order. Weapons in unknown or unmapped slots
|
|
598
|
-
* follow the known slots in their original source order.
|
|
599
|
-
*/
|
|
600
|
-
readonly weapons: readonly FittedWeaponMetrics[];
|
|
601
|
-
/** The additive totals across the **enabled** weapons. */
|
|
602
|
-
readonly total: WeaponTotals;
|
|
603
|
-
}
|
|
604
|
-
/**
|
|
605
|
-
* A build's jump ranges at the loads that matter. The three single-jump values and
|
|
606
|
-
* each total result's `range` are in light-years.
|
|
607
|
-
*/
|
|
608
|
-
interface JumpRangeSummary {
|
|
609
|
-
/**
|
|
610
|
-
* Best single jump: no cargo, and only one jump's fuel aboard — the figure the game
|
|
611
|
-
* and EDSY label "maximum jump range".
|
|
612
|
-
*/
|
|
613
|
-
readonly max: number;
|
|
614
|
-
/** Single jump on a full tank with an empty hold. */
|
|
615
|
-
readonly unladen: number;
|
|
616
|
-
/** Single jump on a full tank with a full hold. */
|
|
617
|
-
readonly laden: number;
|
|
618
|
-
/** Summed range and jump count on one jump's fuel, empty hold. */
|
|
619
|
-
readonly totalMax: TotalRangeDetails;
|
|
620
|
-
/** Summed range and jump count on one full tank, empty hold. */
|
|
621
|
-
readonly totalUnladen: TotalRangeDetails;
|
|
622
|
-
/** Summed range and jump count on one full tank, full hold. */
|
|
623
|
-
readonly totalLaden: TotalRangeDetails;
|
|
624
|
-
}
|
|
625
399
|
/** A blueprint candidate for a module symbol, with its grades and availability route. */
|
|
626
400
|
interface AvailableBlueprint {
|
|
627
|
-
/** The blueprint's Frontier
|
|
628
|
-
readonly
|
|
401
|
+
/** The blueprint's Frontier symbol, e.g. `"FSD_LongRange"`. */
|
|
402
|
+
readonly blueprintSymbol: string;
|
|
629
403
|
/** The grades the blueprint offers, ascending (e.g. `[1, 2, 3, 4, 5]`). */
|
|
630
404
|
readonly grades: readonly number[];
|
|
631
405
|
/**
|
|
@@ -688,6 +462,46 @@ interface SlefExportOptions extends LoadoutExportOptions {
|
|
|
688
462
|
/**
|
|
689
463
|
* A fitted ship — read a SLEF export, or assemble a hull from scratch.
|
|
690
464
|
*
|
|
465
|
+
* ## Member index
|
|
466
|
+
*
|
|
467
|
+
* - **Construct** — {@link fromSlef}, {@link fromLoadout}, {@link empty},
|
|
468
|
+
* {@link default}. The constructor is private; every build starts at one of these four.
|
|
469
|
+
* - **Inspect** — {@link shipSymbol}, {@link shipName}, {@link shipIdent},
|
|
470
|
+
* {@link unladenMass}, {@link cargoCapacity}, {@link fuelCapacity}, {@link hullValue},
|
|
471
|
+
* {@link modulesValue}, {@link rebuy}, {@link sourcePurchase}, {@link importOutcomes},
|
|
472
|
+
* {@link slots}, {@link fittedModuleAt}, {@link fittedModules},
|
|
473
|
+
* {@link modulesForSlot}, {@link availableBlueprints},
|
|
474
|
+
* {@link availableExperimentalEffects}, {@link validation | validation()}.
|
|
475
|
+
* - **Edit** — {@link setModule}, {@link removeModule}, {@link repairFixedMount},
|
|
476
|
+
* {@link applyBlueprint}, {@link setExperimentalEffect},
|
|
477
|
+
* {@link completeEngineeringGrade}, {@link setPreEngineeredVariant},
|
|
478
|
+
* {@link clearEngineering}, {@link setModuleEnabled}, {@link setModulePriority}. Each
|
|
479
|
+
* returns `this` unless it reports a result of its own.
|
|
480
|
+
* - **Analyse** — not here. Jump range, mass, cost, power, heat, mobility, shields,
|
|
481
|
+
* armour and firepower live on
|
|
482
|
+
* {@link ships!BuildMetrics | BuildMetrics}, which reads this build:
|
|
483
|
+
* `BuildMetrics.of(build).maxJumpRange()`. The split lets an outfitting editor import
|
|
484
|
+
* the editors without the calculations, and a viewer the calculations without the
|
|
485
|
+
* editors.
|
|
486
|
+
* - **Export** — {@link toLoadoutEvent}, {@link toSlef}, {@link toSlefString}.
|
|
487
|
+
*
|
|
488
|
+
* ## Properties against methods
|
|
489
|
+
*
|
|
490
|
+
* **A property is a fact this build already carries; a method does something.** Every
|
|
491
|
+
* getter above is an identity, an aggregate figure, or what a capture stated — it
|
|
492
|
+
* computes nothing, takes no options, and never throws. Everything that does work is a
|
|
493
|
+
* call: reading the catalogues, enumerating mounts, editing the fit, exporting it, and
|
|
494
|
+
* every figure on {@link ships!BuildMetrics | BuildMetrics}.
|
|
495
|
+
*
|
|
496
|
+
* The rule makes the split predictable, not harmless. Two of those calls take no
|
|
497
|
+
* argument and read like facts — {@link validation | validation()}, which revalidates
|
|
498
|
+
* the whole fit, and {@link fittedModules | fittedModules()}, which allocates and
|
|
499
|
+
* deeply freezes a fresh snapshot on every call — so they are methods by the rule above
|
|
500
|
+
* even though a reader may reach for them as properties. **A forgotten `()` still hands
|
|
501
|
+
* you the function rather than the value**, and in plain JavaScript nothing complains:
|
|
502
|
+
* `build.fittedModules` is a function reference, `build.fittedModules()` is the list.
|
|
503
|
+
* TypeScript catches it; a `.js` consumer will not.
|
|
504
|
+
*
|
|
691
505
|
* @example
|
|
692
506
|
* Read a build a player already flies, and ask it what an outfitting screen shows.
|
|
693
507
|
* Every figure below is one build's — a Krait Phantom explorer. Figures the capture
|
|
@@ -695,6 +509,7 @@ interface SlefExportOptions extends LoadoutExportOptions {
|
|
|
695
509
|
* describe survives import; the rest are computed from the fit.
|
|
696
510
|
*
|
|
697
511
|
* ```ts
|
|
512
|
+
* import { BuildMetrics } from '@elite-dangerous-almanac/core/ships/build-metrics';
|
|
698
513
|
* import { ShipLoadout } from '@elite-dangerous-almanac/core/ships/ship-loadout';
|
|
699
514
|
* import type { LoadoutEvent } from '@elite-dangerous-almanac/core/ships/slef';
|
|
700
515
|
*
|
|
@@ -707,10 +522,11 @@ interface SlefExportOptions extends LoadoutExportOptions {
|
|
|
707
522
|
* build.shipName; // -> 'Jenny Longuet'
|
|
708
523
|
* build.unladenMass; // -> 388.830017 (tonnes)
|
|
709
524
|
*
|
|
710
|
-
*
|
|
711
|
-
*
|
|
712
|
-
*
|
|
713
|
-
*
|
|
525
|
+
* const metrics = BuildMetrics.of(build);
|
|
526
|
+
* metrics.maxJumpRange(); // -> 60.5478 (ly, best single jump)
|
|
527
|
+
* metrics.powerBudget().withinBudget; // -> true
|
|
528
|
+
* metrics.shieldMetrics()?.strength; // -> 743.12 (MJ)
|
|
529
|
+
* metrics.armourMetrics().hitPoints; // -> 307.8
|
|
714
530
|
* ```
|
|
715
531
|
*/
|
|
716
532
|
declare class ShipLoadout {
|
|
@@ -755,7 +571,7 @@ declare class ShipLoadout {
|
|
|
755
571
|
* unresolved symbol, a resolved one the mount refuses, and no entry at all are
|
|
756
572
|
* corrected alike, each keeping the source's `On`, `Priority` and `Health`. A
|
|
757
573
|
* removable mount may stand empty, so an article *it* refuses stays where the event
|
|
758
|
-
* put it and is reported by {@link validation} instead.
|
|
574
|
+
* put it and is reported by {@link validation | validation()} instead.
|
|
759
575
|
*
|
|
760
576
|
* Normalization makes the captured aggregates untrustworthy, so they are dropped:
|
|
761
577
|
* {@link unladenMass}, {@link cargoCapacity} and {@link fuelCapacity} are recomputed
|
|
@@ -818,7 +634,7 @@ declare class ShipLoadout {
|
|
|
818
634
|
* import { ShipLoadout } from '@elite-dangerous-almanac/core/ships/ship-loadout';
|
|
819
635
|
*
|
|
820
636
|
* const stock = ShipLoadout.default('SideWinder');
|
|
821
|
-
* stock.validation.complete; // -> true
|
|
637
|
+
* stock.validation().complete; // -> true
|
|
822
638
|
* stock.fittedModuleAt('FrameShiftDrive')?.symbol;
|
|
823
639
|
* // -> 'Int_Hyperdrive_Size2_Class1'
|
|
824
640
|
* ```
|
|
@@ -864,14 +680,14 @@ declare class ShipLoadout {
|
|
|
864
680
|
* unknown — including after an edit or import normalization discarded an import's
|
|
865
681
|
* figure, since no catalogue records what a replaced module was bought for. Unlike
|
|
866
682
|
* mass and capacity it is not recomputed from what remains; {@link sourcePurchase}
|
|
867
|
-
* keeps the captured figure and {@link buildCost} prices the current fit.
|
|
683
|
+
* keeps the captured figure and {@link ships!BuildMetrics.buildCost | BuildMetrics.buildCost} prices the current fit.
|
|
868
684
|
*/
|
|
869
685
|
get modulesValue(): number | null;
|
|
870
686
|
/**
|
|
871
687
|
* Insurance rebuy cost in credits represented by the build, or `null` if
|
|
872
688
|
* unknown. Discarded by an edit or by import normalization for the same reason as
|
|
873
689
|
* {@link modulesValue}, and likewise kept by {@link sourcePurchase};
|
|
874
|
-
* {@link buildCost} rebuys the current fit at catalogue prices instead.
|
|
690
|
+
* {@link ships!BuildMetrics.buildCost | BuildMetrics.buildCost} rebuys the current fit at catalogue prices instead.
|
|
875
691
|
*/
|
|
876
692
|
get rebuy(): number | null;
|
|
877
693
|
/**
|
|
@@ -933,8 +749,10 @@ declare class ShipLoadout {
|
|
|
933
749
|
* mounts are filled — every build fills those, so on a build the two answers agree.
|
|
934
750
|
* Neither question reports import normalization, so read {@link importOutcomes}
|
|
935
751
|
* beside them.
|
|
752
|
+
*
|
|
753
|
+
* @returns The validation report, recomputed from the current fit on every call.
|
|
936
754
|
*/
|
|
937
|
-
|
|
755
|
+
validation(): LoadoutValidation;
|
|
938
756
|
/**
|
|
939
757
|
* Frozen point-in-time views of the hull's mounts in outfitting-panel order.
|
|
940
758
|
*
|
|
@@ -991,7 +809,7 @@ declare class ShipLoadout {
|
|
|
991
809
|
*
|
|
992
810
|
* declare const build: ShipLoadout;
|
|
993
811
|
*
|
|
994
|
-
* build.availableBlueprints('FrameShiftDrive').map(({
|
|
812
|
+
* build.availableBlueprints('FrameShiftDrive').map(({ blueprintSymbol }) => blueprintSymbol);
|
|
995
813
|
* ```
|
|
996
814
|
*/
|
|
997
815
|
availableBlueprints(slotKey: string): readonly AvailableBlueprint[];
|
|
@@ -1131,17 +949,17 @@ declare class ShipLoadout {
|
|
|
1131
949
|
*
|
|
1132
950
|
* @param slotKey - The slot whose module to engineer, matched case-insensitively
|
|
1133
951
|
* (journal spelling).
|
|
1134
|
-
* @param
|
|
952
|
+
* @param blueprintSymbol - The blueprint recipe's Frontier symbol, e.g. `"FSD_LongRange"`.
|
|
1135
953
|
* @param options - {@link ApplyBlueprintOptions}: `grade` (1–5), optional `quality`
|
|
1136
|
-
* (0–1, default 1), and optional `experimental` effect
|
|
954
|
+
* (0–1, default 1), and optional `experimental` effect symbol. A nullish
|
|
1137
955
|
* `experimental` means no effect, the same as leaving it out. Each is read once,
|
|
1138
956
|
* before anything is checked, so an accessor cannot answer the check and the use
|
|
1139
957
|
* differently.
|
|
1140
958
|
* @returns `this`, for chaining.
|
|
1141
959
|
* @throws {RangeError} If the slot is empty, or the blueprint/grade/experimental is
|
|
1142
960
|
* unknown, or `quality` is outside `[0, 1]`.
|
|
1143
|
-
* @throws {TypeError} If `slotKey` or `
|
|
1144
|
-
* object, or `options.
|
|
961
|
+
* @throws {TypeError} If `slotKey` or `blueprintSymbol` is not a string, `options` is not an
|
|
962
|
+
* object, or `options.experimentalEffectSymbol` carries a value that is not a string — a nullish
|
|
1145
963
|
* one is no effect, not a wrong type. Also if the fitted module has no stats to
|
|
1146
964
|
* engineer, is final and accepts no further engineering, is not offered the blueprint
|
|
1147
965
|
* by its own menu, is not offered the experimental effect by it, or the id names a
|
|
@@ -1151,6 +969,7 @@ declare class ShipLoadout {
|
|
|
1151
969
|
* stored as a partial journal modifier block.
|
|
1152
970
|
* @example
|
|
1153
971
|
* ```ts
|
|
972
|
+
* import { BuildMetrics } from '@elite-dangerous-almanac/core/ships/build-metrics';
|
|
1154
973
|
* import { getModuleBySymbol } from '@elite-dangerous-almanac/core/ships/modules';
|
|
1155
974
|
* import { CORE_MODULES } from '@elite-dangerous-almanac/core/ships/modules-core';
|
|
1156
975
|
* import type { ShipLoadout } from '@elite-dangerous-almanac/core/ships/ship-loadout';
|
|
@@ -1162,12 +981,12 @@ declare class ShipLoadout {
|
|
|
1162
981
|
* build.setModule('FrameShiftDrive', fsd)
|
|
1163
982
|
* .applyBlueprint('FrameShiftDrive', 'FSD_LongRange', {
|
|
1164
983
|
* grade: 5,
|
|
1165
|
-
*
|
|
984
|
+
* experimentalEffectSymbol: 'special_fsd_heavy',
|
|
1166
985
|
* });
|
|
1167
|
-
* build.maxJumpRange(); // uses the engineered optimal mass
|
|
986
|
+
* BuildMetrics.of(build).maxJumpRange(); // uses the engineered optimal mass
|
|
1168
987
|
* ```
|
|
1169
988
|
*/
|
|
1170
|
-
applyBlueprint(slotKey: string,
|
|
989
|
+
applyBlueprint(slotKey: string, blueprintSymbol: string, options: ApplyBlueprintOptions): this;
|
|
1171
990
|
/**
|
|
1172
991
|
* Add, replace or remove only the fitted module's experimental effect.
|
|
1173
992
|
*
|
|
@@ -1177,7 +996,7 @@ declare class ShipLoadout {
|
|
|
1177
996
|
* leave the build unchanged and return stable structured data.
|
|
1178
997
|
*
|
|
1179
998
|
* @param slotKey - The engineered slot, matched case-insensitively.
|
|
1180
|
-
* @param experimental - Experimental-effect
|
|
999
|
+
* @param experimental - Experimental-effect symbol, or `null` to remove the effect.
|
|
1181
1000
|
* @returns A frozen result identifying an update, no-op or lossless refusal.
|
|
1182
1001
|
* @throws {TypeError} If `slotKey` or a non-null `experimental` is not a string.
|
|
1183
1002
|
* @example
|
|
@@ -1247,7 +1066,7 @@ declare class ShipLoadout {
|
|
|
1247
1066
|
* import { ShipLoadout } from '@elite-dangerous-almanac/core/ships/ship-loadout';
|
|
1248
1067
|
*
|
|
1249
1068
|
* const festive = getPreEngineeredVariants('Hpt_FlakMortar_Turret_Medium')
|
|
1250
|
-
* .find((variant) => variant.
|
|
1069
|
+
* .find((variant) => variant.blueprintSymbol === 'Decorative_Red')!;
|
|
1251
1070
|
* const build = ShipLoadout.empty('Krait_MkII')
|
|
1252
1071
|
* .setPreEngineeredVariant('MediumHardpoint1', festive);
|
|
1253
1072
|
* build.fittedModuleAt('MediumHardpoint1')?.effectiveStats?.damage; // -> 0.34
|
|
@@ -1292,7 +1111,7 @@ declare class ShipLoadout {
|
|
|
1292
1111
|
*
|
|
1293
1112
|
* @param slotKey - The slot's journal key, matched case-insensitively.
|
|
1294
1113
|
* @param priority - The journal's **zero-based** group, `0`–`4`. Note that the
|
|
1295
|
-
* outfitting panel — and {@link powerBudget}'s `bands[].priority` — number the same
|
|
1114
|
+
* outfitting panel — and {@link ships!BuildMetrics.powerBudget | BuildMetrics.powerBudget}'s `bands[].priority` — number the same
|
|
1296
1115
|
* five groups `1`–`5`.
|
|
1297
1116
|
* @returns `this`, for chaining.
|
|
1298
1117
|
* @throws {RangeError} If the slot is empty, or `priority` is not an integer in `[0, 4]`.
|
|
@@ -1353,531 +1172,6 @@ declare class ShipLoadout {
|
|
|
1353
1172
|
* ```
|
|
1354
1173
|
*/
|
|
1355
1174
|
toSlefString(options: SlefExportOptions): string;
|
|
1356
|
-
/**
|
|
1357
|
-
* The resolved frame-shift-drive constants for this build — post-engineering,
|
|
1358
|
-
* with any Guardian FSD Booster folded into `jumpBoost`.
|
|
1359
|
-
*
|
|
1360
|
-
* @throws {TypeError} If the fitted drive's record is missing any of its required
|
|
1361
|
-
* jump constants.
|
|
1362
|
-
*/
|
|
1363
|
-
get frameShiftDrive(): FrameShiftDriveParams;
|
|
1364
|
-
/**
|
|
1365
|
-
* The fitted thrusters' post-engineering mass curve, or `null` when the build has
|
|
1366
|
-
* none — the thruster counterpart of {@link frameShiftDrive}.
|
|
1367
|
-
*
|
|
1368
|
-
* @remarks
|
|
1369
|
-
* A {@link ships!ThrusterParams | ThrusterParams} carries the three masses the
|
|
1370
|
-
* curve is defined over and the multiplier at each, plus the separate `speedCurve`
|
|
1371
|
-
* and `rotationCurve` an enhanced-performance thruster refines them with. Pass it
|
|
1372
|
-
* straight to
|
|
1373
|
-
* {@link ships!thrusterMassCurveMultiplier | thrusterMassCurveMultiplier} for the
|
|
1374
|
-
* multiplier at a mass of your own, or read `optMass` and `maxMass` against
|
|
1375
|
-
* {@link ships!MobilityMetrics.loadedMass | loadedMass} for where this build sits
|
|
1376
|
-
* on the curve.
|
|
1377
|
-
*
|
|
1378
|
-
* This is the fitted article's curve, so a switched-off or shed thruster still has
|
|
1379
|
-
* one; {@link mobilityMetricsResult} is what judges whether the build can use it.
|
|
1380
|
-
* It answers `null` rather than throwing — unlike `frameShiftDrive`, which the jump
|
|
1381
|
-
* equation cannot do without — when no thrusters are fitted or the fitted record
|
|
1382
|
-
* carries no complete curve.
|
|
1383
|
-
*
|
|
1384
|
-
* @example
|
|
1385
|
-
* ```ts
|
|
1386
|
-
* import { ShipLoadout } from '@elite-dangerous-almanac/core/ships/ship-loadout';
|
|
1387
|
-
*
|
|
1388
|
-
* const build = ShipLoadout.default('Anaconda');
|
|
1389
|
-
* build.thrusters?.optMass; // -> 1440, tonnes
|
|
1390
|
-
* build.thrusters?.maxMass; // -> 2160, past which the ship does not move at all
|
|
1391
|
-
* ```
|
|
1392
|
-
*/
|
|
1393
|
-
get thrusters(): ThrusterParams | null;
|
|
1394
|
-
/**
|
|
1395
|
-
* The fitted frame shift drive's dimensionless mass factor at a chosen load.
|
|
1396
|
-
*
|
|
1397
|
-
* @param options - {@link JumpOptions}. `fuel` defaults to a full main tank and
|
|
1398
|
-
* `cargo` to `0`.
|
|
1399
|
-
* @returns `optMass / loadedMass`: `1` at the drive's optimised mass, below `1`
|
|
1400
|
-
* above it and above `1` below it.
|
|
1401
|
-
* @remarks
|
|
1402
|
-
* This is the mass term used by the jump equation, not the three-point performance
|
|
1403
|
-
* curve used by thrusters and shield generators. Main-tank fuel contributes to the
|
|
1404
|
-
* loaded mass; the Guardian FSD Booster's additive range does not contribute to the
|
|
1405
|
-
* factor.
|
|
1406
|
-
* @throws {TypeError} If the build has no usable frame shift drive.
|
|
1407
|
-
* @throws {RangeError} If fuel or cargo is not finite and non-negative, or loaded
|
|
1408
|
-
* mass is zero.
|
|
1409
|
-
* @example
|
|
1410
|
-
* ```ts
|
|
1411
|
-
* import type { ShipLoadout } from '@elite-dangerous-almanac/core/ships/ship-loadout';
|
|
1412
|
-
*
|
|
1413
|
-
* declare const build: ShipLoadout;
|
|
1414
|
-
* build.frameShiftDriveMassFactor({ fuel: 8, cargo: 32 }); // dimensionless
|
|
1415
|
-
* ```
|
|
1416
|
-
*/
|
|
1417
|
-
frameShiftDriveMassFactor(options?: JumpOptions): number;
|
|
1418
|
-
/**
|
|
1419
|
-
* Best single-jump range, in light-years — no cargo, and exactly one jump's fuel
|
|
1420
|
-
* aboard (the lightest the ship jumps). This is the figure the game and EDSY label
|
|
1421
|
-
* "maximum jump range".
|
|
1422
|
-
*
|
|
1423
|
-
* @returns The best single jump, in light-years, or `0` for a capture that states a
|
|
1424
|
-
* main tank of `0`.
|
|
1425
|
-
* @throws {TypeError} If the build has no usable frame shift drive.
|
|
1426
|
-
*/
|
|
1427
|
-
maxJumpRange(): number;
|
|
1428
|
-
/**
|
|
1429
|
-
* The range of a single jump for a chosen fuel and cargo load, in light-years.
|
|
1430
|
-
*
|
|
1431
|
-
* @param options - {@link JumpOptions}. `fuel` defaults to a full main tank,
|
|
1432
|
-
* `cargo` to `0`.
|
|
1433
|
-
* @returns The jump's range, in light-years.
|
|
1434
|
-
* @throws {TypeError} If the build has no usable frame shift drive.
|
|
1435
|
-
* @throws {RangeError} If fuel or cargo is not finite and non-negative.
|
|
1436
|
-
*/
|
|
1437
|
-
jumpRange(options?: JumpOptions): number;
|
|
1438
|
-
/**
|
|
1439
|
-
* Single-jump range on a full tank with a full cargo hold, in light-years.
|
|
1440
|
-
*
|
|
1441
|
-
* @returns The jump's range, in light-years.
|
|
1442
|
-
* @throws {TypeError} If the build has no usable frame shift drive.
|
|
1443
|
-
*/
|
|
1444
|
-
ladenJumpRange(): number;
|
|
1445
|
-
/**
|
|
1446
|
-
* The fuel a single jump of a given distance costs, in tonnes.
|
|
1447
|
-
*
|
|
1448
|
-
* @param distance - The jump distance, in light-years.
|
|
1449
|
-
* @param options - {@link JumpOptions}. `fuel` defaults to a full main tank,
|
|
1450
|
-
* `cargo` to `0`.
|
|
1451
|
-
* @returns Fuel used, in tonnes (capped at the drive's max fuel per jump).
|
|
1452
|
-
* @throws {TypeError} If the build has no usable frame shift drive.
|
|
1453
|
-
* @throws {RangeError} If fuel or cargo is not finite and non-negative.
|
|
1454
|
-
*/
|
|
1455
|
-
fuelPerJump(distance: number, options?: JumpOptions): number;
|
|
1456
|
-
/**
|
|
1457
|
-
* Total range and jump count for a chosen fuel and cargo load.
|
|
1458
|
-
*
|
|
1459
|
-
* @param options - {@link JumpOptions}. `fuel` defaults to a full main tank,
|
|
1460
|
-
* `cargo` to `0`.
|
|
1461
|
-
* @returns Summed range in light-years and the jumps made before the tank is empty.
|
|
1462
|
-
* @throws {TypeError} If the build has no usable frame shift drive.
|
|
1463
|
-
* @throws {RangeError} If fuel or cargo is not finite and non-negative, or the
|
|
1464
|
-
* fuel load would require more than 100,000 jumps.
|
|
1465
|
-
* @example
|
|
1466
|
-
* ```ts
|
|
1467
|
-
* import type { ShipLoadout } from '@elite-dangerous-almanac/core/ships/ship-loadout';
|
|
1468
|
-
*
|
|
1469
|
-
* declare const build: ShipLoadout;
|
|
1470
|
-
* build.totalRange().jumps; // jumps available from one full main tank
|
|
1471
|
-
* build.totalRange({ fuel: 8, cargo: 32 }).range; // range for that partial load
|
|
1472
|
-
* ```
|
|
1473
|
-
*/
|
|
1474
|
-
totalRange(options?: JumpOptions): TotalRangeDetails;
|
|
1475
|
-
/**
|
|
1476
|
-
* Resolve one of the package's standard load conditions for jump and mobility views.
|
|
1477
|
-
*
|
|
1478
|
-
* @param load - `'maximum'` for one jump's fuel and no cargo, `'unladen'` for a
|
|
1479
|
-
* full main tank and no cargo, or `'laden'` for a full main tank and full hold.
|
|
1480
|
-
* @returns The fuel and cargo carried, and the {@link StandardLoadInputs.mass} the
|
|
1481
|
-
* ship weighs carrying them, all in tonnes. Only `'maximum'` can come back
|
|
1482
|
-
* incomplete: it validates the whole fitted drive, jump booster included, so a
|
|
1483
|
-
* complete one can be passed straight to {@link jumpRange}.
|
|
1484
|
-
* @throws {RangeError} If `load` is not a recognised standard load.
|
|
1485
|
-
* @example
|
|
1486
|
-
* ```ts
|
|
1487
|
-
* import type { ShipLoadout } from '@elite-dangerous-almanac/core/ships/ship-loadout';
|
|
1488
|
-
*
|
|
1489
|
-
* declare const build: ShipLoadout;
|
|
1490
|
-
* const load = build.standardLoadResult('maximum');
|
|
1491
|
-
* if (load.complete) build.mobilityMetrics({ ...load.value, enginesPips: 2 });
|
|
1492
|
-
* ```
|
|
1493
|
-
* @example
|
|
1494
|
-
* ```ts
|
|
1495
|
-
* import { ShipLoadout } from '@elite-dangerous-almanac/core/ships/ship-loadout';
|
|
1496
|
-
*
|
|
1497
|
-
* const build = ShipLoadout.default('Anaconda');
|
|
1498
|
-
* build.standardLoadResult('laden').value?.mass; // -> 1210, tonnes with a full tank and hold
|
|
1499
|
-
* ```
|
|
1500
|
-
*/
|
|
1501
|
-
standardLoadResult(load: StandardLoad): CalculationResult<StandardLoadInputs>;
|
|
1502
|
-
/**
|
|
1503
|
-
* Every jump figure at once — best, unladen, laden, and each load's total.
|
|
1504
|
-
*
|
|
1505
|
-
* @returns The {@link JumpRangeSummary}. Single-jump figures and each total's
|
|
1506
|
-
* `range` are in light-years. For a partial load, call {@link jumpRange} for one
|
|
1507
|
-
* jump or {@link totalRange} for every jump with the `fuel` and `cargo` you
|
|
1508
|
-
* actually have.
|
|
1509
|
-
* @throws {TypeError} If the build has no usable frame shift drive.
|
|
1510
|
-
* @example
|
|
1511
|
-
* ```ts
|
|
1512
|
-
* import type { ShipLoadout } from '@elite-dangerous-almanac/core/ships/ship-loadout';
|
|
1513
|
-
*
|
|
1514
|
-
* declare const build: ShipLoadout;
|
|
1515
|
-
*
|
|
1516
|
-
* const jumps = build.jumpRangeSummary();
|
|
1517
|
-
* jumps.max; // -> 89.41 (one jump's fuel, empty hold)
|
|
1518
|
-
* jumps.laden; // -> the range with the hold full
|
|
1519
|
-
* jumps.totalMax.jumps; // the best jump expressed as a total
|
|
1520
|
-
* // Half a tank and 32 t aboard:
|
|
1521
|
-
* build.jumpRange({ fuel: build.fuelCapacity.main / 2, cargo: 32 });
|
|
1522
|
-
* ```
|
|
1523
|
-
*/
|
|
1524
|
-
jumpRangeSummary(): JumpRangeSummary;
|
|
1525
|
-
/**
|
|
1526
|
-
* The build's power budget: what the plant makes, what the modules draw with
|
|
1527
|
-
* hardpoints retracted and deployed, and which priority groups stay lit.
|
|
1528
|
-
*
|
|
1529
|
-
* Draws are post-engineering, modules switched off in the journal are skipped, and
|
|
1530
|
-
* weapons (plus the utility fittings that are not always powered) count only
|
|
1531
|
-
* towards the deployed total.
|
|
1532
|
-
*
|
|
1533
|
-
* @returns The {@link PowerBudget}. `consumers` includes modules with positive
|
|
1534
|
-
* draw; passive and zero-draw fittings are absent.
|
|
1535
|
-
* @throws {RangeError} If a power capacity or module draw is negative or not finite.
|
|
1536
|
-
* @example
|
|
1537
|
-
* ```ts
|
|
1538
|
-
* import type { ShipLoadout } from '@elite-dangerous-almanac/core/ships/ship-loadout';
|
|
1539
|
-
*
|
|
1540
|
-
* declare const build: ShipLoadout;
|
|
1541
|
-
*
|
|
1542
|
-
* const power = build.powerBudget();
|
|
1543
|
-
* power.available; // -> 20.4 MW generated
|
|
1544
|
-
* power.deployed; // -> 19.02 MW drawn, hardpoints out
|
|
1545
|
-
* power.withinBudget; // -> true
|
|
1546
|
-
* power.bands[4]?.poweredDeployed; // -> is priority group 5 still lit?
|
|
1547
|
-
* ```
|
|
1548
|
-
*/
|
|
1549
|
-
powerBudget(): PowerBudget;
|
|
1550
|
-
/**
|
|
1551
|
-
* The build's heat: what it idles at, what it runs at flying and jumping, and
|
|
1552
|
-
* whether firing everything cooks it.
|
|
1553
|
-
*
|
|
1554
|
-
* Every figure is post-engineering. The heat a build makes follows what the plant
|
|
1555
|
-
* actually feeds, so a module switched off — or one in a priority group the plant
|
|
1556
|
-
* cannot keep lit — contributes nothing.
|
|
1557
|
-
*
|
|
1558
|
-
* @returns The {@link HeatMetrics}, or `null` when the build has no powered power
|
|
1559
|
-
* plant.
|
|
1560
|
-
* @example
|
|
1561
|
-
* ```ts
|
|
1562
|
-
* import type { ShipLoadout } from '@elite-dangerous-almanac/core/ships/ship-loadout';
|
|
1563
|
-
*
|
|
1564
|
-
* declare const build: ShipLoadout;
|
|
1565
|
-
*
|
|
1566
|
-
* const heat = build.heatMetrics();
|
|
1567
|
-
* heat?.idle.gauge; // -> 0.23, i.e. the gauge reads 23%
|
|
1568
|
-
* heat?.firingSustained.overheats; // -> false: the guns run cool enough to hold
|
|
1569
|
-
* heat?.firingDrained.secondsToOverheat; // -> how long an alpha strike has on an empty WEP
|
|
1570
|
-
* ```
|
|
1571
|
-
*/
|
|
1572
|
-
heatMetrics(): HeatMetrics | null;
|
|
1573
|
-
/**
|
|
1574
|
-
* The build's speed, boost and rotation rates at a chosen load and ENG allocation.
|
|
1575
|
-
*
|
|
1576
|
-
* @remarks
|
|
1577
|
-
* Main-tank fuel contributes to the flight model's loaded mass. Reserve-tank fuel
|
|
1578
|
-
* does not: although the statistics panel includes it in the displayed current
|
|
1579
|
-
* mass, ten observed builds reproduce their angular rates only when the reserve is
|
|
1580
|
-
* excluded from the thruster mass curve.
|
|
1581
|
-
*
|
|
1582
|
-
* @param options - Fuel defaults to a full main tank, cargo to `0`, and ENG pips to `4`.
|
|
1583
|
-
* @returns Loaded {@link MobilityMetrics}, or `null` when no fully described
|
|
1584
|
-
* thrusters are powered with hardpoints retracted. Use
|
|
1585
|
-
* {@link mobilityMetricsResult} to distinguish the unavailable conditions.
|
|
1586
|
-
* @throws {RangeError} If fuel or cargo is not finite and non-negative, or
|
|
1587
|
-
* `enginesPips` is outside `[0, 4]`.
|
|
1588
|
-
* @example
|
|
1589
|
-
* ```ts
|
|
1590
|
-
* import type { ShipLoadout } from '@elite-dangerous-almanac/core/ships/ship-loadout';
|
|
1591
|
-
*
|
|
1592
|
-
* declare const build: ShipLoadout;
|
|
1593
|
-
* build.mobilityMetrics({ cargo: 32, fuel: 8, enginesPips: 2 })?.speed; // -> m/s
|
|
1594
|
-
* ```
|
|
1595
|
-
*/
|
|
1596
|
-
mobilityMetrics(options?: MobilityOptions): MobilityMetrics | null;
|
|
1597
|
-
/**
|
|
1598
|
-
* The build's mobility with a diagnostic when its thrusters or retracted power
|
|
1599
|
-
* supply is unavailable.
|
|
1600
|
-
*
|
|
1601
|
-
* @param options - Fuel defaults to a full main tank, cargo to `0`, and ENG pips to `4`.
|
|
1602
|
-
* @returns A complete {@link MobilityMetrics} value, otherwise `null` plus the input
|
|
1603
|
-
* or fitted-module state that prevented the calculation.
|
|
1604
|
-
* @throws {RangeError} If fuel or cargo is not finite and non-negative, or
|
|
1605
|
-
* `enginesPips` is outside `[0, 4]`.
|
|
1606
|
-
* @example
|
|
1607
|
-
* ```ts
|
|
1608
|
-
* import type { ShipLoadout } from '@elite-dangerous-almanac/core/ships/ship-loadout';
|
|
1609
|
-
*
|
|
1610
|
-
* declare const build: ShipLoadout;
|
|
1611
|
-
* const result = build.mobilityMetricsResult({ enginesPips: 2 });
|
|
1612
|
-
* if (result.complete) result.value.speed; // metres per second
|
|
1613
|
-
* else result.issues[0].reason; // unavailable-state discriminator
|
|
1614
|
-
* ```
|
|
1615
|
-
*/
|
|
1616
|
-
mobilityMetricsResult(options?: MobilityOptions): CalculationResult<MobilityMetrics>;
|
|
1617
|
-
/**
|
|
1618
|
-
* The build's shields: strength in megajoules, where it comes from, and the
|
|
1619
|
-
* effective resistances.
|
|
1620
|
-
*
|
|
1621
|
-
* Shield strength scales with the **hull's** mass, not the build's, so fitting
|
|
1622
|
-
* more modules never weakens it. Boosters, Guardian shield reinforcement and any
|
|
1623
|
-
* engineering are all folded in; switched-off or shed boosters and reinforcement
|
|
1624
|
-
* are ignored, while a switched-off or shed generator makes the metric unavailable.
|
|
1625
|
-
*
|
|
1626
|
-
* @param options - {@link DefenceOptions}. `systemsPips` (0–4) folds the SYS
|
|
1627
|
-
* capacitor's own resistance into the reported figures; it defaults to `0`, which
|
|
1628
|
-
* is what an outfitting screen shows.
|
|
1629
|
-
* @returns The {@link ShieldMetrics}, or `null` when the build has no shield
|
|
1630
|
-
* generator powered with hardpoints retracted. Use
|
|
1631
|
-
* {@link shieldMetricsResult} to distinguish the unavailable conditions.
|
|
1632
|
-
* @throws {RangeError} If `systemsPips` is outside `[0, 4]` or not finite.
|
|
1633
|
-
* @example
|
|
1634
|
-
* ```ts
|
|
1635
|
-
* import type { ShipLoadout } from '@elite-dangerous-almanac/core/ships/ship-loadout';
|
|
1636
|
-
*
|
|
1637
|
-
* declare const build: ShipLoadout;
|
|
1638
|
-
*
|
|
1639
|
-
* const shields = build.shieldMetrics();
|
|
1640
|
-
* shields?.strength; // -> MJ
|
|
1641
|
-
* shields?.resistances.thermal; // -> negative on a stock generator
|
|
1642
|
-
* build.shieldMetrics({ systemsPips: 4 })?.resistances.thermal; // -> with 4 pips to SYS
|
|
1643
|
-
* ```
|
|
1644
|
-
*/
|
|
1645
|
-
shieldMetrics(options?: DefenceOptions): ShieldMetrics | null;
|
|
1646
|
-
/**
|
|
1647
|
-
* The build's shields with a diagnostic when its hull, generator or retracted
|
|
1648
|
-
* power supply is unavailable.
|
|
1649
|
-
*
|
|
1650
|
-
* @param options - {@link DefenceOptions}. `systemsPips` defaults to `0`.
|
|
1651
|
-
* @returns A complete {@link ShieldMetrics} value, otherwise `null` plus the input
|
|
1652
|
-
* or fitted-module state that prevented the calculation.
|
|
1653
|
-
* @throws {RangeError} If `systemsPips` is outside `[0, 4]` or not finite.
|
|
1654
|
-
* @example
|
|
1655
|
-
* ```ts
|
|
1656
|
-
* import type { ShipLoadout } from '@elite-dangerous-almanac/core/ships/ship-loadout';
|
|
1657
|
-
*
|
|
1658
|
-
* declare const build: ShipLoadout;
|
|
1659
|
-
* const result = build.shieldMetricsResult();
|
|
1660
|
-
* if (result.complete) result.value.strength; // megajoules
|
|
1661
|
-
* else result.issues[0].reason; // unavailable-state discriminator
|
|
1662
|
-
* ```
|
|
1663
|
-
*/
|
|
1664
|
-
shieldMetricsResult(options?: DefenceOptions): CalculationResult<ShieldMetrics>;
|
|
1665
|
-
/**
|
|
1666
|
-
* Time for this build's shield to rise after collapse and then regenerate to full.
|
|
1667
|
-
*
|
|
1668
|
-
* @param options - SYS pips in `[0, 4]`, defaulting to `4`.
|
|
1669
|
-
* @returns Recovery rates and seconds, or `null` when no shield generator is powered
|
|
1670
|
-
* with hardpoints retracted. Use
|
|
1671
|
-
* {@link shieldRecoveryResult} to distinguish the unavailable conditions.
|
|
1672
|
-
* Insufficient zero-pip recharge produces `Infinity`.
|
|
1673
|
-
* @throws {RangeError} If `systemsPips` is outside `[0, 4]` or not finite.
|
|
1674
|
-
* @example
|
|
1675
|
-
* ```ts
|
|
1676
|
-
* import type { ShipLoadout } from '@elite-dangerous-almanac/core/ships/ship-loadout';
|
|
1677
|
-
*
|
|
1678
|
-
* declare const build: ShipLoadout;
|
|
1679
|
-
* build.shieldRecovery({ systemsPips: 4 })?.recoveryTime; // -> seconds from collapse to 50%
|
|
1680
|
-
* ```
|
|
1681
|
-
*/
|
|
1682
|
-
shieldRecovery(options?: DefenceOptions): ShieldRecovery | null;
|
|
1683
|
-
/**
|
|
1684
|
-
* The build's shield recovery with a diagnostic when its hull, generator or
|
|
1685
|
-
* retracted power supply is unavailable.
|
|
1686
|
-
*
|
|
1687
|
-
* @param options - SYS pips in `[0, 4]`, defaulting to `4`.
|
|
1688
|
-
* @returns A complete {@link ShieldRecovery} value, otherwise `null` plus the input
|
|
1689
|
-
* or fitted-module state that prevented the calculation.
|
|
1690
|
-
* @throws {RangeError} If `systemsPips` is outside `[0, 4]` or not finite.
|
|
1691
|
-
* @example
|
|
1692
|
-
* ```ts
|
|
1693
|
-
* import type { ShipLoadout } from '@elite-dangerous-almanac/core/ships/ship-loadout';
|
|
1694
|
-
*
|
|
1695
|
-
* declare const build: ShipLoadout;
|
|
1696
|
-
* const result = build.shieldRecoveryResult();
|
|
1697
|
-
* if (result.complete) result.value.recoveryTime; // seconds
|
|
1698
|
-
* else result.issues[0].reason; // unavailable-state discriminator
|
|
1699
|
-
* ```
|
|
1700
|
-
*/
|
|
1701
|
-
shieldRecoveryResult(options?: DefenceOptions): CalculationResult<ShieldRecovery>;
|
|
1702
|
-
/**
|
|
1703
|
-
* Every fitted shield cell bank and the usable rearmed reinforcement pool.
|
|
1704
|
-
*
|
|
1705
|
-
* Every fitted bank remains in `banks`, where `powered` says whether it is switched
|
|
1706
|
-
* on and its priority group is fed with hardpoints deployed. The totals include only
|
|
1707
|
-
* those powered banks, so a build whose plant is switched off or outdrawn reports
|
|
1708
|
-
* every bank unpowered and zero totals.
|
|
1709
|
-
*
|
|
1710
|
-
* @returns A frozen {@link CellBankSummary}; no banks is an empty list and zero totals.
|
|
1711
|
-
* @example
|
|
1712
|
-
* ```ts
|
|
1713
|
-
* import type { ShipLoadout } from '@elite-dangerous-almanac/core/ships/ship-loadout';
|
|
1714
|
-
*
|
|
1715
|
-
* declare const build: ShipLoadout;
|
|
1716
|
-
* build.cellBanks().totalRestorable; // -> MJ across every powered fitted cell
|
|
1717
|
-
* ```
|
|
1718
|
-
*/
|
|
1719
|
-
cellBanks(): CellBankSummary;
|
|
1720
|
-
/**
|
|
1721
|
-
* Price the whole build from the catalogues: shop credits, Merc Coin and the
|
|
1722
|
-
* engineering materials its modifications consume.
|
|
1723
|
-
*
|
|
1724
|
-
* No modification is charged twice. A Mercenary article arrives at the grade it was sold at,
|
|
1725
|
-
* so only the climb above that grade bills materials and further Merc Coin, and an
|
|
1726
|
-
* experimental effect the article came with is free while one added on top is not. A
|
|
1727
|
-
* fixed reward article — festive, Guardian, community-goal — identifies a recipe it
|
|
1728
|
-
* was never rolled from, so it contributes no materials at all.
|
|
1729
|
-
*
|
|
1730
|
-
* @returns A frozen {@link BuildCost}. `credits.modules`, `credits.total` and
|
|
1731
|
-
* `credits.rebuy` are lower bounds while {@link BuildCredits.unpriced} is non-empty;
|
|
1732
|
-
* built-in hull fittings are free rather than unpriced.
|
|
1733
|
-
* @remarks
|
|
1734
|
-
* This is the one place `ShipLoadout` reads the material and Merc Coin cost
|
|
1735
|
-
* catalogues, which is why the facade carries them; import
|
|
1736
|
-
* {@link ships/blueprint-costs!getBlueprintCost | getBlueprintCost} and
|
|
1737
|
-
* {@link ships/experimental-effect-costs!getExperimentalEffectCost | getExperimentalEffectCost}
|
|
1738
|
-
* directly to price one recipe without a build.
|
|
1739
|
-
* @example
|
|
1740
|
-
* ```ts
|
|
1741
|
-
* import { ShipLoadout } from '@elite-dangerous-almanac/core/ships/ship-loadout';
|
|
1742
|
-
*
|
|
1743
|
-
* const build = ShipLoadout.default('Anaconda');
|
|
1744
|
-
* build.buildCost().credits.hull; // -> 142456440
|
|
1745
|
-
* build.applyBlueprint('FrameShiftDrive', 'FSD_LongRange', { grade: 5 });
|
|
1746
|
-
* build.buildCost().materials.find((material) => material.symbol === 'Arsenic')?.count; // -> 5
|
|
1747
|
-
* ```
|
|
1748
|
-
* @example
|
|
1749
|
-
* ```ts
|
|
1750
|
-
* import { getPreEngineeredVariants } from '@elite-dangerous-almanac/core/ships/pre-engineered';
|
|
1751
|
-
* import { ShipLoadout } from '@elite-dangerous-almanac/core/ships/ship-loadout';
|
|
1752
|
-
*
|
|
1753
|
-
* const variant = getPreEngineeredVariants('Hpt_Railgun_Fixed_Medium')
|
|
1754
|
-
* .find((candidate) => candidate.acquisition === 'mercenary')!;
|
|
1755
|
-
* const build = ShipLoadout.default('Python')
|
|
1756
|
-
* .setPreEngineeredVariant('MediumHardpoint1', variant);
|
|
1757
|
-
* build.buildCost().mercCoins; // -> 950
|
|
1758
|
-
* ```
|
|
1759
|
-
*/
|
|
1760
|
-
buildCost(): BuildCost;
|
|
1761
|
-
/**
|
|
1762
|
-
* Weigh the whole build: the hull, the fitted modules, and the load on top of them.
|
|
1763
|
-
*
|
|
1764
|
-
* @remarks
|
|
1765
|
-
* The mass companion to {@link buildCost}, answering the same question in tonnes
|
|
1766
|
-
* that that one answers in credits. Every module's mass is post-engineering, so a
|
|
1767
|
-
* Lightweight roll is already in `modules`.
|
|
1768
|
-
*
|
|
1769
|
-
* The reserve tank is **not** counted. The main tank is the fuel the drive and the
|
|
1770
|
-
* flight model see, and it is what {@link jumpRange} and {@link mobilityMetrics}
|
|
1771
|
-
* weigh; the game's statistics panel additionally counts the reserve in the current
|
|
1772
|
-
* mass it displays, so add {@link fuelCapacity}`.reserve` to reproduce that reading.
|
|
1773
|
-
*
|
|
1774
|
-
* @param options - {@link JumpOptions}. `fuel` defaults to a full main tank and
|
|
1775
|
-
* `cargo` to `0`, matching {@link jumpRange} and {@link mobilityMetrics}. Pass
|
|
1776
|
-
* {@link standardLoadResult} to weigh one of the standard loads.
|
|
1777
|
-
* @returns A frozen {@link BuildMass}, every figure in tonnes.
|
|
1778
|
-
* @throws {RangeError} If fuel or cargo is not finite and non-negative.
|
|
1779
|
-
* @example
|
|
1780
|
-
* ```ts
|
|
1781
|
-
* import { ShipLoadout } from '@elite-dangerous-almanac/core/ships/ship-loadout';
|
|
1782
|
-
*
|
|
1783
|
-
* const build = ShipLoadout.default('Anaconda');
|
|
1784
|
-
* const mass = build.buildMass();
|
|
1785
|
-
* mass.hull; // -> 400
|
|
1786
|
-
* mass.modules; // -> 664
|
|
1787
|
-
* mass.total; // -> 1096, a full main tank and an empty hold
|
|
1788
|
-
* build.buildMass({ cargo: build.cargoCapacity }).total; // -> 1210
|
|
1789
|
-
* ```
|
|
1790
|
-
*/
|
|
1791
|
-
buildMass(options?: JumpOptions): BuildMass;
|
|
1792
|
-
/**
|
|
1793
|
-
* The build's armour: hull hit points, the bulkhead and reinforcement each
|
|
1794
|
-
* contribute, and the effective resistances.
|
|
1795
|
-
*
|
|
1796
|
-
* @returns The {@link ArmourMetrics}, read off the fitted bulkhead.
|
|
1797
|
-
* @example
|
|
1798
|
-
* ```ts
|
|
1799
|
-
* import type { ShipLoadout } from '@elite-dangerous-almanac/core/ships/ship-loadout';
|
|
1800
|
-
*
|
|
1801
|
-
* declare const build: ShipLoadout;
|
|
1802
|
-
*
|
|
1803
|
-
* const hull = build.armourMetrics();
|
|
1804
|
-
* hull.hitPoints; // -> total hull points
|
|
1805
|
-
* hull.resistances.explosive; // -> lightweight alloy is explosively weak
|
|
1806
|
-
* hull.effectiveHitPoints.thermal; // -> thermal damage the hull can soak
|
|
1807
|
-
* ```
|
|
1808
|
-
*/
|
|
1809
|
-
armourMetrics(): ArmourMetrics;
|
|
1810
|
-
/**
|
|
1811
|
-
* The build's firepower: DPS, sustained DPS, weapons-capacitor draw, heat and power
|
|
1812
|
-
* draw for every fitted weapon, plus the totals.
|
|
1813
|
-
*
|
|
1814
|
-
* Every figure is post-engineering. A weapon switched off in the journal is still
|
|
1815
|
-
* listed — with its own metrics — but left out of the totals.
|
|
1816
|
-
*
|
|
1817
|
-
* @returns The {@link BuildWeaponMetrics}.
|
|
1818
|
-
* @example
|
|
1819
|
-
* ```ts
|
|
1820
|
-
* import type { ShipLoadout } from '@elite-dangerous-almanac/core/ships/ship-loadout';
|
|
1821
|
-
*
|
|
1822
|
-
* declare const build: ShipLoadout;
|
|
1823
|
-
*
|
|
1824
|
-
* const guns = build.weaponMetrics();
|
|
1825
|
-
* guns.total.damagePerSecond; // -> burst DPS across the hardpoints
|
|
1826
|
-
* guns.total.sustainedDamagePerSecond; // -> with reloads folded in
|
|
1827
|
-
* guns.total.energyPerSecond; // -> MW asked of the WEP capacitor
|
|
1828
|
-
* guns.total.powerDraw; // -> MW asked of the power plant when deployed
|
|
1829
|
-
* guns.weapons[0]?.metrics.damageByType.thermal;
|
|
1830
|
-
* guns.weapons[0]?.maximumRange; // post-engineering metres, when known
|
|
1831
|
-
* guns.weapons[0]?.armourPiercing; // post-engineering rating, when known
|
|
1832
|
-
* guns.weapons[0]?.ammunition?.total; // -> rounds aboard when fully rearmed
|
|
1833
|
-
* ```
|
|
1834
|
-
*/
|
|
1835
|
-
weaponMetrics(): BuildWeaponMetrics;
|
|
1836
|
-
/**
|
|
1837
|
-
* WEP-capacitor recharge and endurance while every powered weapon fires.
|
|
1838
|
-
*
|
|
1839
|
-
* @param options - WEP pips in `[0, 4]`, defaulting to `4`.
|
|
1840
|
-
* @returns Actual recharge, sustained draw, net drain and seconds from full to
|
|
1841
|
-
* empty. The deployed power budget is applied to the distributor and weapons, so a
|
|
1842
|
-
* module the plant sheds contributes nothing. With no powered distributor, capacity
|
|
1843
|
-
* and recharge are zero. A load that draws no more than recharge reports
|
|
1844
|
-
* `Infinity` for `timeToDrain`.
|
|
1845
|
-
* @throws {RangeError} If `weaponsPips` is outside `[0, 4]` or not finite.
|
|
1846
|
-
* @example
|
|
1847
|
-
* ```ts
|
|
1848
|
-
* import type { ShipLoadout } from '@elite-dangerous-almanac/core/ships/ship-loadout';
|
|
1849
|
-
*
|
|
1850
|
-
* declare const build: ShipLoadout;
|
|
1851
|
-
* build.weaponsCapacitorMetrics({ weaponsPips: 2 }).timeToDrain; // seconds
|
|
1852
|
-
* ```
|
|
1853
|
-
*/
|
|
1854
|
-
weaponsCapacitorMetrics(options?: WeaponsOptions): WeaponsCapacitorMetrics;
|
|
1855
|
-
/**
|
|
1856
|
-
* All three power-distributor capacitors at selected pip allocations.
|
|
1857
|
-
*
|
|
1858
|
-
* @param options - SYS, ENG and WEP pips in `[0, 4]`, each defaulting
|
|
1859
|
-
* independently to `4`. The allocations need not sum to six, which permits
|
|
1860
|
-
* independent comparisons of the three maxima.
|
|
1861
|
-
* @returns Capacity, rated four-pip recharge and actual pip-scaled recharge for
|
|
1862
|
-
* SYS, ENG and WEP, or `null` when the distributor is switched off, its six
|
|
1863
|
-
* capacitor stats cannot be resolved, or the retracted power budget sheds it. That
|
|
1864
|
-
* retracted state represents the distributor itself; firing endurance in
|
|
1865
|
-
* {@link weaponsCapacitorMetrics} separately applies the deployed state.
|
|
1866
|
-
* @throws {RangeError} If any pip allocation is outside `[0, 4]` or not finite.
|
|
1867
|
-
* @example
|
|
1868
|
-
* ```ts
|
|
1869
|
-
* import type { ShipLoadout } from '@elite-dangerous-almanac/core/ships/ship-loadout';
|
|
1870
|
-
*
|
|
1871
|
-
* declare const build: ShipLoadout;
|
|
1872
|
-
* const distributor = build.distributorMetrics({
|
|
1873
|
-
* systemsPips: 2,
|
|
1874
|
-
* enginesPips: 2,
|
|
1875
|
-
* weaponsPips: 2,
|
|
1876
|
-
* });
|
|
1877
|
-
* distributor?.engines.rechargeRate; // MJ/s
|
|
1878
|
-
* ```
|
|
1879
|
-
*/
|
|
1880
|
-
distributorMetrics(options?: DistributorOptions): DistributorMetrics | null;
|
|
1881
1175
|
}
|
|
1882
1176
|
|
|
1883
|
-
export { type ApplyBlueprintOptions, type AvailableBlueprint, type
|
|
1177
|
+
export { type ApplyBlueprintOptions, type AvailableBlueprint, type EngineeringNormalizationCode, type EngineeringNormalizationResult, type EngineeringNormalizationUnchanged, type EngineeringNormalizationUnsupported, type EngineeringNormalized, type ExperimentalEffectMutationCode, type ExperimentalEffectMutationResult, type ExperimentalEffectUnchanged, type ExperimentalEffectUnsupported, type ExperimentalEffectUpdated, type FittedModule, type FixedMountRepairResult, type ImmovableReason, LoadoutEditError, type LoadoutEditErrorCode, type LoadoutExportOptions, type LoadoutImportOutcome, type LoadoutSlot, ShipLoadout, type SlefExportOptions };
|