Class StarMapUI

constructor

• new StarMapUI(
      scene: Scene,
      player: Player,
      starSystemDatabase: StarSystemDatabase,
      soundPlayer: ISoundPlayer,
  ): StarMapUI

  Parameters

  • scene: Scene
  • player: Player
  • starSystemDatabase: StarSystemDatabase
  • soundPlayer: ISoundPlayer

  Returns StarMapUI

ReadonlycurrentSystemCursor

ReadonlycurrentSystemCursorContainer

Readonlycursor

ReadonlydistanceToSol

Readonlyfactions

ReadonlyhoveredSystemCursor

ReadonlyhoveredSystemCursorContainer

ReadonlyhtmlRoot

ReadonlyhumanPresence

ReadonlyinfoPanel

ReadonlyinfoPanelStarPreview

ReadonlyinfoPanelTitle

ReadonlynbPlanets

ReadonlynbSpaceStations

ReadonlyonSystemFocusObservable

ReadonlyselectedSystemCursor

ReadonlyselectedSystemCursorContainer

ReadonlyshortHandUI

ReadonlyshortHandUIBookmarkButton

ReadonlyshortHandUIButtonContainer

ReadonlyshortHandUIDistanceFromCurrent

ReadonlyshortHandUIFactions

ReadonlyshortHandUIPlotItineraryButton

ReadonlyshortHandUISystemType

ReadonlyshortHandUITitle

ReadonlystarSector

dispose

• dispose(): void

  Returns void

rebuildSystemIcons

• rebuildSystemIcons(): void

  Returns void

setCurrentSystem

• setCurrentSystem(
      systemCoordinates: {
          localX: number;
          localY: number;
          localZ: number;
          starSectorX: number;
          starSectorY: number;
          starSectorZ: number;
      },
  ): void

  Parameters

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

  Returns void

setHoveredSystem

• setHoveredSystem(
      system:
          | null
          | {
              localX: number;
              localY: number;
              localZ: number;
              starSectorX: number;
              starSectorY: number;
              starSectorZ: number;
          },
  ): void

  Parameters

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

  Returns void

setSelectedSystem

• setSelectedSystem(
      targetSystemModel: DeepReadonly<StarSystemModel>,
      currentSystemCoordinates:
          | null
          | {
              localX: number;
              localY: number;
              localZ: number;
              starSectorX: number;
              starSectorY: number;
              starSectorZ: number;
          },
  ): void

  Parameters

  • targetSystemModel: DeepReadonly<StarSystemModel>
  • currentSystemCoordinates:
        | null
        | {
            localX: number;
            localY: number;
            localZ: number;
            starSectorX: number;
            starSectorY: number;
            starSectorZ: number;
        }
    • null
    • {
          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

  Returns void

update

• update(playerPosition: Vector3, centerOfUniversePosition: Vector3): void

  Parameters

  • playerPosition: Vector3
  • centerOfUniversePosition: Vector3

  Returns void