i18n.Function.getSuitDescription - Elite-Dangerous-Almanac/Almanac-Core GitHub Wiki
@elite-dangerous-almanac/core / i18n / getSuitDescription
getSuitDescription(
suit,locale):string|null
Defined in: src/i18n/suits.ts:81
Look up an Odyssey suit's display description — the prose the game shows a player, in all six stored locales.
string
Either the grade-independent family Suit.family carries or one grade's
Frontier symbol, exactly as getSuitName accepts. Matching ignores case and
surrounding whitespace.
string
A BCP 47 locale. All six stored locales are complete for this dataset.
string | null
The localized description, or null when the suit is unknown or the
requested locale is not one this catalogue stores.
This is display prose, not a statement of what the suit does: it names no shield
strength, no battery capacity and no resistance. Those are the stats
SUITS carries, and the two are deliberately not the same string. English is the
game's own wording here rather than a projection of Suit.name.
If a present suit or locale is not a string.
import { getSuitDescription } from '@elite-dangerous-almanac/core/i18n/suits';
getSuitDescription('flightsuit', 'en')?.startsWith('Remlok'); // -> true
getSuitDescription('flightsuit', 'ja'); // -> null