ships.Function.getExperimentalEffect

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

Function: getExperimentalEffect()

getExperimentalEffect(experimentalEffectSymbol): ExperimentalEffect | null

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

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

Parameters

experimentalEffectSymbol

string

The effect id, e.g. "special_fsd_heavy". Leading/trailing whitespace and case are ignored.

Returns

ExperimentalEffect | null

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

Throws

If experimentalEffectSymbol is present and not a string. A nullish experimentalEffectSymbol 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', ... }, ...]