i18n.Function.getMaterialName

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

Function: getMaterialName()

getMaterialName(symbol, locale): string | null

Defined in: src/i18n/materials.ts:40

Look up a ship engineering material's source-backed display name for a locale.

Parameters

symbol

string

Frontier's material symbol, such as "GridResistors". 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 or script subtag is dropped: every stored locale is a bare language tag.

Returns

string | null

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

Remarks

This function bundles names only, not material grades, categories or engineering costs. Missing translations never silently fall back to English. Odyssey micro resources use getMicroResourceName instead.

Throws

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

Example

import { getMaterialName } from '@elite-dangerous-almanac/core/i18n/materials';

getMaterialName('GridResistors', 'de-DE'); // -> 'Gitterwiderstände'
getMaterialName('vanadium', 'de'); // -> null