Classes
enum	BattleSide

Public Member Functions
void	genCombined ()

void	genCombinedDoNotRemoveEmpty ()

void	uncombine ()

CampaignFleetAPI	getCombinedOne ()

CampaignFleetAPI	getCombinedTwo ()

boolean	canJoin (CampaignFleetAPI fleet)

BattleSide	pickSide (CampaignFleetAPI fleet)

boolean	join (CampaignFleetAPI fleet)

boolean	isPlayerInvolved ()

List< CampaignFleetAPI >	getFleetsFor (EngagementResultForFleetAPI side)

boolean	isPlayerSide (EngagementResultForFleetAPI side)

CampaignFleetAPI	getCombinedFor (CampaignFleetAPI participantOrCombined)

CampaignFleetAPI	getSourceFleet (FleetMemberAPI member)

List< CampaignFleetAPI >	getSideFor (CampaignFleetAPI participantOrCombined)

CampaignFleetAPI	getPrimary (List< CampaignFleetAPI > side)

boolean	isPlayerSide (List< CampaignFleetAPI > side)

List< CampaignFleetAPI >	getPlayerSide ()

void	removeEmptyFleets ()

boolean	isPlayerPrimary ()

boolean	isDone ()

List< CampaignFleetAPI >	getSideOne ()

List< CampaignFleetAPI >	getSideTwo ()

List< CampaignFleetAPI >	getNonPlayerSide ()

CampaignFleetAPI	getPlayerCombined ()

CampaignFleetAPI	getNonPlayerCombined ()

CampaignFleetAPI	getCombined (BattleSide side)

CampaignFleetAPI	getOtherSideCombined (BattleSide side)

void	leave (CampaignFleetAPI fleet, boolean engagedInHostilities)

List< CampaignFleetAPI >	getSide (BattleSide side)

List< CampaignFleetAPI >	getOtherSide (BattleSide side)

boolean	knowsWhoPlayerIs (List< CampaignFleetAPI > side)

BattleSide	pickSide (CampaignFleetAPI fleet, boolean considerPlayerTransponderStatus)

void	takeSnapshots ()

List< CampaignFleetAPI >	getSnapshotSideOne ()

List< CampaignFleetAPI >	getSnapshotSideTwo ()

List< CampaignFleetAPI >	getSnapshotSideFor (CampaignFleetAPI participantOrCombined)

List< CampaignFleetAPI >	getSnapshotFor (List< CampaignFleetAPI > side)

List< CampaignFleetAPI >	getBothSides ()

List< CampaignFleetAPI >	getSnapshotBothSides ()

List< CampaignFleetAPI >	getOtherSideFor (CampaignFleetAPI participantOrCombined)

boolean	isOnPlayerSide (CampaignFleetAPI participantOrCombined)

List< CampaignFleetAPI >	getOtherSideSnapshotFor (CampaignFleetAPI participantOrCombined)

List< CampaignFleetAPI >	getPlayerSideSnapshot ()

List< CampaignFleetAPI >	getNonPlayerSideSnapshot ()

boolean	isInvolved (CampaignFleetAPI test)

float	getPlayerInvolvementFraction ()

boolean	hasSnapshots ()

void	applyVisibilityMod (CampaignFleetAPI fleet)

boolean	onSameSide (CampaignFleetAPI one, CampaignFleetAPI two)

boolean	onPlayerSide (CampaignFleetAPI fleet)

CampaignFleetAPI	getClosestInvolvedFleetTo (CampaignFleetAPI fleet)

void	finish (BattleSide winner)

void	finish (BattleSide winner, boolean engagedInHostilities)

boolean	isPlayerInvolvedAtStart ()

void	setPlayerInvolvedAtStart (boolean playerInvolvedAtStart)

void	setPlayerInvolvementFraction (float playerInvolvementFraction)

CampaignFleetAPI	getPrimary (List< CampaignFleetAPI > side, boolean nonPlayer)

Map< FleetMemberAPI, CampaignFleetAPI >	getMemberSourceMap ()

long	getSeed ()

Vector2f	computeCenterOfMass ()

boolean	isStationInvolved ()

boolean	isStationInvolvedOnPlayerSide ()

boolean	isStationInvolved (List< CampaignFleetAPI > side)

List< CampaignFleetAPI >	getStationSide ()

void	genCombined (boolean withStation)

boolean	join (CampaignFleetAPI fleet, BattleSide side)

boolean	wasFleetDefeated (CampaignFleetAPI fleet, CampaignFleetAPI primaryWinner)

boolean	wasFleetVictorious (CampaignFleetAPI fleet, CampaignFleetAPI primaryWinner)

Detailed Description

Definition at line 10 of file BattleAPI.java.

Member Function Documentation

◆ applyVisibilityMod()

void com.fs.starfarer.api.campaign.BattleAPI.applyVisibilityMod ( CampaignFleetAPI fleet )

◆ canJoin()

boolean com.fs.starfarer.api.campaign.BattleAPI.canJoin ( CampaignFleetAPI fleet )

◆ computeCenterOfMass()

Vector2f com.fs.starfarer.api.campaign.BattleAPI.computeCenterOfMass ( )

◆ finish() [1/2]

void com.fs.starfarer.api.campaign.BattleAPI.finish ( BattleSide winner )

◆ finish() [2/2]

void com.fs.starfarer.api.campaign.BattleAPI.finish	(	BattleSide	winner,
		boolean	engagedInHostilities )

◆ genCombined() [1/2]

void com.fs.starfarer.api.campaign.BattleAPI.genCombined ( )

◆ genCombined() [2/2]

void com.fs.starfarer.api.campaign.BattleAPI.genCombined ( boolean withStation )

◆ genCombinedDoNotRemoveEmpty()

void com.fs.starfarer.api.campaign.BattleAPI.genCombinedDoNotRemoveEmpty ( )

◆ getBothSides()

List< CampaignFleetAPI > com.fs.starfarer.api.campaign.BattleAPI.getBothSides ( )

◆ getClosestInvolvedFleetTo()

CampaignFleetAPI com.fs.starfarer.api.campaign.BattleAPI.getClosestInvolvedFleetTo ( CampaignFleetAPI fleet )

◆ getCombined()

CampaignFleetAPI com.fs.starfarer.api.campaign.BattleAPI.getCombined ( BattleSide side )

◆ getCombinedFor()

CampaignFleetAPI com.fs.starfarer.api.campaign.BattleAPI.getCombinedFor ( CampaignFleetAPI participantOrCombined )

◆ getCombinedOne()

CampaignFleetAPI com.fs.starfarer.api.campaign.BattleAPI.getCombinedOne ( )

◆ getCombinedTwo()

CampaignFleetAPI com.fs.starfarer.api.campaign.BattleAPI.getCombinedTwo ( )

◆ getFleetsFor()

List< CampaignFleetAPI > com.fs.starfarer.api.campaign.BattleAPI.getFleetsFor ( EngagementResultForFleetAPI side )

◆ getMemberSourceMap()

Map< FleetMemberAPI, CampaignFleetAPI > com.fs.starfarer.api.campaign.BattleAPI.getMemberSourceMap ( )

◆ getNonPlayerCombined()

CampaignFleetAPI com.fs.starfarer.api.campaign.BattleAPI.getNonPlayerCombined ( )

◆ getNonPlayerSide()

List< CampaignFleetAPI > com.fs.starfarer.api.campaign.BattleAPI.getNonPlayerSide ( )

◆ getNonPlayerSideSnapshot()

List< CampaignFleetAPI > com.fs.starfarer.api.campaign.BattleAPI.getNonPlayerSideSnapshot ( )

Snapshot before the battle, containing any fleets that may have been eliminated during.

Returns

◆ getOtherSide()

List< CampaignFleetAPI > com.fs.starfarer.api.campaign.BattleAPI.getOtherSide ( BattleSide side )

◆ getOtherSideCombined()

CampaignFleetAPI com.fs.starfarer.api.campaign.BattleAPI.getOtherSideCombined ( BattleSide side )

◆ getOtherSideFor()

List< CampaignFleetAPI > com.fs.starfarer.api.campaign.BattleAPI.getOtherSideFor ( CampaignFleetAPI participantOrCombined )

◆ getOtherSideSnapshotFor()

List< CampaignFleetAPI > com.fs.starfarer.api.campaign.BattleAPI.getOtherSideSnapshotFor ( CampaignFleetAPI participantOrCombined )

◆ getPlayerCombined()

CampaignFleetAPI com.fs.starfarer.api.campaign.BattleAPI.getPlayerCombined ( )

◆ getPlayerInvolvementFraction()

float com.fs.starfarer.api.campaign.BattleAPI.getPlayerInvolvementFraction ( )

◆ getPlayerSide()

List< CampaignFleetAPI > com.fs.starfarer.api.campaign.BattleAPI.getPlayerSide ( )

◆ getPlayerSideSnapshot()

List< CampaignFleetAPI > com.fs.starfarer.api.campaign.BattleAPI.getPlayerSideSnapshot ( )

Snapshot before the battle, containing any fleets that may have been eliminated during.

Returns

◆ getPrimary() [1/2]

CampaignFleetAPI com.fs.starfarer.api.campaign.BattleAPI.getPrimary ( List< CampaignFleetAPI > side )

◆ getPrimary() [2/2]

CampaignFleetAPI com.fs.starfarer.api.campaign.BattleAPI.getPrimary	(	List< CampaignFleetAPI >	side,
		boolean	nonPlayer )

◆ getSeed()

long com.fs.starfarer.api.campaign.BattleAPI.getSeed ( )

◆ getSide()

List< CampaignFleetAPI > com.fs.starfarer.api.campaign.BattleAPI.getSide ( BattleSide side )

◆ getSideFor()

List< CampaignFleetAPI > com.fs.starfarer.api.campaign.BattleAPI.getSideFor ( CampaignFleetAPI participantOrCombined )

◆ getSideOne()

List< CampaignFleetAPI > com.fs.starfarer.api.campaign.BattleAPI.getSideOne ( )

◆ getSideTwo()

List< CampaignFleetAPI > com.fs.starfarer.api.campaign.BattleAPI.getSideTwo ( )

◆ getSnapshotBothSides()

List< CampaignFleetAPI > com.fs.starfarer.api.campaign.BattleAPI.getSnapshotBothSides ( )

◆ getSnapshotFor()

List< CampaignFleetAPI > com.fs.starfarer.api.campaign.BattleAPI.getSnapshotFor ( List< CampaignFleetAPI > side )

◆ getSnapshotSideFor()

List< CampaignFleetAPI > com.fs.starfarer.api.campaign.BattleAPI.getSnapshotSideFor ( CampaignFleetAPI participantOrCombined )

◆ getSnapshotSideOne()

List< CampaignFleetAPI > com.fs.starfarer.api.campaign.BattleAPI.getSnapshotSideOne ( )

◆ getSnapshotSideTwo()

List< CampaignFleetAPI > com.fs.starfarer.api.campaign.BattleAPI.getSnapshotSideTwo ( )

◆ getSourceFleet()

CampaignFleetAPI com.fs.starfarer.api.campaign.BattleAPI.getSourceFleet ( FleetMemberAPI member )

◆ getStationSide()

List< CampaignFleetAPI > com.fs.starfarer.api.campaign.BattleAPI.getStationSide ( )

◆ hasSnapshots()

boolean com.fs.starfarer.api.campaign.BattleAPI.hasSnapshots ( )

◆ isDone()

boolean com.fs.starfarer.api.campaign.BattleAPI.isDone ( )

◆ isInvolved()

boolean com.fs.starfarer.api.campaign.BattleAPI.isInvolved ( CampaignFleetAPI test )

◆ isOnPlayerSide()

boolean com.fs.starfarer.api.campaign.BattleAPI.isOnPlayerSide ( CampaignFleetAPI participantOrCombined )

◆ isPlayerInvolved()

boolean com.fs.starfarer.api.campaign.BattleAPI.isPlayerInvolved ( )

◆ isPlayerInvolvedAtStart()

boolean com.fs.starfarer.api.campaign.BattleAPI.isPlayerInvolvedAtStart ( )

◆ isPlayerPrimary()

boolean com.fs.starfarer.api.campaign.BattleAPI.isPlayerPrimary ( )

◆ isPlayerSide() [1/2]

boolean com.fs.starfarer.api.campaign.BattleAPI.isPlayerSide ( EngagementResultForFleetAPI side )

◆ isPlayerSide() [2/2]

boolean com.fs.starfarer.api.campaign.BattleAPI.isPlayerSide ( List< CampaignFleetAPI > side )

◆ isStationInvolved() [1/2]

boolean com.fs.starfarer.api.campaign.BattleAPI.isStationInvolved ( )

◆ isStationInvolved() [2/2]

boolean com.fs.starfarer.api.campaign.BattleAPI.isStationInvolved ( List< CampaignFleetAPI > side )

◆ isStationInvolvedOnPlayerSide()

boolean com.fs.starfarer.api.campaign.BattleAPI.isStationInvolvedOnPlayerSide ( )

◆ join() [1/2]

boolean com.fs.starfarer.api.campaign.BattleAPI.join ( CampaignFleetAPI fleet )

◆ join() [2/2]

boolean com.fs.starfarer.api.campaign.BattleAPI.join	(	CampaignFleetAPI	fleet,
		BattleSide	side )

◆ knowsWhoPlayerIs()

boolean com.fs.starfarer.api.campaign.BattleAPI.knowsWhoPlayerIs ( List< CampaignFleetAPI > side )

◆ leave()

void com.fs.starfarer.api.campaign.BattleAPI.leave	(	CampaignFleetAPI	fleet,
		boolean	engagedInHostilities )

◆ onPlayerSide()

boolean com.fs.starfarer.api.campaign.BattleAPI.onPlayerSide ( CampaignFleetAPI fleet )

◆ onSameSide()

boolean com.fs.starfarer.api.campaign.BattleAPI.onSameSide	(	CampaignFleetAPI	one,
		CampaignFleetAPI	two )

◆ pickSide() [1/2]

BattleSide com.fs.starfarer.api.campaign.BattleAPI.pickSide ( CampaignFleetAPI fleet )

◆ pickSide() [2/2]

BattleSide com.fs.starfarer.api.campaign.BattleAPI.pickSide	(	CampaignFleetAPI	fleet,
		boolean	considerPlayerTransponderStatus )

◆ removeEmptyFleets()

void com.fs.starfarer.api.campaign.BattleAPI.removeEmptyFleets ( )

◆ setPlayerInvolvedAtStart()

void com.fs.starfarer.api.campaign.BattleAPI.setPlayerInvolvedAtStart ( boolean playerInvolvedAtStart )

◆ setPlayerInvolvementFraction()

void com.fs.starfarer.api.campaign.BattleAPI.setPlayerInvolvementFraction ( float playerInvolvementFraction )

◆ takeSnapshots()

void com.fs.starfarer.api.campaign.BattleAPI.takeSnapshots ( )

◆ uncombine()

void com.fs.starfarer.api.campaign.BattleAPI.uncombine ( )

◆ wasFleetDefeated()

boolean com.fs.starfarer.api.campaign.BattleAPI.wasFleetDefeated	(	CampaignFleetAPI	fleet,
		CampaignFleetAPI	primaryWinner )

◆ wasFleetVictorious()

boolean com.fs.starfarer.api.campaign.BattleAPI.wasFleetVictorious	(	CampaignFleetAPI	fleet,
		CampaignFleetAPI	primaryWinner )

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

src/com/fs/starfarer/api/campaign/BattleAPI.java

Classes

Public Member Functions