com.fs.starfarer.api.campaign

Interface SectorEntityToken

All Superinterfaces:

HasMemory

All Known Subinterfaces:

AsteroidAPI, CampaignFleetAPI, CampaignProgressIndicatorAPI, CampaignTerrainAPI, CustomCampaignEntityAPI, JumpPointAPI, NascentGravityWellAPI, OrbitalStationAPI, PlanetAPI, RingBandAPI

public interface SectorEntityToken
extends HasMemory

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SectorEntityToken.VisibilityLevel

Method Summary

Modifier and Type	Method and Description
void	addAbility(java.lang.String id)
void	addDropRandom(SalvageEntityGenDataSpec.DropData data)
void	addDropRandom(java.lang.String group, int chances)
void	addDropRandom(java.lang.String group, int chances, int value)
void	addDropValue(SalvageEntityGenDataSpec.DropData data)
void	addDropValue(java.lang.String group, int value)
void	addFloatingText(java.lang.String text, java.awt.Color color, float duration)
void	addFloatingText(java.lang.String text, java.awt.Color color, float duration, boolean showWhenOnlySensorContact)
void	addScript(EveryFrameScript script)
void	addTag(java.lang.String tag)
void	advance(float amount)
void	autoUpdateHyperLocationBasedOnInSystemEntityAtRadius(SectorEntityToken entity, float radius)
void	clearAbilities()
void	clearFloatingText()
void	clearTags()
void	fadeInIndicator()
void	fadeOutIndicator()
void	forceOutIndicator()
void	forceSensorContactFaderBrightness(float b)
void	forceSensorFaderBrightness(float b)
void	forceSensorFaderOut()
java.util.Map<java.lang.String,AbilityPlugin>	getAbilities()
AbilityPlugin	getAbility(java.lang.String id)
PersonAPI	getActivePerson()
java.lang.Boolean	getAlwaysUseSensorFaderBrightness()
java.lang.String	getAutogenJumpPointNameInHyper()
float	getBaseSensorRangeToDetect(float sensorProfile)
CargoAPI	getCargo() For the player fleet, the actual cargo.
float	getCircularOrbitAngle()
float	getCircularOrbitPeriod()
float	getCircularOrbitRadius()
Constellation	getConstellation()
LocationAPI	getContainingLocation()
java.util.Map<java.lang.String,java.lang.Object>	getCustomData()
java.lang.String	getCustomDescriptionId()
CustomEntitySpecAPI	getCustomEntitySpec()
java.lang.String	getCustomEntityType()
InteractionDialogImageVisual	getCustomInteractionDialogImageVisual()
CustomCampaignEntityPlugin	getCustomPlugin() Only returns non-null for custom campaign entities with a plugin.
StatBonus	getDetectedRangeMod()
java.lang.Float	getDetectionRangeDetailsOverrideMult()
java.lang.Float	getDiscoveryXP()
java.util.List<SalvageEntityGenDataSpec.DropData>	getDropRandom()
java.util.List<SalvageEntityGenDataSpec.DropData>	getDropValue()
float	getExtendedDetectedAtRange() Applies to the 5000/2000 max sensor range limit in normal/hyper space.
float	getFacing()
FactionAPI	getFaction()
java.lang.String	getFullName()
java.lang.String	getId()
java.awt.Color	getIndicatorColor()
java.awt.Color	getLightColor()
SectorEntityToken	getLightSource()
org.lwjgl.util.vector.Vector2f	getLocation()
org.lwjgl.util.vector.Vector2f	getLocationInHyperspace() The location in hyperspace of the LocationAPI containing this entity, or this entity's location if it's already in hyperspace.
MarketAPI	getMarket()
float	getMaxSensorRangeToDetect(SectorEntityToken other) Does not includes fleet radii - i.e.
MemoryAPI	getMemory() Will cause the relevant updateFacts() methods to run to update the entity's perception of the world.
MemoryAPI	getMemoryWithoutUpdate() Get the memory without updating facts.
java.lang.String	getName()
OrbitAPI	getOrbit()
SectorEntityToken	getOrbitFocus()
float	getRadius()
java.lang.Float	getSalvageXP()
java.util.List<EveryFrameScript>	getScripts()
float	getSensorContactFaderBrightness()
float	getSensorFaderBrightness()
float	getSensorProfile()
StatBonus	getSensorRangeMod()
float	getSensorStrength()
StarSystemAPI	getStarSystem()
java.util.Collection<java.lang.String>	getTags()
org.lwjgl.util.vector.Vector2f	getVelocity() In pixels per second.
SectorEntityToken.VisibilityLevel	getVisibilityLevelOfPlayerFleet()
SectorEntityToken.VisibilityLevel	getVisibilityLevelTo(SectorEntityToken other)
SectorEntityToken.VisibilityLevel	getVisibilityLevelToPlayerFleet()
boolean	hasAbility(java.lang.String id)
boolean	hasDiscoveryXP()
boolean	hasSalvageXP()
boolean	hasScriptOfClass(java.lang.Class c)
boolean	hasSensorProfile()
boolean	hasSensorStrength()
boolean	hasTag(java.lang.String tag)
boolean	isAlive() Returns false if: 1) getContainingLocation() is null, or 2) getContainingLocation() doesn't contain this entity
boolean	isDiscoverable()
boolean	isExpired()
boolean	isFreeTransfer()
boolean	isInCurrentLocation()
boolean	isInHyperspace()
boolean	isInOrNearSystem(StarSystemAPI system) True if in system or within commRelayRangeAroundSystem light-years.
boolean	isPlayerFleet()
boolean	isSkipForJumpPointAutoGen()
boolean	isStar()
boolean	isSystemCenter()
boolean	isTransponderOn()
boolean	isVisibleToPlayerFleet()
boolean	isVisibleToSensorsOf(SectorEntityToken other)
void	removeAbility(java.lang.String id)
void	removeScript(EveryFrameScript script)
void	removeScriptsOfClass(java.lang.Class c)
void	removeTag(java.lang.String tag)
void	setActivePerson(PersonAPI activePerson)
void	setAlwaysUseSensorFaderBrightness(java.lang.Boolean alwaysUseSensorFaderBrightness) Always use sensor fader brightness for rendering circular indicator around the entity.
void	setAutogenJumpPointNameInHyper(java.lang.String autogenJumpPointNameInHyper)
void	setCircularOrbit(SectorEntityToken focus, float angle, float orbitRadius, float orbitDays) Causes this entity to enter a circular, fixed orbit around focus.
void	setCircularOrbitAngle(float angle)
void	setCircularOrbitPointingDown(SectorEntityToken focus, float angle, float orbitRadius, float orbitDays) Causes this entity to enter a circular, fixed orbit around focus.
void	setCircularOrbitWithSpin(SectorEntityToken focus, float angle, float orbitRadius, float orbitDays, float minSpin, float maxSpin) Causes this entity to enter a circular, fixed orbit around focus.
void	setContainingLocation(LocationAPI location)
void	setCustomDescriptionId(java.lang.String customDescriptionId)
void	setCustomInteractionDialogImageVisual(InteractionDialogImageVisual visual)
void	setDetectionRangeDetailsOverrideMult(java.lang.Float detectionRangeDetailsOverrideMult)
void	setDiscoverable(java.lang.Boolean discoverable)
void	setDiscoveryXP(java.lang.Float discoveryXP)
void	setExpired(boolean expired)
void	setExtendedDetectedAtRange(java.lang.Float extendedDetectedAtRange) Applies to the 5000/2000 max sensor range limit in normal/hyper space.
void	setFacing(float facing)
void	setFaction(java.lang.String factionId)
void	setFixedLocation(float x, float y)
void	setFreeTransfer(boolean freeTransfer) Whether moving ships and items to and from this entity has a cost.
void	setId(java.lang.String id)
void	setInteractionImage(java.lang.String category, java.lang.String key)
void	setLightSource(SectorEntityToken star, java.awt.Color color)
void	setLocation(float x, float y)
void	setMarket(MarketAPI market) Sets market for specified planet object.
void	setMemory(MemoryAPI memory)
void	setName(java.lang.String name)
void	setOrbit(OrbitAPI orbit)
void	setOrbitFocus(SectorEntityToken focus)
void	setSalvageXP(java.lang.Float salvageXP)
void	setSensorProfile(java.lang.Float sensorProfile)
void	setSensorStrength(java.lang.Float sensorStrength)
void	setSkipForJumpPointAutoGen(boolean skipForJumpPointAutoGen)
void	setTransponderOn(boolean transponderOn)

Method Detail

isPlayerFleet

boolean isPlayerFleet()

getMarket

MarketAPI getMarket()

setMarket

void setMarket(MarketAPI market)

Sets market for specified planet object.

Parameters:

market - Specify the market object to add to planet.

getCargo

CargoAPI getCargo()

For the player fleet, the actual cargo. For AI fleets, only non-logistics-related stuff - i.e. goods being carried, etc. NOT supplies/fuel/crew/etc.

Returns:

getLocation

org.lwjgl.util.vector.Vector2f getLocation()

getLocationInHyperspace

org.lwjgl.util.vector.Vector2f getLocationInHyperspace()

The location in hyperspace of the LocationAPI containing this entity, or this entity's location if it's already in hyperspace.

Returns:

getOrbit

OrbitAPI getOrbit()

setOrbit

void setOrbit(OrbitAPI orbit)

getId

java.lang.String getId()

getName

java.lang.String getName()

getFullName

java.lang.String getFullName()

setFaction

void setFaction(java.lang.String factionId)

getContainingLocation

LocationAPI getContainingLocation()

getRadius

float getRadius()

getFaction

FactionAPI getFaction()

getCustomDescriptionId

java.lang.String getCustomDescriptionId()

setCustomDescriptionId

void setCustomDescriptionId(java.lang.String customDescriptionId)

setCustomInteractionDialogImageVisual

void setCustomInteractionDialogImageVisual(InteractionDialogImageVisual visual)

getCustomInteractionDialogImageVisual

InteractionDialogImageVisual getCustomInteractionDialogImageVisual()

setFreeTransfer

void setFreeTransfer(boolean freeTransfer)

Whether moving ships and items to and from this entity has a cost.

Parameters:

freeTransfer -

isFreeTransfer

boolean isFreeTransfer()

hasTag

boolean hasTag(java.lang.String tag)

addTag

void addTag(java.lang.String tag)

removeTag

void removeTag(java.lang.String tag)

getTags

java.util.Collection<java.lang.String> getTags()

clearTags

void clearTags()

setFixedLocation

void setFixedLocation(float x,
                      float y)

setCircularOrbit

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

Causes this entity to enter a circular, fixed orbit around focus.

Parameters:

focus - The entity to orbit around.

angle - The initial angle the orbit will start at, relative to focus.

orbitRadius - The radius of the orbit.

orbitDays - The orbit will make a complete rotation after this many days. Negative values cause the orbit to move counterclockwise. Warning: If set to zero, will cause numerous issues including preventing serialization.

setCircularOrbitPointingDown

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

Causes this entity to enter a circular, fixed orbit around focus. This orbit causes the orbiting entity to always have the bottom of its sprite pointing at the focus.

Parameters:

focus - The entity to orbit around.

angle - The initial angle the orbit will start at, relative to focus.

orbitRadius - The radius of the orbit.

orbitDays - The orbit will make a complete rotation after this many days. Negative values cause the orbit to move counterclockwise. Warning: If set to zero, will cause numerous issues including preventing serialization.

setCircularOrbitWithSpin

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

Causes this entity to enter a circular, fixed orbit around focus. This orbit causes the orbiting entity to spin independently of the orbit.

Parameters:

focus - The entity to orbit around.

angle - The initial angle the orbit will start at, relative to focus.

orbitRadius - The radius of the orbit.

orbitDays - The orbit will make a complete rotation after this many days. Negative values cause the orbit to move counterclockwise. Warning: If set to zero, will cause numerous issues including preventing serialization.

minSpin - The minimum speed at which this entity will spin.

maxSpin - The maximum speed at which this entity will spin. The speed is randomly picked between minSpin and maxSpin.

getMemory

MemoryAPI getMemory()

Will cause the relevant updateFacts() methods to run to update the entity's perception of the world. Return value should be stored and re-used rather than calling this method again, unless a fact update is needed.

Specified by:

getMemory in interface HasMemory

Returns:

getMemoryWithoutUpdate

MemoryAPI getMemoryWithoutUpdate()

Get the memory without updating facts.

Specified by:

getMemoryWithoutUpdate in interface HasMemory

Returns:

getFacing

float getFacing()

setFacing

void setFacing(float facing)

isInHyperspace

boolean isInHyperspace()

addScript

void addScript(EveryFrameScript script)

removeScript

void removeScript(EveryFrameScript script)

removeScriptsOfClass

void removeScriptsOfClass(java.lang.Class c)

isInOrNearSystem

boolean isInOrNearSystem(StarSystemAPI system)

True if in system or within commRelayRangeAroundSystem light-years.

Parameters:

system -

Returns:

isInCurrentLocation

boolean isInCurrentLocation()

getVelocity

org.lwjgl.util.vector.Vector2f getVelocity()

In pixels per second.

Returns:

setInteractionImage

void setInteractionImage(java.lang.String category,
                         java.lang.String key)

setName

void setName(java.lang.String name)

isAlive

boolean isAlive()

Returns false if: 1) getContainingLocation() is null, or 2) getContainingLocation() doesn't contain this entity

Returns:

getActivePerson

PersonAPI getActivePerson()

setActivePerson

void setActivePerson(PersonAPI activePerson)

isVisibleToSensorsOf

boolean isVisibleToSensorsOf(SectorEntityToken other)

isVisibleToPlayerFleet

boolean isVisibleToPlayerFleet()

getVisibilityLevelToPlayerFleet

SectorEntityToken.VisibilityLevel getVisibilityLevelToPlayerFleet()

getVisibilityLevelTo

SectorEntityToken.VisibilityLevel getVisibilityLevelTo(SectorEntityToken other)

addAbility

void addAbility(java.lang.String id)

removeAbility

void removeAbility(java.lang.String id)

getAbility

AbilityPlugin getAbility(java.lang.String id)

hasAbility

boolean hasAbility(java.lang.String id)

getAbilities

java.util.Map<java.lang.String,AbilityPlugin> getAbilities()

isTransponderOn

boolean isTransponderOn()

setTransponderOn

void setTransponderOn(boolean transponderOn)

addFloatingText

void addFloatingText(java.lang.String text,
                     java.awt.Color color,
                     float duration)

getLightSource

SectorEntityToken getLightSource()

getLightColor

java.awt.Color getLightColor()

setMemory

void setMemory(MemoryAPI memory)

getCustomData

java.util.Map<java.lang.String,java.lang.Object> getCustomData()

getIndicatorColor

java.awt.Color getIndicatorColor()

getCustomPlugin

CustomCampaignEntityPlugin getCustomPlugin()

Only returns non-null for custom campaign entities with a plugin.

Returns:

getCircularOrbitRadius

float getCircularOrbitRadius()

getCircularOrbitPeriod

float getCircularOrbitPeriod()

getOrbitFocus

SectorEntityToken getOrbitFocus()

setId

void setId(java.lang.String id)

getAutogenJumpPointNameInHyper

java.lang.String getAutogenJumpPointNameInHyper()

setAutogenJumpPointNameInHyper

void setAutogenJumpPointNameInHyper(java.lang.String autogenJumpPointNameInHyper)

isSkipForJumpPointAutoGen

boolean isSkipForJumpPointAutoGen()

setSkipForJumpPointAutoGen

void setSkipForJumpPointAutoGen(boolean skipForJumpPointAutoGen)

getCircularOrbitAngle

float getCircularOrbitAngle()

getCustomEntityType

java.lang.String getCustomEntityType()

getSensorStrength

float getSensorStrength()

setSensorStrength

void setSensorStrength(java.lang.Float sensorStrength)

getSensorProfile

float getSensorProfile()

setSensorProfile

void setSensorProfile(java.lang.Float sensorProfile)

getDetectedRangeMod

StatBonus getDetectedRangeMod()

getSensorRangeMod

StatBonus getSensorRangeMod()

getBaseSensorRangeToDetect

float getBaseSensorRangeToDetect(float sensorProfile)

hasSensorStrength

boolean hasSensorStrength()

hasSensorProfile

boolean hasSensorProfile()

getMaxSensorRangeToDetect

float getMaxSensorRangeToDetect(SectorEntityToken other)

Does not includes fleet radii - i.e. the returned range is from outer edge to outer edge.

Returns:

isDiscoverable

boolean isDiscoverable()

setDiscoverable

void setDiscoverable(java.lang.Boolean discoverable)

getCustomEntitySpec

CustomEntitySpecAPI getCustomEntitySpec()

getDropValue

java.util.List<SalvageEntityGenDataSpec.DropData> getDropValue()

getDropRandom

java.util.List<SalvageEntityGenDataSpec.DropData> getDropRandom()

addDropValue

void addDropValue(java.lang.String group,
                  int value)

addDropRandom

void addDropRandom(java.lang.String group,
                   int chances)

addDropRandom

void addDropRandom(java.lang.String group,
                   int chances,
                   int value)

isExpired

boolean isExpired()

setExpired

void setExpired(boolean expired)

getSensorFaderBrightness

float getSensorFaderBrightness()

getSensorContactFaderBrightness

float getSensorContactFaderBrightness()

forceSensorFaderBrightness

void forceSensorFaderBrightness(float b)

getDiscoveryXP

java.lang.Float getDiscoveryXP()

setDiscoveryXP

void setDiscoveryXP(java.lang.Float discoveryXP)

hasDiscoveryXP

boolean hasDiscoveryXP()

addDropValue

void addDropValue(SalvageEntityGenDataSpec.DropData data)

addDropRandom

void addDropRandom(SalvageEntityGenDataSpec.DropData data)

setAlwaysUseSensorFaderBrightness

void setAlwaysUseSensorFaderBrightness(java.lang.Boolean alwaysUseSensorFaderBrightness)

Always use sensor fader brightness for rendering circular indicator around the entity.

Parameters:

alwaysUseSensorFaderBrightness -

getAlwaysUseSensorFaderBrightness

java.lang.Boolean getAlwaysUseSensorFaderBrightness()

advance

void advance(float amount)

hasScriptOfClass

boolean hasScriptOfClass(java.lang.Class c)

setContainingLocation

void setContainingLocation(LocationAPI location)

clearAbilities

void clearAbilities()

getConstellation

Constellation getConstellation()

isStar

boolean isStar()

getSalvageXP

java.lang.Float getSalvageXP()

setSalvageXP

void setSalvageXP(java.lang.Float salvageXP)

hasSalvageXP

boolean hasSalvageXP()

setDetectionRangeDetailsOverrideMult

void setDetectionRangeDetailsOverrideMult(java.lang.Float detectionRangeDetailsOverrideMult)

getDetectionRangeDetailsOverrideMult

java.lang.Float getDetectionRangeDetailsOverrideMult()

getVisibilityLevelOfPlayerFleet

SectorEntityToken.VisibilityLevel getVisibilityLevelOfPlayerFleet()

setCircularOrbitAngle

void setCircularOrbitAngle(float angle)

addFloatingText

void addFloatingText(java.lang.String text,
                     java.awt.Color color,
                     float duration,
                     boolean showWhenOnlySensorContact)

isSystemCenter

boolean isSystemCenter()

getStarSystem

StarSystemAPI getStarSystem()

clearFloatingText

void clearFloatingText()

setLocation

void setLocation(float x,
                 float y)

autoUpdateHyperLocationBasedOnInSystemEntityAtRadius

void autoUpdateHyperLocationBasedOnInSystemEntityAtRadius(SectorEntityToken entity,
                                                          float radius)

forceSensorContactFaderBrightness

void forceSensorContactFaderBrightness(float b)

forceSensorFaderOut

void forceSensorFaderOut()

setLightSource

void setLightSource(SectorEntityToken star,
                    java.awt.Color color)

getScripts

java.util.List<EveryFrameScript> getScripts()

getExtendedDetectedAtRange

float getExtendedDetectedAtRange()

Applies to the 5000/2000 max sensor range limit in normal/hyper space. Does not, by itself, increase the range at which the entity is detected, just applies to the limit.

Returns:

setExtendedDetectedAtRange

void setExtendedDetectedAtRange(java.lang.Float extendedDetectedAtRange)

Applies to the 5000/2000 max sensor range limit in normal/hyper space. Does not, by itself, increase the range at which the entity is detected, just applies to the limit.

fadeOutIndicator

void fadeOutIndicator()

fadeInIndicator

void fadeInIndicator()

forceOutIndicator

void forceOutIndicator()

setOrbitFocus

void setOrbitFocus(SectorEntityToken focus)