i18n.Function.getOutfittingFamilyName

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

Function: getOutfittingFamilyName()

getOutfittingFamilyName(familyId, locale): string | null

Defined in: src/i18n/module-families.ts:38

Look up an outfitting family's source-backed display name for a locale.

Parameters

familyId

string

The stable family id carried by OutfittingModuleIdentity.familyId, such as "shieldGenerators". Matching ignores case and surrounding whitespace.

locale

string

A BCP 47 language or regional tag, such as "de" or "de-DE"; see GameLocale for how a tag is matched.

Returns

string | null

The localized family name; the canonical OUTFITTING_FAMILIES name for any English tag; or null when the family is unknown, the locale is unsupported, or the pinned source carries no category label for that family and locale.

Remarks

Every module carries a family, so an outfitting list can group and label every choice ShipLoadout.modulesForSlot() returns from this lookup alone. The table bundles no module stats. Missing translations never silently fall back to English: a family the game does not name separately in its outfitting menu carries its canonical English alone, until a source publishes the other five locales.

Throws

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

Example

import { getOutfittingFamilyName } from '@elite-dangerous-almanac/core/i18n/module-families';

getOutfittingFamilyName('shieldGenerators', 'de-DE'); // -> 'Schildgeneratoren'
getOutfittingFamilyName('xenoScanners', 'de'); // -> null