ships.Function.shieldMetrics

@elite-dangerous-almanac/core / ships / shieldMetrics

Function: shieldMetrics()

shieldMetrics(input): ShieldMetrics

Defined in: src/ships/shields.ts:273

Everything an outfitting screen shows about a build's shields: strength, where it comes from, and the effective resistances.

Parameters

input

ShieldInput

The hull's mass and base shield strength, the fitted generator, and any powered boosters, Guardian reinforcement and SYS pips.

Returns

ShieldMetrics

The ShieldMetrics. With no generator fitted there is no shield for a resistance to apply to: every strength figure is 0 — any reinforcement passed is dropped, since a Guardian package has no shield to reinforce — and resistances and effectiveHitPoints are 0 for every damage type, so a hull with no shields gets no benefit from the SYS pips. The pips are still reported on their own, as systemsResistance. massCurveMultiplier is 0 and boostMultiplier is 1, whatever boosters are fitted, since there is no generator strength to multiply.

Throws

If systemsPips is not a finite number in [0, 4]. The pips are checked before the generator, so this applies with no generator fitted too.

Example

import { shieldMetrics } from '@elite-dangerous-almanac/core/ships/shields';
import type { ShieldGeneratorParams } from '@elite-dangerous-almanac/core/ships/shields';

declare const gen: ShieldGeneratorParams;

const shields = shieldMetrics({
  hullMass: 400,
  baseShieldStrength: 350,
  generator: gen,
  boosters: [{ shieldBoost: 0.2, kineticResistance: 0 }],
});
shields.strength;                 // -> MJ
shields.resistances.kinetic;      // -> effective kinetic resistance
shields.effectiveHitPoints.kinetic; // -> kinetic damage the shield can soak