com.fs.starfarer.api.campaign

Interface StarSystemAPI

All Superinterfaces:

LocationAPI

public interface StarSystemAPI
extends LocationAPI

Author:

Alex Mosolov Copyright 2012 Fractal Softworks, LLC

Method Summary

Methods

Modifier and Type	Method and Description
void	autogenerateHyperspaceJumpPoints() Calls autogenerateHyperspaceJumpPoints(false, false)
void	autogenerateHyperspaceJumpPoints(boolean generateEntrancesAtGasGiants, boolean generateFringeJumpPoint) Generates jump points into the system and adds them to hyperspace.
void	autogenerateHyperspaceJumpPoints(boolean generateEntrancesAtGasGiants, boolean generateFringeJumpPoint, boolean generatePlanetConditions)
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.
StarAge	getAge()
java.util.List<JumpPointAPI>	getAutogeneratedJumpPointsInHyper()
java.util.List<NascentGravityWellAPI>	getAutogeneratedNascentWellsInHyper()
java.lang.String	getBaseName() Star name without "Star System" appended to it.
SectorEntityToken	getCenter()
Constellation	getConstellation() Can be null for non-procgen systems.
float	getDaysSinceLastPlayerVisit()
java.lang.Boolean	getDoNotShowIntelFromThisLocationOnMap()
SectorEntityToken	getHyperspaceAnchor() A location token corresponding to the center of the system in hyperspace.
long	getLastPlayerVisitTimestamp()
java.awt.Color	getLightColor()
Vector2f	getLocation()
java.lang.Float	getMapGridHeightOverride()
java.lang.Float	getMapGridWidthOverride()
float	getMaxRadiusInHyperspace() Only considers jump points into the system generated by autogenerateHyperspaceJumpPoints.
java.lang.String	getOptionalUniqueId() If non-null, will be used by the SectorAPI.getStarSystem(String) method.
PlanetAPI	getSecondary()
PlanetAPI	getStar()
PlanetAPI	getTertiary()
StarSystemGenerator.StarSystemType	getType()
boolean	hasBlackHole()
boolean	hasPulsar()
java.lang.Boolean	hasSystemwideNebula()
SectorEntityToken	initNonStarCenter()
PlanetAPI	initStar(java.lang.String id, java.lang.String type, java.awt.Color color, float radius, float coronaSize) Deprecated.
PlanetAPI	initStar(java.lang.String id, java.lang.String type, float radius, float coronaSize)
PlanetAPI	initStar(java.lang.String id, java.lang.String type, float radius, float hyperspaceLocationX, float hyperspaceLocationY, float coronaSize) Also automatically creates a wormhole/jump point leading to the star from hyperspace.
PlanetAPI	initStar(java.lang.String id, java.lang.String type, float radius, float coronaSize, float windBurnLevel, float flareProbability, float crLossMult) Will not automatically generate a hyperspace anchor for the star.
boolean	isEnteredByPlayer()
boolean	isInConstellation() Returns false if the constellation is null or contains only one star system.
boolean	isProcgen()
void	setAge(StarAge age)
void	setBaseName(java.lang.String baseName)
void	setCenter(SectorEntityToken center)
void	setConstellation(Constellation constellation)
void	setDoNotShowIntelFromThisLocationOnMap(java.lang.Boolean doNotShowIntelFromThisLocationOnMap)
void	setEnteredByPlayer(boolean enteredByPlayer)
void	setHasSystemwideNebula(java.lang.Boolean hasSystemwideNebula)
void	setHyperspaceAnchor(SectorEntityToken hyperspaceAnchor)
void	setLightColor(java.awt.Color lightColor) Only applicable if this location has a light source (i.e.
void	setMapGridHeightOverride(java.lang.Float mapGridHeightOverride)
void	setMapGridWidthOverride(java.lang.Float mapGridWidthOverride)
void	setMaxRadiusInHyperspace(float maxRadiusInHyperspace)
void	setOptionalUniqueId(java.lang.String optionalUniqueId) If non-null, will be used by the SectorAPI.getStarSystem(String) method.
void	setProcgen(boolean isProcgen)
void	setSecondary(PlanetAPI secondary)
void	setStar(PlanetAPI star)
void	setTertiary(PlanetAPI tertiary)
void	setType(StarSystemGenerator.StarSystemType type)

Methods inherited from interface com.fs.starfarer.api.campaign.LocationAPI

activeThisFrame, addAsteroid, addAsteroidBelt, addAsteroidBelt, addCorona, addCorona, addCustomEntity, addCustomEntity, addCustomEntity, addCustomEntity, addEntity, addFleetStub, addHitParticle, addOrbitalJunk, addParticle, addPlanet, addRadioChatter, addRingBand, addRingBand, addScript, addSpawnPoint, addTag, addTerrain, clearTags, createToken, createToken, getAllEntities, getAsteroids, getBackgroundColorShifter, getBackgroundParticleColorShifter, getBackgroundTextureFilename, getCustomEntities, getCustomEntitiesWithTag, getEntities, getEntitiesWithTag, getEntityById, getEntityByName, getFleets, getFleetStubs, getGravityWells, getId, getJumpPoints, getMemoryWithoutUpdate, getName, getNameWithLowercaseType, getNameWithLowercaseTypeShort, getNameWithNoType, getNameWithTypeIfNebula, getNameWithTypeShort, getOrbitalStations, getPersistentData, getPlanets, getScripts, getSpawnPoints, getTags, getTerrainCopy, hasTag, isCurrentLocation, isDeepSpace, isHyperspace, isNebula, removeEntity, removeFleetStub, removeScript, removeScriptsOfClass, removeSpawnPoint, removeTag, renderingLayersUpdated, setBackgroundOffset, setBackgroundTextureFilename, setName, spawnFleet, updateAllOrbits

Method Detail

getLocation

Vector2f getLocation()

Specified by:

getLocation in interface LocationAPI

initStar

PlanetAPI initStar(java.lang.String id,
                 java.lang.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(java.lang.String id,
                 java.lang.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(java.lang.String id,
                            java.lang.String type,
                            java.awt.Color color,
                            float radius,
                            float coronaSize)

Deprecated.

Color argument is not used. Use PlanetAPI.getSpec() instead.

initStar

PlanetAPI initStar(java.lang.String id,
                 java.lang.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

java.awt.Color getLightColor()

setLightColor

void setLightColor(java.awt.Color lightColor)

Only applicable if this location has a light source (i.e. a star).

Parameters:

lightColor -

getBaseName

java.lang.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(java.lang.String baseName)

getSecondary

PlanetAPI getSecondary()

setSecondary

void setSecondary(PlanetAPI secondary)

getTertiary

PlanetAPI getTertiary()

setTertiary

void setTertiary(PlanetAPI tertiary)

getAutogeneratedJumpPointsInHyper

java.util.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

java.lang.Boolean hasSystemwideNebula()

setHasSystemwideNebula

void setHasSystemwideNebula(java.lang.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

java.lang.Boolean getDoNotShowIntelFromThisLocationOnMap()

setDoNotShowIntelFromThisLocationOnMap

void setDoNotShowIntelFromThisLocationOnMap(java.lang.Boolean doNotShowIntelFromThisLocationOnMap)

hasBlackHole

boolean hasBlackHole()

getMapGridWidthOverride

java.lang.Float getMapGridWidthOverride()

setMapGridWidthOverride

void setMapGridWidthOverride(java.lang.Float mapGridWidthOverride)

getMapGridHeightOverride

java.lang.Float getMapGridHeightOverride()

setMapGridHeightOverride

void setMapGridHeightOverride(java.lang.Float mapGridHeightOverride)

setMaxRadiusInHyperspace

void setMaxRadiusInHyperspace(float maxRadiusInHyperspace)

getOptionalUniqueId

java.lang.String getOptionalUniqueId()

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

Parameters:

optionalUniqueId -

setOptionalUniqueId

void setOptionalUniqueId(java.lang.String optionalUniqueId)

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

Parameters:

optionalUniqueId -

getAutogeneratedNascentWellsInHyper

java.util.List<NascentGravityWellAPI> getAutogeneratedNascentWellsInHyper()