DotNet.Localization.Class.DisplayText

EliteDangerousAlmanac / Localization / DisplayText

Class: DisplayText

Defined in: dotnet/src/EliteDangerousAlmanac/Localization/DisplayText.cs:30

Source-backed display names and descriptions for the outfitting, personal-equipment, engineering, material and market catalogues.

The display text this package builds rather than a source publishes.

Remarks

Every lookup takes the identifier its owning catalogue is keyed by — a Frontier symbol, or the library identifier where the game publishes none, as for a suit tool — and a BCP 47 tag. Case and surrounding whitespace are ignored on both.

English is complete. For a name it is the owning record's own name, and for a description it is the game's display prose, which no other catalogue publishes. Every other language is sparse: a lookup answers null where the pinned source carries no translation, which leaves the application in charge of its own fallback policy. Read GameLocale for how a tag is matched.

A catalogue loads from its shared data file on first use. Every record is immutable, so one caller cannot change another caller's answers.

A mount label, a slot name and a diagnostic message are English prose written here. A lookup answers one for an English tag alone and null otherwise, so an application never mistakes English for the language it asked for. The stable codes beside a diagnostic stay readable whatever the tag, for an application that supplies a message catalogue of its own.

Methods

BlueprintName()

static BlueprintName(blueprintSymbol, locale): string?

Defined in: dotnet/src/EliteDangerousAlmanac/Localization/DisplayText.cs:113

Reads an engineering blueprint's display name.

Parameters

blueprintSymbol

string?

The blueprint symbol, such as FSD_LongRange.

locale

string?

A BCP 47 tag.

Returns

string?

The name, or null for a miss.

CalculationIssueMessage()

static CalculationIssueMessage(issue, locale): string?

Defined in: dotnet/src/EliteDangerousAlmanac/Localization/DisplayText.Diagnostics.cs:121

Reads a calculation finding's message.

Parameters

issue

CalculationIssue

The finding.

locale

string?

A BCP 47 tag.

Returns

string?

The message, or null for a tag that is not English.

Exceptions

ArgumentNullException

The finding is absent.

CodexRegionName()

static CodexRegionName(regionId, locale): string?

Defined in: dotnet/src/EliteDangerousAlmanac/Localization/DisplayText.cs:163

Reads a galactic codex region's display name.

Parameters

regionId

int

The region identifier, 1 to 42, as Astronomy.CodexRegion.Id carries it. Region 0 means "outside the mapped region grid" and has no name.

locale

string?

A BCP 47 tag, such as de or de-DE.

Returns

string?

The name, or null where the identifier is outside 1 to 42 or the catalogue carries no such language.

Remarks

The catalogue is keyed by the region identifier, not by the English name, because the identifier is the region's stable identity and the name is the value being translated.

Every stored language is complete, so a language it carries always answers. The game leaves many regions untranslated in some languages, and spells Izanami, Temple, Mare Somnia, Xibalba and Tenebrae alike in all six. Those source values are stored verbatim rather than read as a missing translation.

CommodityName()

static CommodityName(symbol, locale): string?

Defined in: dotnet/src/EliteDangerousAlmanac/Localization/DisplayText.cs:137

Reads a market commodity's display name.

Parameters

symbol

string?

The commodity symbol, such as Gold.

locale

string?

A BCP 47 tag.

Returns

string?

The name, or null for a miss.

ExperimentalEffectDescription()

static ExperimentalEffectDescription(effectSymbol, locale): string?

Defined in: dotnet/src/EliteDangerousAlmanac/Localization/DisplayText.cs:130

Reads an experimental effect's description.

Parameters

effectSymbol

string?

The effect symbol.

locale

string?

A BCP 47 tag.

Returns

string?

The game's own display prose, or null for a miss. No other catalogue publishes it, English included.

ExperimentalEffectName()

static ExperimentalEffectName(effectSymbol, locale): string?

Defined in: dotnet/src/EliteDangerousAlmanac/Localization/DisplayText.cs:120

Reads an experimental effect's display name.

Parameters

effectSymbol

string?

The effect symbol, such as Weapon_Overload.

locale

string?

A BCP 47 tag.

Returns

string?

The name, or null for a miss.

LoadoutEditErrorMessage()

static LoadoutEditErrorMessage(error, locale): string?

Defined in: dotnet/src/EliteDangerousAlmanac/Localization/DisplayText.Diagnostics.cs:143

Reads a refused edit's message.

Parameters

error

LoadoutEditException

The refusal.

locale

string?

A BCP 47 tag.

Returns

string?

The message, or null for a tag that is not English.

Exceptions

ArgumentNullException

The refusal is absent.

LoadoutIssueMessage()

static LoadoutIssueMessage(issue, locale): string?

Defined in: dotnet/src/EliteDangerousAlmanac/Localization/DisplayText.Diagnostics.cs:110

Reads a validation finding's message.

Parameters

issue

LoadoutIssue

The finding.

locale

string?

A BCP 47 tag.

Returns

string?

The message, or null for a tag that is not English.

Exceptions

ArgumentNullException

The finding is absent.

LoadoutSlotName()

static LoadoutSlotName(slot, locale): string?

Defined in: dotnet/src/EliteDangerousAlmanac/Localization/DisplayText.Diagnostics.cs:87

Reads a ship mount's label.

Parameters

slot

BuildSlot

The mount, as the hull states it.

locale

string?

A BCP 47 tag.

Returns

string?

The label, or null for a tag that is not English.

Exceptions

ArgumentNullException

The mount is absent.

MaterialName()

static MaterialName(symbol, locale): string?

Defined in: dotnet/src/EliteDangerousAlmanac/Localization/DisplayText.cs:173

Reads an engineering material's display name.

Parameters

symbol

string?

The material symbol, such as GridResistors.

locale

string?

A BCP 47 tag.

Returns

string?

The name, or null for a miss.

MicroResourceName()

static MicroResourceName(symbol, locale): string?

Defined in: dotnet/src/EliteDangerousAlmanac/Localization/DisplayText.cs:180

Reads an Odyssey micro-resource's display name.

Parameters

symbol

string?

The micro-resource symbol, such as graphene.

locale

string?

A BCP 47 tag.

Returns

string?

The name, or null for a miss.

ModuleName()

static ModuleName(symbol, locale): string?

Defined in: dotnet/src/EliteDangerousAlmanac/Localization/DisplayText.cs:92

Reads an outfitting module's display name.

Parameters

symbol

string?

Frontier's module symbol, such as Int_Hyperdrive_Size6_Class5.

locale

string?

A BCP 47 tag, such as de or de-DE.

Returns

string?

The name, or null where no module carries the symbol or the catalogue carries no such language.

Remarks

Every stored language is complete for this catalogue, so a language it carries always answers. This lookup reads the name table alone, and never the module stats.

OutfittingFamilyName()

static OutfittingFamilyName(familyId, locale): string?

Defined in: dotnet/src/EliteDangerousAlmanac/Localization/DisplayText.cs:106

Reads an outfitting family's display name.

Parameters

familyId

string?

The family identifier, such as shieldGenerators.

locale

string?

A BCP 47 tag.

Returns

string?

The name, or null where no family carries the identifier or the source publishes no label for it.

Remarks

This catalogue is the sparsest one: a family the game does not name separately in its outfitting menu has English alone.

PersonalModificationDescription()

static PersonalModificationDescription(modificationSymbol, locale): string?

Defined in: dotnet/src/EliteDangerousAlmanac/Localization/DisplayText.cs:225

Reads a personal modification's description.

Parameters

modificationSymbol

string?

The recipe symbol.

locale

string?

A BCP 47 tag.

Returns

string?

The game's own display prose, or null for a miss.

PersonalModificationName()

static PersonalModificationName(modificationSymbol, locale): string?

Defined in: dotnet/src/EliteDangerousAlmanac/Localization/DisplayText.cs:218

Reads a personal modification's display name.

Parameters

modificationSymbol

string?

The recipe symbol, such as weapon_scope.

locale

string?

A BCP 47 tag.

Returns

string?

The name, or null for a miss.

PersonalMountName()

static PersonalMountName(mount, locale): string?

Defined in: dotnet/src/EliteDangerousAlmanac/Localization/DisplayText.Diagnostics.cs:74

Reads a suit weapon mount's label.

Parameters

mount

PersonalMount

The mount.

locale

string?

A BCP 47 tag.

Returns

string?

The label, or null for a tag that is not English, or a mount no suit carries.

Exceptions

ArgumentNullException

The mount is absent.

PersonalToolName()

static PersonalToolName(id, locale): string?

Defined in: dotnet/src/EliteDangerousAlmanac/Localization/DisplayText.cs:204

Reads a suit tool's display name.

Parameters

id

string?

The tool identifier, such as energylink.

locale

string?

A BCP 47 tag.

Returns

string?

The name, or null for a miss.

PersonalWeaponDescription()

static PersonalWeaponDescription(symbol, locale): string?

Defined in: dotnet/src/EliteDangerousAlmanac/Localization/DisplayText.cs:211

Reads a personal weapon's description.

Parameters

symbol

string?

The weapon's item symbol.

locale

string?

A BCP 47 tag.

Returns

string?

The game's own display prose, or null for a miss.

PreEngineeredVariantName()

static PreEngineeredVariantName(variant, locale): string?

Defined in: dotnet/src/EliteDangerousAlmanac/Localization/DisplayText.Diagnostics.cs:51

Reads a pre-engineered variant's display name.

Parameters

variant

PreEngineeredVariant

The variant, which names the article the game sells.

locale

string?

A BCP 47 tag.

Returns

string?

The name, or null where no record carries the variant or the source publishes no spelling for the language.

Remarks

A variant is named by its whole identity rather than by its base module: one hull module carries several purchased articles, and each has a name of its own.

Exceptions

ArgumentNullException

The variant is absent.

SlefDiagnosticMessage()

static SlefDiagnosticMessage(diagnostic, locale): string?

Defined in: dotnet/src/EliteDangerousAlmanac/Localization/DisplayText.Diagnostics.cs:132

Reads an import diagnostic's message.

Parameters

diagnostic

SlefDiagnostic

The diagnostic.

locale

string?

A BCP 47 tag.

Returns

string?

The message, or null for a tag that is not English.

Exceptions

ArgumentNullException

The diagnostic is absent.

SlotRestrictionLabel()

static SlotRestrictionLabel(restriction, locale): string?

Defined in: dotnet/src/EliteDangerousAlmanac/Localization/DisplayText.Diagnostics.cs:100

Reads the label for what a restricted mount takes.

Parameters

restriction

SlotRestriction

The restriction the mount carries.

locale

string?

A BCP 47 tag.

Returns

string?

The label, or null for a tag that is not English, or a restriction this package carries no label for.

SuitDescription()

static SuitDescription(suit, locale): string?

Defined in: dotnet/src/EliteDangerousAlmanac/Localization/DisplayText.cs:197

Reads a personal suit's description.

Parameters

suit

string?

The suit family or a grade-specific item symbol.

locale

string?

A BCP 47 tag.

Returns

string?

The game's own display prose, or null for a miss.

SuitName()

static SuitName(suit, locale): string?

Defined in: dotnet/src/EliteDangerousAlmanac/Localization/DisplayText.cs:190

Reads a personal suit's display name.

Parameters

suit

string?

The suit family, such as utilitysuit, or a grade-specific item symbol.

locale

string?

A BCP 47 tag.

Returns

string?

The name, or null for a miss.

Remarks

A suit is named once for its family, so every grade answers alike.