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

Public Member Functions
List< FleetMemberAPI >	getMembersInPriorityOrder ()
List< FleetMemberAPI >	getMembersListCopy ()
List< FleetMemberAPI >	getCombatReadyMembersListCopy ()
float	getFleetPointsUsed ()
void	addFleetMember (FleetMemberAPI member)
void	removeFleetMember (FleetMemberAPI member)
void	clear ()
void	scuttle (FleetMemberAPI member)
float	getMaxBurnLevel ()
float	getMinBurnLevel ()
float	getBurnLevel ()
void	setFlagship (FleetMemberAPI flagship)
CampaignFleetAPI	getFleet ()
float	getTravelSpeed ()
void	takeSnapshot ()
ArrayList< FleetMemberAPI >	getSnapshot ()
boolean	areAnyShipsPerformingRepairs ()
void	sort ()
List< OfficerDataAPI >	getOfficersCopy ()
void	addOfficer (PersonAPI person)
void	removeOfficer (PersonAPI person)
OfficerDataAPI	getOfficerData (PersonAPI person)
FleetMemberAPI	getMemberWithCaptain (PersonAPI captain)
int	getNumMembers ()
void	syncMemberLists ()
boolean	isOnlySyncMemberLists ()
void	setOnlySyncMemberLists (boolean onlySyncMemberLists)
void	syncIfNeeded ()
void	setSyncNeeded ()
List< FleetMemberAPI >	getMembersListWithFightersCopy ()
PersonAPI	getCommander ()
float	getMinCrew ()
void	ensureHasFlagship ()
FleetMemberAPI	addFleetMember (String variantId)
void	addOfficer (OfficerDataAPI officer)
void	updateCargoCapacities ()
String	pickShipName (FleetMemberAPI member, Random random)
float	getEffectiveStrength ()
Map< String, Object >	getCacheClearedOnSync ()
float	getMinBurnLevelUnmodified ()
Random	getShipNameRandom ()
void	setShipNameRandom (Random shipNameRandom)
void	sortToMatchOrder (List< FleetMemberAPI > originalOrder)
boolean	isForceNoSync ()
void	setForceNoSync (boolean forceNoSync)

Detailed Description

Definition at line 12 of file FleetDataAPI.java.

Member Function Documentation

addFleetMember() [1/2]

void com.fs.starfarer.api.campaign.FleetDataAPI.addFleetMember

(

FleetMemberAPI

member

)

addFleetMember() [2/2]

FleetMemberAPI com.fs.starfarer.api.campaign.FleetDataAPI.addFleetMember

(

String

variantId

)

addOfficer() [1/2]

void com.fs.starfarer.api.campaign.FleetDataAPI.addOfficer

(

OfficerDataAPI

officer

)

addOfficer() [2/2]

void com.fs.starfarer.api.campaign.FleetDataAPI.addOfficer

(

PersonAPI

person

)

areAnyShipsPerformingRepairs()

boolean com.fs.starfarer.api.campaign.FleetDataAPI.areAnyShipsPerformingRepairs

(

)

clear()

void com.fs.starfarer.api.campaign.FleetDataAPI.clear

(

)

ensureHasFlagship()

void com.fs.starfarer.api.campaign.FleetDataAPI.ensureHasFlagship

(

)

getBurnLevel()

float com.fs.starfarer.api.campaign.FleetDataAPI.getBurnLevel

(

)

Effective burn level this fleet can go at; includes effect of being in deep hyperspace (where getMinBurnLevel() does not).

Returns

getCacheClearedOnSync()

Map< String, Object > com.fs.starfarer.api.campaign.FleetDataAPI.getCacheClearedOnSync

(

)

Useful for skills that need to do some computations to figure out effect magnitude, but where the values might change if the fleet composition changed.

Returns

getCombatReadyMembersListCopy()

List< FleetMemberAPI > com.fs.starfarer.api.campaign.FleetDataAPI.getCombatReadyMembersListCopy

(

)

getCommander()

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

(

)

getEffectiveStrength()

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

(

)

getFleet()

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

(

)

getFleetPointsUsed()

float com.fs.starfarer.api.campaign.FleetDataAPI.getFleetPointsUsed

(

)

getMaxBurnLevel()

float com.fs.starfarer.api.campaign.FleetDataAPI.getMaxBurnLevel

(

)

Maximum burn level of fastest ship in the fleet. Includes getStats().getFleetwideMaxBurnMod(). Does NOT include mothballed ships.

Returns

getMembersInPriorityOrder()

List< FleetMemberAPI > com.fs.starfarer.api.campaign.FleetDataAPI.getMembersInPriorityOrder

(

)

Returns: "logistical priority" members first, then non-mothballed, then mothballed. Retains normal order within each category.

Returns

getMembersListCopy()

List< FleetMemberAPI > com.fs.starfarer.api.campaign.FleetDataAPI.getMembersListCopy

(

)

getMembersListWithFightersCopy()

List< FleetMemberAPI > com.fs.starfarer.api.campaign.FleetDataAPI.getMembersListWithFightersCopy

(

)

getMemberWithCaptain()

FleetMemberAPI com.fs.starfarer.api.campaign.FleetDataAPI.getMemberWithCaptain

(

PersonAPI

captain

)

getMinBurnLevel()

float com.fs.starfarer.api.campaign.FleetDataAPI.getMinBurnLevel

(

)

Maximum burn level of slowest ship in the fleet. Includes getStats().getFleetwideMaxBurnMod()

Returns

getMinBurnLevelUnmodified()

float com.fs.starfarer.api.campaign.FleetDataAPI.getMinBurnLevelUnmodified

(

)

getMinCrew()

float com.fs.starfarer.api.campaign.FleetDataAPI.getMinCrew

(

)

getNumMembers()

int com.fs.starfarer.api.campaign.FleetDataAPI.getNumMembers

(

)

getOfficerData()

OfficerDataAPI com.fs.starfarer.api.campaign.FleetDataAPI.getOfficerData

(

PersonAPI

person

)

getOfficersCopy()

List< OfficerDataAPI > com.fs.starfarer.api.campaign.FleetDataAPI.getOfficersCopy

(

)

getShipNameRandom()

Random com.fs.starfarer.api.campaign.FleetDataAPI.getShipNameRandom

(

)

getSnapshot()

ArrayList< FleetMemberAPI > com.fs.starfarer.api.campaign.FleetDataAPI.getSnapshot

(

)

Returns fleet members at time snapshot was taken. Useful to get the state of the fleet before a battle/prior to it being destroyed/etc.

Returns

getTravelSpeed()

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

(

)

In pixels/second. There are 10 real seconds in a day.

Returns

isForceNoSync()

boolean com.fs.starfarer.api.campaign.FleetDataAPI.isForceNoSync

(

)

isOnlySyncMemberLists()

boolean com.fs.starfarer.api.campaign.FleetDataAPI.isOnlySyncMemberLists

(

)

pickShipName()

String com.fs.starfarer.api.campaign.FleetDataAPI.pickShipName	(	FleetMemberAPI	member,
		Random	random )

removeFleetMember()

void com.fs.starfarer.api.campaign.FleetDataAPI.removeFleetMember

(

FleetMemberAPI

member

)

removeOfficer()

void com.fs.starfarer.api.campaign.FleetDataAPI.removeOfficer

(

PersonAPI

person

)

scuttle()

void com.fs.starfarer.api.campaign.FleetDataAPI.scuttle

(

FleetMemberAPI

member

)

Removes from the fleet, adds fuel/supplies gained from scuttling, adds any equipped weapons to cargo.

Parameters

member

setFlagship()

void com.fs.starfarer.api.campaign.FleetDataAPI.setFlagship

(

FleetMemberAPI

flagship

)

Will also set the captains of all the other ships to a new person with all-0 stats.

Parameters

flagship

setForceNoSync()

void com.fs.starfarer.api.campaign.FleetDataAPI.setForceNoSync

(

boolean

forceNoSync

)

setOnlySyncMemberLists()

void com.fs.starfarer.api.campaign.FleetDataAPI.setOnlySyncMemberLists

(

boolean

onlySyncMemberLists

)

setShipNameRandom()

void com.fs.starfarer.api.campaign.FleetDataAPI.setShipNameRandom

(

Random

shipNameRandom

)

setSyncNeeded()

void com.fs.starfarer.api.campaign.FleetDataAPI.setSyncNeeded

(

)

sort()

void com.fs.starfarer.api.campaign.FleetDataAPI.sort

(

)

sortToMatchOrder()

void com.fs.starfarer.api.campaign.FleetDataAPI.sortToMatchOrder

(

List< FleetMemberAPI >

originalOrder

)

syncIfNeeded()

void com.fs.starfarer.api.campaign.FleetDataAPI.syncIfNeeded

(

)

syncMemberLists()

void com.fs.starfarer.api.campaign.FleetDataAPI.syncMemberLists

(

)

takeSnapshot()

void com.fs.starfarer.api.campaign.FleetDataAPI.takeSnapshot

(

)

Makes a copy of the current fleet members. The snapshot is transient and will not be in the save file.

updateCargoCapacities()

void com.fs.starfarer.api.campaign.FleetDataAPI.updateCargoCapacities

(

)

---

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

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