Interface EncyclopaediaGalactica

Database holding all the exploration data gathered by players.

interface EncyclopaediaGalactica {
    contributeDiscoveryIfNew(data: SpaceDiscoveryData): Promise<boolean>;
    estimateDiscovery(object: UniverseObjectId): Promise<number>;
    getBackendString(): string;
    hasObjectBeenDiscovered(objectId: UniverseObjectId): Promise<boolean>;
}

Implemented by

EncyclopaediaGalacticaManager

Index

Methods

contributeDiscoveryIfNew estimateDiscovery getBackendString hasObjectBeenDiscovered

Methods

contributeDiscoveryIfNew

contributeDiscoveryIfNew(data: SpaceDiscoveryData): Promise<boolean>
Tries to add a new astronomical object to the database under the given explorer name.
Parameters
- data: SpaceDiscoveryData
  The space exploration data to add.
Returns Promise<boolean>
True if the object was added, false if it was already present.
- Defined in society/encyclopaediaGalactica.ts:46

estimateDiscovery

estimateDiscovery(object: UniverseObjectId): Promise<number>
Estimates the value of an astronomical object given the current encyclopaedia data.
Parameters
- object: UniverseObjectId
  The object to evaluate.
Returns Promise<number>
The estimated value of the object in credits.
- Defined in society/encyclopaediaGalactica.ts:60

getBackendString

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

Returns string
- Defined in society/encyclopaediaGalactica.ts:65

hasObjectBeenDiscovered

hasObjectBeenDiscovered(objectId: UniverseObjectId): Promise<boolean>
Finds out if an object has already been discovered.
Parameters
- objectId: UniverseObjectId
  The ID of the object to check.
Returns Promise<boolean>
True if the object has been discovered, false otherwise.
- Defined in society/encyclopaediaGalactica.ts:53