Cosmos Journeyer API Documentation - v1.10.1
    Preparing search index...
    • Parameters

      Returns Promise<
          Result<
              {
                  player: {
                      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;
                      }[];
                  };
                  playerLocation: | {
                      position: { x: number; y: number; z: number };
                      rotation: { w: number; x: number; y: number; z: number };
                      type: "relative";
                      universeObjectId: {
                          idInSystem: string;
                          systemCoordinates: {
                              localX: number;
                              localY: number;
                              localZ: number;
                              starSectorX: number;
                              starSectorY: number;
                              starSectorZ: number;
                          };
                      };
                  }
                  | {
                      type: "atStation";
                      universeObjectId: {
                          idInSystem: string;
                          systemCoordinates: {
                              localX: number;
                              localY: number;
                              localZ: number;
                              starSectorX: number;
                              starSectorY: number;
                              starSectorZ: number;
                          };
                      };
                  }
                  | {
                      latitude: number;
                      longitude: number;
                      type: "onSurface";
                      universeObjectId: {
                          idInSystem: string;
                          systemCoordinates: {
                              localX: number;
                              localY: number;
                              localZ: number;
                              starSectorX: number;
                              starSectorY: number;
                              starSectorZ: number;
                          };
                      };
                  }
                  | { shipId: string; type: "inSpaceship" };
                  shipLocations: Record<
                      string,
                      | {
                          position: { x: number; y: number; z: number };
                          rotation: { w: number; x: number; y: number; z: number };
                          type: "relative";
                          universeObjectId: {
                              idInSystem: string;
                              systemCoordinates: {
                                  localX: number;
                                  localY: number;
                                  localZ: number;
                                  starSectorX: number;
                                  starSectorY: number;
                                  starSectorZ: number;
                              };
                          };
                      }
                      | {
                          type: "atStation";
                          universeObjectId: {
                              idInSystem: string;
                              systemCoordinates: {
                                  localX: number;
                                  localY: number;
                                  localZ: number;
                                  starSectorX: number;
                                  starSectorY: number;
                                  starSectorZ: number;
                              };
                          };
                      }
                      | {
                          latitude: number;
                          longitude: number;
                          type: "onSurface";
                          universeObjectId: {
                              idInSystem: string;
                              systemCoordinates: {
                                  localX: number;
                                  localY: number;
                                  localZ: number;
                                  starSectorX: number;
                                  starSectorY: number;
                                  starSectorZ: number;
                              };
                          };
                      }
                      | { shipId: string; type: "inSpaceship" },
                  >;
                  timestamp: number;
              },
              SaveLoadingError,
          >,
      >