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

    The controller of the star system manages all resources specific to a single star system. Changing star system means destroying and creating a new controller.

    Index

    Properties

    The model of the star system that describes it and generates the randomness

    scene: UberScene
    starFieldBox: StarFieldBox

    Methods

    • Parameters

      • targetCoordinates: {
            localX: number;
            localY: number;
            localZ: number;
            starSectorX: number;
            starSectorY: number;
            starSectorZ: number;
        }
        • 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

      • starSystemDatabase: StarSystemDatabase

      Returns null | SystemTarget

    • Translates all celestial bodies and spacestations in the system by the given displacement

      Parameters

      • displacement: Vector3

        The displacement applied to all bodies

      Returns void

    • Updates the system and all its orbital objects forward in time by the given delta time. The nearest object is kept in place and the other objects are updated accordingly.

      Parameters

      • deltaSeconds: number

        The time elapsed since the last update

      • chunkForge: ChunkForge

        The chunk forge used to update the LOD of the telluric planets

      Returns void

    • Updates the material shaders of all the bodies in the system with the given delta time

      Parameters

      • deltaSeconds: number

        The time elapsed in seconds since the last update

      Returns void