com.fs.starfarer.api.combat

Interface CombatTaskManagerAPI

public interface CombatTaskManagerAPI

Method Summary

Modifier and Type	Method and Description
void	clearEmptyWaypoints()
void	clearTasks()
CombatFleetManagerAPI.AssignmentInfo	createAssignment(CombatAssignmentType type, AssignmentTargetAPI target, boolean useCommandPoint) target should be one of: BattleObjectiveAPI DeployedFleetMemberAPI the result of createWaypoint()
AssignmentTargetAPI	createWaypoint2(org.lwjgl.util.vector.Vector2f loc, boolean ally)
java.util.List<CombatFleetManagerAPI.AssignmentInfo>	getAllAssignments()
CombatFleetManagerAPI.AssignmentInfo	getAssignmentFor(ShipAPI ship) Returns the current assignment for a ship (the assignment type, and the target, if any).
CombatFleetManagerAPI.AssignmentInfo	getAssignmentInfoForTarget(AssignmentTargetAPI target)
AssignmentTargetAPI	getAssignmentTargetFor(ShipAPI ship)
int	getCommandPointsLeft()
MutableStat	getCommandPointsStat()
float	getCPInterval()
MutableStat	getCPRateModifier()
float	getCPRateMult()
float	getSecondsUntilNextPoint()
void	giveAssignment(DeployedFleetMemberAPI member, CombatFleetManagerAPI.AssignmentInfo assignment, boolean useCommandPointIfNeeded)
boolean	isFullAssault()
boolean	isInFullRetreat()
boolean	isPreventFullRetreat()
void	orderFullRetreat() Cancels all assignment and orders all ships to retreat.
void	orderRetreat(DeployedFleetMemberAPI member, boolean useCommandPointIfNeeded, boolean direct)
void	orderSearchAndDestroy() Cancels all assignments.
void	orderSearchAndDestroy(DeployedFleetMemberAPI member, boolean useCommandPointIfNeeded)
void	reassign()
void	removeAssignment(CombatFleetManagerAPI.AssignmentInfo info)
void	setAssignmentWeight(CombatFleetManagerAPI.AssignmentInfo info, float weight)
void	setFullAssault(boolean explicitSearchAndDestroy)
void	setPreventFullRetreat(boolean preventFullRetreat)

Method Detail

getAssignmentFor

CombatFleetManagerAPI.AssignmentInfo getAssignmentFor(ShipAPI ship)

Returns the current assignment for a ship (the assignment type, and the target, if any). Returns null if there isn't one (i.e. the ship is on a default search-and-destroy). For fighter wings, can pass in any fighter from the wing to get the assignment.

Parameters:

ship -

Returns:

getAllAssignments

java.util.List<CombatFleetManagerAPI.AssignmentInfo> getAllAssignments()

createAssignment

CombatFleetManagerAPI.AssignmentInfo createAssignment(CombatAssignmentType type,
                                                      AssignmentTargetAPI target,
                                                      boolean useCommandPoint)

target should be one of: BattleObjectiveAPI DeployedFleetMemberAPI the result of createWaypoint()

Parameters:

type -

target -

useCommandPointIfNeeded -

Returns:

giveAssignment

void giveAssignment(DeployedFleetMemberAPI member,
                    CombatFleetManagerAPI.AssignmentInfo assignment,
                    boolean useCommandPointIfNeeded)

orderRetreat

void orderRetreat(DeployedFleetMemberAPI member,
                  boolean useCommandPointIfNeeded,
                  boolean direct)

orderSearchAndDestroy

void orderSearchAndDestroy(DeployedFleetMemberAPI member,
                           boolean useCommandPointIfNeeded)

orderSearchAndDestroy

void orderSearchAndDestroy()

Cancels all assignments. New assignments can still be created.

orderFullRetreat

void orderFullRetreat()

Cancels all assignment and orders all ships to retreat. Can not be aborted.

isInFullRetreat

boolean isInFullRetreat()

getCommandPointsStat

MutableStat getCommandPointsStat()

getCommandPointsLeft

int getCommandPointsLeft()

isPreventFullRetreat

boolean isPreventFullRetreat()

setPreventFullRetreat

void setPreventFullRetreat(boolean preventFullRetreat)

isFullAssault

boolean isFullAssault()

setFullAssault

void setFullAssault(boolean explicitSearchAndDestroy)

getSecondsUntilNextPoint

float getSecondsUntilNextPoint()

getCPRateMult

float getCPRateMult()

getCPInterval

float getCPInterval()

getCPRateModifier

MutableStat getCPRateModifier()

removeAssignment

void removeAssignment(CombatFleetManagerAPI.AssignmentInfo info)

clearEmptyWaypoints

void clearEmptyWaypoints()

createWaypoint2

AssignmentTargetAPI createWaypoint2(org.lwjgl.util.vector.Vector2f loc,
                                    boolean ally)

setAssignmentWeight

void setAssignmentWeight(CombatFleetManagerAPI.AssignmentInfo info,
                         float weight)

reassign

void reassign()

getAssignmentTargetFor

AssignmentTargetAPI getAssignmentTargetFor(ShipAPI ship)

clearTasks

void clearTasks()

getAssignmentInfoForTarget

CombatFleetManagerAPI.AssignmentInfo getAssignmentInfoForTarget(AssignmentTargetAPI target)