Package com.fs.starfarer.api.campaign

Interface StarSystemAPI

All Superinterfaces:
LocationAPI
public interface StarSystemAPI extends LocationAPI
Author:
Alex Mosolov Copyright 2012 Fractal Softworks, LLC

  • Method Details

    • getLocation

      org.lwjgl.util.vector.Vector2f getLocation()
      Specified by:
      getLocation in interface LocationAPI

    • initStar

      PlanetAPI initStar(String id, String type, float radius, float coronaSize, float windBurnLevel, float flareProbability, float crLossMult)
      Will not automatically generate a hyperspace anchor for the star. Call autogenerateHyperspaceJumpPoints() to do that, or create the anchor manually using JumpPointAPI.
      Parameters:
      id - unique id for this star
      type -
      color -
      radius -
      Returns:

    • initStar

      PlanetAPI initStar(String id, String type, float radius, float coronaSize)

    • generateAnchorIfNeeded

      void generateAnchorIfNeeded()
      Generates the hyperspace anchor for the star (and nothing else - no gas giant gravity wells or fringe jump point), unless one was already generated.

    • initStar

      @Deprecated PlanetAPI initStar(String id, String type, Color color, float radius, float coronaSize)
      Deprecated.
      Color argument is not used. Use PlanetAPI.getSpec() instead.

    • initStar

      PlanetAPI initStar(String id, String type, float radius, float hyperspaceLocationX, float hyperspaceLocationY, float coronaSize)
      Also automatically creates a wormhole/jump point leading to the star from hyperspace. This wormhole can be accessed using getHyperspaceAnchor().
      Parameters:
      id - unique id for this star
      type -
      color -
      radius -
      hyperspaceLocationX -
      hyperspaceLocationY -
      Returns:

    • getHyperspaceAnchor

      SectorEntityToken getHyperspaceAnchor()
      A location token corresponding to the center of the system in hyperspace.

    • setHyperspaceAnchor

      void setHyperspaceAnchor(SectorEntityToken hyperspaceAnchor)

    • getStar

      PlanetAPI getStar()

    • autogenerateHyperspaceJumpPoints

      void autogenerateHyperspaceJumpPoints()
      Calls autogenerateHyperspaceJumpPoints(false, false)

    • autogenerateHyperspaceJumpPoints

      void autogenerateHyperspaceJumpPoints(boolean generateEntrancesAtGasGiants, boolean generateFringeJumpPoint)
      Generates jump points into the system and adds them to hyperspace. Jump points generated are based on the jump points within the system. Also adds jump destinations from all in-system jump points to the associated, newly-generated hyperspace jump points. Will also generate a wormhole for the star if one doesn't exist already.
      Parameters:
      generateEntrancesAtGasGiants - whether one-way jump points into the system are generated at gas giants
      generateFringeJumpPoint - whether an extra jump point (two-way) is generated on the fringes of the system

    • getLightColor

      Color getLightColor()

    • setLightColor

      void setLightColor(Color lightColor)
      Only applicable if this location has a light source (i.e. a star).
      Parameters:
      lightColor -

    • getBaseName

      String getBaseName()
      Star name without "Star System" appended to it.
      Returns:

    • getMaxRadiusInHyperspace

      float getMaxRadiusInHyperspace()
      Only considers jump points into the system generated by autogenerateHyperspaceJumpPoints.
      Returns:

    • initNonStarCenter

      SectorEntityToken initNonStarCenter()

    • getCenter

      SectorEntityToken getCenter()

    • setStar

      void setStar(PlanetAPI star)

    • setBaseName

      void setBaseName(String baseName)

    • getSecondary

      PlanetAPI getSecondary()

    • setSecondary

      void setSecondary(PlanetAPI secondary)

    • getTertiary

      PlanetAPI getTertiary()

    • setTertiary

      void setTertiary(PlanetAPI tertiary)

    • getAutogeneratedJumpPointsInHyper

      List<JumpPointAPI> getAutogeneratedJumpPointsInHyper()

    • getType

      StarSystemGenerator.StarSystemType getType()

    • setType

      void setType(StarSystemGenerator.StarSystemType type)

    • getConstellation

      Constellation getConstellation()
      Can be null for non-procgen systems. Can be a one-system constellation for lone star systems.
      Specified by:
      getConstellation in interface LocationAPI
      Returns:

    • isInConstellation

      boolean isInConstellation()
      Returns false if the constellation is null or contains only one star system.
      Specified by:
      isInConstellation in interface LocationAPI
      Returns:

    • setConstellation

      void setConstellation(Constellation constellation)

    • setCenter

      void setCenter(SectorEntityToken center)

    • autogenerateHyperspaceJumpPoints

      void autogenerateHyperspaceJumpPoints(boolean generateEntrancesAtGasGiants, boolean generateFringeJumpPoint, boolean generatePlanetConditions)

    • setProcgen

      void setProcgen(boolean isProcgen)

    • isProcgen

      boolean isProcgen()

    • getAge

      StarAge getAge()

    • setAge

      void setAge(StarAge age)

    • hasSystemwideNebula

      Boolean hasSystemwideNebula()

    • setHasSystemwideNebula

      void setHasSystemwideNebula(Boolean hasSystemwideNebula)

    • isEnteredByPlayer

      boolean isEnteredByPlayer()

    • setEnteredByPlayer

      void setEnteredByPlayer(boolean enteredByPlayer)

    • getLastPlayerVisitTimestamp

      long getLastPlayerVisitTimestamp()
      Specified by:
      getLastPlayerVisitTimestamp in interface LocationAPI

    • getDaysSinceLastPlayerVisit

      float getDaysSinceLastPlayerVisit()
      Specified by:
      getDaysSinceLastPlayerVisit in interface LocationAPI

    • hasPulsar

      boolean hasPulsar()

    • getDoNotShowIntelFromThisLocationOnMap

      Boolean getDoNotShowIntelFromThisLocationOnMap()

    • setDoNotShowIntelFromThisLocationOnMap

      void setDoNotShowIntelFromThisLocationOnMap(Boolean doNotShowIntelFromThisLocationOnMap)

    • hasBlackHole

      boolean hasBlackHole()

    • getMapGridWidthOverride

      Float getMapGridWidthOverride()

    • setMapGridWidthOverride

      void setMapGridWidthOverride(Float mapGridWidthOverride)

    • getMapGridHeightOverride

      Float getMapGridHeightOverride()

    • setMapGridHeightOverride

      void setMapGridHeightOverride(Float mapGridHeightOverride)

    • setMaxRadiusInHyperspace

      void setMaxRadiusInHyperspace(float maxRadiusInHyperspace)

    • getOptionalUniqueId

      String getOptionalUniqueId()
      If non-null, will be used by the SectorAPI.getStarSystem(String) method.
      Parameters:
      optionalUniqueId -

    • setOptionalUniqueId

      void setOptionalUniqueId(String optionalUniqueId)
      If non-null, will be used by the SectorAPI.getStarSystem(String) method.
      Parameters:
      optionalUniqueId -

    • getAutogeneratedNascentWellsInHyper

      List<NascentGravityWellAPI> getAutogeneratedNascentWellsInHyper()