DotNet.Astronomy.Class.SectorName

EliteDangerousAlmanac / Astronomy / SectorName

Class: SectorName

Defined in: dotnet/src/EliteDangerousAlmanac/Astronomy/SectorName.cs:38

The names the game gives the sectors it does not name by hand.

Remarks

Most of the galaxy carries no hand-written sector name. The game builds one from the sector's own place on the grid, under one of two schemes that a hash of the place picks between. One scheme writes a single run-together word such as Synuefe. The other writes two words such as Blae Eock.

FromGridPosition is the forward reading and ToGridPosition is its inverse. Both are pure, and the tables behind them are built once.

The algorithm is the EDTS reference one. See ATTRIBUTIONS.md for credit and licence terms.

Methods

Canonicalize()

static Canonicalize(name): string?

Defined in: dotnet/src/EliteDangerousAlmanac/Astronomy/SectorName.cs:104

Writes a procedural sector name in its own casing.

Parameters

name

string?

The name in any casing, with any surrounding whitespace.

Returns

string?

The name as the game writes it, such as Blae Eock for blae eock, or null where the name is not a procedural sector name.

FromGridPosition()

static FromGridPosition(position): string

Defined in: dotnet/src/EliteDangerousAlmanac/Astronomy/SectorName.cs:50

Reads the procedural name of one sector.

Parameters

position

SectorGridPosition

The sector's place on the grid.

Returns

string

The name in its own casing, such as Synuefe or Blae Eock.

Exceptions

ArgumentNullException

The position is absent.

ArgumentOutOfRangeException

An axis is outside zero through 127, or the generator gives that place no name.

ToGridPosition()

static ToGridPosition(name): SectorGridPosition?

Defined in: dotnet/src/EliteDangerousAlmanac/Astronomy/SectorName.cs:73

Reads the grid position one procedural sector name states.

Parameters

name

string?

The name in any casing, with any surrounding whitespace.

Returns

SectorGridPosition?

The sector's place on the grid, or null where the name is not a procedural sector name. An absent name is a miss, answered the way an unknown one is.

Remarks

Word parts overlap, so more than one reading of a name is possible. Only the reading that writes the name back out again is taken.