Inheritance diagram for com.fs.starfarer.api.campaign.PlanetAPI:

Collaboration diagram for com.fs.starfarer.api.campaign.PlanetAPI:

Public Member Functions
String	getTypeId ()

boolean	isStar ()

boolean	isNormalStar ()

boolean	isGasGiant ()

boolean	isMoon ()

PlanetSpecAPI	getSpec ()

void	applySpecChanges ()

void	setRadius (float radius)

Color	getLightColorOverrideIfStar ()

void	setLightColorOverrideIfStar (Color lightColorOverrideIfStar)

String	getTypeNameWithWorld ()

String	getTypeNameWithLowerCaseWorld ()

void	setTypeId (String typeId)

boolean	hasCondition (String id)

void	setSecondLight (Vector3f location, Color color)

String	getTypeNameWithWorldLowerCase ()

void	changeType (String type, Random random)

String	getDescriptionIdOverride ()

void	setDescriptionIdOverride (String descriptionIdOverride)

boolean	isBlackHole ()

Public Member Functions inherited from com.fs.starfarer.api.campaign.SectorEntityToken
boolean	isPlayerFleet ()

MarketAPI	getMarket ()

void	setMarket (MarketAPI market)

CargoAPI	getCargo ()

Vector2f	getLocation ()

Vector2f	getLocationInHyperspace ()

OrbitAPI	getOrbit ()

void	setOrbit (OrbitAPI orbit)

String	getId ()

String	getName ()

String	getFullName ()

void	setFaction (String factionId)

LocationAPI	getContainingLocation ()

float	getRadius ()

FactionAPI	getFaction ()

String	getCustomDescriptionId ()

void	setCustomDescriptionId (String customDescriptionId)

void	setCustomInteractionDialogImageVisual (InteractionDialogImageVisual visual)

InteractionDialogImageVisual	getCustomInteractionDialogImageVisual ()

void	setFreeTransfer (boolean freeTransfer)

boolean	isFreeTransfer ()

boolean	hasTag (String tag)

void	addTag (String tag)

void	removeTag (String tag)

Collection< String >	getTags ()

void	clearTags ()

void	setFixedLocation (float x, float y)

void	setCircularOrbit (SectorEntityToken focus, float angle, float orbitRadius, float orbitDays)

void	setCircularOrbitPointingDown (SectorEntityToken focus, float angle, float orbitRadius, float orbitDays)

void	setCircularOrbitWithSpin (SectorEntityToken focus, float angle, float orbitRadius, float orbitDays, float minSpin, float maxSpin)

MemoryAPI	getMemory ()

MemoryAPI	getMemoryWithoutUpdate ()

float	getFacing ()

void	setFacing (float facing)

boolean	isInHyperspace ()

void	addScript (EveryFrameScript script)

void	removeScript (EveryFrameScript script)

void	removeScriptsOfClass (Class c)

boolean	isInOrNearSystem (StarSystemAPI system)

boolean	isInCurrentLocation ()

Vector2f	getVelocity ()

void	setInteractionImage (String category, String key)

void	setName (String name)

boolean	isAlive ()

PersonAPI	getActivePerson ()

void	setActivePerson (PersonAPI activePerson)

boolean	isVisibleToSensorsOf (SectorEntityToken other)

boolean	isVisibleToPlayerFleet ()

VisibilityLevel	getVisibilityLevelToPlayerFleet ()

VisibilityLevel	getVisibilityLevelTo (SectorEntityToken other)

void	addAbility (String id)

void	removeAbility (String id)

AbilityPlugin	getAbility (String id)

boolean	hasAbility (String id)

Map< String, AbilityPlugin >	getAbilities ()

boolean	isTransponderOn ()

void	setTransponderOn (boolean transponderOn)

void	addFloatingText (String text, Color color, float duration)

SectorEntityToken	getLightSource ()

Color	getLightColor ()

void	setMemory (MemoryAPI memory)

Map< String, Object >	getCustomData ()

Color	getIndicatorColor ()

CustomCampaignEntityPlugin	getCustomPlugin ()

float	getCircularOrbitRadius ()

float	getCircularOrbitPeriod ()

SectorEntityToken	getOrbitFocus ()

void	setId (String id)

String	getAutogenJumpPointNameInHyper ()

void	setAutogenJumpPointNameInHyper (String autogenJumpPointNameInHyper)

boolean	isSkipForJumpPointAutoGen ()

void	setSkipForJumpPointAutoGen (boolean skipForJumpPointAutoGen)

float	getCircularOrbitAngle ()

String	getCustomEntityType ()

float	getSensorStrength ()

void	setSensorStrength (Float sensorStrength)

float	getSensorProfile ()

void	setSensorProfile (Float sensorProfile)

StatBonus	getDetectedRangeMod ()

StatBonus	getSensorRangeMod ()

float	getBaseSensorRangeToDetect (float sensorProfile)

boolean	hasSensorStrength ()

boolean	hasSensorProfile ()

float	getMaxSensorRangeToDetect (SectorEntityToken other)

boolean	isDiscoverable ()

void	setDiscoverable (Boolean discoverable)

CustomEntitySpecAPI	getCustomEntitySpec ()

List< DropData >	getDropValue ()

List< DropData >	getDropRandom ()

void	addDropValue (String group, int value)

void	addDropRandom (String group, int chances)

void	addDropRandom (String group, int chances, int value)

boolean	isExpired ()

void	setExpired (boolean expired)

float	getSensorFaderBrightness ()

float	getSensorContactFaderBrightness ()

void	forceSensorFaderBrightness (float b)

Float	getDiscoveryXP ()

void	setDiscoveryXP (Float discoveryXP)

boolean	hasDiscoveryXP ()

void	addDropValue (DropData data)

void	addDropRandom (DropData data)

void	setAlwaysUseSensorFaderBrightness (Boolean alwaysUseSensorFaderBrightness)

Boolean	getAlwaysUseSensorFaderBrightness ()

void	advance (float amount)

boolean	hasScriptOfClass (Class c)

void	setContainingLocation (LocationAPI location)

void	clearAbilities ()

Constellation	getConstellation ()

Float	getSalvageXP ()

void	setSalvageXP (Float salvageXP)

boolean	hasSalvageXP ()

void	setDetectionRangeDetailsOverrideMult (Float detectionRangeDetailsOverrideMult)

Float	getDetectionRangeDetailsOverrideMult ()

VisibilityLevel	getVisibilityLevelOfPlayerFleet ()

void	setCircularOrbitAngle (float angle)

void	addFloatingText (String text, Color color, float duration, boolean showWhenOnlySensorContact)

boolean	isSystemCenter ()

StarSystemAPI	getStarSystem ()

void	clearFloatingText ()

void	setLocation (float x, float y)

void	autoUpdateHyperLocationBasedOnInSystemEntityAtRadius (SectorEntityToken entity, float radius)

void	forceSensorContactFaderBrightness (float b)

void	forceSensorFaderOut ()

void	setLightSource (SectorEntityToken star, Color color)

List< EveryFrameScript >	getScripts ()

float	getExtendedDetectedAtRange ()

void	setExtendedDetectedAtRange (Float extendedDetectedAtRange)

void	fadeOutIndicator ()

void	fadeInIndicator ()

void	forceOutIndicator ()

void	setOrbitFocus (SectorEntityToken focus)

Detailed Description

Definition at line 10 of file PlanetAPI.java.

Member Function Documentation

◆ applySpecChanges()

void com.fs.starfarer.api.campaign.PlanetAPI.applySpecChanges ( )

Applies any changes made using getSpec().setXXX to the planet's graphics.

◆ changeType()

void com.fs.starfarer.api.campaign.PlanetAPI.changeType	(	String	type,
		Random	random
	)

◆ getDescriptionIdOverride()

String com.fs.starfarer.api.campaign.PlanetAPI.getDescriptionIdOverride ( )

◆ getLightColorOverrideIfStar()

Color com.fs.starfarer.api.campaign.PlanetAPI.getLightColorOverrideIfStar ( )

◆ getSpec()

PlanetSpecAPI com.fs.starfarer.api.campaign.PlanetAPI.getSpec ( )

The object returned by this method can be changed to control how this specific planet looks, without affecting other planets of the same type.

applySpecChanges() must be called for the changes to take effect.

Returns

◆ getTypeId()

String com.fs.starfarer.api.campaign.PlanetAPI.getTypeId ( )

◆ getTypeNameWithLowerCaseWorld()

String com.fs.starfarer.api.campaign.PlanetAPI.getTypeNameWithLowerCaseWorld ( )

◆ getTypeNameWithWorld()

String com.fs.starfarer.api.campaign.PlanetAPI.getTypeNameWithWorld ( )

◆ getTypeNameWithWorldLowerCase()

String com.fs.starfarer.api.campaign.PlanetAPI.getTypeNameWithWorldLowerCase ( )

◆ hasCondition()

boolean com.fs.starfarer.api.campaign.PlanetAPI.hasCondition ( String id )

◆ isBlackHole()

boolean com.fs.starfarer.api.campaign.PlanetAPI.isBlackHole ( )

◆ isGasGiant()

boolean com.fs.starfarer.api.campaign.PlanetAPI.isGasGiant ( )

◆ isMoon()

boolean com.fs.starfarer.api.campaign.PlanetAPI.isMoon ( )

◆ isNormalStar()

boolean com.fs.starfarer.api.campaign.PlanetAPI.isNormalStar ( )

Star, not a black hole or a pulsar or a nebula center.

Returns

◆ isStar()

boolean com.fs.starfarer.api.campaign.PlanetAPI.isStar ( )

Implements com.fs.starfarer.api.campaign.SectorEntityToken.

◆ setDescriptionIdOverride()

void com.fs.starfarer.api.campaign.PlanetAPI.setDescriptionIdOverride ( String descriptionIdOverride )

◆ setLightColorOverrideIfStar()

void com.fs.starfarer.api.campaign.PlanetAPI.setLightColorOverrideIfStar ( Color lightColorOverrideIfStar )

◆ setRadius()

void com.fs.starfarer.api.campaign.PlanetAPI.setRadius ( float radius )

◆ setSecondLight()

void com.fs.starfarer.api.campaign.PlanetAPI.setSecondLight	(	Vector3f	location,
		Color	color
	)

◆ setTypeId()

void com.fs.starfarer.api.campaign.PlanetAPI.setTypeId ( String typeId )

The documentation for this interface was generated from the following file:

src/com/fs/starfarer/api/campaign/PlanetAPI.java

Public Member Functions