Logo FSBarV1_Archived

UnitLabels Module

Generated unit-label lookup table mapping each `BarData` unit internal name to a 1- or 2-character display code. Uniqueness is guaranteed per `(MovementShape, FactionId)` bucket — the rendered glyph's shape and stroke colour already distinguish factions and movement classes, so two units can share a label iff they differ in at least one of those two dimensions. Feature 028-unit-viz-language.

Functions and values

Function or value Description

BarDataVersion

Full Usage: BarDataVersion

Returns: string

`BarData` package version this table was generated against.

Returns: string

GeneratedAtUtc

Full Usage: GeneratedAtUtc

Returns: string

UTC ISO 8601 timestamp at which this table was generated.

Returns: string

Labels

Full Usage: Labels

Returns: Map<string, string>

Lookup: internal name → 1- or 2-character display code. Contract: unique within each (shape, faction) bucket; most entries are a single glyph, only the densest tails overflow to two characters.

Returns: Map<string, string>

lookupOrFallback internalName

Full Usage: lookupOrFallback internalName

Parameters:
    internalName : string

Returns: string

Returns the code for an internal name, or `"??"` if unknown.

internalName : string
Returns: string

tryLookup internalName

Full Usage: tryLookup internalName

Parameters:
    internalName : string

Returns: string option

Returns the code for an internal name, or `None` if unknown.

internalName : string
Returns: string option

Type something to start searching.