Uses of Interface
com.fs.starfarer.api.campaign.PlanetAPI

Packages that use PlanetAPI

Package	Description
com.fs.starfarer.api.campaign
com.fs.starfarer.api.campaign.econ
com.fs.starfarer.api.campaign.listeners
com.fs.starfarer.api.impl.campaign
com.fs.starfarer.api.impl.campaign.abilities
com.fs.starfarer.api.impl.campaign.econ.impl
com.fs.starfarer.api.impl.campaign.enc
com.fs.starfarer.api.impl.campaign.intel
com.fs.starfarer.api.impl.campaign.intel.bar.events
com.fs.starfarer.api.impl.campaign.intel.bar.events.historian
com.fs.starfarer.api.impl.campaign.intel.misc
com.fs.starfarer.api.impl.campaign.missions
com.fs.starfarer.api.impl.campaign.missions.academy
com.fs.starfarer.api.impl.campaign.missions.hub
com.fs.starfarer.api.impl.campaign.plog
com.fs.starfarer.api.impl.campaign.procgen
com.fs.starfarer.api.impl.campaign.procgen.themes
com.fs.starfarer.api.impl.campaign.rulecmd.salvage
com.fs.starfarer.api.impl.campaign.rulecmd.salvage.special
com.fs.starfarer.api.impl.campaign.tutorial
com.fs.starfarer.api.impl.campaign.world
com.fs.starfarer.api.impl.combat
com.fs.starfarer.api.mission
com.fs.starfarer.api.plugins
com.fs.starfarer.api.ui
com.fs.starfarer.api.util

Uses of PlanetAPI in com.fs.starfarer.api.campaign

Methods in com.fs.starfarer.api.campaign that return PlanetAPI

Modifier and Type	Method	Description
PlanetAPI	LocationAPI.addPlanet(String id, SectorEntityToken focus, String name, String type, float angle, float radius, float orbitRadius, float orbitDays)
PlanetAPI	StarSystemAPI.getSecondary()
PlanetAPI	StarSystemAPI.getStar()
PlanetAPI	StarSystemAPI.getTertiary()
PlanetAPI	StarSystemAPI.initStar(String id, String type, float radius, float coronaSize)
PlanetAPI	StarSystemAPI.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.
PlanetAPI	StarSystemAPI.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.
PlanetAPI	StarSystemAPI.initStar(String id, String type, Color color, float radius, float coronaSize)	Deprecated.

Methods in com.fs.starfarer.api.campaign that return types with arguments of type PlanetAPI

Modifier and Type	Method	Description
List<PlanetAPI>	LocationAPI.getPlanets()

Methods in com.fs.starfarer.api.campaign with parameters of type PlanetAPI

Modifier and Type	Method	Description
void	StarSystemAPI.setSecondary(PlanetAPI secondary)
void	StarSystemAPI.setStar(PlanetAPI star)
void	StarSystemAPI.setTertiary(PlanetAPI tertiary)

Uses of PlanetAPI in com.fs.starfarer.api.campaign.econ

Methods in com.fs.starfarer.api.campaign.econ that return PlanetAPI

Modifier and Type	Method	Description
PlanetAPI	MarketAPI.getPlanetEntity()

Uses of PlanetAPI in com.fs.starfarer.api.campaign.listeners

Methods in com.fs.starfarer.api.campaign.listeners with parameters of type PlanetAPI

Modifier and Type	Method	Description
static void	ListenerUtil.reportPlayerColonizedPlanet(PlanetAPI planet)
void	PlayerColonizationListener.reportPlayerColonizedPlanet(PlanetAPI planet)
void	CoreDiscoverEntityPlugin.reportPlayerSurveyedPlanet(PlanetAPI planet)
static void	ListenerUtil.reportPlayerSurveyedPlanet(PlanetAPI planet)
void	SurveyPlanetListener.reportPlayerSurveyedPlanet(PlanetAPI planet)

Uses of PlanetAPI in com.fs.starfarer.api.impl.campaign

Methods in com.fs.starfarer.api.impl.campaign with parameters of type PlanetAPI

Modifier and Type	Method	Description
String	SurveyPluginImpl.getSurveyDataType(PlanetAPI planet)
void	SurveyPluginImpl.init(CampaignFleetAPI fleet, PlanetAPI planet)

Uses of PlanetAPI in com.fs.starfarer.api.impl.campaign.abilities

Methods in com.fs.starfarer.api.impl.campaign.abilities that return PlanetAPI

Modifier and Type	Method	Description
PlanetAPI	RemoteSurveyAbility.findBestPlanet()

Uses of PlanetAPI in com.fs.starfarer.api.impl.campaign.econ.impl

Methods in com.fs.starfarer.api.impl.campaign.econ.impl with parameters of type PlanetAPI

Modifier and Type	Method	Description
void	Mining.applyVisuals(PlanetAPI planet)
static void	PlanetaryShield.applyVisuals(PlanetAPI planet)
void	Mining.unapplyVisuals(PlanetAPI planet)
static void	PlanetaryShield.unapplyVisuals(PlanetAPI planet)

Uses of PlanetAPI in com.fs.starfarer.api.impl.campaign.enc

Methods in com.fs.starfarer.api.impl.campaign.enc that return PlanetAPI

Modifier and Type	Method	Description
PlanetAPI	AbyssalRogueStellarObjectEPEC.addBlackHole(StarSystemAPI system, StarSystemGenerator.GenContext context, HyperspaceAbyssPluginImpl.AbyssalEPData data)

Uses of PlanetAPI in com.fs.starfarer.api.impl.campaign.intel

Fields in com.fs.starfarer.api.impl.campaign.intel declared as PlanetAPI

Modifier and Type	Field	Description
protected PlanetAPI	SurveyPlanetMissionIntel.planet

Fields in com.fs.starfarer.api.impl.campaign.intel with type parameters of type PlanetAPI

Modifier and Type	Field	Description
protected WeightedRandomPicker<PlanetAPI>	SurveyPlanetIntelCreator.planetPicker

Methods in com.fs.starfarer.api.impl.campaign.intel that return PlanetAPI

Modifier and Type	Method	Description
PlanetAPI	SurveyPlanetMissionIntel.getPlanet()
protected PlanetAPI	SurveyPlanetIntelCreator.pickPlanet()

Methods in com.fs.starfarer.api.impl.campaign.intel with parameters of type PlanetAPI

Modifier and Type	Method	Description
static boolean	SurveyPlanetIntelCreator.isValidMissionTarget(PlanetAPI planet)
void	SurveyPlanetMissionIntel.reportPlayerSurveyedPlanet(PlanetAPI planet)

Constructors in com.fs.starfarer.api.impl.campaign.intel with parameters of type PlanetAPI

Modifier	Constructor	Description
	SurveyPlanetMissionIntel(PlanetAPI planet)

Uses of PlanetAPI in com.fs.starfarer.api.impl.campaign.intel.bar.events

Fields in com.fs.starfarer.api.impl.campaign.intel.bar.events declared as PlanetAPI

Modifier and Type	Field	Description
protected PlanetAPI	PlanetaryShieldIntel.planet

Methods in com.fs.starfarer.api.impl.campaign.intel.bar.events that return PlanetAPI

Modifier and Type	Method	Description
static PlanetAPI	PlanetaryShieldBarEvent.getTargetPlanet()

Constructors in com.fs.starfarer.api.impl.campaign.intel.bar.events with parameters of type PlanetAPI

Modifier	Constructor	Description
	PlanetaryShieldIntel(PlanetAPI planet, PlanetaryShieldBarEvent event)

Uses of PlanetAPI in com.fs.starfarer.api.impl.campaign.intel.bar.events.historian

Methods in com.fs.starfarer.api.impl.campaign.intel.bar.events.historian that return PlanetAPI

Modifier and Type	Method	Description
PlanetAPI	BaseHistorianOfferCreator.pickUnexploredRuins(Random random)

Uses of PlanetAPI in com.fs.starfarer.api.impl.campaign.intel.misc

Fields in com.fs.starfarer.api.impl.campaign.intel.misc declared as PlanetAPI

Modifier and Type	Field	Description
protected PlanetAPI	RemoteSurveyDataForPlanetIntel.planet
protected PlanetAPI	SurveyDataForPlanetIntel.planet

Constructors in com.fs.starfarer.api.impl.campaign.intel.misc with parameters of type PlanetAPI

Modifier	Constructor	Description
	RemoteSurveyDataForPlanetIntel(PlanetAPI planet)
	SurveyDataForPlanetIntel(PlanetAPI planet, String longText, TextPanelAPI textPanel)

Uses of PlanetAPI in com.fs.starfarer.api.impl.campaign.missions

Fields in com.fs.starfarer.api.impl.campaign.missions declared as PlanetAPI

Modifier and Type	Field	Description
protected PlanetAPI	RaidSecretOutpostMission.planet
protected PlanetAPI	RuinsDataSwapMission.planet

Methods in com.fs.starfarer.api.impl.campaign.missions that return PlanetAPI

Modifier and Type	Method	Description
static PlanetAPI	RecoverAPlanetkiller.getTundra()

Uses of PlanetAPI in com.fs.starfarer.api.impl.campaign.missions.academy

Fields in com.fs.starfarer.api.impl.campaign.missions.academy declared as PlanetAPI

Modifier and Type	Field	Description
protected PlanetAPI	GAProjectZiggurat.baseRuins
protected PlanetAPI	BasicExampleGADataFromRuins.planet
protected PlanetAPI	GADataFromRuins.planet
protected PlanetAPI	GAOutpost.planet
protected PlanetAPI	GATransverseJump.planet

Uses of PlanetAPI in com.fs.starfarer.api.impl.campaign.missions.hub

Fields in com.fs.starfarer.api.impl.campaign.missions.hub declared as PlanetAPI

Modifier and Type	Field	Description
PlanetAPI	MissionTrigger.TriggerActionContext.planet

Methods in com.fs.starfarer.api.impl.campaign.missions.hub that return PlanetAPI

Modifier and Type	Method	Description
PlanetAPI	HubMissionWithSearch.pickPlanet()
PlanetAPI	HubMissionWithSearch.pickPlanet(boolean resetSearch)

Methods in com.fs.starfarer.api.impl.campaign.missions.hub with parameters of type PlanetAPI

Modifier and Type	Method	Description
String	BaseHubMission.getGoToPlanetTextPre(PlanetAPI planet)
String	BaseHubMission.getGoToPlanetTextShort(PlanetAPI planet)
boolean	HubMissionWithSearch.MultiplePlanetRequirements.planetMatchesRequirement(PlanetAPI planet)
boolean	HubMissionWithSearch.PlanetFullySurveyedReq.planetMatchesRequirement(PlanetAPI planet)
boolean	HubMissionWithSearch.PlanetInDirectionOfOtherMissionsReq.planetMatchesRequirement(PlanetAPI planet)
boolean	HubMissionWithSearch.PlanetIsGasGiantReq.planetMatchesRequirement(PlanetAPI planet)
boolean	HubMissionWithSearch.PlanetIsPopulatedReq.planetMatchesRequirement(PlanetAPI planet)
boolean	HubMissionWithSearch.PlanetOrbitIsNotNearJumpPoint.planetMatchesRequirement(PlanetAPI planet)
boolean	HubMissionWithSearch.PlanetRequirement.planetMatchesRequirement(PlanetAPI planet)
boolean	HubMissionWithSearch.PlanetUnexploredRuinsReq.planetMatchesRequirement(PlanetAPI planet)
boolean	HubMissionWithSearch.PlanetUnsurveyedReq.planetMatchesRequirement(PlanetAPI planet)
boolean	HubMissionWithSearch.RequiredPlanetConditions.planetMatchesRequirement(PlanetAPI planet)
boolean	HubMissionWithSearch.RequiredPlanetTags.planetMatchesRequirement(PlanetAPI planet)
void	HubMissionWithSearch.requirePlanetNot(PlanetAPI planet)

Uses of PlanetAPI in com.fs.starfarer.api.impl.campaign.plog

Methods in com.fs.starfarer.api.impl.campaign.plog with parameters of type PlanetAPI

Modifier and Type	Method	Description
void	PlaythroughLog.reportPlayerColonizedPlanet(PlanetAPI planet)

Uses of PlanetAPI in com.fs.starfarer.api.impl.campaign.procgen

Fields in com.fs.starfarer.api.impl.campaign.procgen declared as PlanetAPI

Modifier and Type	Field	Description
PlanetAPI	StarSystemGenerator.GenContext.parent
protected PlanetAPI	EventTestPluginImpl.planet
protected PlanetAPI	ProcGenTestPluginImpl.planet
PlanetAPI	StarSystemGenerator.GeneratedPlanet.planet
protected PlanetAPI	StarSystemGenerator.secondary
protected PlanetAPI	StarSystemGenerator.star
protected PlanetAPI	StarSystemGenerator.tertiary

Fields in com.fs.starfarer.api.impl.campaign.procgen with type parameters of type PlanetAPI

Modifier and Type	Field	Description
protected Map<SectorEntityToken,PlanetAPI>	Constellation.lagrangeParentMap
protected Map<SectorEntityToken,PlanetAPI>	StarSystemGenerator.lagrangeParentMap

Methods in com.fs.starfarer.api.impl.campaign.procgen that return PlanetAPI

Modifier and Type	Method	Description
protected PlanetAPI	StarSystemGenerator.addRandomStar(String id, String name)

Methods in com.fs.starfarer.api.impl.campaign.procgen that return types with arguments of type PlanetAPI

Modifier and Type	Method	Description
Map<SectorEntityToken,PlanetAPI>	Constellation.getLagrangeParentMap()
Map<SectorEntityToken,PlanetAPI>	StarSystemGenerator.getLagrangeParentMap()

Methods in com.fs.starfarer.api.impl.campaign.procgen with parameters of type PlanetAPI

Modifier and Type	Method	Description
void	ColdConditionGenerator.addConditions(Set<String> conditionsSoFar, StarSystemGenerator.GenContext context, PlanetAPI planet)
void	GravityConditionGenerator.addConditions(Set<String> conditionsSoFar, StarSystemGenerator.GenContext context, PlanetAPI planet)
void	HotConditionGenerator.addConditions(Set<String> conditionsSoFar, StarSystemGenerator.GenContext context, PlanetAPI planet)
void	LightConditionGenerator.addConditions(Set<String> conditionsSoFar, StarSystemGenerator.GenContext context, PlanetAPI planet)
void	PlanetConditionGenerator.ConditionGenerator.addConditions(Set<String> conditionsSoFar, StarSystemGenerator.GenContext context, PlanetAPI planet)
void	RadiationConditionGenerator.addConditions(Set<String> conditionsSoFar, StarSystemGenerator.GenContext context, PlanetAPI planet)
protected void	StarSystemGenerator.addFarStar(PlanetAPI farStar, float orbitAngle, float baseOrbitRadius, float orbitPeriod)
static StarSystemGenerator.GenContext	PlanetConditionGenerator.createContext(PlanetAPI planet, StarAge age)
static void	PlanetConditionGenerator.generateConditionsForPlanet(PlanetAPI planet, StarAge age)
static void	PlanetConditionGenerator.generateConditionsForPlanet(StarSystemGenerator.GenContext context, PlanetAPI planet)
static void	PlanetConditionGenerator.generateConditionsForPlanet(StarSystemGenerator.GenContext context, PlanetAPI planet, StarAge age)
static WeightedRandomPicker<String>	PlanetConditionGenerator.getGroupPicker(String group, Set<String> conditionsSoFar, StarSystemGenerator.GenContext context, PlanetAPI planet)
protected Color	StarSystemGenerator.pickLightColorForStar(PlanetAPI star)
protected void	StarSystemGenerator.setBlackHoleIfBlackHole(PlanetAPI star)
protected void	StarSystemGenerator.setPulsarIfNeutron(PlanetAPI star)

Method parameters in com.fs.starfarer.api.impl.campaign.procgen with type arguments of type PlanetAPI

Modifier and Type	Method	Description
void	Constellation.setLagrangeParentMap(Map<SectorEntityToken,PlanetAPI> lagrangeParentMap)

Constructors in com.fs.starfarer.api.impl.campaign.procgen with parameters of type PlanetAPI

Modifier	Constructor	Description
	GenContext(StarSystemGenerator gen, StarSystemAPI system, SectorEntityToken center, StarGenDataSpec starData, PlanetAPI parent, int orbitIndex, String age, float currentRadius, float maxOrbitRadius, String parentCategory, int parentOrbitIndex)
	GeneratedPlanet(SectorEntityToken parent, PlanetAPI planet, boolean isMoon, float orbitDays, float orbitRadius, float orbitAngle)

Uses of PlanetAPI in com.fs.starfarer.api.impl.campaign.procgen.themes

Fields in com.fs.starfarer.api.impl.campaign.procgen.themes with type parameters of type PlanetAPI

Modifier and Type	Field	Description
List<PlanetAPI>	BaseThemeGenerator.StarSystemData.gasGiants
List<PlanetAPI>	BaseThemeGenerator.StarSystemData.habitable
List<PlanetAPI>	BaseThemeGenerator.StarSystemData.planets
List<PlanetAPI>	BaseThemeGenerator.StarSystemData.resourceRich
List<PlanetAPI>	BaseThemeGenerator.StarSystemData.stars

Methods in com.fs.starfarer.api.impl.campaign.procgen.themes that return PlanetAPI

Modifier and Type	Method	Description
static PlanetAPI	DerelictThemeGenerator.findInterestingPlanet(List<StarSystemAPI> systems, Set<PlanetAPI> exclude)
static PlanetAPI	DerelictThemeGenerator.findInterestingPlanet(List<StarSystemAPI> systems, Set<PlanetAPI> exclude, boolean includeKnown, boolean includeRuins, Random random)

Methods in com.fs.starfarer.api.impl.campaign.procgen.themes with parameters of type PlanetAPI

Modifier and Type	Method	Description
void	BaseThemeGenerator.addRuins(PlanetAPI planet)
static String	DerelictThemeGenerator.getInterestingCondition(PlanetAPI planet, boolean includeRuins)
String	BaseThemeGenerator.pickRuinsType(PlanetAPI planet)
boolean	BaseThemeGenerator.shouldHaveDecivilized(PlanetAPI planet, String ruins)

Method parameters in com.fs.starfarer.api.impl.campaign.procgen.themes with type arguments of type PlanetAPI

Modifier and Type	Method	Description
static PlanetAPI	DerelictThemeGenerator.findInterestingPlanet(List<StarSystemAPI> systems, Set<PlanetAPI> exclude)
static PlanetAPI	DerelictThemeGenerator.findInterestingPlanet(List<StarSystemAPI> systems, Set<PlanetAPI> exclude, boolean includeKnown, boolean includeRuins, Random random)

Uses of PlanetAPI in com.fs.starfarer.api.impl.campaign.rulecmd.salvage

Fields in com.fs.starfarer.api.impl.campaign.rulecmd.salvage declared as PlanetAPI

Modifier and Type	Field	Description
protected PlanetAPI	RedPlanet.planet

Uses of PlanetAPI in com.fs.starfarer.api.impl.campaign.rulecmd.salvage.special

Methods in com.fs.starfarer.api.impl.campaign.rulecmd.salvage.special with parameters of type PlanetAPI

Modifier and Type	Method	Description
static String	BreadcrumbSpecial.getStarColorName(PlanetAPI star)
static String	DomainSurveyDerelictSpecial.getStarDescription(PlanetAPI star)
static String	BreadcrumbSpecial.getStarTypeName(PlanetAPI star)

Uses of PlanetAPI in com.fs.starfarer.api.impl.campaign.tutorial

Fields in com.fs.starfarer.api.impl.campaign.tutorial declared as PlanetAPI

Modifier and Type	Field	Description
protected PlanetAPI	CampaignTutorialScript.ancyra
protected PlanetAPI	TutorialMissionEvent.ancyra
protected PlanetAPI	TutorialMissionIntel.ancyra
protected PlanetAPI	TutorialMissionEvent.jangala
protected PlanetAPI	TutorialMissionIntel.jangala
protected PlanetAPI	TutorialMissionEvent.pontus
protected PlanetAPI	TutorialMissionIntel.pontus
protected PlanetAPI	TutorialMissionEvent.tetra
protected PlanetAPI	TutorialMissionIntel.tetra

Methods in com.fs.starfarer.api.impl.campaign.tutorial with parameters of type PlanetAPI

Modifier and Type	Method	Description
static PersonAPI	TutorialMissionEvent.createMainContact(PlanetAPI ancyra)
static PersonAPI	TutorialMissionIntel.createMainContact(PlanetAPI ancyra)

Uses of PlanetAPI in com.fs.starfarer.api.impl.campaign.world

Methods in com.fs.starfarer.api.impl.campaign.world with parameters of type PlanetAPI

Modifier and Type	Method	Description
protected void	NamelessRock.addOnslaughtMkI(PlanetAPI rock)

Uses of PlanetAPI in com.fs.starfarer.api.impl.combat

Fields in com.fs.starfarer.api.impl.combat declared as PlanetAPI

Modifier and Type	Field	Description
protected PlanetAPI	BattleCreationPluginImpl.NearbyPlanetData.planet

Methods in com.fs.starfarer.api.impl.combat that return PlanetAPI

Modifier and Type	Method	Description
protected PlanetAPI	BattleCreationPluginImpl.getClosestPlanet(CampaignFleetAPI playerFleet)

Constructors in com.fs.starfarer.api.impl.combat with parameters of type PlanetAPI

Modifier	Constructor	Description
	NearbyPlanetData(org.lwjgl.util.vector.Vector2f offset, PlanetAPI planet)

Uses of PlanetAPI in com.fs.starfarer.api.mission

Methods in com.fs.starfarer.api.mission with parameters of type PlanetAPI

Modifier and Type	Method	Description
void	MissionDefinitionAPI.addPlanet(float x, float y, float radius, PlanetAPI planet, float gravity, boolean backgroundPlanet)	Bases the look of the planet on the PlanetAPI passed in.

Uses of PlanetAPI in com.fs.starfarer.api.plugins

Methods in com.fs.starfarer.api.plugins with parameters of type PlanetAPI

Modifier and Type	Method	Description
default int	SurveyPlugin.getSurveyDataScore(PlanetAPI planet)
String	SurveyPlugin.getSurveyDataType(PlanetAPI planet)
void	SurveyPlugin.init(CampaignFleetAPI fleet, PlanetAPI planet)

Uses of PlanetAPI in com.fs.starfarer.api.ui

Methods in com.fs.starfarer.api.ui with parameters of type PlanetAPI

Modifier and Type	Method	Description
void	TooltipMakerAPI.showFullSurveyReqs(PlanetAPI planet, boolean withText, float pad)
void	TooltipMakerAPI.showPlanetInfo(PlanetAPI planet, float pad)
void	TooltipMakerAPI.showPlanetInfo(PlanetAPI planet, float w, float h, boolean withName, float pad)
void	TooltipMakerAPI.showPlanetInfo(PlanetAPI planet, float w, float h, TooltipMakerAPI.PlanetInfoParams params, float pad)

Uses of PlanetAPI in com.fs.starfarer.api.util

Methods in com.fs.starfarer.api.util that return PlanetAPI

Modifier and Type	Method	Description
static PlanetAPI	Misc.getPulsarInSystem(StarSystemAPI system)

Methods in com.fs.starfarer.api.util with parameters of type PlanetAPI

Modifier and Type	Method	Description
static void	Misc.addSurveyDataFor(PlanetAPI planet, TextPanelAPI text)
static StarCoronaTerrainPlugin	Misc.getCoronaFor(PlanetAPI star)
static int	Misc.getEstimatedOrbitIndex(PlanetAPI planet)
static JumpPointAPI	Misc.getJumpPointTo(PlanetAPI star)
static MagneticFieldTerrainPlugin	Misc.getMagneticFieldFor(PlanetAPI planet)
static String	Misc.getPlanetSurveyClass(PlanetAPI planet)
static PulsarBeamTerrainPlugin	Misc.getPulsarFor(PlanetAPI star)
static String	Misc.getStarId(PlanetAPI planet)
static void	Misc.initConditionMarket(PlanetAPI planet)
static void	Misc.initEconomyMarket(PlanetAPI planet)