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

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

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

Classes
class	JumpDestination

Public Member Functions
void	setRadius (float radius)
void	addDestination (JumpDestination destination)
void	clearDestinations ()
void	removeDestination (SectorEntityToken destination)
List< JumpDestination >	getDestinations ()
void	setDestinationVisual (String category, String id, SectorEntityToken entity)
void	setStandardWormholeToStarOrPlanetVisual (SectorEntityToken entity)
void	setStandardWormholeToHyperspaceVisual ()
void	setStandardWormholeToStarfieldVisual ()
void	setStandardWormholeToNothingVisual ()
boolean	isAutoCreateEntranceFromHyperspace ()
boolean	isStarAnchor ()
boolean	isGasGiantAnchor ()
void	setAutoCreateEntranceFromHyperspace (boolean autoCreateEntrance)
SectorEntityToken	getDestinationVisualEntity ()
SectorEntityToken	getRelatedPlanet ()
void	setRelatedPlanet (SectorEntityToken relatedPlanet)
void	autoUpdateHyperJumpPointLocationBasedOnInSystemEntityAtRadius (SectorEntityToken entity, float radius)
void	open ()
void	close ()
void	forceOpen ()
void	forceClose ()
StarSystemAPI	getDestinationStarSystem ()
boolean	isWormhole ()
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 ()
boolean	isStar ()
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 6 of file JumpPointAPI.java.

Member Function Documentation

addDestination()

void com.fs.starfarer.api.campaign.JumpPointAPI.addDestination

(

JumpDestination

destination

)

autoUpdateHyperJumpPointLocationBasedOnInSystemEntityAtRadius()

void com.fs.starfarer.api.campaign.JumpPointAPI.autoUpdateHyperJumpPointLocationBasedOnInSystemEntityAtRadius	(	SectorEntityToken	entity,
		float	radius
	)

May only be called after this jump point was added to the system, and also after StarSystemAPI.autogenerateHyperspaceAnchors() was called for the system, OR initStar() was called with the "location in hyperspace" parameters (which auto-generates the main hyperspace anchor).

Parameters

entity
radius

clearDestinations()

void com.fs.starfarer.api.campaign.JumpPointAPI.clearDestinations

(

)

close()

void com.fs.starfarer.api.campaign.JumpPointAPI.close

(

)

Purely visual.

forceClose()

void com.fs.starfarer.api.campaign.JumpPointAPI.forceClose

(

)

Skips animation.

forceOpen()

void com.fs.starfarer.api.campaign.JumpPointAPI.forceOpen

(

)

Skips animation.

getDestinations()

List< JumpDestination > com.fs.starfarer.api.campaign.JumpPointAPI.getDestinations

(

)

getDestinationStarSystem()

StarSystemAPI com.fs.starfarer.api.campaign.JumpPointAPI.getDestinationStarSystem

(

)

getDestinationVisualEntity()

SectorEntityToken com.fs.starfarer.api.campaign.JumpPointAPI.getDestinationVisualEntity

(

)

getRelatedPlanet()

SectorEntityToken com.fs.starfarer.api.campaign.JumpPointAPI.getRelatedPlanet

(

)

isAutoCreateEntranceFromHyperspace()

boolean com.fs.starfarer.api.campaign.JumpPointAPI.isAutoCreateEntranceFromHyperspace

(

)

isGasGiantAnchor()

boolean com.fs.starfarer.api.campaign.JumpPointAPI.isGasGiantAnchor

(

)

Returns

Whether the jump point leads to a gas giant.

isStarAnchor()

boolean com.fs.starfarer.api.campaign.JumpPointAPI.isStarAnchor

(

)

Returns

Whether the jump point leads to a star.

isWormhole()

boolean com.fs.starfarer.api.campaign.JumpPointAPI.isWormhole

(

)

open()

void com.fs.starfarer.api.campaign.JumpPointAPI.open

(

)

Purely visual.

removeDestination()

void com.fs.starfarer.api.campaign.JumpPointAPI.removeDestination

(

SectorEntityToken

destination

)

setAutoCreateEntranceFromHyperspace()

void com.fs.starfarer.api.campaign.JumpPointAPI.setAutoCreateEntranceFromHyperspace

(

boolean

autoCreateEntrance

)

setDestinationVisual()

void com.fs.starfarer.api.campaign.JumpPointAPI.setDestinationVisual	(	String	category,
		String	id,
		SectorEntityToken	entity
	)

Also automatically sets the jump point size.

Parameters

category	in settings.json
id	under category in settings.json
entity	can be null or a star/planet. Entity will be displayed at the end of the wormhole, above the background.

setRadius()

void com.fs.starfarer.api.campaign.JumpPointAPI.setRadius

(

float

radius

)

setRelatedPlanet()

void com.fs.starfarer.api.campaign.JumpPointAPI.setRelatedPlanet

(

SectorEntityToken

relatedPlanet

)

This planet will be displayed by auto-generated jump points using this jump point as an exit. Should only be set for a jump point in the same location as the planet; only used for visuals. ONLY necessary if StatSystemAPI.autogenerateHyperspaceJumpPoints() is subsequently called.

Parameters

relatedPlanet

setStandardWormholeToHyperspaceVisual()

void com.fs.starfarer.api.campaign.JumpPointAPI.setStandardWormholeToHyperspaceVisual

(

)

setStandardWormholeToNothingVisual()

void com.fs.starfarer.api.campaign.JumpPointAPI.setStandardWormholeToNothingVisual

(

)

setStandardWormholeToStarfieldVisual()

void com.fs.starfarer.api.campaign.JumpPointAPI.setStandardWormholeToStarfieldVisual

(

)

setStandardWormholeToStarOrPlanetVisual()

void com.fs.starfarer.api.campaign.JumpPointAPI.setStandardWormholeToStarOrPlanetVisual

(

SectorEntityToken

entity

)

---

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

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