com.fs.starfarer.api.campaign

Interface JumpPointAPI

All Superinterfaces:

HasMemory, SectorEntityToken

public interface JumpPointAPI
extends SectorEntityToken

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	JumpPointAPI.JumpDestination

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

SectorEntityToken.VisibilityLevel

Method Summary

Modifier and Type	Method and Description
void	addDestination(JumpPointAPI.JumpDestination destination)
void	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).
void	clearDestinations()
void	close() Purely visual.
void	forceClose() Skips animation.
void	forceOpen() Skips animation.
java.util.List<JumpPointAPI.JumpDestination>	getDestinations()
StarSystemAPI	getDestinationStarSystem()
SectorEntityToken	getDestinationVisualEntity()
SectorEntityToken	getRelatedPlanet()
boolean	isAutoCreateEntranceFromHyperspace()
boolean	isGasGiantAnchor()
boolean	isStarAnchor()
boolean	isWormhole()
void	open() Purely visual.
void	removeDestination(SectorEntityToken destination)
void	setAutoCreateEntranceFromHyperspace(boolean autoCreateEntrance)
void	setDestinationVisual(java.lang.String category, java.lang.String id, SectorEntityToken entity) Also automatically sets the jump point size.
void	setRadius(float radius)
void	setRelatedPlanet(SectorEntityToken relatedPlanet) This planet will be displayed by auto-generated jump points using this jump point as an exit.
void	setStandardWormholeToHyperspaceVisual()
void	setStandardWormholeToNothingVisual()
void	setStandardWormholeToStarfieldVisual()
void	setStandardWormholeToStarOrPlanetVisual(SectorEntityToken entity)

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, isStar, 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, setOrbitFocus, setSalvageXP, setSensorProfile, setSensorStrength, setSkipForJumpPointAutoGen, setTransponderOn

Method Detail

setRadius

void setRadius(float radius)

addDestination

void addDestination(JumpPointAPI.JumpDestination destination)

clearDestinations

void clearDestinations()

removeDestination

void removeDestination(SectorEntityToken destination)

getDestinations

java.util.List<JumpPointAPI.JumpDestination> getDestinations()

setDestinationVisual

void setDestinationVisual(java.lang.String category,
                          java.lang.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.

setStandardWormholeToStarOrPlanetVisual

void setStandardWormholeToStarOrPlanetVisual(SectorEntityToken entity)

setStandardWormholeToHyperspaceVisual

void setStandardWormholeToHyperspaceVisual()

setStandardWormholeToStarfieldVisual

void setStandardWormholeToStarfieldVisual()

setStandardWormholeToNothingVisual

void setStandardWormholeToNothingVisual()

isAutoCreateEntranceFromHyperspace

boolean isAutoCreateEntranceFromHyperspace()

isStarAnchor

boolean isStarAnchor()

Returns:

Whether the jump point leads to a star.

isGasGiantAnchor

boolean isGasGiantAnchor()

Returns:

Whether the jump point leads to a gas giant.

setAutoCreateEntranceFromHyperspace

void setAutoCreateEntranceFromHyperspace(boolean autoCreateEntrance)

getDestinationVisualEntity

SectorEntityToken getDestinationVisualEntity()

getRelatedPlanet

SectorEntityToken getRelatedPlanet()

setRelatedPlanet

void 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 -

autoUpdateHyperJumpPointLocationBasedOnInSystemEntityAtRadius

void 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 -

open

void open()

Purely visual.

close

void close()

Purely visual.

forceOpen

void forceOpen()

Skips animation.

forceClose

void forceClose()

Skips animation.

getDestinationStarSystem

StarSystemAPI getDestinationStarSystem()

isWormhole

boolean isWormhole()