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

Class BaseThemeGenerator

java.lang.Object

com.fs.starfarer.api.impl.campaign.procgen.themes.BaseThemeGenerator

All Implemented Interfaces:

ThemeGenerator

Direct Known Subclasses:

DerelictThemeGenerator, MiscellaneousThemeGenerator, RemnantThemeGenerator, RuinsThemeGenerator

public abstract class BaseThemeGenerator
extends Object
implements ThemeGenerator

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BaseThemeGenerator.AddedEntity
static class	BaseThemeGenerator.EntityLocation
static enum	BaseThemeGenerator.HabitationLevel
static enum	BaseThemeGenerator.LocationType
static class	BaseThemeGenerator.OrbitGap
static class	BaseThemeGenerator.OrbitItem
static class	BaseThemeGenerator.StarSystemData

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	DEBUG
static float	NOT_HABITABLE_PLANET_PROB
static float	ORBITAL_HABITAT_PROB
protected Random	random

Constructor Summary

Constructors

Constructor	Description
BaseThemeGenerator()

Method Summary

Modifier and Type	Method	Description
void	addCaches(BaseThemeGenerator.StarSystemData data, float chanceToAddAny, int min, int max, WeightedRandomPicker<String> cacheTypes)
BaseThemeGenerator.AddedEntity	addCommRelay(BaseThemeGenerator.StarSystemData data, float prob)
BaseThemeGenerator.AddedEntity	addDebrisField(BaseThemeGenerator.StarSystemData data, SectorEntityToken focus, float radius)
void	addDebrisFields(BaseThemeGenerator.StarSystemData data, float chanceToAddAny, int min, int max)
void	addDebrisFields(BaseThemeGenerator.StarSystemData data, float chanceToAddAny, int min, int max, String defFaction, float defProb, int minStr, int maxStr)
void	addDerelictShip(BaseThemeGenerator.StarSystemData data, BaseThemeGenerator.EntityLocation loc, WeightedRandomPicker<String> factions)
BaseThemeGenerator.AddedEntity	addDerelictShip(BaseThemeGenerator.StarSystemData data, BaseThemeGenerator.EntityLocation loc, String variantId)
void	addDerelictShips(BaseThemeGenerator.StarSystemData data, float chanceToAddAny, int min, int max, WeightedRandomPicker<String> factions)
static BaseThemeGenerator.AddedEntity	addEntity(Random random, LocationAPI system, BaseThemeGenerator.EntityLocation loc, String type, String faction)
static BaseThemeGenerator.AddedEntity	addEntity(Random random, StarSystemAPI system, WeightedRandomPicker<BaseThemeGenerator.EntityLocation> locs, String type, String faction)
static BaseThemeGenerator.AddedEntity	addEntityAutoDetermineType(Random random, LocationAPI system, BaseThemeGenerator.EntityLocation loc, String type, String faction)
void	addHabCenters(BaseThemeGenerator.StarSystemData data, float chanceToAddAny, int min, int max, WeightedRandomPicker<String> stationTypes)
BaseThemeGenerator.AddedEntity	addInactiveGate(BaseThemeGenerator.StarSystemData data, float prob, float probDebris, float probShips, WeightedRandomPicker<String> factions)
void	addMiningStations(BaseThemeGenerator.StarSystemData data, float chanceToAddAny, int min, int max, WeightedRandomPicker<String> stationTypes)
static BaseThemeGenerator.AddedEntity	addNonSalvageEntity(LocationAPI system, BaseThemeGenerator.EntityLocation loc, String type, String faction)
List<BaseThemeGenerator.AddedEntity>	addObjectives(BaseThemeGenerator.StarSystemData data, float prob)
void	addResearchStations(BaseThemeGenerator.StarSystemData data, float chanceToAddAny, int min, int max, WeightedRandomPicker<String> stationTypes)
void	addRuins(PlanetAPI planet)
static SectorEntityToken	addSalvageEntity(LocationAPI location, String id, String faction)
static SectorEntityToken	addSalvageEntity(LocationAPI location, String id, String faction, Object pluginParams)
static SectorEntityToken	addSalvageEntity(Random random, LocationAPI location, String id, String faction)
static SectorEntityToken	addSalvageEntity(Random random, LocationAPI location, String id, String faction, Object pluginParams)
void	addShipGraveyard(BaseThemeGenerator.StarSystemData data, float chanceToAddAny, int min, int max, WeightedRandomPicker<String> factions)
void	addShipGraveyard(BaseThemeGenerator.StarSystemData data, SectorEntityToken focus, WeightedRandomPicker<String> factions)
void	addShipGraveyard(BaseThemeGenerator.StarSystemData data, SectorEntityToken focus, WeightedRandomPicker<String> factions, WeightedRandomPicker<String> hulls)
BaseThemeGenerator.AddedEntity	addStation(BaseThemeGenerator.EntityLocation loc, BaseThemeGenerator.StarSystemData data, String customEntityId, String factionId)
static void	clearRuins(MarketAPI market)
static BaseThemeGenerator.StarSystemData	computeSystemData(StarSystemAPI system)
static boolean	constellationIsEmpty(Constellation c)
static void	convertOrbitNoSpin(SectorEntityToken entity)
static void	convertOrbitNoSpin(SectorEntityToken entity, float facing)
static void	convertOrbitPointingDown(SectorEntityToken entity)
static void	convertOrbitWithSpin(SectorEntityToken entity, float spin)
static BaseThemeGenerator.EntityLocation	createLocationAtRandomGap(Random random, SectorEntityToken center, float minGap)
WeightedRandomPicker<String>	createStringPicker(Object... params)
static WeightedRandomPicker<String>	createStringPicker(Random random, Object... params)
static List<BaseThemeGenerator.OrbitGap>	findGaps(SectorEntityToken center, float minPad, float maxDist, float minGap)
static CargoAPI	genCargoFromDrop(SectorEntityToken entity)
abstract void	generateForSector(ThemeGenContext context, float allowedSectorFraction)
static float	getInnerRadius(StarSystemAPI system)
static WeightedRandomPicker<BaseThemeGenerator.EntityLocation>	getLocations(Random random, StarSystemAPI system, float minGap, LinkedHashMap<BaseThemeGenerator.LocationType,Float> weights)
static WeightedRandomPicker<BaseThemeGenerator.EntityLocation>	getLocations(Random random, StarSystemAPI system, Set<SectorEntityToken> exclude, float minGap, LinkedHashMap<BaseThemeGenerator.LocationType,Float> weights)
static ObjectiveGenDataSpec	getObjectiveSpec(String id)
static float	getOrbitalRadius(SectorEntityToken center)
abstract int	getOrder()	Themes with lower "order" values get their shot at generating content first.
static float	getOuterRadius(StarSystemAPI system)
Random	getRandom()
protected List<Constellation>	getSortedAvailableConstellations(ThemeGenContext context, boolean emptyOk, org.lwjgl.util.vector.Vector2f sortFrom, List<Constellation> exclude)	Sorted by *descending* distance from sortFrom.
abstract String	getThemeId()
float	getWeight()	What fraction of the Sector this theme wants to be used for, relative to other themes.
static boolean	isAreaEmpty(LocationAPI loc, org.lwjgl.util.vector.Vector2f coords)
static BaseThemeGenerator.EntityLocation	pickAnyLocation(Random random, StarSystemAPI system, float gap, Set<SectorEntityToken> exclude)
static BaseThemeGenerator.EntityLocation	pickCommonLocation(Random random, StarSystemAPI system, float gap, boolean allowStarOrbit, Set<SectorEntityToken> exclude)
static BaseThemeGenerator.EntityLocation	pickHiddenLocation(Random random, StarSystemAPI system, float gap, Set<SectorEntityToken> exclude)
static BaseThemeGenerator.EntityLocation	pickHiddenLocationNotNearStar(Random random, StarSystemAPI system, float gap, Set<SectorEntityToken> exclude)
static SectorEntityToken	pickOuterEntityToSpawnNear(Random random, StarSystemAPI system)
String	pickRuinsType(PlanetAPI planet)
static BaseThemeGenerator.EntityLocation	pickUncommonLocation(Random random, StarSystemAPI system, float gap, Set<SectorEntityToken> exclude)
static BaseThemeGenerator.AddedEntity	setEntityLocation(SectorEntityToken entity, BaseThemeGenerator.EntityLocation loc, String type)
void	setRandom(Random random)
boolean	shouldHaveDecivilized(PlanetAPI planet, String ruins)
static boolean	systemIsEmpty(StarSystemAPI system)

Methods inherited from class java.lang.Object

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

Field Details

DEBUG

public static boolean DEBUG

random

protected Random random

NOT_HABITABLE_PLANET_PROB

public static float NOT_HABITABLE_PLANET_PROB

ORBITAL_HABITAT_PROB

public static float ORBITAL_HABITAT_PROB

Constructor Details

BaseThemeGenerator

public BaseThemeGenerator()

Method Details

getOrder

public abstract int getOrder()

Description copied from interface: ThemeGenerator

Themes with lower "order" values get their shot at generating content first.

Specified by:

getOrder in interface ThemeGenerator

Returns:

getThemeId

public abstract String getThemeId()

Specified by:

getThemeId in interface ThemeGenerator

getWeight

public float getWeight()

Description copied from interface: ThemeGenerator

What fraction of the Sector this theme wants to be used for, relative to other themes. The fraction it gets is weight / (total weight of all themes). Base value is 100.

Specified by:

getWeight in interface ThemeGenerator

Returns:

generateForSector

public abstract void generateForSector(ThemeGenContext context,
 float allowedSectorFraction)

Specified by:

generateForSector in interface ThemeGenerator

addShipGraveyard

public void addShipGraveyard(BaseThemeGenerator.StarSystemData data,
 float chanceToAddAny,
 int min,
 int max,
 WeightedRandomPicker<String> factions)

addShipGraveyard

public void addShipGraveyard(BaseThemeGenerator.StarSystemData data,
 SectorEntityToken focus,
 WeightedRandomPicker<String> factions)

addShipGraveyard

public void addShipGraveyard(BaseThemeGenerator.StarSystemData data,
 SectorEntityToken focus,
 WeightedRandomPicker<String> factions,
 WeightedRandomPicker<String> hulls)

addDerelictShips

public void addDerelictShips(BaseThemeGenerator.StarSystemData data,
 float chanceToAddAny,
 int min,
 int max,
 WeightedRandomPicker<String> factions)

addMiningStations

public void addMiningStations(BaseThemeGenerator.StarSystemData data,
 float chanceToAddAny,
 int min,
 int max,
 WeightedRandomPicker<String> stationTypes)

addHabCenters

public void addHabCenters(BaseThemeGenerator.StarSystemData data,
 float chanceToAddAny,
 int min,
 int max,
 WeightedRandomPicker<String> stationTypes)

addResearchStations

public void addResearchStations(BaseThemeGenerator.StarSystemData data,
 float chanceToAddAny,
 int min,
 int max,
 WeightedRandomPicker<String> stationTypes)

addRuins

public void addRuins(PlanetAPI planet)

shouldHaveDecivilized

public boolean shouldHaveDecivilized(PlanetAPI planet,
 String ruins)

addObjectives

public List<BaseThemeGenerator.AddedEntity> addObjectives(BaseThemeGenerator.StarSystemData data,
 float prob)

getObjectiveSpec

public static ObjectiveGenDataSpec getObjectiveSpec(String id)

addCommRelay

public BaseThemeGenerator.AddedEntity addCommRelay(BaseThemeGenerator.StarSystemData data,
 float prob)

addInactiveGate

public BaseThemeGenerator.AddedEntity addInactiveGate(BaseThemeGenerator.StarSystemData data,
 float prob,
 float probDebris,
 float probShips,
 WeightedRandomPicker<String> factions)

pickRuinsType

public String pickRuinsType(PlanetAPI planet)

addStation

public BaseThemeGenerator.AddedEntity addStation(BaseThemeGenerator.EntityLocation loc,
 BaseThemeGenerator.StarSystemData data,
 String customEntityId,
 String factionId)

addCaches

public void addCaches(BaseThemeGenerator.StarSystemData data,
 float chanceToAddAny,
 int min,
 int max,
 WeightedRandomPicker<String> cacheTypes)

addDebrisFields

public void addDebrisFields(BaseThemeGenerator.StarSystemData data,
 float chanceToAddAny,
 int min,
 int max)

addDebrisFields

public void addDebrisFields(BaseThemeGenerator.StarSystemData data,
 float chanceToAddAny,
 int min,
 int max,
 String defFaction,
 float defProb,
 int minStr,
 int maxStr)

addDebrisField

public BaseThemeGenerator.AddedEntity addDebrisField(BaseThemeGenerator.StarSystemData data,
 SectorEntityToken focus,
 float radius)

createStringPicker

public WeightedRandomPicker<String> createStringPicker(Object... params)

createStringPicker

public static WeightedRandomPicker<String> createStringPicker(Random random,
 Object... params)

addDerelictShip

public void addDerelictShip(BaseThemeGenerator.StarSystemData data,
 BaseThemeGenerator.EntityLocation loc,
 WeightedRandomPicker<String> factions)

addDerelictShip

public BaseThemeGenerator.AddedEntity addDerelictShip(BaseThemeGenerator.StarSystemData data,
 BaseThemeGenerator.EntityLocation loc,
 String variantId)

pickCommonLocation

public static BaseThemeGenerator.EntityLocation pickCommonLocation(Random random,
 StarSystemAPI system,
 float gap,
 boolean allowStarOrbit,
 Set<SectorEntityToken> exclude)

pickUncommonLocation

public static BaseThemeGenerator.EntityLocation pickUncommonLocation(Random random,
 StarSystemAPI system,
 float gap,
 Set<SectorEntityToken> exclude)

pickAnyLocation

public static BaseThemeGenerator.EntityLocation pickAnyLocation(Random random,
 StarSystemAPI system,
 float gap,
 Set<SectorEntityToken> exclude)

pickHiddenLocation

public static BaseThemeGenerator.EntityLocation pickHiddenLocation(Random random,
 StarSystemAPI system,
 float gap,
 Set<SectorEntityToken> exclude)

pickHiddenLocationNotNearStar

public static BaseThemeGenerator.EntityLocation pickHiddenLocationNotNearStar(Random random,
 StarSystemAPI system,
 float gap,
 Set<SectorEntityToken> exclude)

getLocations

public static WeightedRandomPicker<BaseThemeGenerator.EntityLocation> getLocations(Random random,
 StarSystemAPI system,
 float minGap,
 LinkedHashMap<BaseThemeGenerator.LocationType,Float> weights)

getLocations

public static WeightedRandomPicker<BaseThemeGenerator.EntityLocation> getLocations(Random random,
 StarSystemAPI system,
 Set<SectorEntityToken> exclude,
 float minGap,
 LinkedHashMap<BaseThemeGenerator.LocationType,Float> weights)

createLocationAtRandomGap

public static BaseThemeGenerator.EntityLocation createLocationAtRandomGap(Random random,
 SectorEntityToken center,
 float minGap)

findGaps

public static List<BaseThemeGenerator.OrbitGap> findGaps(SectorEntityToken center,
 float minPad,
 float maxDist,
 float minGap)

getInnerRadius

public static float getInnerRadius(StarSystemAPI system)

pickOuterEntityToSpawnNear

public static SectorEntityToken pickOuterEntityToSpawnNear(Random random,
 StarSystemAPI system)

getOuterRadius

public static float getOuterRadius(StarSystemAPI system)

isAreaEmpty

public static boolean isAreaEmpty(LocationAPI loc,
 org.lwjgl.util.vector.Vector2f coords)

getOrbitalRadius

public static float getOrbitalRadius(SectorEntityToken center)

addEntity

public static BaseThemeGenerator.AddedEntity addEntity(Random random,
 StarSystemAPI system,
 WeightedRandomPicker<BaseThemeGenerator.EntityLocation> locs,
 String type,
 String faction)

addNonSalvageEntity

public static BaseThemeGenerator.AddedEntity addNonSalvageEntity(LocationAPI system,
 BaseThemeGenerator.EntityLocation loc,
 String type,
 String faction)

addEntityAutoDetermineType

public static BaseThemeGenerator.AddedEntity addEntityAutoDetermineType(Random random,
 LocationAPI system,
 BaseThemeGenerator.EntityLocation loc,
 String type,
 String faction)

addEntity

public static BaseThemeGenerator.AddedEntity addEntity(Random random,
 LocationAPI system,
 BaseThemeGenerator.EntityLocation loc,
 String type,
 String faction)

setEntityLocation

public static BaseThemeGenerator.AddedEntity setEntityLocation(SectorEntityToken entity,
 BaseThemeGenerator.EntityLocation loc,
 String type)

addSalvageEntity

public static SectorEntityToken addSalvageEntity(LocationAPI location,
 String id,
 String faction)

addSalvageEntity

public static SectorEntityToken addSalvageEntity(Random random,
 LocationAPI location,
 String id,
 String faction)

addSalvageEntity

public static SectorEntityToken addSalvageEntity(LocationAPI location,
 String id,
 String faction,
 Object pluginParams)

addSalvageEntity

public static SectorEntityToken addSalvageEntity(Random random,
 LocationAPI location,
 String id,
 String faction,
 Object pluginParams)

genCargoFromDrop

public static CargoAPI genCargoFromDrop(SectorEntityToken entity)

computeSystemData

public static BaseThemeGenerator.StarSystemData computeSystemData(StarSystemAPI system)

clearRuins

public static void clearRuins(MarketAPI market)

convertOrbitPointingDown

public static void convertOrbitPointingDown(SectorEntityToken entity)

convertOrbitNoSpin

public static void convertOrbitNoSpin(SectorEntityToken entity)

convertOrbitNoSpin

public static void convertOrbitNoSpin(SectorEntityToken entity,
 float facing)

convertOrbitWithSpin

public static void convertOrbitWithSpin(SectorEntityToken entity,
 float spin)

getRandom

public Random getRandom()

Specified by:

getRandom in interface ThemeGenerator

setRandom

public void setRandom(Random random)

Specified by:

setRandom in interface ThemeGenerator

getSortedAvailableConstellations

protected List<Constellation> getSortedAvailableConstellations(ThemeGenContext context,
 boolean emptyOk,
 org.lwjgl.util.vector.Vector2f sortFrom,
 List<Constellation> exclude)

Sorted by *descending* distance from sortFrom.

Parameters:

context -

sortFrom -

Returns:

constellationIsEmpty

public static boolean constellationIsEmpty(Constellation c)

systemIsEmpty

public static boolean systemIsEmpty(StarSystemAPI system)