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

constructor

new StarSystemDatabase(fallbackSystem: StarSystemModel): StarSystemDatabase
Parameters
- fallbackSystem: StarSystemModel
Returns StarSystemDatabase
- Defined in src/ts/backend/universe/starSystemDatabase.ts:84

Properties

`Readonly`fallbackSystem

fallbackSystem: DeepReadonly<StarSystemModel>

Fallback system that is guaranteed to exist This can be useful for default mechanisms relying on finding a system in the database if nothing is found

Methods

getObjectModelByUniverseId

getObjectModelByUniverseId(
    universeObjectId: {
        idInSystem: string;
        systemCoordinates: {
            localX: number;
            localY: number;
            localZ: number;
            starSectorX: number;
            starSectorY: number;
            starSectorZ: number;
        };
    },
): null
| DeepReadonly<OrbitalObjectModel>
Searches the database for the given id
Parameters
- universeObjectId: {
      idInSystem: string;
      systemCoordinates: {
          localX: number;
          localY: number;
          localZ: number;
          starSectorX: number;
          starSectorY: number;
          starSectorZ: number;
      };
  }
  The id to look for
  - idInSystem: string
  - systemCoordinates: {
        localX: number;
        localY: number;
        localZ: number;
        starSectorX: number;
        starSectorY: number;
        starSectorZ: number;
    }
    The coordinates of the star system.
    
    localX: number
    Floating point X coordinate of the star system inside the star sector. Must be between -0.5 and 0.5.
    
    localY: number
    Floating point Y coordinate of the star system inside the star sector. Must be between -0.5 and 0.5.
    
    localZ: number
    Floating point Z coordinate of the star system inside the star sector. Must be between -0.5 and 0.5.
    
    starSectorX: number
    Integer coordinates of the star sector along the universe X axis
    
    starSectorY: number
    Integer coordinates of the star sector along the universe Y axis
    
    starSectorZ: number
    Integer coordinates of the star sector along the universe Z axis
Returns null | DeepReadonly<OrbitalObjectModel>
The model if it exists, null otherwise
- Defined in src/ts/backend/universe/starSystemDatabase.ts:456

getSystemCoordinatesFromSeed

getSystemCoordinatesFromSeed(
    starSectorX: number,
    starSectorY: number,
    starSectorZ: number,
    index: number,
): {
    localX: number;
    localY: number;
    localZ: number;
    starSectorX: number;
    starSectorY: number;
    starSectorZ: number;
}
Parameters
- starSectorX: number
- starSectorY: number
- starSectorZ: number
- index: number
  The index of the generated system in the star sector.
Returns {
    localX: number;
    localY: number;
    localZ: number;
    starSectorX: number;
    starSectorY: number;
    starSectorZ: number;
}
The system coordinates of the system generated given the seed.
- localX: number
  Floating point X coordinate of the star system inside the star sector. Must be between -0.5 and 0.5.
- localY: number
  Floating point Y coordinate of the star system inside the star sector. Must be between -0.5 and 0.5.
- localZ: number
  Floating point Z coordinate of the star system inside the star sector. Must be between -0.5 and 0.5.
- starSectorX: number
  Integer coordinates of the star sector along the universe X axis
- starSectorY: number
  Integer coordinates of the star sector along the universe Y axis
- starSectorZ: number
  Integer coordinates of the star sector along the universe Z axis
- Defined in src/ts/backend/universe/starSystemDatabase.ts:318

getSystemCoordinatesInStarSector

getSystemCoordinatesInStarSector(
    sectorX: number,
    sectorY: number,
    sectorZ: number,
): readonly DeepReadonly<
    {
        localX: number;
        localY: number;
        localZ: number;
        starSectorX: number;
        starSectorY: number;
        starSectorZ: number;
    },
>[]
Parameters
- sectorX: number
- sectorY: number
- sectorZ: number
Returns readonly DeepReadonly<
    {
        localX: number;
        localY: number;
        localZ: number;
        starSectorX: number;
        starSectorY: number;
        starSectorZ: number;
    },
>[]
The coordinates of the systems in the given star sector.
- Defined in src/ts/backend/universe/starSystemDatabase.ts:247

getSystemGalacticPosition

getSystemGalacticPosition(
    coordinates: {
        localX: number;
        localY: number;
        localZ: number;
        starSectorX: number;
        starSectorY: number;
        starSectorZ: number;
    },
): Vector3
Parameters
- coordinates: {
      localX: number;
      localY: number;
      localZ: number;
      starSectorX: number;
      starSectorY: number;
      starSectorZ: number;
  }
  The coordinates of the system you want the position of.
  - localX: number
    Floating point X coordinate of the star system inside the star sector. Must be between -0.5 and 0.5.
  - localY: number
    Floating point Y coordinate of the star system inside the star sector. Must be between -0.5 and 0.5.
  - localZ: number
    Floating point Z coordinate of the star system inside the star sector. Must be between -0.5 and 0.5.
  - starSectorX: number
    Integer coordinates of the star sector along the universe X axis
  - starSectorY: number
    Integer coordinates of the star sector along the universe Y axis
  - starSectorZ: number
    Integer coordinates of the star sector along the universe Z axis
Returns Vector3
The position of the given system in the galaxy.
- Defined in src/ts/backend/universe/starSystemDatabase.ts:358

getSystemModelFromCoordinates

getSystemModelFromCoordinates(
    coordinates: {
        localX: number;
        localY: number;
        localZ: number;
        starSectorX: number;
        starSectorY: number;
        starSectorZ: number;
    },
): null
| DeepReadonly<StarSystemModel>
Parameters
- coordinates: {
      localX: number;
      localY: number;
      localZ: number;
      starSectorX: number;
      starSectorY: number;
      starSectorZ: number;
  }
  The coordinates of the system you want the model of.
  - localX: number
    Floating point X coordinate of the star system inside the star sector. Must be between -0.5 and 0.5.
  - localY: number
    Floating point Y coordinate of the star system inside the star sector. Must be between -0.5 and 0.5.
  - localZ: number
    Floating point Z coordinate of the star system inside the star sector. Must be between -0.5 and 0.5.
  - starSectorX: number
    Integer coordinates of the star sector along the universe X axis
  - starSectorY: number
    Integer coordinates of the star sector along the universe Y axis
  - starSectorZ: number
    Integer coordinates of the star sector along the universe Z axis
Returns null | DeepReadonly<StarSystemModel>
The StarSystemModel for the given coordinates, or null if the system is not found.
- Defined in src/ts/backend/universe/starSystemDatabase.ts:187

getSystemModelFromSeed

getSystemModelFromSeed(
    starSectorX: number,
    starSectorY: number,
    starSectorZ: number,
    index: number,
): null | DeepReadonly<StarSystemModel>
Parameters
- starSectorX: number
- starSectorY: number
- starSectorZ: number
- index: number
  The index of the generated system in the star sector.
Returns null | DeepReadonly<StarSystemModel>
The system model of the system generated given the seed, or null if the system is not found.
- Defined in src/ts/backend/universe/starSystemDatabase.ts:349

getSystemModelsInStarSector

getSystemModelsInStarSector(
    sectorX: number,
    sectorY: number,
    sectorZ: number,
): readonly DeepReadonly<StarSystemModel>[]
Parameters
- sectorX: number
- sectorY: number
- sectorZ: number
Returns readonly DeepReadonly<StarSystemModel>[]
All system models (custom and generated) in the given star sector.
- Defined in src/ts/backend/universe/starSystemDatabase.ts:279

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 src/ts/backend/universe/starSystemDatabase.ts:440

isSystemInHumanBubble

isSystemInHumanBubble(
    systemCoordinates: {
        localX: number;
        localY: number;
        localZ: number;
        starSectorX: number;
        starSectorY: number;
        starSectorZ: number;
    },
): boolean
Check if a system is in the human bubble.
Parameters
- systemCoordinates: {
      localX: number;
      localY: number;
      localZ: number;
      starSectorX: number;
      starSectorY: number;
      starSectorZ: number;
  }
  The coordinates of the system to check.
  - localX: number
    Floating point X coordinate of the star system inside the star sector. Must be between -0.5 and 0.5.
  - localY: number
    Floating point Y coordinate of the star system inside the star sector. Must be between -0.5 and 0.5.
  - localZ: number
    Floating point Z coordinate of the star system inside the star sector. Must be between -0.5 and 0.5.
  - starSectorX: number
    Integer coordinates of the star sector along the universe X axis
  - starSectorY: number
    Integer coordinates of the star sector along the universe Y axis
  - starSectorZ: number
    Integer coordinates of the star sector along the universe Z axis
Returns boolean
true if the system is in the human bubble, false otherwise.
- Defined in src/ts/backend/universe/starSystemDatabase.ts:176

registerCustomSystem

registerCustomSystem(system: StarSystemModel): void
Adds the given system to the database
Parameters
- system: StarSystemModel
  The system to register
Returns void
- Defined in src/ts/backend/universe/starSystemDatabase.ts:112

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 src/ts/backend/universe/starSystemDatabase.ts:164

registerSinglePlugin

registerSinglePlugin(
    coordinates: {
        localX: number;
        localY: number;
        localZ: number;
        starSectorX: number;
        starSectorY: number;
        starSectorZ: number;
    },
    plugin: (systemModel: StarSystemModel) => StarSystemModel,
): void
Register a plugin that modifies a single system.
Parameters
- coordinates: {
      localX: number;
      localY: number;
      localZ: number;
      starSectorX: number;
      starSectorY: number;
      starSectorZ: number;
  }
  The coordinates of the system to modify.
  - localX: number
    Floating point X coordinate of the star system inside the star sector. Must be between -0.5 and 0.5.
  - localY: number
    Floating point Y coordinate of the star system inside the star sector. Must be between -0.5 and 0.5.
  - localZ: number
    Floating point Z coordinate of the star system inside the star sector. Must be between -0.5 and 0.5.
  - starSectorX: number
    Integer coordinates of the star sector along the universe X axis
  - starSectorY: number
    Integer coordinates of the star sector along the universe Y axis
  - starSectorZ: number
    Integer coordinates of the star sector along the universe Z axis
- plugin: (systemModel: StarSystemModel) => StarSystemModel
  The plugin to apply to the system.
Returns void
- Defined in src/ts/backend/universe/starSystemDatabase.ts:152

Class StarSystemDatabase

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns StarSystemDatabase

Properties

ReadonlyfallbackSystem

Methods

getObjectModelByUniverseId

Parameters

idInSystem: string

systemCoordinates: { localX: number; localY: number; localZ: number; starSectorX: number; starSectorY: number; starSectorZ: number;}

localX: number

localY: number

localZ: number

starSectorX: number

starSectorY: number

starSectorZ: number

Returns null | DeepReadonly<OrbitalObjectModel>

getSystemCoordinatesFromSeed

Parameters

Returns { localX: number; localY: number; localZ: number; starSectorX: number; starSectorY: number; starSectorZ: number;}

localX: number

localY: number

localZ: number

starSectorX: number

starSectorY: number

starSectorZ: number

getSystemCoordinatesInStarSector

Parameters

Returns readonly DeepReadonly< { localX: number; localY: number; localZ: number; starSectorX: number; starSectorY: number; starSectorZ: number; },>[]

getSystemGalacticPosition

Parameters

localX: number

localY: number

localZ: number

starSectorX: number

starSectorY: number

starSectorZ: number

Returns Vector3

getSystemModelFromCoordinates

Parameters

localX: number

localY: number

localZ: number

starSectorX: number

starSectorY: number

starSectorZ: number

Returns null | DeepReadonly<StarSystemModel>

getSystemModelFromSeed

Parameters

Returns null | DeepReadonly<StarSystemModel>

getSystemModelsInStarSector

Parameters

Returns readonly DeepReadonly<StarSystemModel>[]

getSystemPositionsInStarSector

Parameters

Returns Vector3[]

isSystemInHumanBubble

Parameters

localX: number

localY: number

localZ: number

starSectorX: number

starSectorY: number

starSectorZ: number

Returns boolean

registerCustomSystem

Parameters

Returns void

registerGeneralPlugin

Parameters

Returns void

registerSinglePlugin

Parameters

localX: number

`Readonly`fallbackSystem

systemCoordinates: {
localX: number;
localY: number;
localZ: number;
starSectorX: number;
starSectorY: number;
starSectorZ: number;
}

Returns {
localX: number;
localY: number;
localZ: number;
starSectorX: number;
starSectorY: number;
starSectorZ: number;
}

Returns readonly DeepReadonly<
{
localX: number;
localY: number;
localZ: number;
starSectorX: number;
starSectorY: number;
starSectorZ: number;
},
>[]