com.fs.starfarer.api.campaign

Interface PlanetAPI

All Superinterfaces:

HasMemory, SectorEntityToken

public interface PlanetAPI
extends SectorEntityToken

Nested Class Summary

Nested classes/interfaces inherited from interface com.fs.starfarer.api.campaign.SectorEntityToken

SectorEntityToken.VisibilityLevel

Method Summary

Methods

Modifier and Type	Method and Description
void	applySpecChanges() Applies any changes made using getSpec().setXXX to the planet's graphics.
void	changeType(java.lang.String type, java.util.Random random)
java.lang.String	getDescriptionIdOverride()
java.awt.Color	getLightColorOverrideIfStar()
PlanetSpecAPI	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.
java.lang.String	getTypeId()
java.lang.String	getTypeNameWithLowerCaseWorld()
java.lang.String	getTypeNameWithWorld()
java.lang.String	getTypeNameWithWorldLowerCase()
boolean	hasCondition(java.lang.String id)
boolean	isBlackHole()
boolean	isGasGiant()
boolean	isMoon()
boolean	isNormalStar() Star, not a black hole or a pulsar or a nebula center.
boolean	isStar()
void	setDescriptionIdOverride(java.lang.String descriptionIdOverride)
void	setLightColorOverrideIfStar(java.awt.Color lightColorOverrideIfStar)
void	setRadius(float radius)
void	setSecondLight(Vector3f location, java.awt.Color color)
void	setTypeId(java.lang.String typeId)

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

addAbility, addDropRandom, addDropRandom, addDropRandom, addDropValue, addDropValue, addFloatingText, addFloatingText, addScript, addTag, advance, autoUpdateHyperLocationBasedOnInSystemEntityAtRadius, clearAbilities, clearFloatingText, clearTags, fadeInIndicator, fadeOutIndicator, forceOutIndicator, forceSensorContactFaderBrightness, forceSensorFaderBrightness, forceSensorFaderOut, getAbilities, getAbility, getActivePerson, getAlwaysUseSensorFaderBrightness, getAutogenJumpPointNameInHyper, getBaseSensorRangeToDetect, getCargo, getCircularOrbitAngle, getCircularOrbitPeriod, getCircularOrbitRadius, getConstellation, getContainingLocation, getCustomData, getCustomDescriptionId, getCustomEntitySpec, getCustomEntityType, getCustomInteractionDialogImageVisual, getCustomPlugin, getDetectedRangeMod, getDetectionRangeDetailsOverrideMult, getDiscoveryXP, getDropRandom, getDropValue, getExtendedDetectedAtRange, getFacing, getFaction, getFullName, getId, getIndicatorColor, getLightColor, getLightSource, getLocation, getLocationInHyperspace, getMarket, getMaxSensorRangeToDetect, getMemory, getMemoryWithoutUpdate, getName, getOrbit, getOrbitFocus, getRadius, getSalvageXP, getScripts, getSensorContactFaderBrightness, getSensorFaderBrightness, getSensorProfile, getSensorRangeMod, getSensorStrength, getStarSystem, getTags, getVelocity, getVisibilityLevelOfPlayerFleet, getVisibilityLevelTo, getVisibilityLevelToPlayerFleet, hasAbility, hasDiscoveryXP, hasSalvageXP, hasScriptOfClass, hasSensorProfile, hasSensorStrength, hasTag, isAlive, isDiscoverable, isExpired, isFreeTransfer, isInCurrentLocation, isInHyperspace, isInOrNearSystem, isPlayerFleet, isSkipForJumpPointAutoGen, isSystemCenter, isTransponderOn, isVisibleToPlayerFleet, isVisibleToSensorsOf, removeAbility, removeScript, removeScriptsOfClass, removeTag, setActivePerson, setAlwaysUseSensorFaderBrightness, setAutogenJumpPointNameInHyper, setCircularOrbit, setCircularOrbitAngle, setCircularOrbitPointingDown, setCircularOrbitWithSpin, setContainingLocation, setCustomDescriptionId, setCustomInteractionDialogImageVisual, setDetectionRangeDetailsOverrideMult, setDiscoverable, setDiscoveryXP, setExpired, setExtendedDetectedAtRange, setFacing, setFaction, setFixedLocation, setFreeTransfer, setId, setInteractionImage, setLightSource, setLocation, setMarket, setMemory, setName, setOrbit, setSalvageXP, setSensorProfile, setSensorStrength, setSkipForJumpPointAutoGen, setTransponderOn

Method Detail

getTypeId

java.lang.String getTypeId()

isStar

boolean isStar()

Specified by:

isStar in interface SectorEntityToken

isNormalStar

boolean isNormalStar()

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

Returns:

isGasGiant

boolean isGasGiant()

isMoon

boolean isMoon()

getSpec

PlanetSpecAPI 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:

applySpecChanges

void applySpecChanges()

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

setRadius

void setRadius(float radius)

getLightColorOverrideIfStar

java.awt.Color getLightColorOverrideIfStar()

setLightColorOverrideIfStar

void setLightColorOverrideIfStar(java.awt.Color lightColorOverrideIfStar)

getTypeNameWithWorld

java.lang.String getTypeNameWithWorld()

getTypeNameWithLowerCaseWorld

java.lang.String getTypeNameWithLowerCaseWorld()

setTypeId

void setTypeId(java.lang.String typeId)

hasCondition

boolean hasCondition(java.lang.String id)

setSecondLight

void setSecondLight(Vector3f location,
                  java.awt.Color color)

getTypeNameWithWorldLowerCase

java.lang.String getTypeNameWithWorldLowerCase()

changeType

void changeType(java.lang.String type,
              java.util.Random random)

getDescriptionIdOverride

java.lang.String getDescriptionIdOverride()

setDescriptionIdOverride

void setDescriptionIdOverride(java.lang.String descriptionIdOverride)

isBlackHole

boolean isBlackHole()