i18n.Function.getPersonalModificationDescription

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

Function: getPersonalModificationDescription()

getPersonalModificationDescription(modificationSymbol, locale): string | null

Defined in: src/i18n/personal-modifications.ts:93

Look up an engineer-applied personal-equipment modification's display description — the prose the game shows a player, in all six stored locales.

Parameters

modificationSymbol

string

The recipe symbol PERSONAL_MODIFICATIONS is keyed by, exactly as getPersonalModificationName accepts. Matching ignores case and surrounding whitespace.

locale

string

A BCP 47 locale. All six stored locales are complete for this dataset.

Returns

string | null

The localized description, or null when the recipe is unknown or the requested locale is not one this catalogue stores.

Remarks

This is display prose, not a statement of the magnitudes a recipe applies: the game says a modification "allows more ammo to be carried for each weapon", never how much more. PersonalModification.modifiers answers that, and the two are deliberately not the same string. It is also the only account of the recipes whose modifiers list is empty, whether because the recipe switches a capability on or because it moves a stat the panel puts no number on. English is the game's own wording rather than a projection of PersonalModification.name.

Throws

If a present modificationSymbol or locale is not a string.

Example

import { getPersonalModificationDescription } from '@elite-dangerous-almanac/core/i18n/personal-modifications';

getPersonalModificationDescription('suit_nightvision', 'en');
// -> 'Adds Night Vision capabilities to the suit.'
getPersonalModificationDescription('suit_nightvision', 'ja'); // -> null