Cosmos Journeyer API Documentation - v1.10.1
    Preparing search index...
    Index

    Properties

    completedMissions: Mission[] = []
    creationDate: Date
    currentItinerary: {
        localX: number;
        localY: number;
        localZ: number;
        starSectorX: number;
        starSectorY: number;
        starSectorZ: number;
    }[]

    Type declaration

    • 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

    currentMissions: Mission[] = []
    discoveries: {
        local: {
            discoveryTimestamp: number;
            explorerName: string;
            objectId: {
                idInSystem: string;
                systemCoordinates: {
                    localX: number;
                    localY: number;
                    localZ: number;
                    starSectorX: number;
                    starSectorY: number;
                    starSectorZ: number;
                };
            };
        }[];
        uploaded: {
            discoveryTimestamp: number;
            explorerName: string;
            objectId: {
                idInSystem: string;
                systemCoordinates: {
                    localX: number;
                    localY: number;
                    localZ: number;
                    starSectorX: number;
                    starSectorY: number;
                    starSectorZ: number;
                };
            };
        }[];
    }
    instancedSpaceships: Spaceship[] = []
    onBalanceChangedObservable: Observable<number> = ...
    onNameChangedObservable: Observable<string> = ...
    serializedSpaceships: {
        components: {
            optional: [
                | null
                | { quality: number; size: number; type: "discoveryScanner" }
                | { quality: number; size: number; type: "fuelScoop" }
                | {
                    currentFuel01: number;
                    quality: number;
                    size: number;
                    type: "fuelTank";
                },
                | null
                | { quality: number; size: number; type: "discoveryScanner" }
                | { quality: number; size: number; type: "fuelScoop" }
                | {
                    currentFuel01: number;
                    quality: number;
                    size: number;
                    type: "fuelTank";
                },
                | null
                | { quality: number; size: number; type: "discoveryScanner" }
                | { quality: number; size: number; type: "fuelScoop" }
                | {
                    currentFuel01: number;
                    quality: number;
                    size: number;
                    type: "fuelTank";
                },
            ];
            primary: {
                fuelTank: | null
                | {
                    currentFuel01: number;
                    quality: number;
                    size: number;
                    type: "fuelTank";
                };
                thrusters: null
                | { quality: number; size: number; type: "thrusters" };
                warpDrive: null | { quality: number; size: number; type: "warpDrive" };
            };
        };
        id: string;
        name: string;
        type: WANDERER;
    }[] = []
    spareSpaceshipComponents: Set<
        | { quality: number; size: number; type: "discoveryScanner" }
        | { quality: number; size: number; type: "fuelScoop" }
        | {
            currentFuel01: number;
            quality: number;
            size: number;
            type: "fuelTank";
        }
        | { quality: number; size: number; type: "thrusters" }
        | { quality: number; size: number; type: "warpDrive" },
    >
    systemBookmarks: {
        localX: number;
        localY: number;
        localZ: number;
        starSectorX: number;
        starSectorY: number;
        starSectorZ: number;
    }[]

    Type declaration

    • 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

    timePlayedSeconds: number
    tutorials: {
        flightCompleted: boolean;
        fuelScoopingCompleted: boolean;
        starMapCompleted: boolean;
        stationLandingCompleted: boolean;
    }
    uuid: string
    visitedSystemHistory: {
        localX: number;
        localY: number;
        localZ: number;
        starSectorX: number;
        starSectorY: number;
        starSectorZ: number;
    }[] = []

    Type declaration

    • 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

    DEFAULT_BALANCE: number = 10_000
    DEFAULT_NAME: string = "Python"

    Methods

    • Adds the given object to the list of visited objects if it is not already in the list.

      Parameters

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

        The object to add to the list of visited objects.

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

      True if the object was added, false if it was already in the list.

    • Returns true if the player has visited the given object, false otherwise.

      Parameters

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

        The object to check if the player has visited it.

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

      True if the player has visited the object, false otherwise.

    • Parameters

      • serializedPlayer: {
            balance: number;
            completedMissions: {
                missionGiver: {
                    idInSystem: string;
                    systemCoordinates: {
                        localX: number;
                        localY: number;
                        localZ: number;
                        starSectorX: number;
                        starSectorY: number;
                        starSectorZ: number;
                    };
                };
                reward: number;
                tree: MissionNodeSerializedShape;
                type: MissionType;
            }[];
            creationDate: string;
            currentItinerary: {
                localX: number;
                localY: number;
                localZ: number;
                starSectorX: number;
                starSectorY: number;
                starSectorZ: number;
            }[];
            currentMissions: {
                missionGiver: {
                    idInSystem: string;
                    systemCoordinates: {
                        localX: number;
                        localY: number;
                        localZ: number;
                        starSectorX: number;
                        starSectorY: number;
                        starSectorZ: number;
                    };
                };
                reward: number;
                tree: MissionNodeSerializedShape;
                type: MissionType;
            }[];
            discoveries: {
                local: {
                    discoveryTimestamp: number;
                    explorerName: string;
                    objectId: {
                        idInSystem: string;
                        systemCoordinates: {
                            localX: number;
                            localY: number;
                            localZ: number;
                            starSectorX: number;
                            starSectorY: number;
                            starSectorZ: number;
                        };
                    };
                }[];
                uploaded: {
                    discoveryTimestamp: number;
                    explorerName: string;
                    objectId: {
                        idInSystem: string;
                        systemCoordinates: {
                            localX: number;
                            localY: number;
                            localZ: number;
                            starSectorX: number;
                            starSectorY: number;
                            starSectorZ: number;
                        };
                    };
                }[];
            };
            name: string;
            spaceShips: {
                components: {
                    optional: [
                        | null
                        | { quality: number; size: number; type: "discoveryScanner" }
                        | { quality: number; size: number; type: "fuelScoop" }
                        | {
                            currentFuel01: number;
                            quality: number;
                            size: number;
                            type: "fuelTank";
                        },
                        | null
                        | { quality: number; size: number; type: "discoveryScanner" }
                        | { quality: number; size: number; type: "fuelScoop" }
                        | {
                            currentFuel01: number;
                            quality: number;
                            size: number;
                            type: "fuelTank";
                        },
                        | null
                        | { quality: number; size: number; type: "discoveryScanner" }
                        | { quality: number; size: number; type: "fuelScoop" }
                        | {
                            currentFuel01: number;
                            quality: number;
                            size: number;
                            type: "fuelTank";
                        },
                    ];
                    primary: {
                        fuelTank: | null
                        | {
                            currentFuel01: number;
                            quality: number;
                            size: number;
                            type: "fuelTank";
                        };
                        thrusters: null
                        | { quality: number; size: number; type: "thrusters" };
                        warpDrive: null | { quality: number; size: number; type: "warpDrive" };
                    };
                };
                id: string;
                name: string;
                type: WANDERER;
            }[];
            spareSpaceshipComponents: (
                | { quality: number; size: number; type: "discoveryScanner" }
                | { quality: number; size: number; type: "fuelScoop" }
                | {
                    currentFuel01: number;
                    quality: number;
                    size: number;
                    type: "fuelTank";
                }
                | { quality: number; size: number; type: "thrusters" }
                | { quality: number; size: number; type: "warpDrive" }
            )[];
            systemBookmarks: {
                localX: number;
                localY: number;
                localZ: number;
                starSectorX: number;
                starSectorY: number;
                starSectorZ: number;
            }[];
            timePlayedSeconds: number;
            tutorials: {
                flightCompleted: boolean;
                fuelScoopingCompleted: boolean;
                starMapCompleted: boolean;
                stationLandingCompleted: boolean;
            };
            uuid: string;
            visitedSystemHistory: {
                localX: number;
                localY: number;
                localZ: number;
                starSectorX: number;
                starSectorY: number;
                starSectorZ: number;
            }[];
        }
      • starSystemDatabase: StarSystemDatabase

      Returns Player

    • Parameters

      Returns {
          balance: number;
          completedMissions: {
              missionGiver: {
                  idInSystem: string;
                  systemCoordinates: {
                      localX: number;
                      localY: number;
                      localZ: number;
                      starSectorX: number;
                      starSectorY: number;
                      starSectorZ: number;
                  };
              };
              reward: number;
              tree: MissionNodeSerializedShape;
              type: MissionType;
          }[];
          creationDate: string;
          currentItinerary: {
              localX: number;
              localY: number;
              localZ: number;
              starSectorX: number;
              starSectorY: number;
              starSectorZ: number;
          }[];
          currentMissions: {
              missionGiver: {
                  idInSystem: string;
                  systemCoordinates: {
                      localX: number;
                      localY: number;
                      localZ: number;
                      starSectorX: number;
                      starSectorY: number;
                      starSectorZ: number;
                  };
              };
              reward: number;
              tree: MissionNodeSerializedShape;
              type: MissionType;
          }[];
          discoveries: {
              local: {
                  discoveryTimestamp: number;
                  explorerName: string;
                  objectId: {
                      idInSystem: string;
                      systemCoordinates: {
                          localX: number;
                          localY: number;
                          localZ: number;
                          starSectorX: number;
                          starSectorY: number;
                          starSectorZ: number;
                      };
                  };
              }[];
              uploaded: {
                  discoveryTimestamp: number;
                  explorerName: string;
                  objectId: {
                      idInSystem: string;
                      systemCoordinates: {
                          localX: number;
                          localY: number;
                          localZ: number;
                          starSectorX: number;
                          starSectorY: number;
                          starSectorZ: number;
                      };
                  };
              }[];
          };
          name: string;
          spaceShips: {
              components: {
                  optional: [
                      | null
                      | { quality: number; size: number; type: "discoveryScanner" }
                      | { quality: number; size: number; type: "fuelScoop" }
                      | {
                          currentFuel01: number;
                          quality: number;
                          size: number;
                          type: "fuelTank";
                      },
                      | null
                      | { quality: number; size: number; type: "discoveryScanner" }
                      | { quality: number; size: number; type: "fuelScoop" }
                      | {
                          currentFuel01: number;
                          quality: number;
                          size: number;
                          type: "fuelTank";
                      },
                      | null
                      | { quality: number; size: number; type: "discoveryScanner" }
                      | { quality: number; size: number; type: "fuelScoop" }
                      | {
                          currentFuel01: number;
                          quality: number;
                          size: number;
                          type: "fuelTank";
                      },
                  ];
                  primary: {
                      fuelTank: | null
                      | {
                          currentFuel01: number;
                          quality: number;
                          size: number;
                          type: "fuelTank";
                      };
                      thrusters: null
                      | { quality: number; size: number; type: "thrusters" };
                      warpDrive: null | { quality: number; size: number; type: "warpDrive" };
                  };
              };
              id: string;
              name: string;
              type: WANDERER;
          }[];
          spareSpaceshipComponents: (
              | { quality: number; size: number; type: "discoveryScanner" }
              | { quality: number; size: number; type: "fuelScoop" }
              | {
                  currentFuel01: number;
                  quality: number;
                  size: number;
                  type: "fuelTank";
              }
              | { quality: number; size: number; type: "thrusters" }
              | { quality: number; size: number; type: "warpDrive" }
          )[];
          systemBookmarks: {
              localX: number;
              localY: number;
              localZ: number;
              starSectorX: number;
              starSectorY: number;
              starSectorZ: number;
          }[];
          timePlayedSeconds: number;
          tutorials: {
              flightCompleted: boolean;
              fuelScoopingCompleted: boolean;
              starMapCompleted: boolean;
              stationLandingCompleted: boolean;
          };
          uuid: string;
          visitedSystemHistory: {
              localX: number;
              localY: number;
              localZ: number;
              starSectorX: number;
              starSectorY: number;
              starSectorZ: number;
          }[];
      }