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

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

Public Member Functions
String	getId ()
boolean	activeThisFrame ()
String	getBackgroundTextureFilename ()
void	setBackgroundTextureFilename (String backgroundTextureFilename)
void	addSpawnPoint (SpawnPointPlugin point)
void	removeSpawnPoint (SpawnPointPlugin point)
List< SpawnPointPlugin >	getSpawnPoints ()
void	spawnFleet (SectorEntityToken anchor, float xOffset, float yOffset, CampaignFleetAPI fleet)
SectorEntityToken	createToken (float x, float y)
SectorEntityToken	createToken (Vector2f loc)
void	addEntity (SectorEntityToken entity)
void	removeEntity (SectorEntityToken entity)
PlanetAPI	addPlanet (String id, SectorEntityToken focus, String name, String type, float angle, float radius, float orbitRadius, float orbitDays)
SectorEntityToken	addAsteroidBelt (SectorEntityToken focus, int numAsteroids, float orbitRadius, float width, float minOrbitDays, float maxOrbitDays)
SectorEntityToken	addAsteroidBelt (SectorEntityToken focus, int numAsteroids, float orbitRadius, float width, float minOrbitDays, float maxOrbitDays, String terrainId, String optionalName)
void	addOrbitalJunk (SectorEntityToken focus, String junkType, int num, float minSize, float maxSize, float orbitRadius, float width, float minOrbitDays, float maxOrbitDays, float minSpin, float maxSpin)
RingBandAPI	addRingBand (SectorEntityToken focus, String category, String key, float bandWidthInTexture, int bandIndex, Color color, float bandWidthInEngine, float middleRadius, float orbitDays)
SectorEntityToken	addRingBand (SectorEntityToken focus, String category, String key, float bandWidthInTexture, int bandIndex, Color color, float bandWidthInEngine, float middleRadius, float orbitDays, String terrainId, String optionalName)
CustomCampaignEntityAPI	addCustomEntity (String id, String name, String type, String factionId)
CustomCampaignEntityAPI	addCustomEntity (String id, String name, String type, String factionId, float radius, float spriteWidth, float spriteHeight)
SectorEntityToken	addTerrain (String terrainId, Object param)
List	getEntities (Class implementedClassOrInterface)
List< SectorEntityToken >	getEntitiesWithTag (String tag)
List< CampaignFleetAPI >	getFleets ()
List< PlanetAPI >	getPlanets ()
List< SectorEntityToken >	getOrbitalStations ()
List< SectorEntityToken >	getAsteroids ()
SectorEntityToken	getEntityByName (String name)
SectorEntityToken	getEntityById (String id)
Vector2f	getLocation ()
boolean	isHyperspace ()
void	addScript (EveryFrameScript script)
void	removeScriptsOfClass (Class c)
void	removeScript (EveryFrameScript script)
String	getName ()
void	setName (String name)
List< SectorEntityToken >	getAllEntities ()
SectorEntityToken	addCorona (SectorEntityToken star, float extraRadius, float windBurnLevel, float flareProbability, float crLossMult)
SectorEntityToken	addCorona (SectorEntityToken star, String terrainType, float extraRadius, float windBurnLevel, float flareProbability, float crLossMult)
List< CampaignTerrainAPI >	getTerrainCopy ()
Map< String, Object >	getPersistentData ()
AsteroidAPI	addAsteroid (float radius)
void	setBackgroundOffset (float x, float y)
SectorEntityToken	addRadioChatter (SectorEntityToken entity, float extraRadius)
void	updateAllOrbits ()
boolean	isNebula ()
String	getNameWithLowercaseType ()
List< FleetStubAPI >	getFleetStubs ()
void	removeFleetStub (FleetStubAPI stub)
void	addFleetStub (FleetStubAPI stub)
Constellation	getConstellation ()
boolean	isInConstellation ()
String	getNameWithTypeIfNebula ()
Collection< String >	getTags ()
boolean	hasTag (String tag)
void	addTag (String tag)
void	removeTag (String tag)
void	clearTags ()
CustomCampaignEntityAPI	addCustomEntity (String id, String name, String type, String factionId, float radius, float spriteWidth, float spriteHeight, Object pluginParams)
CustomCampaignEntityAPI	addCustomEntity (String id, String name, String type, String factionId, Object pluginParams)
List< SectorEntityToken >	getJumpPoints ()
long	getLastPlayerVisitTimestamp ()
float	getDaysSinceLastPlayerVisit ()
List< CustomCampaignEntityAPI >	getCustomEntitiesWithTag (String tag)
List< EveryFrameScript >	getScripts ()
void	addHitParticle (Vector2f loc, Vector2f vel, float size, float brightness, float duration, Color color)
void	renderingLayersUpdated (SectorEntityToken entity)
MemoryAPI	getMemoryWithoutUpdate ()
ParticleControllerAPI	addParticle (Vector2f loc, Vector2f vel, float size, float brightness, float rampUp, float duration, Color color)
String	getNameWithNoType ()
boolean	isCurrentLocation ()
String	getNameWithLowercaseTypeShort ()
String	getNameWithTypeShort ()
List< NascentGravityWellAPI >	getGravityWells ()
List< CustomCampaignEntityAPI >	getCustomEntities ()
ColorShifterAPI	getBackgroundColorShifter ()
ColorShifterAPI	getBackgroundParticleColorShifter ()
boolean	isDeepSpace ()

Detailed Description

Author

Alex Mosolov

Copyright 2012 Fractal Softworks, LLC

Definition at line 20 of file LocationAPI.java.

Member Function Documentation

activeThisFrame()

boolean com.fs.starfarer.api.campaign.LocationAPI.activeThisFrame

(

)

Whether the location's advance() method was/will be called this frame. Always returns true for the current location.

Returns

addAsteroid()

AsteroidAPI com.fs.starfarer.api.campaign.LocationAPI.addAsteroid

(

float

radius

)

addAsteroidBelt() [1/2]

SectorEntityToken com.fs.starfarer.api.campaign.LocationAPI.addAsteroidBelt	(	SectorEntityToken	focus,
		int	numAsteroids,
		float	orbitRadius,
		float	width,
		float	minOrbitDays,
		float	maxOrbitDays
	)

addAsteroidBelt() [2/2]

SectorEntityToken com.fs.starfarer.api.campaign.LocationAPI.addAsteroidBelt	(	SectorEntityToken	focus,
		int	numAsteroids,
		float	orbitRadius,
		float	width,
		float	minOrbitDays,
		float	maxOrbitDays,
		String	terrainId,
		String	optionalName
	)

addCorona() [1/2]

SectorEntityToken com.fs.starfarer.api.campaign.LocationAPI.addCorona	(	SectorEntityToken	star,
		float	extraRadius,
		float	windBurnLevel,
		float	flareProbability,
		float	crLossMult
	)

addCorona() [2/2]

SectorEntityToken com.fs.starfarer.api.campaign.LocationAPI.addCorona	(	SectorEntityToken	star,
		String	terrainType,
		float	extraRadius,
		float	windBurnLevel,
		float	flareProbability,
		float	crLossMult
	)

addCustomEntity() [1/4]

CustomCampaignEntityAPI com.fs.starfarer.api.campaign.LocationAPI.addCustomEntity	(	String	id,
		String	name,
		String	type,
		String	factionId
	)

Adds a custom entity. Use SectorEntityToken.setFixedLocation() or .setCircularOrbit (or setOrbit) to set its location and/or orbit.

Parameters

id	unique id. autogenerated if null.
name	default name for entity used if this is null
type	id in custom_entities.json
factionId	defaults to "neutral" if not specified

Returns

addCustomEntity() [2/4]

CustomCampaignEntityAPI com.fs.starfarer.api.campaign.LocationAPI.addCustomEntity	(	String	id,
		String	name,
		String	type,
		String	factionId,
		float	radius,
		float	spriteWidth,
		float	spriteHeight
	)

Adds a custom entity with a radius/spritWidth/spriteHeight different than those defined for this entity type in custom_entities.json. Use SectorEntityToken.setFixedLocation() or .setCircularOrbit (or setOrbit) to set its location and/or orbit.

Parameters

id	unique id. autogenerated if null.
name	default name for entity used if this is null
type	id in custom_entities.json
factionId	defaults to "neutral" if not specified
radius
spriteWidth
spriteHeight

Returns

addCustomEntity() [3/4]

CustomCampaignEntityAPI com.fs.starfarer.api.campaign.LocationAPI.addCustomEntity	(	String	id,
		String	name,
		String	type,
		String	factionId,
		float	radius,
		float	spriteWidth,
		float	spriteHeight,
		Object	pluginParams
	)

addCustomEntity() [4/4]

CustomCampaignEntityAPI com.fs.starfarer.api.campaign.LocationAPI.addCustomEntity	(	String	id,
		String	name,
		String	type,
		String	factionId,
		Object	pluginParams
	)

addEntity()

void com.fs.starfarer.api.campaign.LocationAPI.addEntity

(

SectorEntityToken

entity

)

addFleetStub()

void com.fs.starfarer.api.campaign.LocationAPI.addFleetStub

(

FleetStubAPI

stub

)

addHitParticle()

void com.fs.starfarer.api.campaign.LocationAPI.addHitParticle	(	Vector2f	loc,
		Vector2f	vel,
		float	size,
		float	brightness,
		float	duration,
		Color	color
	)

addOrbitalJunk()

void com.fs.starfarer.api.campaign.LocationAPI.addOrbitalJunk	(	SectorEntityToken	focus,
		String	junkType,
		int	num,
		float	minSize,
		float	maxSize,
		float	orbitRadius,
		float	width,
		float	minOrbitDays,
		float	maxOrbitDays,
		float	minSpin,
		float	maxSpin
	)

addParticle()

ParticleControllerAPI com.fs.starfarer.api.campaign.LocationAPI.addParticle	(	Vector2f	loc,
		Vector2f	vel,
		float	size,
		float	brightness,
		float	rampUp,
		float	duration,
		Color	color
	)

addPlanet()

PlanetAPI com.fs.starfarer.api.campaign.LocationAPI.addPlanet	(	String	id,
		SectorEntityToken	focus,
		String	name,
		String	type,
		float	angle,
		float	radius,
		float	orbitRadius,
		float	orbitDays
	)

addRadioChatter()

SectorEntityToken com.fs.starfarer.api.campaign.LocationAPI.addRadioChatter	(	SectorEntityToken	entity,
		float	extraRadius
	)

addRingBand() [1/2]

RingBandAPI com.fs.starfarer.api.campaign.LocationAPI.addRingBand	(	SectorEntityToken	focus,
		String	category,
		String	key,
		float	bandWidthInTexture,
		int	bandIndex,
		Color	color,
		float	bandWidthInEngine,
		float	middleRadius,
		float	orbitDays
	)

Texture must have vertical, equal width bands in it. Each band must tile vertically with itself.

Returns a RingBandAPI - i.e. the visuals.

Parameters

focus
category	graphics category in settings.json
key	id within category
bandWidthInTexture
bandIndex
color
bandWidthInEngine
orbitDays
middleRadius

Returns

addRingBand() [2/2]

SectorEntityToken com.fs.starfarer.api.campaign.LocationAPI.addRingBand	(	SectorEntityToken	focus,
		String	category,
		String	key,
		float	bandWidthInTexture,
		int	bandIndex,
		Color	color,
		float	bandWidthInEngine,
		float	middleRadius,
		float	orbitDays,
		String	terrainId,
		String	optionalName
	)

Same as above, but with a "terrain" ring also being added. If there are multiple rings occupying the same location, it's best to only have one of them add terrain.

Returns the terrain entity, NOT the RingBandAPI visuals.

Parameters

focus
category
key
bandWidthInTexture
bandIndex
color
bandWidthInEngine
middleRadius
orbitDays
terrainId
optionalName

Returns

addScript()

void com.fs.starfarer.api.campaign.LocationAPI.addScript

(

EveryFrameScript

script

)

Will run every time this location's advance() is called. Note that locations that are not "current" may run at a lower number of "frames" per second.

Parameters

script

addSpawnPoint()

void com.fs.starfarer.api.campaign.LocationAPI.addSpawnPoint

(

SpawnPointPlugin

point

)

addTag()

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

(

String

tag

)

addTerrain()

SectorEntityToken com.fs.starfarer.api.campaign.LocationAPI.addTerrain	(	String	terrainId,
		Object	param
	)

clearTags()

void com.fs.starfarer.api.campaign.LocationAPI.clearTags

(

)

createToken() [1/2]

SectorEntityToken com.fs.starfarer.api.campaign.LocationAPI.createToken	(	float	x,
		float	y
	)

Not actually added to the location, and doesn't need to be. Can be added via addEntity if it needs to have an orbit.

Parameters

x
y

Returns

createToken() [2/2]

SectorEntityToken com.fs.starfarer.api.campaign.LocationAPI.createToken

(

Vector2f

loc

)

getAllEntities()

List< SectorEntityToken > com.fs.starfarer.api.campaign.LocationAPI.getAllEntities

(

)

getAsteroids()

List< SectorEntityToken > com.fs.starfarer.api.campaign.LocationAPI.getAsteroids

(

)

getBackgroundColorShifter()

ColorShifterAPI com.fs.starfarer.api.campaign.LocationAPI.getBackgroundColorShifter

(

)

getBackgroundParticleColorShifter()

ColorShifterAPI com.fs.starfarer.api.campaign.LocationAPI.getBackgroundParticleColorShifter

(

)

getBackgroundTextureFilename()

String com.fs.starfarer.api.campaign.LocationAPI.getBackgroundTextureFilename

(

)

getConstellation()

Constellation com.fs.starfarer.api.campaign.LocationAPI.getConstellation

(

)

Implemented in com.fs.starfarer.api.campaign.StarSystemAPI.

getCustomEntities()

List< CustomCampaignEntityAPI > com.fs.starfarer.api.campaign.LocationAPI.getCustomEntities

(

)

getCustomEntitiesWithTag()

List< CustomCampaignEntityAPI > com.fs.starfarer.api.campaign.LocationAPI.getCustomEntitiesWithTag

(

String

tag

)

Similar to getEntitiesWithTag(), but for custom entities only. More performant since there are less entities to iterate through.

Parameters

tag

Returns

getDaysSinceLastPlayerVisit()

float com.fs.starfarer.api.campaign.LocationAPI.getDaysSinceLastPlayerVisit

(

)

Implemented in com.fs.starfarer.api.campaign.StarSystemAPI.

getEntities()

List com.fs.starfarer.api.campaign.LocationAPI.getEntities

(

Class

implementedClassOrInterface

)

Examples: getEntities(JumpPointAPI.class) - gets all jump points getEntities(CampaignFleetAPI.class) - gets all fleets

General version of getFleets(), getPlanets(), etc

Parameters

implementedClassOrInterface

Returns

getEntitiesWithTag()

List< SectorEntityToken > com.fs.starfarer.api.campaign.LocationAPI.getEntitiesWithTag

(

String

tag

)

getEntityById()

SectorEntityToken com.fs.starfarer.api.campaign.LocationAPI.getEntityById

(

String

id

)

getEntityByName()

SectorEntityToken com.fs.starfarer.api.campaign.LocationAPI.getEntityByName

(

String

name

)

Use getEntityById() instead

Parameters

name

Returns

getFleets()

List< CampaignFleetAPI > com.fs.starfarer.api.campaign.LocationAPI.getFleets

(

)

getFleetStubs()

List< FleetStubAPI > com.fs.starfarer.api.campaign.LocationAPI.getFleetStubs

(

)

getGravityWells()

List< NascentGravityWellAPI > com.fs.starfarer.api.campaign.LocationAPI.getGravityWells

(

)

getId()

String com.fs.starfarer.api.campaign.LocationAPI.getId

(

)

getJumpPoints()

List< SectorEntityToken > com.fs.starfarer.api.campaign.LocationAPI.getJumpPoints

(

)

getLastPlayerVisitTimestamp()

long com.fs.starfarer.api.campaign.LocationAPI.getLastPlayerVisitTimestamp

(

)

Implemented in com.fs.starfarer.api.campaign.StarSystemAPI.

getLocation()

Vector2f com.fs.starfarer.api.campaign.LocationAPI.getLocation

(

)

Implemented in com.fs.starfarer.api.campaign.StarSystemAPI.

getMemoryWithoutUpdate()

MemoryAPI com.fs.starfarer.api.campaign.LocationAPI.getMemoryWithoutUpdate

(

)

getName()

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

(

)

getNameWithLowercaseType()

String com.fs.starfarer.api.campaign.LocationAPI.getNameWithLowercaseType

(

)

getNameWithLowercaseTypeShort()

String com.fs.starfarer.api.campaign.LocationAPI.getNameWithLowercaseTypeShort

(

)

getNameWithNoType()

String com.fs.starfarer.api.campaign.LocationAPI.getNameWithNoType

(

)

getNameWithTypeIfNebula()

String com.fs.starfarer.api.campaign.LocationAPI.getNameWithTypeIfNebula

(

)

getNameWithTypeShort()

String com.fs.starfarer.api.campaign.LocationAPI.getNameWithTypeShort

(

)

getOrbitalStations()

List< SectorEntityToken > com.fs.starfarer.api.campaign.LocationAPI.getOrbitalStations

(

)

Use getEntitiesWithTag(Tags.STATION) instead, in order to pick up custom entities that are acting as stations. Regular stations also have this tag and will also be picked up by that method.

Returns

getPersistentData()

Map< String, Object > com.fs.starfarer.api.campaign.LocationAPI.getPersistentData

(

)

getPlanets()

List< PlanetAPI > com.fs.starfarer.api.campaign.LocationAPI.getPlanets

(

)

getScripts()

List< EveryFrameScript > com.fs.starfarer.api.campaign.LocationAPI.getScripts

(

)

getSpawnPoints()

List< SpawnPointPlugin > com.fs.starfarer.api.campaign.LocationAPI.getSpawnPoints

(

)

getTags()

Collection< String > com.fs.starfarer.api.campaign.LocationAPI.getTags

(

)

getTerrainCopy()

List< CampaignTerrainAPI > com.fs.starfarer.api.campaign.LocationAPI.getTerrainCopy

(

)

hasTag()

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

(

String

tag

)

isCurrentLocation()

boolean com.fs.starfarer.api.campaign.LocationAPI.isCurrentLocation

(

)

isDeepSpace()

boolean com.fs.starfarer.api.campaign.LocationAPI.isDeepSpace

(

)

isHyperspace()

boolean com.fs.starfarer.api.campaign.LocationAPI.isHyperspace

(

)

isInConstellation()

boolean com.fs.starfarer.api.campaign.LocationAPI.isInConstellation

(

)

Implemented in com.fs.starfarer.api.campaign.StarSystemAPI.

isNebula()

boolean com.fs.starfarer.api.campaign.LocationAPI.isNebula

(

)

removeEntity()

void com.fs.starfarer.api.campaign.LocationAPI.removeEntity

(

SectorEntityToken

entity

)

removeFleetStub()

void com.fs.starfarer.api.campaign.LocationAPI.removeFleetStub

(

FleetStubAPI

stub

)

removeScript()

void com.fs.starfarer.api.campaign.LocationAPI.removeScript

(

EveryFrameScript

script

)

removeScriptsOfClass()

void com.fs.starfarer.api.campaign.LocationAPI.removeScriptsOfClass

(

Class

c

)

removeSpawnPoint()

void com.fs.starfarer.api.campaign.LocationAPI.removeSpawnPoint

(

SpawnPointPlugin

point

)

removeTag()

void com.fs.starfarer.api.campaign.LocationAPI.removeTag

(

String

tag

)

renderingLayersUpdated()

void com.fs.starfarer.api.campaign.LocationAPI.renderingLayersUpdated

(

SectorEntityToken

entity

)

setBackgroundOffset()

void com.fs.starfarer.api.campaign.LocationAPI.setBackgroundOffset	(	float	x,
		float	y
	)

setBackgroundTextureFilename()

void com.fs.starfarer.api.campaign.LocationAPI.setBackgroundTextureFilename

(

String

backgroundTextureFilename

)

setName()

void com.fs.starfarer.api.campaign.LocationAPI.setName

(

String

name

)

spawnFleet()

void com.fs.starfarer.api.campaign.LocationAPI.spawnFleet	(	SectorEntityToken	anchor,
		float	xOffset,
		float	yOffset,
		CampaignFleetAPI	fleet
	)

updateAllOrbits()

void com.fs.starfarer.api.campaign.LocationAPI.updateAllOrbits

(

)

---

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

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