Package com.fs.starfarer.api.impl.campaign.procgen

Class StarSystemGenerator

java.lang.Object

com.fs.starfarer.api.impl.campaign.procgen.StarSystemGenerator

public class StarSystemGenerator
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StarSystemGenerator.CustomConstellationParams
static class	StarSystemGenerator.GenContext
static class	StarSystemGenerator.GeneratedPlanet
static class	StarSystemGenerator.GenResult
static class	StarSystemGenerator.LagrangePoint
static enum	StarSystemGenerator.LagrangePointType
static enum	StarSystemGenerator.StarSystemType

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<SectorEntityToken,List<SectorEntityToken>>	allNameableEntitiesAdded
protected String	backgroundName
static Map<String,WeightedRandomPicker<String>>	backgroundsByNebulaType
static final float	BASE_INCR
static final float	BASE_INCR_MOON
static final String	CAT_GIANT
static final String	CAT_HAB1
static final String	CAT_HAB2
static final String	CAT_HAB3
static final String	CAT_HAB4
static final String	CAT_HAB5
static final String	CAT_NOTHING
protected float	centerRadius
static final String	COL_BINARY
static final String	COL_IN_ASTEROIDS
static final String	COL_IS_MOON
static final String	COL_LAGRANGE
static final String	COL_TRINARY
protected StarAge	constellationAge
protected AgeGenDataSpec	constellationAgeData
static boolean	DEBUG
static final float	FAR_MAX_ORBIT_RADIUS
protected LocationAPI	hyper
static final float	LAGRANGE_OFFSET
protected Map<SectorEntityToken,PlanetAPI>	lagrangeParentMap
static final float	MAX_ORBIT_RADIUS
static final float	MAX_STAR_DIST
static final float	MIN_MOON_RADIUS
static final float	MIN_STAR_DIST
static final float	MOON_RADIUS_MAX_FRACTION_OF_NORMAL
static final float	MOON_RADIUS_MAX_FRACTION_OF_PARENT
static final float	MOON_RADIUS_MIN_FRACTION_OF_NORMAL
static final String	NEBULA_AMBER
static final String	NEBULA_BLUE
static final String	NEBULA_DEFAULT
static final String	NEBULA_NONE
protected String	nebulaType
static Map<StarAge,String>	nebulaTypes
protected StarSystemGenerator.CustomConstellationParams	params
static final float	PITCH_MAX
static final float	PITCH_MIN
static Random	random
protected PlanetAPI	secondary
protected SectorAPI	sector
protected PlanetAPI	star
protected StarAge	starAge
protected AgeGenDataSpec	starAgeData
protected StarGenDataSpec	starData
static final float	STARTING_RADIUS_MOON_BASE
static final float	STARTING_RADIUS_MOON_RANGE
static final float	STARTING_RADIUS_STAR_BASE
static final float	STARTING_RADIUS_STAR_RANGE
protected StarSystemAPI	system
protected SectorEntityToken	systemCenter
protected StarSystemGenerator.StarSystemType	systemType
static final String	TAG_FIRST_ORBIT_ONLY
static final String	TAG_GIANT_MOON
static final String	TAG_LAGRANGE_ONLY
static final String	TAG_NOT_IN_NEBULA
static final String	TAG_NOT_NEBULA_UNLESS_MOON
static final String	TAG_REQUIRES_NEBULA
static List<TerrainGenPlugin>	terrainPlugins
protected PlanetAPI	tertiary
static final float	TILT_MAX
static final float	TILT_MIN

Constructor Summary

Constructors

Constructor	Description
StarSystemGenerator(StarSystemGenerator.CustomConstellationParams params)

Method Summary

Modifier and Type	Method	Description
protected void	addFarStar(PlanetAPI farStar, float orbitAngle, float baseOrbitRadius, float orbitPeriod)
protected void	addJumpPoint(StarSystemGenerator.LagrangePoint p, String name)
protected void	addJumpPoints(StarSystemGenerator.GenResult result, boolean farStarMode)
static float	addOrbitingEntities(StarSystemAPI system, SectorEntityToken parentStar, StarAge age, int min, int max, float startingRadius, int nameOffset, boolean withSpecialNames)
static float	addOrbitingEntities(StarSystemAPI system, SectorEntityToken parentStar, StarAge age, int min, int max, float startingRadius, int nameOffset, boolean withSpecialNames, boolean allowHabitable)
protected StarSystemGenerator.GenResult	addOrbitingEntities(StarSystemGenerator.GenContext context, int numOrbits, boolean addingMoons, boolean addMoons, boolean parentIsMoon, boolean nothingOk)
StarSystemGenerator.GenResult	addPlanet(StarSystemGenerator.GenContext context, PlanetGenDataSpec planetData, boolean isMoon, boolean addMoons)
protected StarSystemGenerator.GenResult	addPlanetsAndTerrain(float maxOrbitRadius)
protected PlanetAPI	addRandomStar(String id, String name)
protected void	addStableLocations()
static void	addStableLocations(StarSystemAPI system, int num)
protected boolean	addStars(String id)
protected void	addStuffAtLagrangePoints(StarSystemGenerator.GenContext context, StarSystemGenerator.GeneratedPlanet planet)
protected void	addSystemwideNebula()
static void	addSystemwideNebula(StarSystemAPI system, StarAge age)
protected StarSystemGenerator.GenResult	addTerrain(StarSystemGenerator.GenContext context, TerrainGenDataSpec terrainData)
static void	addTerrainGenPlugin(TerrainGenPlugin plugin)
protected void	cleanup()
Constellation	generate()
void	generateSystem(org.lwjgl.util.vector.Vector2f loc)
Map<SectorEntityToken,List<SectorEntityToken>>	getAllEntitiesAdded()
static Color	getColor(Color min, Color max)
StarAge	getConstellationAge()
protected float	getHabOffset(EntityGenDataSpec data)
Map<SectorEntityToken,PlanetAPI>	getLagrangeParentMap()
String	getNebulaType()
static float	getNormalRandom(float min, float max)
static float	getNormalRandom(Random random, float min, float max)
protected WeightedRandomPicker<EntityGenDataSpec>	getPickerForCategory(CategoryGenDataSpec categoryData, StarSystemGenerator.GenContext context, String extraMult)
protected WeightedRandomPicker<EntityGenDataSpec>	getPickerForCategory(CategoryGenDataSpec categoryData, StarSystemGenerator.GenContext context, String extraMult, boolean nothingOk)
static float	getRadius(float min, float max)
static float	getRandom(float min, float max)
StarAge	getStarAge()
void	init(StarSystemAPI system, StarAge age)
protected boolean	initSystem(String name, org.lwjgl.util.vector.Vector2f loc)
boolean	isCategoryEmpty(CategoryGenDataSpec categoryData, StarSystemGenerator.GenContext context, String extraMult, boolean nothingOk)
CategoryGenDataSpec	pickCategory(StarSystemGenerator.GenContext context, String extraMult, boolean nothingOk)
static FullName.Gender	pickGender()
protected Color	pickLightColorForStar(PlanetAPI star)
void	pickNebulaAndBackground()
PlanetSpecAPI	pickStar(StarAge age)
protected StarSystemGenerator.StarSystemType	pickSystemType(StarAge constellationAge)
static TerrainGenPlugin	pickTerrainGenPlugin(TerrainGenDataSpec terrainData, StarSystemGenerator.GenContext context)
static void	removeTerrainGenPlugin(TerrainGenPlugin plugin)
protected void	setBlackHoleIfBlackHole(PlanetAPI star)
protected void	setDefaultLightColorBasedOnStars()
protected void	setPulsarIfNeutron(PlanetAPI star)
protected void	switchPrimaryAndSecondaryIfNeeded(boolean sizeDownSmaller)
protected void	switchPrimaryAndTertiaryIfNeeded(boolean sizeDownSmaller)
protected void	updateAgeAfterPickingStar()
static void	updateBackgroundPickers()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MIN_STAR_DIST

public static final float MIN_STAR_DIST

See Also:

• Constant Field Values

MAX_STAR_DIST

public static final float MAX_STAR_DIST

See Also:

• Constant Field Values

TILT_MIN

public static final float TILT_MIN

See Also:

• Constant Field Values

TILT_MAX

public static final float TILT_MAX

See Also:

• Constant Field Values

PITCH_MIN

public static final float PITCH_MIN

See Also:

• Constant Field Values

PITCH_MAX

public static final float PITCH_MAX

See Also:

• Constant Field Values

MAX_ORBIT_RADIUS

public static final float MAX_ORBIT_RADIUS

See Also:

• Constant Field Values

FAR_MAX_ORBIT_RADIUS

public static final float FAR_MAX_ORBIT_RADIUS

See Also:

• Constant Field Values

LAGRANGE_OFFSET

public static final float LAGRANGE_OFFSET

See Also:

• Constant Field Values

BASE_INCR

public static final float BASE_INCR

See Also:

• Constant Field Values

BASE_INCR_MOON

public static final float BASE_INCR_MOON

See Also:

• Constant Field Values

STARTING_RADIUS_STAR_BASE

public static final float STARTING_RADIUS_STAR_BASE

See Also:

• Constant Field Values

STARTING_RADIUS_STAR_RANGE

public static final float STARTING_RADIUS_STAR_RANGE

See Also:

• Constant Field Values

STARTING_RADIUS_MOON_BASE

public static final float STARTING_RADIUS_MOON_BASE

See Also:

• Constant Field Values

STARTING_RADIUS_MOON_RANGE

public static final float STARTING_RADIUS_MOON_RANGE

See Also:

• Constant Field Values

MOON_RADIUS_MAX_FRACTION_OF_PARENT

public static final float MOON_RADIUS_MAX_FRACTION_OF_PARENT

See Also:

• Constant Field Values

MOON_RADIUS_MIN_FRACTION_OF_NORMAL

public static final float MOON_RADIUS_MIN_FRACTION_OF_NORMAL

See Also:

• Constant Field Values

MOON_RADIUS_MAX_FRACTION_OF_NORMAL

public static final float MOON_RADIUS_MAX_FRACTION_OF_NORMAL

See Also:

• Constant Field Values

MIN_MOON_RADIUS

public static final float MIN_MOON_RADIUS

See Also:

• Constant Field Values

TAG_FIRST_ORBIT_ONLY

public static final String TAG_FIRST_ORBIT_ONLY

See Also:

• Constant Field Values

TAG_GIANT_MOON

public static final String TAG_GIANT_MOON

See Also:

• Constant Field Values

TAG_LAGRANGE_ONLY

public static final String TAG_LAGRANGE_ONLY

See Also:

• Constant Field Values

TAG_NOT_IN_NEBULA

public static final String TAG_NOT_IN_NEBULA

See Also:

• Constant Field Values

TAG_REQUIRES_NEBULA

public static final String TAG_REQUIRES_NEBULA

See Also:

• Constant Field Values

TAG_NOT_NEBULA_UNLESS_MOON

public static final String TAG_NOT_NEBULA_UNLESS_MOON

See Also:

• Constant Field Values

CAT_HAB5

public static final String CAT_HAB5

See Also:

• Constant Field Values

CAT_HAB4

public static final String CAT_HAB4

See Also:

• Constant Field Values

CAT_HAB3

public static final String CAT_HAB3

See Also:

• Constant Field Values

CAT_HAB2

public static final String CAT_HAB2

See Also:

• Constant Field Values

CAT_HAB1

public static final String CAT_HAB1

See Also:

• Constant Field Values

CAT_NOTHING

public static final String CAT_NOTHING

See Also:

• Constant Field Values

CAT_GIANT

public static final String CAT_GIANT

See Also:

• Constant Field Values

COL_LAGRANGE

public static final String COL_LAGRANGE

See Also:

• Constant Field Values

COL_IN_ASTEROIDS

public static final String COL_IN_ASTEROIDS

See Also:

• Constant Field Values

COL_IS_MOON

public static final String COL_IS_MOON

See Also:

• Constant Field Values

COL_BINARY

public static final String COL_BINARY

See Also:

• Constant Field Values

COL_TRINARY

public static final String COL_TRINARY

See Also:

• Constant Field Values

NEBULA_DEFAULT

public static final String NEBULA_DEFAULT

See Also:

• Constant Field Values

NEBULA_AMBER

public static final String NEBULA_AMBER

See Also:

• Constant Field Values

NEBULA_BLUE

public static final String NEBULA_BLUE

See Also:

• Constant Field Values

NEBULA_NONE

public static final String NEBULA_NONE

See Also:

• Constant Field Values

nebulaTypes

public static Map<StarAge,String> nebulaTypes

backgroundsByNebulaType

public static Map<String,WeightedRandomPicker<String>> backgroundsByNebulaType

terrainPlugins

public static List<TerrainGenPlugin> terrainPlugins

random

public static Random random

DEBUG

public static boolean DEBUG

constellationAge

protected StarAge constellationAge

systemType

protected StarSystemGenerator.StarSystemType systemType

starAge

protected StarAge starAge

sector

protected SectorAPI sector

system

protected StarSystemAPI system

hyper

protected LocationAPI hyper

star

protected PlanetAPI star

secondary

protected PlanetAPI secondary

tertiary

protected PlanetAPI tertiary

systemCenter

protected SectorEntityToken systemCenter

centerRadius

protected float centerRadius

constellationAgeData

protected AgeGenDataSpec constellationAgeData

starAgeData

protected AgeGenDataSpec starAgeData

starData

protected StarGenDataSpec starData

nebulaType

protected String nebulaType

backgroundName

protected String backgroundName

lagrangeParentMap

protected Map<SectorEntityToken,PlanetAPI> lagrangeParentMap

allNameableEntitiesAdded

protected Map<SectorEntityToken,List<SectorEntityToken>> allNameableEntitiesAdded

params

protected StarSystemGenerator.CustomConstellationParams params

Constructor Details

StarSystemGenerator

public StarSystemGenerator(StarSystemGenerator.CustomConstellationParams params)

Method Details

addTerrainGenPlugin

public static void addTerrainGenPlugin(TerrainGenPlugin plugin)

removeTerrainGenPlugin

public static void removeTerrainGenPlugin(TerrainGenPlugin plugin)

updateBackgroundPickers

public static void updateBackgroundPickers()

pickTerrainGenPlugin

public static TerrainGenPlugin pickTerrainGenPlugin(TerrainGenDataSpec terrainData,
 StarSystemGenerator.GenContext context)

pickNebulaAndBackground

public void pickNebulaAndBackground()

generate

public Constellation generate()

generateSystem

public void generateSystem(org.lwjgl.util.vector.Vector2f loc)

addFarStar

protected void addFarStar(PlanetAPI farStar,
 float orbitAngle,
 float baseOrbitRadius,
 float orbitPeriod)

pickSystemType

protected StarSystemGenerator.StarSystemType pickSystemType(StarAge constellationAge)

addStars

protected boolean addStars(String id)

setBlackHoleIfBlackHole

protected void setBlackHoleIfBlackHole(PlanetAPI star)

setPulsarIfNeutron

protected void setPulsarIfNeutron(PlanetAPI star)

switchPrimaryAndSecondaryIfNeeded

protected void switchPrimaryAndSecondaryIfNeeded(boolean sizeDownSmaller)

switchPrimaryAndTertiaryIfNeeded

protected void switchPrimaryAndTertiaryIfNeeded(boolean sizeDownSmaller)

addStableLocations

protected void addStableLocations()

addStableLocations

public static void addStableLocations(StarSystemAPI system,
 int num)

addJumpPoints

protected void addJumpPoints(StarSystemGenerator.GenResult result,
 boolean farStarMode)

addJumpPoint

protected void addJumpPoint(StarSystemGenerator.LagrangePoint p,
 String name)

addOrbitingEntities

public static float addOrbitingEntities(StarSystemAPI system,
 SectorEntityToken parentStar,
 StarAge age,
 int min,
 int max,
 float startingRadius,
 int nameOffset,
 boolean withSpecialNames)

addOrbitingEntities

public static float addOrbitingEntities(StarSystemAPI system,
 SectorEntityToken parentStar,
 StarAge age,
 int min,
 int max,
 float startingRadius,
 int nameOffset,
 boolean withSpecialNames,
 boolean allowHabitable)

addSystemwideNebula

public static void addSystemwideNebula(StarSystemAPI system,
 StarAge age)

addSystemwideNebula

protected void addSystemwideNebula()

addPlanetsAndTerrain

protected StarSystemGenerator.GenResult addPlanetsAndTerrain(float maxOrbitRadius)

addOrbitingEntities

protected StarSystemGenerator.GenResult addOrbitingEntities(StarSystemGenerator.GenContext context,
 int numOrbits,
 boolean addingMoons,
 boolean addMoons,
 boolean parentIsMoon,
 boolean nothingOk)

addTerrain

protected StarSystemGenerator.GenResult addTerrain(StarSystemGenerator.GenContext context,
 TerrainGenDataSpec terrainData)

addPlanet

public StarSystemGenerator.GenResult addPlanet(StarSystemGenerator.GenContext context,
 PlanetGenDataSpec planetData,
 boolean isMoon,
 boolean addMoons)

addStuffAtLagrangePoints

protected void addStuffAtLagrangePoints(StarSystemGenerator.GenContext context,
 StarSystemGenerator.GeneratedPlanet planet)

pickCategory

public CategoryGenDataSpec pickCategory(StarSystemGenerator.GenContext context,
 String extraMult,
 boolean nothingOk)

isCategoryEmpty

public boolean isCategoryEmpty(CategoryGenDataSpec categoryData,
 StarSystemGenerator.GenContext context,
 String extraMult,
 boolean nothingOk)

getHabOffset

protected float getHabOffset(EntityGenDataSpec data)

getPickerForCategory

protected WeightedRandomPicker<EntityGenDataSpec> getPickerForCategory(CategoryGenDataSpec categoryData,
 StarSystemGenerator.GenContext context,
 String extraMult)

getPickerForCategory

protected WeightedRandomPicker<EntityGenDataSpec> getPickerForCategory(CategoryGenDataSpec categoryData,
 StarSystemGenerator.GenContext context,
 String extraMult,
 boolean nothingOk)

setDefaultLightColorBasedOnStars

protected void setDefaultLightColorBasedOnStars()

pickLightColorForStar

protected Color pickLightColorForStar(PlanetAPI star)

addRandomStar

protected PlanetAPI addRandomStar(String id,
 String name)

init

public void init(StarSystemAPI system,
 StarAge age)

initSystem

protected boolean initSystem(String name,
 org.lwjgl.util.vector.Vector2f loc)

updateAgeAfterPickingStar

protected void updateAgeAfterPickingStar()

cleanup

protected void cleanup()

getNebulaType

public String getNebulaType()

getConstellationAge

public StarAge getConstellationAge()

getStarAge

public StarAge getStarAge()

pickStar

public PlanetSpecAPI pickStar(StarAge age)

getColor

public static Color getColor(Color min,
 Color max)

getNormalRandom

public static float getNormalRandom(float min,
 float max)

getNormalRandom

public static float getNormalRandom(Random random,
 float min,
 float max)

getRadius

public static float getRadius(float min,
 float max)

getRandom

public static float getRandom(float min,
 float max)

getLagrangeParentMap

public Map<SectorEntityToken,PlanetAPI> getLagrangeParentMap()

getAllEntitiesAdded

public Map<SectorEntityToken,List<SectorEntityToken>> getAllEntitiesAdded()

pickGender

public static FullName.Gender pickGender()