Package com.fs.starfarer.api.campaign

Interface FleetEncounterContextPlugin

All Known Implementing Classes:

FleetEncounterContext

public interface FleetEncounterContextPlugin

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	FleetEncounterContextPlugin.DataForEncounterSide
static enum	FleetEncounterContextPlugin.DisengageHarryAvailability
static enum	FleetEncounterContextPlugin.EngagementOutcome	This, and any FleetEncounterContext code that uses this, is only used for battles involving the player, and not AI vs AI autoresloved ones.
static class	FleetEncounterContextPlugin.FleetMemberData
static enum	FleetEncounterContextPlugin.PursueAvailability
static enum	FleetEncounterContextPlugin.Status

Method Summary

Modifier and Type	Method	Description
boolean	adjustPlayerReputation(InteractionDialogAPI dialog, String ffText)
float	computePlayerContribFraction()
BattleAPI	getBattle()
FleetEncounterContextPlugin.DataForEncounterSide	getDataFor(CampaignFleetAPI fleet)
FleetEncounterContextPlugin.DisengageHarryAvailability	getDisengageHarryAvailability(CampaignFleetAPI fleet, CampaignFleetAPI otherFleet)
FleetEncounterContextPlugin.EngagementOutcome	getLastEngagementOutcome()
CampaignFleetAPI	getLoser()
FleetEncounterContextPlugin.DataForEncounterSide	getLoserData()
FleetEncounterContextPlugin.PursueAvailability	getPursuitAvailability(CampaignFleetAPI fleet, CampaignFleetAPI otherFleet)
CampaignFleetAPI	getWinner()
FleetEncounterContextPlugin.DataForEncounterSide	getWinnerData()
boolean	isEngagedInHostilities()
boolean	isOtherFleetHarriedPlayer()
float	performPostVictoryRecovery(EngagementResultAPI result)	Returns average recovery per ship, in the range from 0 to 1.
void	setOtherFleetHarriedPlayer(boolean otherFleetHarriedPlayer)

Method Details

getDataFor

FleetEncounterContextPlugin.DataForEncounterSide getDataFor(CampaignFleetAPI fleet)

getWinnerData

FleetEncounterContextPlugin.DataForEncounterSide getWinnerData()

getLoserData

FleetEncounterContextPlugin.DataForEncounterSide getLoserData()

getWinner

CampaignFleetAPI getWinner()

getLoser

CampaignFleetAPI getLoser()

isEngagedInHostilities

boolean isEngagedInHostilities()

getLastEngagementOutcome

FleetEncounterContextPlugin.EngagementOutcome getLastEngagementOutcome()

getPursuitAvailability

FleetEncounterContextPlugin.PursueAvailability getPursuitAvailability(CampaignFleetAPI fleet,
 CampaignFleetAPI otherFleet)

getDisengageHarryAvailability

FleetEncounterContextPlugin.DisengageHarryAvailability getDisengageHarryAvailability(CampaignFleetAPI fleet,
 CampaignFleetAPI otherFleet)

performPostVictoryRecovery

float performPostVictoryRecovery(EngagementResultAPI result)

Returns average recovery per ship, in the range from 0 to 1.

Parameters:

result -

Returns:

getBattle

BattleAPI getBattle()

setOtherFleetHarriedPlayer

void setOtherFleetHarriedPlayer(boolean otherFleetHarriedPlayer)

isOtherFleetHarriedPlayer

boolean isOtherFleetHarriedPlayer()

adjustPlayerReputation

boolean adjustPlayerReputation(InteractionDialogAPI dialog,
 String ffText)

computePlayerContribFraction

float computePlayerContribFraction()