Class StarSystemDatabase

The StarSystemDatabase defines the content of the universe. It is responsible for generating star system models and system positions in the galaxy.

Index

Constructors

Methods

getSystemCoordinatesFromSeed getSystemCoordinatesInStarSector getSystemGalacticPosition getSystemModelFromCoordinates getSystemModelsInStarSector getSystemPositionsInStarSector isSystemInHumanBubble registerCustomSystem registerGeneralPlugin registerSinglePlugin

Constructors

constructor

new StarSystemDatabase(): StarSystemDatabase
Returns StarSystemDatabase
- Defined in starSystem/starSystemDatabase.ts:71

Methods

getSystemCoordinatesFromSeed

getSystemCoordinatesFromSeed(
    starSectorX: number,
    starSectorY: number,
    starSectorZ: number,
    index: number,
): StarSystemCoordinates
Parameters
- starSectorX: number
- starSectorY: number
- starSectorZ: number
- index: number
  The index of the generated system in the star sector.
Returns StarSystemCoordinates
The system coordinates of the system generated given the seed.
- Defined in starSystem/starSystemDatabase.ts:278

getSystemCoordinatesInStarSector

getSystemCoordinatesInStarSector(
    sectorX: number,
    sectorY: number,
    sectorZ: number,
): StarSystemCoordinates[]
Parameters
- sectorX: number
- sectorY: number
- sectorZ: number
Returns StarSystemCoordinates[]
The coordinates of the systems in the given star sector.
- Defined in starSystem/starSystemDatabase.ts:228

getSystemGalacticPosition

getSystemGalacticPosition(coordinates: StarSystemCoordinates): Vector3
Parameters
- coordinates: StarSystemCoordinates
  The coordinates of the system you want the position of.
Returns Vector3
The position of the given system in the galaxy.
- Defined in starSystem/starSystemDatabase.ts:306

getSystemModelFromCoordinates

getSystemModelFromCoordinates(
coordinates: StarSystemCoordinates,
): null | StarSystemModel
Parameters
- coordinates: StarSystemCoordinates
  The coordinates of the system you want the model of.
Returns null | StarSystemModel
The StarSystemModel for the given coordinates, or null if the system is not found.
- Defined in starSystem/starSystemDatabase.ts:172

getSystemModelsInStarSector

getSystemModelsInStarSector(
    sectorX: number,
    sectorY: number,
    sectorZ: number,
): StarSystemModel[]
Parameters
- sectorX: number
- sectorY: number
- sectorZ: number
Returns StarSystemModel[]
All system models (custom and generated) in the given star sector.
- Defined in starSystem/starSystemDatabase.ts:249

getSystemPositionsInStarSector

getSystemPositionsInStarSector(
    sectorX: number,
    sectorY: number,
    sectorZ: number,
): Vector3[]
Parameters
- sectorX: number
- sectorY: number
- sectorZ: number
Returns Vector3[]
The positions of all systems in the given star sector in galactic space.
- Defined in starSystem/starSystemDatabase.ts:374

isSystemInHumanBubble

isSystemInHumanBubble(systemCoordinates: StarSystemCoordinates): boolean
Check if a system is in the human bubble.
Parameters
- systemCoordinates: StarSystemCoordinates
  The coordinates of the system to check.
Returns boolean
true if the system is in the human bubble, false otherwise.
- Defined in starSystem/starSystemDatabase.ts:161

registerCustomSystem

registerCustomSystem(system: StarSystemModel): void
Adds the given system to the database
Parameters
- system: StarSystemModel
  The system to register
Returns void
- Defined in starSystem/starSystemDatabase.ts:97

registerGeneralPlugin

registerGeneralPlugin(
predicate: (systemModel: StarSystemModel) => boolean,
plugin: (systemModel: StarSystemModel) => StarSystemModel,
): void
Register a plugin that modifies multiple systems.
Parameters
- predicate: (systemModel: StarSystemModel) => boolean
  The predicate used to match systems.
- plugin: (systemModel: StarSystemModel) => StarSystemModel
  The plugin to apply to the matched systems.
Returns void
- Defined in starSystem/starSystemDatabase.ts:149

registerSinglePlugin

registerSinglePlugin(
coordinates: StarSystemCoordinates,
plugin: (systemModel: StarSystemModel) => StarSystemModel,
): void
Register a plugin that modifies a single system.
Parameters
- coordinates: StarSystemCoordinates
  The coordinates of the system to modify.
- plugin: (systemModel: StarSystemModel) => StarSystemModel
  The plugin to apply to the system.
Returns void
- Defined in starSystem/starSystemDatabase.ts:137