i18n.Function.getMaterialName

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

Function: getMaterialName()

getMaterialName(symbol, locale): string | null

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

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" or "de-DE"; see GameLocale for how a tag is matched.

Returns

string | null

The localized material name; the canonical Material.name for any English tag; or null when the symbol is unknown or the locale is not one of the six this catalogue stores.

Remarks

All six stored locales are complete for this dataset, so a supported locale always answers. This function bundles names only, not material grades, categories or engineering costs. 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'); // -> 'Vanadium'
getMaterialName('vanadium', 'it'); // -> null