ships.Interface.OutfittingModuleStats - Elite-Dangerous-Almanac/Almanac-Core GitHub Wiki
@elite-dangerous-almanac/core / ships / OutfittingModuleStats
Defined in: src/ships/modules.ts:518
Sparse performance and capability fields carried by an outfitting module.
Every field is optional because no module family uses every stat. Use the guards in
./module-capabilities when a calculation needs a complete group. The interface is
also useful for functions that accept or return engineered stat snapshots without
requiring a module's identity fields. Masses are tonnes, power is megawatts, jump
ranges are light-years, and weapon ranges are metres.
import type { OutfittingModuleStats } from '@elite-dangerous-almanac/core/ships/modules';
const engineered: OutfittingModuleStats = { mass: 18.4, powerDraw: 0.69 };
readonlyoptionalalwaysPowered?:boolean
Defined in: src/ships/modules.ts:775
true when a hardpoint-mounted module draws its power continuously.
Weapons and most utility fittings only draw power while the hardpoints are
deployed; shield boosters, chaff, heat sinks, point defence, caustic sinks and
shutdown field neutralisers draw theirs all the time, and carry this flag.
Absent on every core/internal module, which are always powered anyway.
See powerDraw and ./power.
readonlyoptionalammoMaximum?:number
Defined in: src/ships/modules.ts:832
Reserve rounds to reload from — the magazine is not counted in it, exactly as the
journal's AmmoInHopper does not count it. Absent beside a clipSize means
nothing limits the refills (the mining Abrasion Blaster); absent beside no clip
either means the module takes no ammunition at all, as the lasers do.
readonlyoptionalarmourPiercing?:number
Defined in: src/ships/modules.ts:849
Armour piercing rating. Damage to a hull is scaled by
min(1, armourPiercing / hardness) against a hull of that Ship.hardness.
readonlyoptionalbootTime?:number
Defined in: src/ships/modules.ts:529
Boot time from power-on, in seconds.
readonlyoptionalburstInterval?:number
Defined in: src/ships/modules.ts:810
Seconds between shots — between bursts on a burst-fire weapon.
readonlyoptionalburstRateOfFire?:number
Defined in: src/ships/modules.ts:814
Shots per second within a burst.
readonlyoptionalburstRounds?:number
Defined in: src/ships/modules.ts:812
Shots in one burst. Absent (or 1) on a weapon that does not fire in bursts.
readonlyoptionalcabinCapacity?:number
Defined in: src/ships/modules.ts:640
Passenger cabin: capacity, in passenger berths.
readonlyoptionalcargoCapacity?:number
Defined in: src/ships/modules.ts:638
Cargo rack: capacity, in tonnes.
readonlyoptionalcausticResistance?:number
Defined in: src/ships/modules.ts:675
Caustic resistance, as a fraction (negative is a weakness).
readonlyoptionalchargeTime?:number
Defined in: src/ships/modules.ts:816
Seconds spent charging before a shot (rail guns), if any.
readonlyoptionalclipSize?:number
Defined in: src/ships/modules.ts:825
Rounds in a clip before reloading. Absent on weapons that never reload.
A capacity, and the largest AmmoInClip a journal can report for the module.
ammunitionCapacity in ./ammunition reads it together with
OutfittingModule.ammoMaximum.
readonlyoptionaldamage?:number
Defined in: src/ships/modules.ts:785
Damage per round — or per second on a continuous-fire (beam) weapon.
readonlyoptionaldamageComponents?:DamageComponents
Defined in: src/ships/modules.ts:793
Exact damage amounts when in-game verification exposes distinct components. On effective fitted stats these scale with engineered total damage, and are absent when engineering converts the weapon to a new fractional damage distribution.
readonlyoptionaldamageDistribution?:DamageDistribution
Defined in: src/ships/modules.ts:787
How damage splits across the damage types.
readonlyoptionaldistributorDraw?:number
Defined in: src/ships/modules.ts:842
Weapons-capacitor draw, in megawatts — per shot, or per second on a
continuous-fire weapon. Shield generators carry it too, as the systems-capacitor
cost of one MJ per second of regeneration — the stat the journal calls
EnergyPerRegen rather than DistributorDraw, and the one Hi-Cap, Lo-draw and
Force Block move.
readonlyoptionalengineeringLocked?:boolean
Defined in: src/ships/modules.ts:695
Whether this particular resolved article accepts no further engineering.
Stock module catalogues omit this field. getPreEngineeredStats sets it on final
pre-engineered Guardian weapons so a fitted article exposes an empty engineering
menu and rejects both blueprints and experimental effects.
readonlyoptionalengineHeatRate?:number
Defined in: src/ships/modules.ts:564
Thrusters: waste heat generated per second at top speed.
The stat the journal calls EngineHeatRate — every Dirty Drive Tuning roll
raises it and every Clean Drive roll lowers it. Frontier's own units: a bare
number the ship's heat model consumes, not a temperature or a percentage.
readonlyoptionalenginesCapacity?:number
Defined in: src/ships/modules.ts:625
Power distributor: ENG capacitor capacity.
readonlyoptionalenginesRecharge?:number
Defined in: src/ships/modules.ts:627
Power distributor: maximum ENG recharge at four pips, in megajoules per second.
readonlyoptionalexplosiveResistance?:number
Defined in: src/ships/modules.ts:673
Explosive resistance, as a fraction (negative is a weakness).
readonlyoptionalfalloffRange?:number
Defined in: src/ships/modules.ts:856
Range at which damage starts to drop off, in metres.
readonlyoptionalfsdHeatRate?:number
Defined in: src/ships/modules.ts:583
Frame shift drive: waste heat generated per second while charging a jump.
The journal's FSDHeatRate, in the same units as
OutfittingModule.engineHeatRate. It is what Faster Boot Sequence trades
away, what Shielded improves, and the whole of the Deep Charge / Thermal Spread
(special_fsd_cooled) experimental effect. A drive's size sets it — every rating
of a size shares one value, and a Supercruise Overcharge (SCO) drive matches the
plain drive of the same size.
readonlyoptionalfuelCapacity?:number
Defined in: src/ships/modules.ts:636
Fuel tank: capacity, in tonnes.
readonlyoptionalfuelMul?:number
Defined in: src/ships/modules.ts:569
FSD: rating (linear) fuel constant.
readonlyoptionalfuelPower?:number
Defined in: src/ships/modules.ts:571
FSD: size (power) fuel constant.
readonlyoptionalguardianZoneResistance?:boolean
Defined in: src/ships/modules.ts:686
Whether Anti-Guardian Zone Resistance protects this Guardian module from a Thargoid anti-Guardian field.
A sparse capability flag rather than a percentage: true means the protection is
inherent or the grade-1 blueprint grants it, while absence means it is not granted.
The Guardian Nanite Torpedo Pylons carry it inherently; read engineered
protection from a fitted module's FittedModule.effectiveStats.
readonlyoptionalheatEfficiency?:number
Defined in: src/ships/modules.ts:618
Power plant: heat efficiency (lower runs cooler).
readonlyoptionalhullBoost?:number
Defined in: src/ships/modules.ts:706
Armour: the hull hit points this bulkhead adds, as a fraction of the hull's
Ship.baseArmour on top of it — 0.8 (lightweight alloy) means
baseArmour × 1.8, 2.5 means baseArmour × 3.5.
Carried by the ship-specific armour modules, which are the core-category
records with a OutfittingModule.ship. List a hull's options with
getBulkheadsForShip.
readonlyoptionalhullReinforcement?:number
Defined in: src/ships/modules.ts:708
Hull reinforcement package: hull hit points added.
readonlyoptionalintegrity?:number
Defined in: src/ships/modules.ts:525
Integrity (hit points against module damage).
readonlyoptionalinterdictorFacingLimit?:number
Defined in: src/ships/modules.ts:758
FSD interdictor: maximum target angle off boresight, in degrees.
readonlyoptionalinterdictorRange?:number
Defined in: src/ships/modules.ts:763
FSD interdictor: maximum target range, in seconds to intercept — the units the game measures a supercruise separation in, not a distance.
readonlyoptionaljitter?:number
Defined in: src/ships/modules.ts:871
Maximum aim deviation, in degrees.
readonlyoptionaljumpBoost?:number
Defined in: src/ships/modules.ts:613
Guardian FSD Booster: flat jump-range bonus, in light-years.
readonlyoptionalkineticResistance?:number
Defined in: src/ships/modules.ts:669
Kinetic resistance, as a fraction (0.4 = 40% resisted, -0.2 = 20% weaker).
readonlyoptionalmass?:number
Defined in: src/ships/modules.ts:523
Mass, in tonnes.
readonlyoptionalmaxFuel?:number
Defined in: src/ships/modules.ts:567
FSD: maximum fuel per jump, in tonnes.
readonlyoptionalmaximumRange?:number
Defined in: src/ships/modules.ts:854
Maximum effective range, in metres. A weapon does no damage beyond it; on a non-scanner utility module, it is the effect's reach.
readonlyoptionalmaxMass?:number
Defined in: src/ships/modules.ts:536
Maximum mass for the performance curve, in tonnes.
readonlyoptionalmaxMultiplier?:number
Defined in: src/ships/modules.ts:542
Maximum performance multiplier, reached at minMass.
readonlyoptionalmaxRotationMultiplier?:number
Defined in: src/ships/modules.ts:554
Thruster maximum rotation multiplier, reached at minMass.
readonlyoptionalmaxSpeedMultiplier?:number
Defined in: src/ships/modules.ts:548
Thruster maximum top-speed multiplier, reached at minMass.
readonlyoptionalminMass?:number
Defined in: src/ships/modules.ts:534
Minimum mass for the performance curve, in tonnes.
readonlyoptionalminMultiplier?:number
Defined in: src/ships/modules.ts:540
Minimum performance multiplier, reached at maxMass.
readonlyoptionalminRotationMultiplier?:number
Defined in: src/ships/modules.ts:552
Thruster minimum rotation multiplier, reached at maxMass.
readonlyoptionalminSpeedMultiplier?:number
Defined in: src/ships/modules.ts:546
Thruster minimum top-speed multiplier, reached at maxMass.
readonlyoptionalmoduleProtection?:number
Defined in: src/ships/modules.ts:715
Module reinforcement package: the fraction of module damage it absorbs
(0.3 = 30%). Protects the modules, not the hull.
readonlyoptionaloptMass?:number
Defined in: src/ships/modules.ts:532
Optimised mass, in tonnes — thrusters, shield generators, and FSDs.
readonlyoptionaloptMultiplier?:number
Defined in: src/ships/modules.ts:538
Performance multiplier at optMass — thruster speed or shield strength.
readonlyoptionaloptRotationMultiplier?:number
Defined in: src/ships/modules.ts:550
Thruster rotation multiplier at optMass, when distinct from acceleration.
readonlyoptionaloptSpeedMultiplier?:number
Defined in: src/ships/modules.ts:544
Thruster top-speed multiplier at optMass, when distinct from acceleration.
readonlyoptionalpowerCapacity?:number
Defined in: src/ships/modules.ts:616
Power plant: power generated, in megawatts.
readonlyoptionalpowerDraw?:number
Defined in: src/ships/modules.ts:527
Power draw, in megawatts.
readonlyoptionalprobeRadius?:number
Defined in: src/ships/modules.ts:753
Detailed Surface Scanner: probe radius, as a percentage (20 = the stock
20%).
Frontier stores this one as a percentage rather than a fraction, and the journal
reports it that way too — a grade 4 Expanded Probe Scanning Radius roll takes the
stock 20 to 28. The journal spells the label DSS_PatchRadius; the blueprint
recipe spells it ProbeRadius, and both resolve here.
readonlyoptionalprojectileRange?:ProjectileRangeBoundaries
Defined in: src/ships/modules.ts:858
Projectile boundary parameters; these are not effective distances in metres.
readonlyoptionalrateOfFire?:number
Defined in: src/ships/modules.ts:808
Shots per second with the burst pattern folded in — the journal's RateOfFire.
Absent on continuous-fire weapons (beam and mining lasers), whose damage is
already per second. Excludes charge and reload time; OutfittingModule.chargeTime
is the delay before a shot lands, while OutfittingModule.clipSize and
OutfittingModule.reloadTime give the sustained rate.
readonlyoptionalrefuelRate?:number
Defined in: src/ships/modules.ts:634
Fuel scoop: scoop rate, in tonnes per second.
readonlyoptionalreloadTime?:number
Defined in: src/ships/modules.ts:834
Seconds to reload a clip.
readonlyoptionalroundsPerShot?:number
Defined in: src/ships/modules.ts:798
Rounds fired per shot, for the weapons that fire several at once (fragment cannons, shard cannons). Absent means one round per shot.
readonlyoptionalscanAngle?:number
Defined in: src/ships/modules.ts:740
Scan cone half-angle, in degrees — how far off boresight a target can sit and still be scanned. Wide Angle raises it; Long Range and Lightweight narrow it.
readonlyoptionalscannerRange?:number
Defined in: src/ships/modules.ts:735
Scan range, in metres.
On a utility scanner it is the distance the scan reaches. On a core sensor suite it is the range at which a contact with typical emissions resolves — the "typical sensor range" the outfitting panel shows in kilometres and the journal reports in metres, not the suite's absolute detection ceiling.
This is the sole distance field on utility scanners and sensor suites. A journal
may spell its modifier ScannerRange or Range; both labels resolve here. Weapon
distance is the separate OutfittingModule.maximumRange field.
readonlyoptionalscanTime?:number
Defined in: src/ships/modules.ts:742
Seconds a scan takes to complete. Utility scanners only.
readonlyoptionalshieldAddition?:number
Defined in: src/ships/modules.ts:710
Guardian shield reinforcement package: shield megajoules added.
readonlyoptionalshieldBankDuration?:number
Defined in: src/ships/modules.ts:660
Shield cell bank: seconds one cell keeps reinforcing for.
readonlyoptionalshieldBankHeat?:number
Defined in: src/ships/modules.ts:656
Shield cell bank: waste heat generated by firing one cell.
readonlyoptionalshieldBankReinforcement?:number
Defined in: src/ships/modules.ts:654
Shield cell bank: shield megajoules restored per second while a cell runs.
readonlyoptionalshieldBankSpinUp?:number
Defined in: src/ships/modules.ts:658
Shield cell bank: seconds between firing a cell and the shields starting to rise.
readonlyoptionalshieldBoost?:number
Defined in: src/ships/modules.ts:647
Shield booster: shield strength bonus, as a fraction (0.04 = +4%).
readonlyoptionalshieldBrokenRegenRate?:number
Defined in: src/ships/modules.ts:645
Shield generator: broken (down) regeneration rate, MJ per second.
readonlyoptionalshieldRegenRate?:number
Defined in: src/ships/modules.ts:643
Shield generator: regeneration rate, MJ per second.
readonlyoptionalshotSpeed?:number
Defined in: src/ships/modules.ts:869
Projectile speed, in metres per second.
Absent on the weapons that have no projectile to speed up — the pulse, burst, beam and mining lasers, rail guns, Gauss cannons and mine launchers all hit (or drop) where they are aimed. No registry publishes a figure for them because there is none, so Long Range and Focused simply leave their shot speed alone; see ShipLoadout.applyBlueprint.
readonlyoptionalsupercruiseOvercharge?:boolean
Defined in: src/ships/modules.ts:611
Frame shift drive: true on a Supercruise Overcharge drive, the line the
outfitting screen labels SCO.
A sparse capability flag on the Overcharge drives and absent everywhere else,
including on the ordinary drives of the same sizes and ratings. Read it rather
than matching Int_Hyperdrive_Overcharge on the symbol: the capability is the
record's to state, so a consumer that reads the flag stays correct for any
article the catalogue flags, whatever Frontier names it.
The two lines share every jump constant this library models, so the flag changes no jump calculation; it is what an outfitting list filters and labels on, and it is what makes a drive unfittable below its own size — an SCO drive takes the mount of its own class and no larger one, where an ordinary drive may be underfitted. The overcharged supercruise behaviour itself — the boosted acceleration and the extra fuel it burns — is in-flight behaviour the game publishes no figures for, and the library models none of it.
import { getModuleBySymbol } from '@elite-dangerous-almanac/core/ships/modules';
getModuleBySymbol('Int_Hyperdrive_Overcharge_Size5_Class5')?.supercruiseOvercharge; // -> true
getModuleBySymbol('Int_Hyperdrive_Size5_Class5')?.supercruiseOvercharge; // -> undefined
readonlyoptionalsystemsCapacity?:number
Defined in: src/ships/modules.ts:629
Power distributor: SYS capacitor capacity.
readonlyoptionalsystemsRecharge?:number
Defined in: src/ships/modules.ts:631
Power distributor: maximum SYS recharge at four pips, in megajoules per second.
readonlyoptionalthermalLoad?:number
Defined in: src/ships/modules.ts:844
Heat generated — per shot, or per second on a continuous-fire weapon.
readonlyoptionalthermalResistance?:number
Defined in: src/ships/modules.ts:671
Thermal resistance, as a fraction (negative is a weakness).
readonlyoptionalweaponsCapacity?:number
Defined in: src/ships/modules.ts:621
Power distributor: WEP capacitor capacity.
readonlyoptionalweaponsRecharge?:number
Defined in: src/ships/modules.ts:623
Power distributor: maximum WEP recharge at four pips, in megajoules per second.