astro.Function.nebulaeWithin

@elite-dangerous-almanac/core / astro / nebulaeWithin

Function: nebulaeWithin()

nebulaeWithin(coords, nebulae, radiusLy): NebulaWithDistance[]

Defined in: src/astro/nebulae.ts:235

Every nebula within a radius of a point, nearest first.

Parameters

coords

GalacticPosition

The point to measure from, in light-years (Sol at origin).

nebulae

readonly Nebula[]

The catalogue to search (see nearestNebulae).

radiusLy

number

Search radius in light-years, inclusive of the boundary. Negative radii yield an empty array.

Returns

NebulaWithDistance[]

The matching nebulae sorted by ascending NebulaWithDistance.distanceLy. Ties keep catalogue order. The input array is not modified.

Example

import { nebulaeWithin } from '@elite-dangerous-almanac/core/astro/nebulae';
import { REAL_NEBULAE } from '@elite-dangerous-almanac/core/astro/nebulae-real';

// Real nebulae within 400 ly of Sol
nebulaeWithin({ x: 0, y: 0, z: 0 }, REAL_NEBULAE, 400).map((n) => n.name);
// -> [ 'Pleiades' ]