i18n.Function.getExperimentalEffectName

@elite-dangerous-almanac/core / i18n / getExperimentalEffectName

Function: getExperimentalEffectName()

getExperimentalEffectName(experimentalEffectSymbol, locale): string | null

Defined in: src/i18n/experimental-effects.ts:41

Look up an engineering experimental effect's source-backed display name for a locale.

Parameters

experimentalEffectSymbol

string

Frontier's experimental-effect id, such as "special_concordant_sequence". Matching ignores case and surrounding whitespace.

locale

string

A BCP 47 language or regional tag, such as "de", "de-DE" or "en-GB". Matching is case-insensitive; underscores are accepted in place of hyphens. A regional tag falls back to its language after an exact-locale miss.

Returns

string | null

The localized effect name; the canonical ExperimentalEffect.name for any English tag; or null when the id is unknown, the locale is unsupported, or the pinned source carries no value for that effect and locale.

Remarks

This function bundles names only, not modifier mechanics or material costs. Missing translations never silently fall back to English.

Throws

If experimentalEffectSymbol is present and not a string, or locale is not a string. A nullish experimentalEffectSymbol is a lookup miss and returns null.

Example

import { getExperimentalEffectName } from '@elite-dangerous-almanac/core/i18n/experimental-effects';

getExperimentalEffectName('special_concordant_sequence', 'de');
// -> 'Konkordante Sequenz'
getExperimentalEffectName('special_concordant_sequence', 'ja-JP'); // -> null