com.fs.starfarer.api.campaign.PlanetSpecAPI Interface Reference

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

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

Public Member Functions
String	getName ()
float	getTilt ()
float	getPitch ()
float	getRotation ()
Color	getPlanetColor ()
float	getAtmosphereThickness ()
Color	getAtmosphereColor ()
boolean	isStar ()
String	getPlanetType ()
float	getAtmosphereThicknessMin ()
Vector3f	getLightPosition ()
float	getCloudRotation ()
Color	getIconColor ()
Color	getCloudColor ()
void	setTilt (float tilt)
void	setPitch (float pitch)
void	setRotation (float rotation)
void	setPlanetColor (Color planetColor)
void	setCloudRotation (float cloudRotation)
void	setAtmosphereThickness (float atmosphereThickness)
void	setAtmosphereThicknessMin (float atmosphereThicknessMin)
void	setAtmosphereColor (Color atmosphereColor)
void	setCloudColor (Color cloudColor)
void	setIconColor (Color iconColor)
float	getCoronaSize ()
void	setCoronaSize (float coronaSize)
Color	getCoronaColor ()
void	setCoronaColor (Color coronaColor)
String	getCloudTexture ()
void	setCloudTexture (String textureName)
void	setTexture (String texture)
String	getTexture ()
String	getCoronaTexture ()
void	setCoronaTexture (String coronaTexture)
void	setGlowTexture (String glowTexture)
String	getGlowTexture ()
Color	getGlowColor ()
void	setGlowColor (Color glowColor)
boolean	isUseReverseLightForGlow ()
void	setUseReverseLightForGlow (boolean useReverseLightForGlow)
String	getIconTexture ()
String	getAOrAn ()
boolean	isBlackHole ()
void	setBlackHole (boolean isBlackHole)
boolean	isNebulaCenter ()
void	setNebulaCenter (boolean isNebulaCenter)
float	getScaleMultMapIcon ()
void	setScaleMultMapIcon (float scaleMultMapIcon)
float	getScaleMultStarscapeIcon ()
void	setScaleMultStarscapeIcon (float scaleMultStarscapeIcon)
String	getStarscapeIcon ()
void	setStarscapeIcon (String starscapeIcon)
boolean	isPulsar ()
void	setPulsar (boolean isPulsar)
float	getShieldThickness ()
void	setShieldThickness (float shieldThickness)
String	getShieldTexture ()
void	setShieldTexture (String shieldTexture)
Color	getShieldColor ()
void	setShieldColor (Color shieldColor)
String	getShieldTexture2 ()
void	setShieldTexture2 (String shieldTexture2)
float	getShieldThickness2 ()
void	setShieldThickness2 (float shieldThickness2)
Color	getShieldColor2 ()
void	setShieldColor2 (Color shieldColor2)
boolean	isDoNotShowInCombat ()
void	setDoNotShowInCombat (boolean doNotShowInCombat)
boolean	isGasGiant ()
String	getDescriptionId ()
void	setDescriptionId (String descriptionId)
Set< String >	getTags ()
void	addTag (String tag)
boolean	hasTag (String tag)
Public Member Functions inherited from com.fs.starfarer.api.loading.WithSourceMod
ModSpecAPI	getSourceMod ()

Detailed Description

Definition at line 11 of file PlanetSpecAPI.java.

Member Function Documentation

addTag()

void com.fs.starfarer.api.campaign.PlanetSpecAPI.addTag

(

String

tag

)

getAOrAn()

String com.fs.starfarer.api.campaign.PlanetSpecAPI.getAOrAn

(

)

getAtmosphereColor()

Color com.fs.starfarer.api.campaign.PlanetSpecAPI.getAtmosphereColor

(

)

getAtmosphereThickness()

float com.fs.starfarer.api.campaign.PlanetSpecAPI.getAtmosphereThickness

(

)

getAtmosphereThicknessMin()

float com.fs.starfarer.api.campaign.PlanetSpecAPI.getAtmosphereThicknessMin

(

)

getCloudColor()

Color com.fs.starfarer.api.campaign.PlanetSpecAPI.getCloudColor

(

)

getCloudRotation()

float com.fs.starfarer.api.campaign.PlanetSpecAPI.getCloudRotation

(

)

getCloudTexture()

String com.fs.starfarer.api.campaign.PlanetSpecAPI.getCloudTexture

(

)

Use SettingsAPI.getSpriteName(String category, String id) to get the texture name to pass in here. The texture needs to already be loaded (which textures from settings.json will be). Do NOT just pass in a filename for a texture that's not already loaded.

Returns

getCoronaColor()

Color com.fs.starfarer.api.campaign.PlanetSpecAPI.getCoronaColor

(

)

getCoronaSize()

float com.fs.starfarer.api.campaign.PlanetSpecAPI.getCoronaSize

(

)

getCoronaTexture()

String com.fs.starfarer.api.campaign.PlanetSpecAPI.getCoronaTexture

(

)

getDescriptionId()

String com.fs.starfarer.api.campaign.PlanetSpecAPI.getDescriptionId

(

)

getGlowColor()

Color com.fs.starfarer.api.campaign.PlanetSpecAPI.getGlowColor

(

)

getGlowTexture()

String com.fs.starfarer.api.campaign.PlanetSpecAPI.getGlowTexture

(

)

getIconColor()

Color com.fs.starfarer.api.campaign.PlanetSpecAPI.getIconColor

(

)

getIconTexture()

String com.fs.starfarer.api.campaign.PlanetSpecAPI.getIconTexture

(

)

getLightPosition()

Vector3f com.fs.starfarer.api.campaign.PlanetSpecAPI.getLightPosition

(

)

getName()

String com.fs.starfarer.api.campaign.PlanetSpecAPI.getName

(

)

getPitch()

float com.fs.starfarer.api.campaign.PlanetSpecAPI.getPitch

(

)

getPlanetColor()

Color com.fs.starfarer.api.campaign.PlanetSpecAPI.getPlanetColor

(

)

getPlanetType()

String com.fs.starfarer.api.campaign.PlanetSpecAPI.getPlanetType

(

)

getRotation()

float com.fs.starfarer.api.campaign.PlanetSpecAPI.getRotation

(

)

getScaleMultMapIcon()

float com.fs.starfarer.api.campaign.PlanetSpecAPI.getScaleMultMapIcon

(

)

getScaleMultStarscapeIcon()

float com.fs.starfarer.api.campaign.PlanetSpecAPI.getScaleMultStarscapeIcon

(

)

getShieldColor()

Color com.fs.starfarer.api.campaign.PlanetSpecAPI.getShieldColor

(

)

getShieldColor2()

Color com.fs.starfarer.api.campaign.PlanetSpecAPI.getShieldColor2

(

)

getShieldTexture()

String com.fs.starfarer.api.campaign.PlanetSpecAPI.getShieldTexture

(

)

getShieldTexture2()

String com.fs.starfarer.api.campaign.PlanetSpecAPI.getShieldTexture2

(

)

getShieldThickness()

float com.fs.starfarer.api.campaign.PlanetSpecAPI.getShieldThickness

(

)

getShieldThickness2()

float com.fs.starfarer.api.campaign.PlanetSpecAPI.getShieldThickness2

(

)

getStarscapeIcon()

String com.fs.starfarer.api.campaign.PlanetSpecAPI.getStarscapeIcon

(

)

getTags()

Set< String > com.fs.starfarer.api.campaign.PlanetSpecAPI.getTags

(

)

getTexture()

String com.fs.starfarer.api.campaign.PlanetSpecAPI.getTexture

(

)

getTilt()

float com.fs.starfarer.api.campaign.PlanetSpecAPI.getTilt

(

)

hasTag()

boolean com.fs.starfarer.api.campaign.PlanetSpecAPI.hasTag

(

String

tag

)

isBlackHole()

boolean com.fs.starfarer.api.campaign.PlanetSpecAPI.isBlackHole

(

)

isDoNotShowInCombat()

boolean com.fs.starfarer.api.campaign.PlanetSpecAPI.isDoNotShowInCombat

(

)

isGasGiant()

boolean com.fs.starfarer.api.campaign.PlanetSpecAPI.isGasGiant

(

)

isNebulaCenter()

boolean com.fs.starfarer.api.campaign.PlanetSpecAPI.isNebulaCenter

(

)

isPulsar()

boolean com.fs.starfarer.api.campaign.PlanetSpecAPI.isPulsar

(

)

isStar()

boolean com.fs.starfarer.api.campaign.PlanetSpecAPI.isStar

(

)

isUseReverseLightForGlow()

boolean com.fs.starfarer.api.campaign.PlanetSpecAPI.isUseReverseLightForGlow

(

)

setAtmosphereColor()

void com.fs.starfarer.api.campaign.PlanetSpecAPI.setAtmosphereColor

(

Color

atmosphereColor

)

setAtmosphereThickness()

void com.fs.starfarer.api.campaign.PlanetSpecAPI.setAtmosphereThickness

(

float

atmosphereThickness

)

setAtmosphereThicknessMin()

void com.fs.starfarer.api.campaign.PlanetSpecAPI.setAtmosphereThicknessMin

(

float

atmosphereThicknessMin

)

setBlackHole()

void com.fs.starfarer.api.campaign.PlanetSpecAPI.setBlackHole

(

boolean

isBlackHole

)

setCloudColor()

void com.fs.starfarer.api.campaign.PlanetSpecAPI.setCloudColor

(

Color

cloudColor

)

setCloudRotation()

void com.fs.starfarer.api.campaign.PlanetSpecAPI.setCloudRotation

(

float

cloudRotation

)

setCloudTexture()

void com.fs.starfarer.api.campaign.PlanetSpecAPI.setCloudTexture

(

String

textureName

)

setCoronaColor()

void com.fs.starfarer.api.campaign.PlanetSpecAPI.setCoronaColor

(

Color

coronaColor

)

setCoronaSize()

void com.fs.starfarer.api.campaign.PlanetSpecAPI.setCoronaSize

(

float

coronaSize

)

setCoronaTexture()

void com.fs.starfarer.api.campaign.PlanetSpecAPI.setCoronaTexture

(

String

coronaTexture

)

Use SettingsAPI.getSpriteName(String category, String id) to get the texture name to pass in here. The texture needs to already be loaded (which textures from settings.json will be). Do NOT just pass in a filename for a texture that's not already loaded.

Returns

setDescriptionId()

void com.fs.starfarer.api.campaign.PlanetSpecAPI.setDescriptionId

(

String

descriptionId

)

setDoNotShowInCombat()

void com.fs.starfarer.api.campaign.PlanetSpecAPI.setDoNotShowInCombat

(

boolean

doNotShowInCombat

)

setGlowColor()

void com.fs.starfarer.api.campaign.PlanetSpecAPI.setGlowColor

(

Color

glowColor

)

setGlowTexture()

void com.fs.starfarer.api.campaign.PlanetSpecAPI.setGlowTexture

(

String

glowTexture

)

Use SettingsAPI.getSpriteName(String category, String id) to get the texture name to pass in here. The texture needs to already be loaded (which textures from settings.json will be). Do NOT just pass in a filename for a texture that's not already loaded.

Returns

setIconColor()

void com.fs.starfarer.api.campaign.PlanetSpecAPI.setIconColor

(

Color

iconColor

)

setNebulaCenter()

void com.fs.starfarer.api.campaign.PlanetSpecAPI.setNebulaCenter

(

boolean

isNebulaCenter

)

setPitch()

void com.fs.starfarer.api.campaign.PlanetSpecAPI.setPitch

(

float

pitch

)

setPlanetColor()

void com.fs.starfarer.api.campaign.PlanetSpecAPI.setPlanetColor

(

Color

planetColor

)

setPulsar()

void com.fs.starfarer.api.campaign.PlanetSpecAPI.setPulsar

(

boolean

isPulsar

)

setRotation()

void com.fs.starfarer.api.campaign.PlanetSpecAPI.setRotation

(

float

rotation

)

setScaleMultMapIcon()

void com.fs.starfarer.api.campaign.PlanetSpecAPI.setScaleMultMapIcon

(

float

scaleMultMapIcon

)

setScaleMultStarscapeIcon()

void com.fs.starfarer.api.campaign.PlanetSpecAPI.setScaleMultStarscapeIcon

(

float

scaleMultStarscapeIcon

)

setShieldColor()

void com.fs.starfarer.api.campaign.PlanetSpecAPI.setShieldColor

(

Color

shieldColor

)

setShieldColor2()

void com.fs.starfarer.api.campaign.PlanetSpecAPI.setShieldColor2

(

Color

shieldColor2

)

setShieldTexture()

void com.fs.starfarer.api.campaign.PlanetSpecAPI.setShieldTexture

(

String

shieldTexture

)

setShieldTexture2()

void com.fs.starfarer.api.campaign.PlanetSpecAPI.setShieldTexture2

(

String

shieldTexture2

)

setShieldThickness()

void com.fs.starfarer.api.campaign.PlanetSpecAPI.setShieldThickness

(

float

shieldThickness

)

setShieldThickness2()

void com.fs.starfarer.api.campaign.PlanetSpecAPI.setShieldThickness2

(

float

shieldThickness2

)

setStarscapeIcon()

void com.fs.starfarer.api.campaign.PlanetSpecAPI.setStarscapeIcon

(

String

starscapeIcon

)

setTexture()

void com.fs.starfarer.api.campaign.PlanetSpecAPI.setTexture

(

String

texture

)

Use SettingsAPI.getSpriteName(String category, String id) to get the texture name to pass in here. The texture needs to already be loaded (which textures from settings.json will be). Do NOT just pass in a filename for a texture that's not already loaded.

Returns

setTilt()

void com.fs.starfarer.api.campaign.PlanetSpecAPI.setTilt

(

float

tilt

)

setUseReverseLightForGlow()

void com.fs.starfarer.api.campaign.PlanetSpecAPI.setUseReverseLightForGlow

(

boolean

useReverseLightForGlow

)

---

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

• src/com/fs/starfarer/api/campaign/PlanetSpecAPI.java