Package com.fs.starfarer.api.campaign.ai

Interface CampaignFleetAIAPI

All Known Subinterfaces:

ModularFleetAIAPI

public interface CampaignFleetAIAPI

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	CampaignFleetAIAPI.ActionType
static class	CampaignFleetAIAPI.BoardingActionDecision
static enum	CampaignFleetAIAPI.BoardingActionType
static enum	CampaignFleetAIAPI.EncounterOption
static enum	CampaignFleetAIAPI.InitialBoardingResponse
static enum	CampaignFleetAIAPI.PursuitOption

Method Summary

Modifier and Type	Method	Description
void	addAssignment(FleetAssignment assignment, SectorEntityToken target, float maxDurationInDays, Script onCompletion)
void	addAssignment(FleetAssignment assignment, SectorEntityToken target, float maxDurationInDays, String actionText, boolean addTimeToNext, Script onStart, Script onCompletion)
void	addAssignment(FleetAssignment assignment, SectorEntityToken target, float maxDurationInDays, String actionText, Script onCompletion)
void	addAssignmentAtStart(FleetAssignment assignment, SectorEntityToken target, float maxDurationInDays, Script onCompletion)
void	addAssignmentAtStart(FleetAssignment assignment, SectorEntityToken target, float maxDurationInDays, String actionText, Script onCompletion)
void	advance(float amount)
void	clearAssignments()
void	doNotAttack(SectorEntityToken other, float durDays)
void	dumpResourcesIfNeeded()
String	getActionTextOverride()
FleetActionTextProvider	getActionTextProvider()
List<FleetAssignmentDataAPI>	getAssignmentsCopy()
FleetAssignmentDataAPI	getCurrentAssignment()
FleetAssignment	getCurrentAssignmentType()
boolean	isCurrentAssignment(FleetAssignment assignment)
boolean	isFleeing()
boolean	isHostileTo(CampaignFleetAPI other)
boolean	isMaintainingContact()
CampaignFleetAIAPI.BoardingActionDecision	makeBoardingDecision(FleetEncounterContextPlugin context, FleetMemberAPI toBoard, CrewCompositionAPI maxAvailable)
void	notifyInteractedWith(CampaignFleetAPI otherFleet)
void	performCrashMothballingPriorToEscape(FleetEncounterContextPlugin context, CampaignFleetAPI playerFleet)
CampaignFleetAIAPI.InitialBoardingResponse	pickBoardingResponse(FleetEncounterContextPlugin context, FleetMemberAPI toBoard, CampaignFleetAPI otherFleet)
List<FleetMemberAPI>	pickBoardingTaskForce(FleetEncounterContextPlugin context, FleetMemberAPI toBoard, CampaignFleetAPI otherFleet)
CampaignFleetAIAPI.EncounterOption	pickEncounterOption(FleetEncounterContextPlugin context, CampaignFleetAPI otherFleet)
CampaignFleetAIAPI.EncounterOption	pickEncounterOption(FleetEncounterContextPlugin context, CampaignFleetAPI otherFleet, boolean pureCheck)
CampaignFleetAIAPI.PursuitOption	pickPursuitOption(FleetEncounterContextPlugin context, CampaignFleetAPI otherFleet)
void	removeAssignment(FleetAssignmentDataAPI assignment)
void	removeFirstAssignment()
void	removeFirstAssignmentIfItIs(FleetAssignment assignment)
void	reportNearbyAction(CampaignFleetAIAPI.ActionType type, SectorEntityToken actor, SectorEntityToken target, String responseVariable)
void	setActionTextOverride(String actionTextOverride)
void	setActionTextProvider(FleetActionTextProvider actionTextProvider)
boolean	wantsToJoin(BattleAPI battle, boolean playerInvolved)

Method Details

advance

void advance(float amount)

isHostileTo

boolean isHostileTo(CampaignFleetAPI other)

pickEncounterOption

CampaignFleetAIAPI.EncounterOption pickEncounterOption(FleetEncounterContextPlugin context,
 CampaignFleetAPI otherFleet)

wantsToJoin

boolean wantsToJoin(BattleAPI battle,
 boolean playerInvolved)

pickPursuitOption

CampaignFleetAIAPI.PursuitOption pickPursuitOption(FleetEncounterContextPlugin context,
 CampaignFleetAPI otherFleet)

pickBoardingResponse

CampaignFleetAIAPI.InitialBoardingResponse pickBoardingResponse(FleetEncounterContextPlugin context,
 FleetMemberAPI toBoard,
 CampaignFleetAPI otherFleet)

pickBoardingTaskForce

List<FleetMemberAPI> pickBoardingTaskForce(FleetEncounterContextPlugin context,
 FleetMemberAPI toBoard,
 CampaignFleetAPI otherFleet)

makeBoardingDecision

CampaignFleetAIAPI.BoardingActionDecision makeBoardingDecision(FleetEncounterContextPlugin context,
 FleetMemberAPI toBoard,
 CrewCompositionAPI maxAvailable)

performCrashMothballingPriorToEscape

void performCrashMothballingPriorToEscape(FleetEncounterContextPlugin context,
 CampaignFleetAPI playerFleet)

reportNearbyAction

void reportNearbyAction(CampaignFleetAIAPI.ActionType type,
 SectorEntityToken actor,
 SectorEntityToken target,
 String responseVariable)

getActionTextOverride

String getActionTextOverride()

setActionTextOverride

void setActionTextOverride(String actionTextOverride)

getCurrentAssignment

FleetAssignmentDataAPI getCurrentAssignment()

getAssignmentsCopy

List<FleetAssignmentDataAPI> getAssignmentsCopy()

addAssignmentAtStart

void addAssignmentAtStart(FleetAssignment assignment,
 SectorEntityToken target,
 float maxDurationInDays,
 Script onCompletion)

removeFirstAssignment

void removeFirstAssignment()

addAssignmentAtStart

void addAssignmentAtStart(FleetAssignment assignment,
 SectorEntityToken target,
 float maxDurationInDays,
 String actionText,
 Script onCompletion)

removeFirstAssignmentIfItIs

void removeFirstAssignmentIfItIs(FleetAssignment assignment)

isCurrentAssignment

boolean isCurrentAssignment(FleetAssignment assignment)

addAssignment

void addAssignment(FleetAssignment assignment,
 SectorEntityToken target,
 float maxDurationInDays,
 Script onCompletion)

addAssignment

void addAssignment(FleetAssignment assignment,
 SectorEntityToken target,
 float maxDurationInDays,
 String actionText,
 Script onCompletion)

isFleeing

boolean isFleeing()

removeAssignment

void removeAssignment(FleetAssignmentDataAPI assignment)

clearAssignments

void clearAssignments()

dumpResourcesIfNeeded

void dumpResourcesIfNeeded()

notifyInteractedWith

void notifyInteractedWith(CampaignFleetAPI otherFleet)

getCurrentAssignmentType

FleetAssignment getCurrentAssignmentType()

doNotAttack

void doNotAttack(SectorEntityToken other,
 float durDays)

pickEncounterOption

CampaignFleetAIAPI.EncounterOption pickEncounterOption(FleetEncounterContextPlugin context,
 CampaignFleetAPI otherFleet,
 boolean pureCheck)

getActionTextProvider

FleetActionTextProvider getActionTextProvider()

setActionTextProvider

void setActionTextProvider(FleetActionTextProvider actionTextProvider)

addAssignment

void addAssignment(FleetAssignment assignment,
 SectorEntityToken target,
 float maxDurationInDays,
 String actionText,
 boolean addTimeToNext,
 Script onStart,
 Script onCompletion)

isMaintainingContact

boolean isMaintainingContact()