ships.Function.getExperimentalEffect

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

Function: getExperimentalEffect()

getExperimentalEffect(fdname): ExperimentalEffect | null

Defined in: src/ships/experimental-effects.ts:63

Look up an experimental effect by its Frontier fdname, case-insensitively.

Parameters

fdname

string

The effect id, e.g. "special_fsd_heavy".

Returns

ExperimentalEffect | null

The effect record — its display name, modifier contributions, optional damageDistribution, and optional qualitative description — or null if unknown.

Throws

If fdname is present and not a string. A nullish fdname is a miss, answered the way an unrecognised one is.

Example

import { getExperimentalEffect } from '@elite-dangerous-almanac/core/ships/experimental-effects';

const effect = getExperimentalEffect('special_fsd_heavy');
effect?.name;      // -> 'Mass Manager'
effect?.modifiers; // -> [{ label: 'Integrity', ... }, ...]