ships.Function.frameShiftDriveMassFactor

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

Function: frameShiftDriveMassFactor()

frameShiftDriveMassFactor(mass, fuel, fsd): number

Defined in: src/ships/jump-range.ts:145

Resolve the frame shift drive's mass factor at one loaded mass.

Parameters

mass

number

Ship mass excluding the fuel being modelled, in tonnes — finite and non-negative.

fuel

number

Fuel aboard for this calculation, in tonnes — finite and non-negative. The full amount contributes to loaded mass, even when one jump burns less.

fsd

Pick<FrameShiftDriveParams, "optMass">

A drive's post-engineering optimised mass. A complete FrameShiftDriveParams object is accepted structurally.

Returns

number

The dimensionless optMass / (mass + fuel) factor used by singleJumpRange: 1 at the drive's optimised mass, below 1 above it and above 1 below it.

Remarks

An FSD does not use the three-point min/optimal/max curve that thrusters and shield generators do. Its mass contribution to jump range is this direct inverse ratio. Guardian FSD Booster range is added after the base jump equation and is therefore not part of this factor.

Throws

If an input is negative or non-finite, optMass is not positive, or the loaded mass is zero.

Example

import { frameShiftDriveMassFactor } from '@elite-dangerous-almanac/core/ships/jump-range';

frameShiftDriveMassFactor(990, 10, { optMass: 1000 }); // -> 1