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

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

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

Public Member Functions
boolean	isInCurrentLocation ()
boolean	isInHyperspace ()
void	setLocation (float x, float y)
void	despawn ()
void	despawn (FleetDespawnReason reason, Object param)
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, String actionText)
void	addAssignment (FleetAssignment assignment, SectorEntityToken target, float maxDurationInDays, String actionText, Script onCompletion)
void	clearAssignments ()
void	setPreferredResupplyLocation (SectorEntityToken token)
Vector2f	getVelocity ()
Vector2f	getLocation ()
FleetLogisticsAPI	getLogistics ()
LocationAPI	getContainingLocation ()
PersonAPI	getCommander ()
MutableCharacterStatsAPI	getCommanderStats ()
FleetMemberAPI	getFlagship ()
boolean	isPlayerFleet ()
FleetDataAPI	getFleetData ()
void	removeFleetMemberWithDestructionFlash (FleetMemberAPI member)
void	setName (String name)
float	getTotalSupplyCostPerDay ()
int	getNumCapitals ()
int	getNumCruisers ()
int	getNumDestroyers ()
int	getNumFrigates ()
int	getNumFighters ()
void	updateCounts ()
float	getTravelSpeed ()
CampaignFleetAIAPI	getAI ()
int	getFleetPoints ()
String	getNameWithFaction ()
String	getName ()
boolean	isValidPlayerFleet ()
void	setNoEngaging (float seconds)
MutableFleetStatsAPI	getStats ()
void	setMoveDestination (float x, float y)
void	setMoveDestinationOverride (float x, float y)
SectorEntityToken	getInteractionTarget ()
void	setInteractionTarget (SectorEntityToken target)
boolean	isInHyperspaceTransition ()
void	setAIMode (boolean aiMode)
boolean	isAIMode ()
int	getFleetSizeCount ()
void	setNoFactionInName (boolean noFactionInName)
boolean	isNoFactionInName ()
void	setCommander (PersonAPI commander)
void	forceSync ()
boolean	knowsWhoPlayerIs ()
boolean	isHostileTo (SectorEntityToken other)
List< FleetMemberViewAPI >	getViews ()
FleetMemberViewAPI	getViewForMember (FleetMemberAPI member)
float	getCurrBurnLevel ()
void	setVelocity (float x, float y)
float	getAcceleration ()
void	setFaction (String factionId, boolean includeCaptains)
BattleAPI	getBattle ()
void	setBattle (BattleAPI battle)
void	setAI (CampaignFleetAIAPI campaignFleetAI)
String	getNameWithFactionKeepCase ()
boolean	isFriendlyTo (SectorEntityToken other)
float	getBaseSensorRangeToDetect (float sensorProfile)
Boolean	isDoNotAdvanceAI ()
void	setDoNotAdvanceAI (Boolean doNotAdvanceAI)
List< FleetMemberAPI >	getMembersWithFightersCopy ()
void	setNullAIActionText (String nullAIActionText)
String	getNullAIActionText ()
void	setStationMode (Boolean stationMode)
boolean	isStationMode ()
Boolean	wasMousedOverByPlayer ()
void	setWasMousedOverByPlayer (Boolean wasMousedOverByPlayer)
boolean	isDespawning ()
Vector2f	getMoveDestination ()
List< FleetEventListener >	getEventListeners ()
FleetInflater	getInflater ()
void	setInflater (FleetInflater inflater)
void	inflateIfNeeded ()
void	deflate ()
boolean	isEmpty ()
Boolean	getForceNoSensorProfileUpdate ()
void	setForceNoSensorProfileUpdate (Boolean forceNoSensorProfileUpdate)
boolean	isInflated ()
void	setInflated (Boolean inflated)
Boolean	isNoAutoDespawn ()
void	setNoAutoDespawn (Boolean noAutoDespawn)
void	addAssignment (FleetAssignment assignment, SectorEntityToken target, float maxDurationInDays, String actionText, boolean addTimeToNext, Script onStart, Script onCompletion)
boolean	isHidden ()
void	setHidden (Boolean hidden)
Boolean	getAbortDespawn ()
void	setAbortDespawn (Boolean abortDespawn)
float	getEffectiveStrength ()
int	getNumMembersFast ()
void	goSlowOneFrame (boolean stop)
boolean	wasSlowMoving ()
int	getNumShips ()
void	updateFleetView ()
boolean	hasShipsWithUniqueSig ()
boolean	getGoSlowStop ()
void	goSlowOneFrame ()
boolean	getGoSlowOneFrame ()
Vector2f	getVelocityFromMovementModule ()
void	fadeOutIndicator ()
void	fadeInIndicator ()
void	forceOutIndicator ()
Public Member Functions inherited from com.fs.starfarer.api.campaign.SectorEntityToken
MarketAPI	getMarket ()
void	setMarket (MarketAPI market)
CargoAPI	getCargo ()
Vector2f	getLocationInHyperspace ()
OrbitAPI	getOrbit ()
void	setOrbit (OrbitAPI orbit)
String	getId ()
String	getFullName ()
void	setFaction (String factionId)
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)
void	addScript (EveryFrameScript script)
void	removeScript (EveryFrameScript script)
void	removeScriptsOfClass (Class c)
boolean	isInOrNearSystem (StarSystemAPI system)
void	setInteractionImage (String category, String key)
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 ()
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	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	setOrbitFocus (SectorEntityToken focus)
Public Member Functions inherited from com.fs.starfarer.api.campaign.rules.HasMemory
Public Member Functions inherited from com.fs.starfarer.api.campaign.FleetOrStubAPI
String	getId ()
FleetAssignmentDataAPI	getCurrentAssignment ()
List< FleetAssignmentDataAPI >	getAssignmentsCopy ()
void	addAssignmentAtStart (FleetAssignment assignment, SectorEntityToken target, float maxDurationInDays, String actionText, Script onCompletion)
void	addAssignmentAtStart (FleetAssignment assignment, SectorEntityToken target, float maxDurationInDays, Script onCompletion)
boolean	isCurrentAssignment (FleetAssignment assignment)
void	removeFirstAssignmentIfItIs (FleetAssignment assignment)
void	removeFirstAssignment ()
MemoryAPI	getMemoryWithoutUpdate ()
boolean	isFleet ()
void	addScript (EveryFrameScript script)
void	addEventListener (FleetEventListener listener)
void	removeEventListener (FleetEventListener listener)
List< EveryFrameScript >	getScripts ()
Vector2f	getLocationInHyperspace ()

Detailed Description

Author

Alex Mosolov

Copyright 2012 Fractal Softworks, LLC

Definition at line 23 of file CampaignFleetAPI.java.

Member Function Documentation

addAssignment() [1/5]

void com.fs.starfarer.api.campaign.CampaignFleetAPI.addAssignment	(	FleetAssignment	assignment,
		SectorEntityToken	target,
		float	maxDurationInDays )

Implements com.fs.starfarer.api.campaign.FleetOrStubAPI.

addAssignment() [2/5]

void com.fs.starfarer.api.campaign.CampaignFleetAPI.addAssignment	(	FleetAssignment	assignment,
		SectorEntityToken	target,
		float	maxDurationInDays,
		Script	onCompletion )

Implements com.fs.starfarer.api.campaign.FleetOrStubAPI.

addAssignment() [3/5]

void com.fs.starfarer.api.campaign.CampaignFleetAPI.addAssignment	(	FleetAssignment	assignment,
		SectorEntityToken	target,
		float	maxDurationInDays,
		String	actionText )

Implements com.fs.starfarer.api.campaign.FleetOrStubAPI.

addAssignment() [4/5]

void com.fs.starfarer.api.campaign.CampaignFleetAPI.addAssignment	(	FleetAssignment	assignment,
		SectorEntityToken	target,
		float	maxDurationInDays,
		String	actionText,
		boolean	addTimeToNext,
		Script	onStart,
		Script	onCompletion )

addAssignment() [5/5]

void com.fs.starfarer.api.campaign.CampaignFleetAPI.addAssignment	(	FleetAssignment	assignment,
		SectorEntityToken	target,
		float	maxDurationInDays,
		String	actionText,
		Script	onCompletion )

Implements com.fs.starfarer.api.campaign.FleetOrStubAPI.

clearAssignments()

void com.fs.starfarer.api.campaign.CampaignFleetAPI.clearAssignments

(

)

Implements com.fs.starfarer.api.campaign.FleetOrStubAPI.

deflate()

void com.fs.starfarer.api.campaign.CampaignFleetAPI.deflate

(

)

despawn() [1/2]

void com.fs.starfarer.api.campaign.CampaignFleetAPI.despawn

(

)

Implements com.fs.starfarer.api.campaign.FleetOrStubAPI.

despawn() [2/2]

void com.fs.starfarer.api.campaign.CampaignFleetAPI.despawn	(	FleetDespawnReason	reason,
		Object	param )

Implements com.fs.starfarer.api.campaign.FleetOrStubAPI.

fadeInIndicator()

void com.fs.starfarer.api.campaign.CampaignFleetAPI.fadeInIndicator

(

)

Implements com.fs.starfarer.api.campaign.SectorEntityToken.

fadeOutIndicator()

void com.fs.starfarer.api.campaign.CampaignFleetAPI.fadeOutIndicator

(

)

Implements com.fs.starfarer.api.campaign.SectorEntityToken.

forceOutIndicator()

void com.fs.starfarer.api.campaign.CampaignFleetAPI.forceOutIndicator

(

)

Implements com.fs.starfarer.api.campaign.SectorEntityToken.

forceSync()

void com.fs.starfarer.api.campaign.CampaignFleetAPI.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.

getAbortDespawn()

Boolean com.fs.starfarer.api.campaign.CampaignFleetAPI.getAbortDespawn

(

)

getAcceleration()

float com.fs.starfarer.api.campaign.CampaignFleetAPI.getAcceleration

(

)

In pixels per second, not per day.

Returns

getAI()

CampaignFleetAIAPI com.fs.starfarer.api.campaign.CampaignFleetAPI.getAI

(

)

getBaseSensorRangeToDetect()

float com.fs.starfarer.api.campaign.CampaignFleetAPI.getBaseSensorRangeToDetect

(

float

sensorProfile

)

Implements com.fs.starfarer.api.campaign.SectorEntityToken.

getBattle()

BattleAPI com.fs.starfarer.api.campaign.CampaignFleetAPI.getBattle

(

)

getCommander()

PersonAPI com.fs.starfarer.api.campaign.CampaignFleetAPI.getCommander

(

)

getCommanderStats()

MutableCharacterStatsAPI com.fs.starfarer.api.campaign.CampaignFleetAPI.getCommanderStats

(

)

getContainingLocation()

LocationAPI com.fs.starfarer.api.campaign.CampaignFleetAPI.getContainingLocation

(

)

Implements com.fs.starfarer.api.campaign.SectorEntityToken.

getCurrBurnLevel()

float com.fs.starfarer.api.campaign.CampaignFleetAPI.getCurrBurnLevel

(

)

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

Returns

getEffectiveStrength()

float com.fs.starfarer.api.campaign.CampaignFleetAPI.getEffectiveStrength

(

)

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

Returns

getEventListeners()

List< FleetEventListener > com.fs.starfarer.api.campaign.CampaignFleetAPI.getEventListeners

(

)

Implements com.fs.starfarer.api.campaign.FleetOrStubAPI.

getFlagship()

FleetMemberAPI com.fs.starfarer.api.campaign.CampaignFleetAPI.getFlagship

(

)

getFleetData()

FleetDataAPI com.fs.starfarer.api.campaign.CampaignFleetAPI.getFleetData

(

)

getFleetPoints()

int com.fs.starfarer.api.campaign.CampaignFleetAPI.getFleetPoints

(

)

getFleetSizeCount()

int com.fs.starfarer.api.campaign.CampaignFleetAPI.getFleetSizeCount

(

)

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

Returns

getForceNoSensorProfileUpdate()

Boolean com.fs.starfarer.api.campaign.CampaignFleetAPI.getForceNoSensorProfileUpdate

(

)

getGoSlowOneFrame()

boolean com.fs.starfarer.api.campaign.CampaignFleetAPI.getGoSlowOneFrame

(

)

getGoSlowStop()

boolean com.fs.starfarer.api.campaign.CampaignFleetAPI.getGoSlowStop

(

)

getInflater()

FleetInflater com.fs.starfarer.api.campaign.CampaignFleetAPI.getInflater

(

)

getInteractionTarget()

SectorEntityToken com.fs.starfarer.api.campaign.CampaignFleetAPI.getInteractionTarget

(

)

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

Returns

getLocation()

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

(

)

Implements com.fs.starfarer.api.campaign.SectorEntityToken.

getLogistics()

FleetLogisticsAPI com.fs.starfarer.api.campaign.CampaignFleetAPI.getLogistics

(

)

getMembersWithFightersCopy()

List< FleetMemberAPI > com.fs.starfarer.api.campaign.CampaignFleetAPI.getMembersWithFightersCopy

(

)

getMoveDestination()

Vector2f com.fs.starfarer.api.campaign.CampaignFleetAPI.getMoveDestination

(

)

getName()

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

(

)

Implements com.fs.starfarer.api.campaign.SectorEntityToken.

getNameWithFaction()

String com.fs.starfarer.api.campaign.CampaignFleetAPI.getNameWithFaction

(

)

getNameWithFactionKeepCase()

String com.fs.starfarer.api.campaign.CampaignFleetAPI.getNameWithFactionKeepCase

(

)

getNullAIActionText()

String com.fs.starfarer.api.campaign.CampaignFleetAPI.getNullAIActionText

(

)

getNumCapitals()

int com.fs.starfarer.api.campaign.CampaignFleetAPI.getNumCapitals

(

)

getNumCruisers()

int com.fs.starfarer.api.campaign.CampaignFleetAPI.getNumCruisers

(

)

getNumDestroyers()

int com.fs.starfarer.api.campaign.CampaignFleetAPI.getNumDestroyers

(

)

getNumFighters()

int com.fs.starfarer.api.campaign.CampaignFleetAPI.getNumFighters

(

)

getNumFrigates()

int com.fs.starfarer.api.campaign.CampaignFleetAPI.getNumFrigates

(

)

getNumMembersFast()

int com.fs.starfarer.api.campaign.CampaignFleetAPI.getNumMembersFast

(

)

getNumShips()

int com.fs.starfarer.api.campaign.CampaignFleetAPI.getNumShips

(

)

getStats()

MutableFleetStatsAPI com.fs.starfarer.api.campaign.CampaignFleetAPI.getStats

(

)

getTotalSupplyCostPerDay()

float com.fs.starfarer.api.campaign.CampaignFleetAPI.getTotalSupplyCostPerDay

(

)

getTravelSpeed()

float com.fs.starfarer.api.campaign.CampaignFleetAPI.getTravelSpeed

(

)

getVelocity()

Vector2f com.fs.starfarer.api.campaign.CampaignFleetAPI.getVelocity

(

)

In pixels per second.

Returns

Implements com.fs.starfarer.api.campaign.SectorEntityToken.

getVelocityFromMovementModule()

Vector2f com.fs.starfarer.api.campaign.CampaignFleetAPI.getVelocityFromMovementModule

(

)

getViewForMember()

FleetMemberViewAPI com.fs.starfarer.api.campaign.CampaignFleetAPI.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

getViews()

List< FleetMemberViewAPI > com.fs.starfarer.api.campaign.CampaignFleetAPI.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

goSlowOneFrame() [1/2]

void com.fs.starfarer.api.campaign.CampaignFleetAPI.goSlowOneFrame

(

)

goSlowOneFrame() [2/2]

void com.fs.starfarer.api.campaign.CampaignFleetAPI.goSlowOneFrame

(

boolean

stop

)

hasShipsWithUniqueSig()

boolean com.fs.starfarer.api.campaign.CampaignFleetAPI.hasShipsWithUniqueSig

(

)

Only works for the player fleet.

Returns

inflateIfNeeded()

void com.fs.starfarer.api.campaign.CampaignFleetAPI.inflateIfNeeded

(

)

isAIMode()

boolean com.fs.starfarer.api.campaign.CampaignFleetAPI.isAIMode

(

)

isDespawning()

boolean com.fs.starfarer.api.campaign.CampaignFleetAPI.isDespawning

(

)

isDoNotAdvanceAI()

Boolean com.fs.starfarer.api.campaign.CampaignFleetAPI.isDoNotAdvanceAI

(

)

isEmpty()

boolean com.fs.starfarer.api.campaign.CampaignFleetAPI.isEmpty

(

)

isFriendlyTo()

boolean com.fs.starfarer.api.campaign.CampaignFleetAPI.isFriendlyTo

(

SectorEntityToken

other

)

isHidden()

boolean com.fs.starfarer.api.campaign.CampaignFleetAPI.isHidden

(

)

isHostileTo()

boolean com.fs.starfarer.api.campaign.CampaignFleetAPI.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

isInCurrentLocation()

boolean com.fs.starfarer.api.campaign.CampaignFleetAPI.isInCurrentLocation

(

)

Returns

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

Implements com.fs.starfarer.api.campaign.SectorEntityToken.

isInflated()

boolean com.fs.starfarer.api.campaign.CampaignFleetAPI.isInflated

(

)

isInHyperspace()

boolean com.fs.starfarer.api.campaign.CampaignFleetAPI.isInHyperspace

(

)

Implements com.fs.starfarer.api.campaign.SectorEntityToken.

isInHyperspaceTransition()

boolean com.fs.starfarer.api.campaign.CampaignFleetAPI.isInHyperspaceTransition

(

)

isNoAutoDespawn()

Boolean com.fs.starfarer.api.campaign.CampaignFleetAPI.isNoAutoDespawn

(

)

isNoFactionInName()

boolean com.fs.starfarer.api.campaign.CampaignFleetAPI.isNoFactionInName

(

)

isPlayerFleet()

boolean com.fs.starfarer.api.campaign.CampaignFleetAPI.isPlayerFleet

(

)

Implements com.fs.starfarer.api.campaign.SectorEntityToken.

isStationMode()

boolean com.fs.starfarer.api.campaign.CampaignFleetAPI.isStationMode

(

)

isValidPlayerFleet()

boolean com.fs.starfarer.api.campaign.CampaignFleetAPI.isValidPlayerFleet

(

)

Returns

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

knowsWhoPlayerIs()

boolean com.fs.starfarer.api.campaign.CampaignFleetAPI.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

removeFleetMemberWithDestructionFlash()

void com.fs.starfarer.api.campaign.CampaignFleetAPI.removeFleetMemberWithDestructionFlash

(

FleetMemberAPI

member

)

setAbortDespawn()

void com.fs.starfarer.api.campaign.CampaignFleetAPI.setAbortDespawn

(

Boolean

abortDespawn

)

setAI()

void com.fs.starfarer.api.campaign.CampaignFleetAPI.setAI

(

CampaignFleetAIAPI

campaignFleetAI

)

setAIMode()

void com.fs.starfarer.api.campaign.CampaignFleetAPI.setAIMode

(

boolean

aiMode

)

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

Parameters

aiMode

setBattle()

void com.fs.starfarer.api.campaign.CampaignFleetAPI.setBattle

(

BattleAPI

battle

)

setCommander()

void com.fs.starfarer.api.campaign.CampaignFleetAPI.setCommander

(

PersonAPI

commander

)

setDoNotAdvanceAI()

void com.fs.starfarer.api.campaign.CampaignFleetAPI.setDoNotAdvanceAI

(

Boolean

doNotAdvanceAI

)

setFaction()

void com.fs.starfarer.api.campaign.CampaignFleetAPI.setFaction	(	String	factionId,
		boolean	includeCaptains )

setForceNoSensorProfileUpdate()

void com.fs.starfarer.api.campaign.CampaignFleetAPI.setForceNoSensorProfileUpdate

(

Boolean

forceNoSensorProfileUpdate

)

setHidden()

void com.fs.starfarer.api.campaign.CampaignFleetAPI.setHidden

(

Boolean

hidden

)

setInflated()

void com.fs.starfarer.api.campaign.CampaignFleetAPI.setInflated

(

Boolean

inflated

)

setInflater()

void com.fs.starfarer.api.campaign.CampaignFleetAPI.setInflater

(

FleetInflater

inflater

)

setInteractionTarget()

void com.fs.starfarer.api.campaign.CampaignFleetAPI.setInteractionTarget

(

SectorEntityToken

target

)

setLocation()

void com.fs.starfarer.api.campaign.CampaignFleetAPI.setLocation	(	float	x,
		float	y )

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

Parameters

x
y

Implements com.fs.starfarer.api.campaign.SectorEntityToken.

setMoveDestination()

void com.fs.starfarer.api.campaign.CampaignFleetAPI.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 com.fs.starfarer.api.campaign.CampaignFleetAPI.setMoveDestinationOverride	(	float	x,
		float	y )

Overrides AI and player input.

Parameters

x
y

setName()

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

(

String

name

)

Implements com.fs.starfarer.api.campaign.SectorEntityToken.

setNoAutoDespawn()

void com.fs.starfarer.api.campaign.CampaignFleetAPI.setNoAutoDespawn

(

Boolean

noAutoDespawn

)

setNoEngaging()

void com.fs.starfarer.api.campaign.CampaignFleetAPI.setNoEngaging

(

float

seconds

)

setNoFactionInName()

void com.fs.starfarer.api.campaign.CampaignFleetAPI.setNoFactionInName

(

boolean

noFactionInName

)

setNullAIActionText()

void com.fs.starfarer.api.campaign.CampaignFleetAPI.setNullAIActionText

(

String

nullAIActionText

)

setPreferredResupplyLocation()

void com.fs.starfarer.api.campaign.CampaignFleetAPI.setPreferredResupplyLocation

(

SectorEntityToken

token

)

setStationMode()

void com.fs.starfarer.api.campaign.CampaignFleetAPI.setStationMode

(

Boolean

stationMode

)

setVelocity()

void com.fs.starfarer.api.campaign.CampaignFleetAPI.setVelocity	(	float	x,
		float	y )

In pixels per second, not per day.

setWasMousedOverByPlayer()

void com.fs.starfarer.api.campaign.CampaignFleetAPI.setWasMousedOverByPlayer

(

Boolean

wasMousedOverByPlayer

)

updateCounts()

void com.fs.starfarer.api.campaign.CampaignFleetAPI.updateCounts

(

)

Updates numCapitals/numCruisers/etc

updateFleetView()

void com.fs.starfarer.api.campaign.CampaignFleetAPI.updateFleetView

(

)

wasMousedOverByPlayer()

Boolean com.fs.starfarer.api.campaign.CampaignFleetAPI.wasMousedOverByPlayer

(

)

wasSlowMoving()

boolean com.fs.starfarer.api.campaign.CampaignFleetAPI.wasSlowMoving

(

)

---

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

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