com.fs.starfarer.api.campaign

Interface CampaignFleetAPI

All Superinterfaces:

FleetOrStubAPI, HasMemory, SectorEntityToken

public interface CampaignFleetAPI
extends SectorEntityToken, FleetOrStubAPI

Nested Class Summary

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

SectorEntityToken.VisibilityLevel

Method Summary

Modifier and Type	Method and Description
void	addAssignment(FleetAssignment assignment, SectorEntityToken target, float maxDurationInDays)
void	addAssignment(FleetAssignment assignment, SectorEntityToken target, float maxDurationInDays, Script onCompletion)
void	addAssignment(FleetAssignment assignment, SectorEntityToken target, float maxDurationInDays, java.lang.String actionText)
void	addAssignment(FleetAssignment assignment, SectorEntityToken target, float maxDurationInDays, java.lang.String actionText, boolean addTimeToNext, Script onStart, Script onCompletion)
void	addAssignment(FleetAssignment assignment, SectorEntityToken target, float maxDurationInDays, java.lang.String actionText, Script onCompletion)
void	clearAssignments()
void	deflate()
void	despawn()
void	despawn(CampaignEventListener.FleetDespawnReason reason, java.lang.Object param)
void	fadeInIndicator()
void	fadeOutIndicator()
void	forceOutIndicator()
void	forceSync() Makes sure the fleet's capacities, crew levels, etc match the fleet composition and cargo.
java.lang.Boolean	getAbortDespawn()
float	getAcceleration() In pixels per second, not per day.
CampaignFleetAIAPI	getAI()
float	getBaseSensorRangeToDetect(float sensorProfile)
BattleAPI	getBattle()
PersonAPI	getCommander()
MutableCharacterStatsAPI	getCommanderStats()
LocationAPI	getContainingLocation()
float	getCurrBurnLevel() Current burn level - not maximum, but how fast it's currently going.
float	getEffectiveStrength() Sum of Misc.getMemberStrength(member, true, true, true) for all members.
java.util.List<FleetEventListener>	getEventListeners()
FleetMemberAPI	getFlagship()
FleetDataAPI	getFleetData()
int	getFleetPoints()
int	getFleetSizeCount() fighter, frigate: 1 destroyer: 2 cruiser: 3 capital: 5
java.lang.Boolean	getForceNoSensorProfileUpdate()
boolean	getGoSlowOneFrame()
boolean	getGoSlowStop()
FleetInflater	getInflater()
SectorEntityToken	getInteractionTarget() The fleet is trying to interact with this entity - i.e.
org.lwjgl.util.vector.Vector2f	getLocation()
FleetLogisticsAPI	getLogistics()
java.util.List<FleetMemberAPI>	getMembersWithFightersCopy()
org.lwjgl.util.vector.Vector2f	getMoveDestination()
java.lang.String	getName()
java.lang.String	getNameWithFaction()
java.lang.String	getNameWithFactionKeepCase()
java.lang.String	getNullAIActionText()
int	getNumCapitals()
int	getNumCruisers()
int	getNumDestroyers()
int	getNumFighters()
int	getNumFrigates()
int	getNumMembersFast()
int	getNumShips()
MutableFleetStatsAPI	getStats()
float	getTotalSupplyCostPerDay()
float	getTravelSpeed()
org.lwjgl.util.vector.Vector2f	getVelocity() In pixels per second.
org.lwjgl.util.vector.Vector2f	getVelocityFromMovementModule()
FleetMemberViewAPI	getViewForMember(FleetMemberAPI member) Returns the "view" of the fleet member in the campaign - i.e.
java.util.List<FleetMemberViewAPI>	getViews() Returns the "view" of the fleet member in the campaign - i.e.
void	goSlowOneFrame()
void	goSlowOneFrame(boolean stop)
boolean	hasShipsWithUniqueSig() Only works for the player fleet.
void	inflateIfNeeded()
boolean	isAIMode()
boolean	isDespawning()
java.lang.Boolean	isDoNotAdvanceAI()
boolean	isEmpty()
boolean	isFriendlyTo(SectorEntityToken other)
boolean	isHidden()
boolean	isHostileTo(SectorEntityToken other) Eventually falls back to faction.isHostile(), but may return true if there's hostility due to MakeOtherFleetHostile true, a captain's relationship to the player/other captain, etc.
boolean	isInCurrentLocation()
boolean	isInflated()
boolean	isInHyperspace()
boolean	isInHyperspaceTransition()
java.lang.Boolean	isNoAutoDespawn()
boolean	isNoFactionInName()
boolean	isPlayerFleet()
boolean	isStationMode()
boolean	isValidPlayerFleet()
boolean	knowsWhoPlayerIs() True if the player's transponder is on, or it has seen the player with the transponder on and hasn't lost track of them since that point.
void	removeFleetMemberWithDestructionFlash(FleetMemberAPI member)
void	setAbortDespawn(java.lang.Boolean abortDespawn)
void	setAI(CampaignFleetAIAPI campaignFleetAI)
void	setAIMode(boolean aiMode) Turns off supplies/fuel use, accidents, and ship crew requirements.
void	setBattle(BattleAPI battle)
void	setCommander(PersonAPI commander)
void	setDoNotAdvanceAI(java.lang.Boolean doNotAdvanceAI)
void	setFaction(java.lang.String factionId, boolean includeCaptains)
void	setForceNoSensorProfileUpdate(java.lang.Boolean forceNoSensorProfileUpdate)
void	setHidden(java.lang.Boolean hidden)
void	setInflated(java.lang.Boolean inflated)
void	setInflater(FleetInflater inflater)
void	setInteractionTarget(SectorEntityToken target)
void	setLocation(float x, float y) Use this to set the location.
void	setMoveDestination(float x, float y) Used by the AI to control the fleet as well, so it's not a reliable way to order a fleet around as the AI will be calling this method every frame.
void	setMoveDestinationOverride(float x, float y) Overrides AI and player input.
void	setName(java.lang.String name)
void	setNoAutoDespawn(java.lang.Boolean noAutoDespawn)
void	setNoEngaging(float seconds)
void	setNoFactionInName(boolean noFactionInName)
void	setNullAIActionText(java.lang.String nullAIActionText)
void	setPreferredResupplyLocation(SectorEntityToken token)
void	setStationMode(java.lang.Boolean stationMode)
void	setVelocity(float x, float y) In pixels per second, not per day.
void	setWasMousedOverByPlayer(java.lang.Boolean wasMousedOverByPlayer)
void	updateCounts() Updates numCapitals/numCruisers/etc
void	updateFleetView()
java.lang.Boolean	wasMousedOverByPlayer()
boolean	wasSlowMoving()

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, forceSensorContactFaderBrightness, forceSensorFaderBrightness, forceSensorFaderOut, getAbilities, getAbility, getActivePerson, getAlwaysUseSensorFaderBrightness, getAutogenJumpPointNameInHyper, getCargo, getCircularOrbitAngle, getCircularOrbitPeriod, getCircularOrbitRadius, getConstellation, getCustomData, getCustomDescriptionId, getCustomEntitySpec, getCustomEntityType, getCustomInteractionDialogImageVisual, getCustomPlugin, getDetectedRangeMod, getDetectionRangeDetailsOverrideMult, getDiscoveryXP, getDropRandom, getDropValue, getExtendedDetectedAtRange, getFacing, getFaction, getFullName, getId, getIndicatorColor, getLightColor, getLightSource, getLocationInHyperspace, getMarket, getMaxSensorRangeToDetect, getMemory, getMemoryWithoutUpdate, getOrbit, getOrbitFocus, getRadius, getSalvageXP, getScripts, getSensorContactFaderBrightness, getSensorFaderBrightness, getSensorProfile, getSensorRangeMod, getSensorStrength, getStarSystem, getTags, getVisibilityLevelOfPlayerFleet, getVisibilityLevelTo, getVisibilityLevelToPlayerFleet, hasAbility, hasDiscoveryXP, hasSalvageXP, hasScriptOfClass, hasSensorProfile, hasSensorStrength, hasTag, isAlive, isDiscoverable, isExpired, isFreeTransfer, isInOrNearSystem, 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, setMarket, setMemory, setOrbit, setOrbitFocus, setSalvageXP, setSensorProfile, setSensorStrength, setSkipForJumpPointAutoGen, setTransponderOn

Methods inherited from interface com.fs.starfarer.api.campaign.FleetOrStubAPI

addAssignmentAtStart, addAssignmentAtStart, addEventListener, addScript, getAssignmentsCopy, getCurrentAssignment, getId, getLocationInHyperspace, getMemoryWithoutUpdate, getScripts, isCurrentAssignment, isFleet, removeEventListener, removeFirstAssignment, removeFirstAssignmentIfItIs

Method Detail

isInCurrentLocation

boolean isInCurrentLocation()

Specified by:

isInCurrentLocation in interface SectorEntityToken

Returns:

whether the fleet's LocationAPI is the same one the player's fleet is currently in.

isInHyperspace

boolean isInHyperspace()

Specified by:

isInHyperspace in interface SectorEntityToken

setLocation

void setLocation(float x,
                 float y)

Use this to set the location. DO NOT use getLocation().x = etc, that won't work.

Specified by:

setLocation in interface SectorEntityToken

Parameters:

x -

y -

despawn

void despawn()

Specified by:

despawn in interface FleetOrStubAPI

despawn

void despawn(CampaignEventListener.FleetDespawnReason reason,
             java.lang.Object param)

Specified by:

despawn in interface FleetOrStubAPI

addAssignment

void addAssignment(FleetAssignment assignment,
                   SectorEntityToken target,
                   float maxDurationInDays)

Specified by:

addAssignment in interface FleetOrStubAPI

addAssignment

void addAssignment(FleetAssignment assignment,
                   SectorEntityToken target,
                   float maxDurationInDays,
                   Script onCompletion)

Specified by:

addAssignment in interface FleetOrStubAPI

addAssignment

void addAssignment(FleetAssignment assignment,
                   SectorEntityToken target,
                   float maxDurationInDays,
                   java.lang.String actionText)

Specified by:

addAssignment in interface FleetOrStubAPI

addAssignment

void addAssignment(FleetAssignment assignment,
                   SectorEntityToken target,
                   float maxDurationInDays,
                   java.lang.String actionText,
                   Script onCompletion)

Specified by:

addAssignment in interface FleetOrStubAPI

clearAssignments

void clearAssignments()

Specified by:

clearAssignments in interface FleetOrStubAPI

setPreferredResupplyLocation

void setPreferredResupplyLocation(SectorEntityToken token)

getVelocity

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

Description copied from interface: SectorEntityToken

In pixels per second.

Specified by:

getVelocity in interface SectorEntityToken

Returns:

getLocation

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

Specified by:

getLocation in interface FleetOrStubAPI

Specified by:

getLocation in interface SectorEntityToken

getLogistics

FleetLogisticsAPI getLogistics()

getContainingLocation

LocationAPI getContainingLocation()

Specified by:

getContainingLocation in interface FleetOrStubAPI

Specified by:

getContainingLocation in interface SectorEntityToken

getCommander

PersonAPI getCommander()

getCommanderStats

MutableCharacterStatsAPI getCommanderStats()

getFlagship

FleetMemberAPI getFlagship()

isPlayerFleet

boolean isPlayerFleet()

Specified by:

isPlayerFleet in interface SectorEntityToken

getFleetData

FleetDataAPI getFleetData()

removeFleetMemberWithDestructionFlash

void removeFleetMemberWithDestructionFlash(FleetMemberAPI member)

setName

void setName(java.lang.String name)

Specified by:

setName in interface SectorEntityToken

getTotalSupplyCostPerDay

float getTotalSupplyCostPerDay()

getNumCapitals

int getNumCapitals()

getNumCruisers

int getNumCruisers()

getNumDestroyers

int getNumDestroyers()

getNumFrigates

int getNumFrigates()

getNumFighters

int getNumFighters()

updateCounts

void updateCounts()

Updates numCapitals/numCruisers/etc

getTravelSpeed

float getTravelSpeed()

getAI

CampaignFleetAIAPI getAI()

getFleetPoints

int getFleetPoints()

getNameWithFaction

java.lang.String getNameWithFaction()

getName

java.lang.String getName()

Specified by:

getName in interface SectorEntityToken

isValidPlayerFleet

boolean isValidPlayerFleet()

Returns:

true if the fleet is not empty and doesn't consist entirely of fighter wings.

setNoEngaging

void setNoEngaging(float seconds)

getStats

MutableFleetStatsAPI getStats()

setMoveDestination

void setMoveDestination(float x,
                        float y)

Used by the AI to control the fleet as well, so it's not a reliable way to order a fleet around as the AI will be calling this method every frame.

Parameters:

x -

y -

setMoveDestinationOverride

void setMoveDestinationOverride(float x,
                                float y)

Overrides AI and player input.

Parameters:

x -

y -

getInteractionTarget

SectorEntityToken getInteractionTarget()

The fleet is trying to interact with this entity - i.e. engage an enemy fleet, use a wormhole, etc.

Returns:

setInteractionTarget

void setInteractionTarget(SectorEntityToken target)

isInHyperspaceTransition

boolean isInHyperspaceTransition()

setAIMode

void setAIMode(boolean aiMode)

Turns off supplies/fuel use, accidents, and ship crew requirements. Locks the LR to 100%.

Parameters:

aiMode -

isAIMode

boolean isAIMode()

getFleetSizeCount

int getFleetSizeCount()

fighter, frigate: 1 destroyer: 2 cruiser: 3 capital: 5

Returns:

setNoFactionInName

void setNoFactionInName(boolean noFactionInName)

isNoFactionInName

boolean isNoFactionInName()

setCommander

void setCommander(PersonAPI commander)

forceSync

void forceSync()

Makes sure the fleet's capacities, crew levels, etc match the fleet composition and cargo. Also reapplies any fleet buffs, effects of hullmods, skills, etc.

knowsWhoPlayerIs

boolean knowsWhoPlayerIs()

True if the player's transponder is on, or it has seen the player with the transponder on and hasn't lost track of them since that point.

Returns:

isHostileTo

boolean isHostileTo(SectorEntityToken other)

Eventually falls back to faction.isHostile(), but may return true if there's hostility due to MakeOtherFleetHostile true, a captain's relationship to the player/other captain, etc.

Parameters:

other -

Returns:

getViews

java.util.List<FleetMemberViewAPI> getViews()

Returns the "view" of the fleet member in the campaign - i.e. the little ships flying around. Not every fleet member necessarily has a view. Fleets don't have any member views when they're not currently visible to the player.

Returns:

getViewForMember

FleetMemberViewAPI getViewForMember(FleetMemberAPI member)

Returns the "view" of the fleet member in the campaign - i.e. the little ships flying around. Not every fleet member necessarily has a view. Fleets don't have any member views when they're not currently visible to the player.

Returns:

getCurrBurnLevel

float getCurrBurnLevel()

Current burn level - not maximum, but how fast it's currently going.

Returns:

setVelocity

void setVelocity(float x,
                 float y)

In pixels per second, not per day.

getAcceleration

float getAcceleration()

In pixels per second, not per day.

Returns:

setFaction

void setFaction(java.lang.String factionId,
                boolean includeCaptains)

getBattle

BattleAPI getBattle()

setBattle

void setBattle(BattleAPI battle)

setAI

void setAI(CampaignFleetAIAPI campaignFleetAI)

getNameWithFactionKeepCase

java.lang.String getNameWithFactionKeepCase()

isFriendlyTo

boolean isFriendlyTo(SectorEntityToken other)

getBaseSensorRangeToDetect

float getBaseSensorRangeToDetect(float sensorProfile)

Specified by:

getBaseSensorRangeToDetect in interface SectorEntityToken

isDoNotAdvanceAI

java.lang.Boolean isDoNotAdvanceAI()

setDoNotAdvanceAI

void setDoNotAdvanceAI(java.lang.Boolean doNotAdvanceAI)

getMembersWithFightersCopy

java.util.List<FleetMemberAPI> getMembersWithFightersCopy()

setNullAIActionText

void setNullAIActionText(java.lang.String nullAIActionText)

getNullAIActionText

java.lang.String getNullAIActionText()

setStationMode

void setStationMode(java.lang.Boolean stationMode)

isStationMode

boolean isStationMode()

wasMousedOverByPlayer

java.lang.Boolean wasMousedOverByPlayer()

setWasMousedOverByPlayer

void setWasMousedOverByPlayer(java.lang.Boolean wasMousedOverByPlayer)

isDespawning

boolean isDespawning()

getMoveDestination

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

getEventListeners

java.util.List<FleetEventListener> getEventListeners()

Specified by:

getEventListeners in interface FleetOrStubAPI

getInflater

FleetInflater getInflater()

setInflater

void setInflater(FleetInflater inflater)

inflateIfNeeded

void inflateIfNeeded()

deflate

void deflate()

isEmpty

boolean isEmpty()

getForceNoSensorProfileUpdate

java.lang.Boolean getForceNoSensorProfileUpdate()

setForceNoSensorProfileUpdate

void setForceNoSensorProfileUpdate(java.lang.Boolean forceNoSensorProfileUpdate)

isInflated

boolean isInflated()

setInflated

void setInflated(java.lang.Boolean inflated)

isNoAutoDespawn

java.lang.Boolean isNoAutoDespawn()

setNoAutoDespawn

void setNoAutoDespawn(java.lang.Boolean noAutoDespawn)

addAssignment

void addAssignment(FleetAssignment assignment,
                   SectorEntityToken target,
                   float maxDurationInDays,
                   java.lang.String actionText,
                   boolean addTimeToNext,
                   Script onStart,
                   Script onCompletion)

isHidden

boolean isHidden()

setHidden

void setHidden(java.lang.Boolean hidden)

getAbortDespawn

java.lang.Boolean getAbortDespawn()

setAbortDespawn

void setAbortDespawn(java.lang.Boolean abortDespawn)

getEffectiveStrength

float getEffectiveStrength()

Sum of Misc.getMemberStrength(member, true, true, true) for all members. Cached and updated as needed.

Returns:

getNumMembersFast

int getNumMembersFast()

goSlowOneFrame

void goSlowOneFrame(boolean stop)

wasSlowMoving

boolean wasSlowMoving()

getNumShips

int getNumShips()

updateFleetView

void updateFleetView()

hasShipsWithUniqueSig

boolean hasShipsWithUniqueSig()

Only works for the player fleet.

Returns:

getGoSlowStop

boolean getGoSlowStop()

goSlowOneFrame

void goSlowOneFrame()

getGoSlowOneFrame

boolean getGoSlowOneFrame()

getVelocityFromMovementModule

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

fadeOutIndicator

void fadeOutIndicator()

Specified by:

fadeOutIndicator in interface SectorEntityToken

fadeInIndicator

void fadeInIndicator()

Specified by:

fadeInIndicator in interface SectorEntityToken

forceOutIndicator

void forceOutIndicator()

Specified by:

forceOutIndicator in interface SectorEntityToken