DotNet.Astronomy.Class.NebulaCatalogue - Elite-Dangerous-Almanac/Almanac-Core GitHub Wiki

EliteDangerousAlmanac / Astronomy / NebulaCatalogue

Class: NebulaCatalogue

Defined in: dotnet/src/EliteDangerousAlmanac/Astronomy/Nebulae.cs:88

The nebula catalogues, and the searches that read them.

Remarks

The game models thousands of nebulae, in three classes. Real holds the real nebulae and dark regions a commander recognises, and it is the one most callers want. Planetary is by far the largest, and Procgen holds the ones the generator made. All is the three of them together.

Every search takes the catalogue to read. Nearly all of All is planetary nebulae that most callers never touch, so there is no one catalogue worth reading without being asked to.

Positions are light years with Sol at the origin, which is the frame a journal, EDSM and Spansh report. The catalogue comes from EDAstro. See ATTRIBUTIONS.md for credit and licence terms.

Properties

All

static All: IReadOnlyList<Nebula>

Defined in: dotnet/src/EliteDangerousAlmanac/Astronomy/Nebulae.cs:112

Every catalogued nebula: the real, the planetary and the generated ones.

Remarks

Read Nebula.Type to narrow it down afterwards.

Planetary

static Planetary: IReadOnlyList<Nebula>

Defined in: dotnet/src/EliteDangerousAlmanac/Astronomy/Nebulae.cs:105

Every planetary nebula, in order of name.

Procgen

static Procgen: IReadOnlyList<Nebula>

Defined in: dotnet/src/EliteDangerousAlmanac/Astronomy/Nebulae.cs:108

Every nebula the generator made, in order of name.

Real

static Real: IReadOnlyList<Nebula>

Defined in: dotnet/src/EliteDangerousAlmanac/Astronomy/Nebulae.cs:102

Every real nebula and dark region the game names, in order of name.

Methods

FindByName()

static FindByName(name, nebulae): Nebula?

Defined in: dotnet/src/EliteDangerousAlmanac/Astronomy/Nebulae.cs:204

Finds a nebula by name in one catalogue.

Parameters

name

string?

The name as the catalogue writes it. Any community name in brackets is part of it, so hand over the whole string.

nebulae

IReadOnlyList<Nebula>

The catalogue to read.

Returns

Nebula?

The nebula, or null where that catalogue holds no nebula of the name. Only the catalogue handed over is read, so a real nebula is not found among the planetary ones.

Remarks

Case and surrounding whitespace are ignored, and nothing else is.

Exceptions

ArgumentNullException

The catalogue is absent.

Nearest()

static Nearest(position, nebulae, count?): IReadOnlyList<NebulaNearby>

Defined in: dotnet/src/EliteDangerousAlmanac/Astronomy/Nebulae.cs:126

Reads the nebulae nearest one place, nearest first.

Parameters

position

GalacticPosition

The place to measure from, in light years, with Sol at the origin.

nebulae

IReadOnlyList<Nebula>

The catalogue to read.

count

int = 3

How many to answer with. A count of zero or below answers with none, and a count past the catalogue answers with the whole of it.

Returns

IReadOnlyList<NebulaNearby>

Up to count nebulae, in order of distance. Two at the same distance keep the order the catalogue holds them in. The catalogue is left alone.

Exceptions

ArgumentNullException

The place or the catalogue are absent.

Within()

static Within(position, nebulae, radiusLy): IReadOnlyList<NebulaNearby>

Defined in: dotnet/src/EliteDangerousAlmanac/Astronomy/Nebulae.cs:170

Reads every nebula within a distance of one place, nearest first.

Parameters

position

GalacticPosition

The place to measure from, in light years, with Sol at the origin.

nebulae

IReadOnlyList<Nebula>

The catalogue to read.

radiusLy

double

How far to reach, in light years, counting one exactly that far away. A distance below zero answers with none.

Returns

IReadOnlyList<NebulaNearby>

The nebulae that near, in order of distance. Two at the same distance keep the order the catalogue holds them in. The catalogue is left alone.

Exceptions

ArgumentNullException

The place or the catalogue are absent.

⚠️ **GitHub.com Fallback** ⚠️