Package com.fs.starfarer.api.campaign

Interface BattleAPI

public interface BattleAPI

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	BattleAPI.BattleSide

Method Summary

Modifier and Type	Method	Description
void	applyVisibilityMod(CampaignFleetAPI fleet)
boolean	canJoin(CampaignFleetAPI fleet)
org.lwjgl.util.vector.Vector2f	computeCenterOfMass()
void	finish(BattleAPI.BattleSide winner)
void	finish(BattleAPI.BattleSide winner, boolean engagedInHostilities)
void	genCombined()
void	genCombined(boolean withStation)
void	genCombinedDoNotRemoveEmpty()
List<CampaignFleetAPI>	getBothSides()
CampaignFleetAPI	getClosestInvolvedFleetTo(CampaignFleetAPI fleet)
CampaignFleetAPI	getCombined(BattleAPI.BattleSide side)
CampaignFleetAPI	getCombinedFor(CampaignFleetAPI participantOrCombined)
CampaignFleetAPI	getCombinedOne()
CampaignFleetAPI	getCombinedTwo()
List<CampaignFleetAPI>	getFleetsFor(EngagementResultForFleetAPI side)
Map<FleetMemberAPI,CampaignFleetAPI>	getMemberSourceMap()
CampaignFleetAPI	getNonPlayerCombined()
List<CampaignFleetAPI>	getNonPlayerSide()
List<CampaignFleetAPI>	getNonPlayerSideSnapshot()	Snapshot before the battle, containing any fleets that may have been eliminated during.
List<CampaignFleetAPI>	getOtherSide(BattleAPI.BattleSide side)
CampaignFleetAPI	getOtherSideCombined(BattleAPI.BattleSide side)
List<CampaignFleetAPI>	getOtherSideFor(CampaignFleetAPI participantOrCombined)
List<CampaignFleetAPI>	getOtherSideSnapshotFor(CampaignFleetAPI participantOrCombined)
CampaignFleetAPI	getPlayerCombined()
float	getPlayerInvolvementFraction()
List<CampaignFleetAPI>	getPlayerSide()
List<CampaignFleetAPI>	getPlayerSideSnapshot()	Snapshot before the battle, containing any fleets that may have been eliminated during.
CampaignFleetAPI	getPrimary(List<CampaignFleetAPI> side)
CampaignFleetAPI	getPrimary(List<CampaignFleetAPI> side, boolean nonPlayer)
long	getSeed()
List<CampaignFleetAPI>	getSide(BattleAPI.BattleSide side)
List<CampaignFleetAPI>	getSideFor(CampaignFleetAPI participantOrCombined)
List<CampaignFleetAPI>	getSideOne()
List<CampaignFleetAPI>	getSideTwo()
List<CampaignFleetAPI>	getSnapshotBothSides()
List<CampaignFleetAPI>	getSnapshotFor(List<CampaignFleetAPI> side)
List<CampaignFleetAPI>	getSnapshotSideFor(CampaignFleetAPI participantOrCombined)
List<CampaignFleetAPI>	getSnapshotSideOne()
List<CampaignFleetAPI>	getSnapshotSideTwo()
CampaignFleetAPI	getSourceFleet(FleetMemberAPI member)
List<CampaignFleetAPI>	getStationSide()
boolean	hasSnapshots()
boolean	isDone()
boolean	isInvolved(CampaignFleetAPI test)
boolean	isOnPlayerSide(CampaignFleetAPI participantOrCombined)
boolean	isPlayerInvolved()
boolean	isPlayerInvolvedAtStart()
boolean	isPlayerPrimary()
boolean	isPlayerSide(EngagementResultForFleetAPI side)
boolean	isPlayerSide(List<CampaignFleetAPI> side)
boolean	isStationInvolved()
boolean	isStationInvolved(List<CampaignFleetAPI> side)
boolean	isStationInvolvedOnPlayerSide()
boolean	join(CampaignFleetAPI fleet)
boolean	join(CampaignFleetAPI fleet, BattleAPI.BattleSide side)
boolean	knowsWhoPlayerIs(List<CampaignFleetAPI> side)
void	leave(CampaignFleetAPI fleet, boolean engagedInHostilities)
boolean	onPlayerSide(CampaignFleetAPI fleet)
boolean	onSameSide(CampaignFleetAPI one, CampaignFleetAPI two)
BattleAPI.BattleSide	pickSide(CampaignFleetAPI fleet)
BattleAPI.BattleSide	pickSide(CampaignFleetAPI fleet, boolean considerPlayerTransponderStatus)
void	removeEmptyFleets()
void	setPlayerInvolvedAtStart(boolean playerInvolvedAtStart)
void	setPlayerInvolvementFraction(float playerInvolvementFraction)
void	takeSnapshots()
void	uncombine()
boolean	wasFleetDefeated(CampaignFleetAPI fleet, CampaignFleetAPI primaryWinner)
boolean	wasFleetVictorious(CampaignFleetAPI fleet, CampaignFleetAPI primaryWinner)

Method Details

genCombined

void genCombined()

genCombinedDoNotRemoveEmpty

void genCombinedDoNotRemoveEmpty()

uncombine

void uncombine()

getCombinedOne

CampaignFleetAPI getCombinedOne()

getCombinedTwo

CampaignFleetAPI getCombinedTwo()

canJoin

boolean canJoin(CampaignFleetAPI fleet)

pickSide

BattleAPI.BattleSide pickSide(CampaignFleetAPI fleet)

join

boolean join(CampaignFleetAPI fleet)

isPlayerInvolved

boolean isPlayerInvolved()

getFleetsFor

List<CampaignFleetAPI> getFleetsFor(EngagementResultForFleetAPI side)

isPlayerSide

boolean isPlayerSide(EngagementResultForFleetAPI side)

getCombinedFor

CampaignFleetAPI getCombinedFor(CampaignFleetAPI participantOrCombined)

getSourceFleet

CampaignFleetAPI getSourceFleet(FleetMemberAPI member)

getSideFor

List<CampaignFleetAPI> getSideFor(CampaignFleetAPI participantOrCombined)

getPrimary

CampaignFleetAPI getPrimary(List<CampaignFleetAPI> side)

isPlayerSide

boolean isPlayerSide(List<CampaignFleetAPI> side)

getPlayerSide

List<CampaignFleetAPI> getPlayerSide()

removeEmptyFleets

void removeEmptyFleets()

isPlayerPrimary

boolean isPlayerPrimary()

isDone

boolean isDone()

getSideOne

List<CampaignFleetAPI> getSideOne()

getSideTwo

List<CampaignFleetAPI> getSideTwo()

getNonPlayerSide

List<CampaignFleetAPI> getNonPlayerSide()

getPlayerCombined

CampaignFleetAPI getPlayerCombined()

getNonPlayerCombined

CampaignFleetAPI getNonPlayerCombined()

getCombined

CampaignFleetAPI getCombined(BattleAPI.BattleSide side)

getOtherSideCombined

CampaignFleetAPI getOtherSideCombined(BattleAPI.BattleSide side)

leave

void leave(CampaignFleetAPI fleet,
 boolean engagedInHostilities)

getSide

List<CampaignFleetAPI> getSide(BattleAPI.BattleSide side)

getOtherSide

List<CampaignFleetAPI> getOtherSide(BattleAPI.BattleSide side)

knowsWhoPlayerIs

boolean knowsWhoPlayerIs(List<CampaignFleetAPI> side)

pickSide

BattleAPI.BattleSide pickSide(CampaignFleetAPI fleet,
 boolean considerPlayerTransponderStatus)

takeSnapshots

void takeSnapshots()

getSnapshotSideOne

List<CampaignFleetAPI> getSnapshotSideOne()

getSnapshotSideTwo

List<CampaignFleetAPI> getSnapshotSideTwo()

getSnapshotSideFor

List<CampaignFleetAPI> getSnapshotSideFor(CampaignFleetAPI participantOrCombined)

getSnapshotFor

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

getBothSides

List<CampaignFleetAPI> getBothSides()

getSnapshotBothSides

List<CampaignFleetAPI> getSnapshotBothSides()

getOtherSideFor

List<CampaignFleetAPI> getOtherSideFor(CampaignFleetAPI participantOrCombined)

isOnPlayerSide

boolean isOnPlayerSide(CampaignFleetAPI participantOrCombined)

getOtherSideSnapshotFor

List<CampaignFleetAPI> getOtherSideSnapshotFor(CampaignFleetAPI participantOrCombined)

getPlayerSideSnapshot

List<CampaignFleetAPI> getPlayerSideSnapshot()

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

Returns:

getNonPlayerSideSnapshot

List<CampaignFleetAPI> getNonPlayerSideSnapshot()

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

Returns:

isInvolved

boolean isInvolved(CampaignFleetAPI test)

getPlayerInvolvementFraction

float getPlayerInvolvementFraction()

hasSnapshots

boolean hasSnapshots()

applyVisibilityMod

void applyVisibilityMod(CampaignFleetAPI fleet)

onSameSide

boolean onSameSide(CampaignFleetAPI one,
 CampaignFleetAPI two)

onPlayerSide

boolean onPlayerSide(CampaignFleetAPI fleet)

getClosestInvolvedFleetTo

CampaignFleetAPI getClosestInvolvedFleetTo(CampaignFleetAPI fleet)

finish

void finish(BattleAPI.BattleSide winner)

finish

void finish(BattleAPI.BattleSide winner,
 boolean engagedInHostilities)

isPlayerInvolvedAtStart

boolean isPlayerInvolvedAtStart()

setPlayerInvolvedAtStart

void setPlayerInvolvedAtStart(boolean playerInvolvedAtStart)

setPlayerInvolvementFraction

void setPlayerInvolvementFraction(float playerInvolvementFraction)

getPrimary

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

getMemberSourceMap

Map<FleetMemberAPI,CampaignFleetAPI> getMemberSourceMap()

getSeed

long getSeed()

computeCenterOfMass

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

isStationInvolved

boolean isStationInvolved()

isStationInvolvedOnPlayerSide

boolean isStationInvolvedOnPlayerSide()

isStationInvolved

boolean isStationInvolved(List<CampaignFleetAPI> side)

getStationSide

List<CampaignFleetAPI> getStationSide()

genCombined

void genCombined(boolean withStation)

join

boolean join(CampaignFleetAPI fleet,
 BattleAPI.BattleSide side)

wasFleetDefeated

boolean wasFleetDefeated(CampaignFleetAPI fleet,
 CampaignFleetAPI primaryWinner)

wasFleetVictorious

boolean wasFleetVictorious(CampaignFleetAPI fleet,
 CampaignFleetAPI primaryWinner)