ships.Function.mobilityMetrics

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

Function: mobilityMetrics()

Call Signature

mobilityMetrics(input): MobilityMetrics

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

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

Parameters

input

MobilityInput & object

Hull figures, loaded mass and fitted thrusters.

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 are the hull's four-ENG-PIP endpoints with the fitted thruster's speed and rotation mass-curve multipliers applied. Boost is independent of the ENG allocation and uses the speed curve at the loaded mass, so it is the same figure whatever the pips.

A lower allocation is mobilityCapacitorMetrics: it interpolates each figure from the hull's zero-pip endpoint (minimumSpeed, minPitch, minRoll, minYaw) towards the endpoint used here, and applies the same curves.

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:171

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

Parameters

input

MobilityInput

Hull figures, loaded mass and fitted thrusters.

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 are the hull's four-ENG-PIP endpoints with the fitted thruster's speed and rotation mass-curve multipliers applied. Boost is independent of the ENG allocation and uses the speed curve at the loaded mass, so it is the same figure whatever the pips.

A lower allocation is mobilityCapacitorMetrics: it interpolates each figure from the hull's zero-pip endpoint (minimumSpeed, minPitch, minRoll, minYaw) towards the endpoint used here, and applies the same curves.

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