i18n.Function.getSuitDescription

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

Function: 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.

Parameters

suit

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.

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 suit is unknown or the requested locale is not one this catalogue stores.

Remarks

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.

Throws

If a present suit or locale is not a string.

Example

import { getSuitDescription } from '@elite-dangerous-almanac/core/i18n/suits';

getSuitDescription('flightsuit', 'en')?.startsWith('Remlok'); // -> true
getSuitDescription('flightsuit', 'ja'); // -> null