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

    Function migrateV1ToV2

    • Parameters

      • saveV1: {
            padNumber?: number;
            player: {
                balance: number;
                completedMissions: unknown[];
                creationDate: string;
                currentItinerary: {
                    localX: number;
                    localY: number;
                    localZ: number;
                    starSectorX: number;
                    starSectorY: number;
                    starSectorZ: number;
                }[];
                currentMissions: unknown[];
                discoveries: {
                    local: {
                        discoveryTimestamp: number;
                        explorerName: string;
                        objectId: {
                            objectIndex: number;
                            objectType: SystemObjectType;
                            starSystemCoordinates: {
                                localX: number;
                                localY: number;
                                localZ: number;
                                starSectorX: number;
                                starSectorY: number;
                                starSectorZ: number;
                            };
                        };
                    }[];
                    uploaded: {
                        discoveryTimestamp: number;
                        explorerName: string;
                        objectId: {
                            objectIndex: number;
                            objectType: SystemObjectType;
                            starSystemCoordinates: {
                                localX: number;
                                localY: number;
                                localZ: number;
                                starSectorX: number;
                                starSectorY: number;
                                starSectorZ: number;
                            };
                        };
                    }[];
                };
                name: string;
                spaceShips: {
                    fuelScoop: null
                    | { fuelPerSecond: number };
                    fuelTanks: { currentFuel: number; maxFuel: number }[];
                    id: string;
                    name: string;
                    type: WANDERER;
                }[];
                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;
                }[];
            };
            timestamp: number;
            universeCoordinates: {
                positionX: number;
                positionY: number;
                positionZ: number;
                rotationQuaternionW: number;
                rotationQuaternionX: number;
                rotationQuaternionY: number;
                rotationQuaternionZ: number;
                universeObjectId: {
                    objectIndex: number;
                    objectType: SystemObjectType;
                    starSystemCoordinates: {
                        localX: number;
                        localY: number;
                        localZ: number;
                        starSectorX: number;
                        starSectorY: number;
                        starSectorZ: number;
                    };
                };
            };
            version: string;
        }
        • OptionalpadNumber?: number

          If the player is landed at a facility, store the pad number to allow graceful respawn at the station.

        • player: {
              balance: number;
              completedMissions: unknown[];
              creationDate: string;
              currentItinerary: {
                  localX: number;
                  localY: number;
                  localZ: number;
                  starSectorX: number;
                  starSectorY: number;
                  starSectorZ: number;
              }[];
              currentMissions: unknown[];
              discoveries: {
                  local: {
                      discoveryTimestamp: number;
                      explorerName: string;
                      objectId: {
                          objectIndex: number;
                          objectType: SystemObjectType;
                          starSystemCoordinates: {
                              localX: number;
                              localY: number;
                              localZ: number;
                              starSectorX: number;
                              starSectorY: number;
                              starSectorZ: number;
                          };
                      };
                  }[];
                  uploaded: {
                      discoveryTimestamp: number;
                      explorerName: string;
                      objectId: {
                          objectIndex: number;
                          objectType: SystemObjectType;
                          starSystemCoordinates: {
                              localX: number;
                              localY: number;
                              localZ: number;
                              starSectorX: number;
                              starSectorY: number;
                              starSectorZ: number;
                          };
                      };
                  }[];
              };
              name: string;
              spaceShips: {
                  fuelScoop: null
                  | { fuelPerSecond: number };
                  fuelTanks: { currentFuel: number; maxFuel: number }[];
                  id: string;
                  name: string;
                  type: WANDERER;
              }[];
              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;
              }[];
          }

          The player data.

        • timestamp: number

          The timestamp when the save file was created.

        • universeCoordinates: {
              positionX: number;
              positionY: number;
              positionZ: number;
              rotationQuaternionW: number;
              rotationQuaternionX: number;
              rotationQuaternionY: number;
              rotationQuaternionZ: number;
              universeObjectId: {
                  objectIndex: number;
                  objectType: SystemObjectType;
                  starSystemCoordinates: {
                      localX: number;
                      localY: number;
                      localZ: number;
                      starSectorX: number;
                      starSectorY: number;
                      starSectorZ: number;
                  };
              };
          }

          The coordinates of the current star system and the coordinates inside the star system.

          • positionX: number

            The x coordinate of the player's position in the nearest orbital object's frame of reference.

          • positionY: number

            The y coordinate of the player's position in the nearest orbital object's frame of reference.

          • positionZ: number

            The z coordinate of the player's position in the nearest orbital object's frame of reference.

          • rotationQuaternionW: number

            The w component of the player's rotation quaternion in the nearest orbital object's frame of reference.

          • rotationQuaternionX: number

            The x component of the player's rotation quaternion in the nearest orbital object's frame of reference.

          • rotationQuaternionY: number

            The y component of the player's rotation quaternion in the nearest orbital object's frame of reference.

          • rotationQuaternionZ: number

            The z component of the player's rotation quaternion in the nearest orbital object's frame of reference.

          • universeObjectId: {
                objectIndex: number;
                objectType: SystemObjectType;
                starSystemCoordinates: {
                    localX: number;
                    localY: number;
                    localZ: number;
                    starSectorX: number;
                    starSectorY: number;
                    starSectorZ: number;
                };
            }

            The coordinates of the body in the universe.

            • objectIndex: number

              The index of the object inside the array containing all objects of the given type within the star system.

            • objectType: SystemObjectType

              The type of the object.

            • starSystemCoordinates: {
                  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

        • version: string

          The version of CosmosJourneyer that created this save file.

      • starSystemDatabase: StarSystemDatabase

      Returns {
          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;
      }

      • 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;
            }[];
        }

        The player data.

      • 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

        The timestamp when the save file was created.

    Settings

    Member Visibility