Uses of Interface
com.fs.starfarer.api.campaign.BattleAPI

Packages that use BattleAPI

Package	Description
com.fs.starfarer.api
com.fs.starfarer.api.campaign
com.fs.starfarer.api.campaign.ai
com.fs.starfarer.api.campaign.listeners
com.fs.starfarer.api.characters
com.fs.starfarer.api.combat
com.fs.starfarer.api.impl
com.fs.starfarer.api.impl.campaign
com.fs.starfarer.api.impl.campaign.abilities
com.fs.starfarer.api.impl.campaign.econ.impl
com.fs.starfarer.api.impl.campaign.events
com.fs.starfarer.api.impl.campaign.fleets
com.fs.starfarer.api.impl.campaign.fleets.misc
com.fs.starfarer.api.impl.campaign.intel
com.fs.starfarer.api.impl.campaign.intel.bar.events
com.fs.starfarer.api.impl.campaign.intel.bases
com.fs.starfarer.api.impl.campaign.intel.events
com.fs.starfarer.api.impl.campaign.intel.events.ht
com.fs.starfarer.api.impl.campaign.missions
com.fs.starfarer.api.impl.campaign.missions.cb
com.fs.starfarer.api.impl.campaign.rulecmd
com.fs.starfarer.api.impl.campaign.shared
com.fs.starfarer.api.impl.codex
com.fs.starfarer.api.plugins

Uses of BattleAPI in com.fs.starfarer.api

Methods in com.fs.starfarer.api that return BattleAPI

Modifier and Type	Method	Description
BattleAPI	FactoryAPI.createBattle(CampaignFleetAPI one, CampaignFleetAPI two)

Uses of BattleAPI in com.fs.starfarer.api.campaign

Methods in com.fs.starfarer.api.campaign that return BattleAPI

Modifier and Type	Method	Description
BattleAPI	CampaignFleetAPI.getBattle()
BattleAPI	FleetEncounterContextPlugin.getBattle()

Methods in com.fs.starfarer.api.campaign with parameters of type BattleAPI

Modifier and Type	Method	Description
PluginPick<BattleAutoresolverPlugin>	BaseCampaignPlugin.pickBattleAutoresolverPlugin(BattleAPI battle)
PluginPick<BattleAutoresolverPlugin>	CampaignPlugin.pickBattleAutoresolverPlugin(BattleAPI battle)	Returns a plugin used to quickly resolve a battle outcome.
void	BaseCampaignEventListener.reportBattleFinished(CampaignFleetAPI primaryWinner, BattleAPI battle)
void	CampaignEventListener.reportBattleFinished(CampaignFleetAPI primaryWinner, BattleAPI battle)
void	SectorAPI.reportBattleFinished(CampaignFleetAPI primaryWinner, BattleAPI battle)	Called after an autoresolve round that finishes a battle, after reportBattleOccurred.
void	BaseCampaignEventListener.reportBattleOccurred(CampaignFleetAPI primaryWinner, BattleAPI battle)
void	CampaignEventListener.reportBattleOccurred(CampaignFleetAPI primaryWinner, BattleAPI battle)	Once for each autoresolve round for AI vs AI.
void	SectorAPI.reportBattleOccurred(CampaignFleetAPI primaryWinner, BattleAPI battle)	Called once per each autoresolve round of the battle.
void	CampaignFleetAPI.setBattle(BattleAPI battle)

Uses of BattleAPI in com.fs.starfarer.api.campaign.ai

Methods in com.fs.starfarer.api.campaign.ai with parameters of type BattleAPI

Modifier and Type	Method	Description
boolean	CampaignFleetAIAPI.wantsToJoin(BattleAPI battle, boolean playerInvolved)
boolean	TacticalModulePlugin.wantsToJoin(BattleAPI battle, boolean playerInvolved)

Uses of BattleAPI in com.fs.starfarer.api.campaign.listeners

Methods in com.fs.starfarer.api.campaign.listeners with parameters of type BattleAPI

Modifier and Type	Method	Description
void	BaseFleetEventListener.reportBattleOccurred(CampaignFleetAPI fleet, CampaignFleetAPI primaryWinner, BattleAPI battle)
void	FleetEventListener.reportBattleOccurred(CampaignFleetAPI fleet, CampaignFleetAPI primaryWinner, BattleAPI battle)	"fleet" will be null if the listener is registered with the ListenerManager, and non-null if the listener is added directly to a fleet.
static void	ListenerUtil.reportBattleOccurred(CampaignFleetAPI fleet, CampaignFleetAPI primaryWinner, BattleAPI battle)

Uses of BattleAPI in com.fs.starfarer.api.characters

Methods in com.fs.starfarer.api.characters with parameters of type BattleAPI

Modifier and Type	Method	Description
void	AbilityPlugin.fleetJoinedBattle(BattleAPI battle)
void	AbilityPlugin.fleetLeftBattle(BattleAPI battle, boolean engagedInHostilities)

Uses of BattleAPI in com.fs.starfarer.api.combat

Methods in com.fs.starfarer.api.combat that return BattleAPI

Modifier and Type	Method	Description
BattleAPI	EngagementResultAPI.getBattle()

Methods in com.fs.starfarer.api.combat with parameters of type BattleAPI

Modifier and Type	Method	Description
void	EngagementResultAPI.setBattle(BattleAPI battle)

Uses of BattleAPI in com.fs.starfarer.api.impl

Methods in com.fs.starfarer.api.impl with parameters of type BattleAPI

Modifier and Type	Method	Description
void	SimulatorPluginImpl.reportPlayerBattleOccurred(CampaignFleetAPI primaryWinner, BattleAPI battle)

Uses of BattleAPI in com.fs.starfarer.api.impl.campaign

Fields in com.fs.starfarer.api.impl.campaign declared as BattleAPI

Modifier and Type	Field	Description
protected final BattleAPI	BattleAutoresolverPluginImpl.battle
BattleAPI	BattleAutoresolverPluginImpl.EngagementResultImpl.battle
protected BattleAPI	FleetEncounterContext.battle

Methods in com.fs.starfarer.api.impl.campaign that return BattleAPI

Modifier and Type	Method	Description
BattleAPI	BattleAutoresolverPluginImpl.EngagementResultImpl.getBattle()
BattleAPI	FleetEncounterContext.getBattle()

Methods in com.fs.starfarer.api.impl.campaign with parameters of type BattleAPI

Modifier and Type	Method	Description
static void	CoreScript.generateOrAddToDebrisFieldFromBattle(CampaignFleetAPI primaryWinner, BattleAPI battle)
List<FleetMemberAPI>	FleetEncounterContext.getRecoverableShips(BattleAPI battle, CampaignFleetAPI winningFleet, CampaignFleetAPI otherFleet)
PluginPick<BattleAutoresolverPlugin>	CoreCampaignPluginImpl.pickBattleAutoresolverPlugin(BattleAPI battle)
void	CoreScript.reportBattleOccurred(CampaignFleetAPI primaryWinner, BattleAPI battle)
void	BattleAutoresolverPluginImpl.EngagementResultImpl.setBattle(BattleAPI battle)
void	FleetEncounterContext.setBattle(BattleAPI battle)

Constructors in com.fs.starfarer.api.impl.campaign with parameters of type BattleAPI

Modifier	Constructor	Description
	BattleAutoresolverPluginImpl(BattleAPI battle)
	EngagementResultImpl(BattleAPI battle, CampaignFleetAPI winner, CampaignFleetAPI loser)

Uses of BattleAPI in com.fs.starfarer.api.impl.campaign.abilities

Methods in com.fs.starfarer.api.impl.campaign.abilities with parameters of type BattleAPI

Modifier and Type	Method	Description
void	BaseAbilityPlugin.fleetJoinedBattle(BattleAPI battle)
void	SustainedBurnAbility.fleetJoinedBattle(BattleAPI battle)
void	BaseAbilityPlugin.fleetLeftBattle(BattleAPI battle, boolean engagedInHostilities)
void	DurationAbilityWithCost2.fleetLeftBattle(BattleAPI battle, boolean engagedInHostilities)
void	EmergencyBurnAbility.fleetLeftBattle(BattleAPI battle, boolean engagedInHostilities)
void	FractureJumpAbility.fleetLeftBattle(BattleAPI battle, boolean engagedInHostilities)
void	InterdictionPulseAbility.fleetLeftBattle(BattleAPI battle, boolean engagedInHostilities)
void	SustainedBurnAbility.fleetLeftBattle(BattleAPI battle, boolean engagedInHostilities)

Uses of BattleAPI in com.fs.starfarer.api.impl.campaign.econ.impl

Methods in com.fs.starfarer.api.impl.campaign.econ.impl with parameters of type BattleAPI

Modifier and Type	Method	Description
void	LionsGuardHQ.reportBattleOccurred(CampaignFleetAPI fleet, CampaignFleetAPI primaryWinner, BattleAPI battle)
void	MilitaryBase.reportBattleOccurred(CampaignFleetAPI fleet, CampaignFleetAPI primaryWinner, BattleAPI battle)
void	OrbitalStation.reportBattleOccurred(CampaignFleetAPI fleet, CampaignFleetAPI primaryWinner, BattleAPI battle)

Uses of BattleAPI in com.fs.starfarer.api.impl.campaign.events

Methods in com.fs.starfarer.api.impl.campaign.events with parameters of type BattleAPI

Modifier and Type	Method	Description
void	BaseEventPlugin.reportBattleFinished(CampaignFleetAPI primaryWinner, BattleAPI battle)
void	BaseEventPlugin.reportBattleOccurred(CampaignFleetAPI primaryWinner, BattleAPI battle)

Uses of BattleAPI in com.fs.starfarer.api.impl.campaign.fleets

Methods in com.fs.starfarer.api.impl.campaign.fleets with parameters of type BattleAPI

Modifier and Type	Method	Description
void	BaseLimitedFleetManager.reportBattleOccurred(CampaignFleetAPI fleet, CampaignFleetAPI primaryWinner, BattleAPI battle)
void	EconomyFleetRouteManager.reportBattleOccurred(CampaignFleetAPI fleet, CampaignFleetAPI primaryWinner, BattleAPI battle)
void	PatrolFleetManager.reportBattleOccurred(CampaignFleetAPI primaryWinner, BattleAPI battle)
void	PatrolFleetManagerV2.reportBattleOccurred(CampaignFleetAPI fleet, CampaignFleetAPI primaryWinner, BattleAPI battle)
void	PersonalFleetScript.reportBattleOccurred(CampaignFleetAPI fleet, CampaignFleetAPI primaryWinner, BattleAPI battle)
void	PilgrimageFleetRouteManager.reportBattleOccurred(CampaignFleetAPI fleet, CampaignFleetAPI primaryWinner, BattleAPI battle)	Deprecated.
void	RouteManager.reportBattleOccurred(CampaignFleetAPI fleet, CampaignFleetAPI primaryWinner, BattleAPI battle)
void	SeededFleetManager.reportBattleOccurred(CampaignFleetAPI fleet, CampaignFleetAPI primaryWinner, BattleAPI battle)
void	SourceBasedFleetManager.reportBattleOccurred(CampaignFleetAPI fleet, CampaignFleetAPI primaryWinner, BattleAPI battle)

Uses of BattleAPI in com.fs.starfarer.api.impl.campaign.fleets.misc

Methods in com.fs.starfarer.api.impl.campaign.fleets.misc with parameters of type BattleAPI

Modifier and Type	Method	Description
void	BaseMiscFleetCreatorPlugin.reportBattleOccurred(MiscFleetRouteManager manager, CampaignFleetAPI fleet, CampaignFleetAPI primaryWinner, BattleAPI battle)
void	MiscAcademyFleetCreator.reportBattleOccurred(MiscFleetRouteManager manager, CampaignFleetAPI fleet, CampaignFleetAPI primaryWinner, BattleAPI battle)
void	MiscFleetCreatorPlugin.reportBattleOccurred(MiscFleetRouteManager manager, CampaignFleetAPI fleet, CampaignFleetAPI primaryWinner, BattleAPI battle)
void	MiscFleetRouteManager.reportBattleOccurred(CampaignFleetAPI fleet, CampaignFleetAPI primaryWinner, BattleAPI battle)
void	MiscPilgrimFleetCreator.reportBattleOccurred(MiscFleetRouteManager manager, CampaignFleetAPI fleet, CampaignFleetAPI primaryWinner, BattleAPI battle)

Uses of BattleAPI in com.fs.starfarer.api.impl.campaign.intel

Methods in com.fs.starfarer.api.impl.campaign.intel with parameters of type BattleAPI

Modifier and Type	Method	Description
void	FactionCommissionIntel.reportBattleOccurred(CampaignFleetAPI fleet, CampaignFleetAPI primaryWinner, BattleAPI battle)
void	PersonBountyIntel.reportBattleOccurred(CampaignFleetAPI fleet, CampaignFleetAPI primaryWinner, BattleAPI battle)
void	SystemBountyIntel.reportBattleOccurred(CampaignFleetAPI fleet, CampaignFleetAPI primaryWinner, BattleAPI battle)

Uses of BattleAPI in com.fs.starfarer.api.impl.campaign.intel.bar.events

Methods in com.fs.starfarer.api.impl.campaign.intel.bar.events with parameters of type BattleAPI

Modifier and Type	Method	Description
void	DeliveryFailureConsequences.reportBattleOccurred(CampaignFleetAPI fleet, CampaignFleetAPI primaryWinner, BattleAPI battle)

Uses of BattleAPI in com.fs.starfarer.api.impl.campaign.intel.bases

Methods in com.fs.starfarer.api.impl.campaign.intel.bases with parameters of type BattleAPI

Modifier and Type	Method	Description
void	LuddicPathBaseIntel.reportBattleOccurred(CampaignFleetAPI fleet, CampaignFleetAPI primaryWinner, BattleAPI battle)
void	LuddicPathCellsIntel.reportBattleOccurred(CampaignFleetAPI fleet, CampaignFleetAPI primaryWinner, BattleAPI battle)
void	PirateBaseIntel.reportBattleOccurred(CampaignFleetAPI fleet, CampaignFleetAPI primaryWinner, BattleAPI battle)

Uses of BattleAPI in com.fs.starfarer.api.impl.campaign.intel.events

Methods in com.fs.starfarer.api.impl.campaign.intel.events with parameters of type BattleAPI

Modifier and Type	Method	Description
void	HostileActivityEventIntel.reportBattleOccurred(CampaignFleetAPI fleet, CampaignFleetAPI primaryWinner, BattleAPI battle)
void	TriTachyonHostileActivityFactor.reportBattleOccurred(CampaignFleetAPI fleet, CampaignFleetAPI primaryWinner, BattleAPI battle)

Uses of BattleAPI in com.fs.starfarer.api.impl.campaign.intel.events.ht

Methods in com.fs.starfarer.api.impl.campaign.intel.events.ht with parameters of type BattleAPI

Modifier and Type	Method	Description
void	HyperspaceTopographyEventIntel.reportBattleOccurred(CampaignFleetAPI fleet, CampaignFleetAPI primaryWinner, BattleAPI battle)

Uses of BattleAPI in com.fs.starfarer.api.impl.campaign.missions

Methods in com.fs.starfarer.api.impl.campaign.missions with parameters of type BattleAPI

Modifier and Type	Method	Description
void	PirateSystemBounty.reportBattleOccurred(CampaignFleetAPI fleet, CampaignFleetAPI primaryWinner, BattleAPI battle)

Uses of BattleAPI in com.fs.starfarer.api.impl.campaign.missions.cb

Methods in com.fs.starfarer.api.impl.campaign.missions.cb with parameters of type BattleAPI

Modifier and Type	Method	Description
void	BaseCustomBounty.reportBattleOccurred(CampaignFleetAPI fleet, CampaignFleetAPI primaryWinner, BattleAPI battle)

Uses of BattleAPI in com.fs.starfarer.api.impl.campaign.rulecmd

Methods in com.fs.starfarer.api.impl.campaign.rulecmd with parameters of type BattleAPI

Modifier and Type	Method	Description
void	HA_CMD.StationKingScript.reportBattleOccurred(CampaignFleetAPI fleet, CampaignFleetAPI primaryWinner, BattleAPI battle)

Uses of BattleAPI in com.fs.starfarer.api.impl.campaign.shared

Methods in com.fs.starfarer.api.impl.campaign.shared with parameters of type BattleAPI

Modifier and Type	Method	Description
void	StarSystemActivityTracker.reportBattleOccurred(CampaignFleetAPI primaryWinner, BattleAPI battle)

Uses of BattleAPI in com.fs.starfarer.api.impl.codex

Methods in com.fs.starfarer.api.impl.codex with parameters of type BattleAPI

Modifier and Type	Method	Description
void	CodexUnlocker.reportBattleOccurred(CampaignFleetAPI nullHere, CampaignFleetAPI primaryWinner, BattleAPI battle)

Uses of BattleAPI in com.fs.starfarer.api.plugins

Methods in com.fs.starfarer.api.plugins with parameters of type BattleAPI

Modifier and Type	Method	Description
void	SimulatorPlugin.reportPlayerBattleOccurred(CampaignFleetAPI primaryWinner, BattleAPI battle)