Class EncyclopaediaGalacticaLocal

Database holding all the exploration data gathered by players.

Implements

EncyclopaediaGalactica

Index

Constructors

constructor

Methods

contributeDiscoveryIfNew estimateDiscovery getBackendString hasObjectBeenDiscovered reset

Constructors

constructor

new EncyclopaediaGalacticaLocal(
starSystemDatabase: StarSystemDatabase,
): EncyclopaediaGalacticaLocal
Parameters
- starSystemDatabase: StarSystemDatabase
Returns EncyclopaediaGalacticaLocal
- Defined in src/ts/backend/encyclopaedia/encyclopaediaGalacticaLocal.ts:26

Methods

contributeDiscoveryIfNew

contributeDiscoveryIfNew(
    data: {
        discoveryTimestamp: number;
        explorerName: string;
        objectId: {
            idInSystem: string;
            systemCoordinates: {
                localX: number;
                localY: number;
                localZ: number;
                starSectorX: number;
                starSectorY: number;
                starSectorZ: number;
            };
        };
    },
): Promise<boolean>
Tries to add a new astronomical object to the database under the given explorer name.
Parameters
- data: {
      discoveryTimestamp: number;
      explorerName: string;
      objectId: {
          idInSystem: string;
          systemCoordinates: {
              localX: number;
              localY: number;
              localZ: number;
              starSectorX: number;
              starSectorY: number;
              starSectorZ: number;
          };
      };
  }
  The space exploration data to add.
  - discoveryTimestamp: number
    The timestamp at which the object was discovered.
  - explorerName: string
    The name of the explorer who discovered the object.
  - objectId: {
        idInSystem: string;
        systemCoordinates: {
            localX: number;
            localY: number;
            localZ: number;
            starSectorX: number;
            starSectorY: number;
            starSectorZ: number;
        };
    }
    The ID of the object discovered.
    
    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 Promise<boolean>
True if the object was added, false if it was already present.
Implementation of EncyclopaediaGalactica.contributeDiscoveryIfNew
- Defined in src/ts/backend/encyclopaedia/encyclopaediaGalacticaLocal.ts:30

estimateDiscovery

estimateDiscovery(
    object: {
        idInSystem: string;
        systemCoordinates: {
            localX: number;
            localY: number;
            localZ: number;
            starSectorX: number;
            starSectorY: number;
            starSectorZ: number;
        };
    },
): Promise<Result<number, string>>
Estimates the value of an astronomical object given the current encyclopaedia data.
Parameters
- object: {
      idInSystem: string;
      systemCoordinates: {
          localX: number;
          localY: number;
          localZ: number;
          starSectorX: number;
          starSectorY: number;
          starSectorZ: number;
      };
  }
  The object to evaluate.
  - 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 Promise<Result<number, string>>
The estimated value of the object in credits.
Implementation of EncyclopaediaGalactica.estimateDiscovery
- Defined in src/ts/backend/encyclopaedia/encyclopaediaGalacticaLocal.ts:68

getBackendString

getBackendString(): string
Gets a human readable string for the encyclopaedia backend.

Returns string
Implementation of EncyclopaediaGalactica.getBackendString
- Defined in src/ts/backend/encyclopaedia/encyclopaediaGalacticaLocal.ts:125

hasObjectBeenDiscovered

hasObjectBeenDiscovered(
    objectId: {
        idInSystem: string;
        systemCoordinates: {
            localX: number;
            localY: number;
            localZ: number;
            starSectorX: number;
            starSectorY: number;
            starSectorZ: number;
        };
    },
): Promise<boolean>
Finds out if an object has already been discovered.
Parameters
- objectId: {
      idInSystem: string;
      systemCoordinates: {
          localX: number;
          localY: number;
          localZ: number;
          starSectorX: number;
          starSectorY: number;
          starSectorZ: number;
      };
  }
  The ID of the object to check.
  - 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 Promise<boolean>
True if the object has been discovered, false otherwise.
Implementation of EncyclopaediaGalactica.hasObjectBeenDiscovered
- Defined in src/ts/backend/encyclopaedia/encyclopaediaGalacticaLocal.ts:42

reset

reset(): void
Returns void
- Defined in src/ts/backend/encyclopaedia/encyclopaediaGalacticaLocal.ts:121

Class EncyclopaediaGalacticaLocal

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns EncyclopaediaGalacticaLocal

Methods

contributeDiscoveryIfNew

Parameters

discoveryTimestamp: number

explorerName: string

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

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 Promise<boolean>

estimateDiscovery

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 Promise<Result<number, string>>

getBackendString

Returns string

hasObjectBeenDiscovered

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 Promise<boolean>

reset

Returns void

Settings

On This Page

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

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

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

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