ships.Function.mobilityMetrics

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

Function: mobilityMetrics()

Call Signature

mobilityMetrics(input): MobilityMetrics

Defined in: src/ships/mobility.ts:213

Calculate a loaded ship's top speed, boost speed and rotation rates.

Parameters

input

MobilityInput & object

Hull figures, loaded mass, fitted thrusters and ENG pips.

Returns

MobilityMetrics

The build's MobilityMetrics, or null without thrusters. A mass above the thrusters' maximum returns zero performance rather than a fabricated curve value.

Remarks

Speed, pitch, roll and yaw interpolate linearly from their installed zero-ENG-PIP endpoints to their four-PIP endpoints. The fitted thruster's speed and rotation mass-curve multipliers are then applied to those interpolated hull values. Boost is independent of ENG allocation and uses the speed curve at the loaded mass.

Throws

If an input is not finite or is outside its documented range, or a thruster curve does not follow the ordering documented by ThrusterCurveParams.

Example

import { mobilityMetrics } from '@elite-dangerous-almanac/core/ships/mobility';

mobilityMetrics({
  minimumSpeed: 100, maximumSpeed: 220, boost: 320,
  minPitch: 34, pitch: 42, minRoll: 110, roll: 110, minYaw: 16, yaw: 16,
  mass: 48,
  thrusters: {
    minMass: 24, optMass: 48, maxMass: 72,
    minMultiplier: 0.83, optMultiplier: 1, maxMultiplier: 1.03,
  },
}).speed; // -> 220

Call Signature

mobilityMetrics(input): MobilityMetrics | null

Defined in: src/ships/mobility.ts:216

Calculate a loaded ship's top speed, boost speed and rotation rates.

Parameters

input

MobilityInput

Hull figures, loaded mass, fitted thrusters and ENG pips.

Returns

MobilityMetrics | null

The build's MobilityMetrics, or null without thrusters. A mass above the thrusters' maximum returns zero performance rather than a fabricated curve value.

Remarks

Speed, pitch, roll and yaw interpolate linearly from their installed zero-ENG-PIP endpoints to their four-PIP endpoints. The fitted thruster's speed and rotation mass-curve multipliers are then applied to those interpolated hull values. Boost is independent of ENG allocation and uses the speed curve at the loaded mass.

Throws

If an input is not finite or is outside its documented range, or a thruster curve does not follow the ordering documented by ThrusterCurveParams.

Example

import { mobilityMetrics } from '@elite-dangerous-almanac/core/ships/mobility';

mobilityMetrics({
  minimumSpeed: 100, maximumSpeed: 220, boost: 320,
  minPitch: 34, pitch: 42, minRoll: 110, roll: 110, minYaw: 16, yaw: 16,
  mass: 48,
  thrusters: {
    minMass: 24, optMass: 48, maxMass: 72,
    minMultiplier: 0.83, optMultiplier: 1, maxMultiplier: 1.03,
  },
}).speed; // -> 220