Starsector API
Loading...
Searching...
No Matches
com.fs.starfarer.api.combat.CombatTaskManagerAPI Interface Reference

Public Member Functions

AssignmentInfo getAssignmentFor (ShipAPI ship)
 
List< AssignmentInfo > getAllAssignments ()
 
AssignmentInfo createAssignment (CombatAssignmentType type, AssignmentTargetAPI target, boolean useCommandPoint)
 
void giveAssignment (DeployedFleetMemberAPI member, AssignmentInfo assignment, boolean useCommandPointIfNeeded)
 
void orderRetreat (DeployedFleetMemberAPI member, boolean useCommandPointIfNeeded, boolean direct)
 
void orderSearchAndDestroy (DeployedFleetMemberAPI member, boolean useCommandPointIfNeeded)
 
void orderSearchAndDestroy ()
 
void orderFullRetreat ()
 
boolean isInFullRetreat ()
 
MutableStat getCommandPointsStat ()
 
int getCommandPointsLeft ()
 
boolean isPreventFullRetreat ()
 
void setPreventFullRetreat (boolean preventFullRetreat)
 
boolean isFullAssault ()
 
void setFullAssault (boolean explicitSearchAndDestroy)
 
float getSecondsUntilNextPoint ()
 
float getCPRateMult ()
 
float getCPInterval ()
 
MutableStat getCPRateModifier ()
 
void removeAssignment (AssignmentInfo info)
 
void clearEmptyWaypoints ()
 

Detailed Description

Definition at line 7 of file CombatTaskManagerAPI.java.

Member Function Documentation

◆ clearEmptyWaypoints()

void com.fs.starfarer.api.combat.CombatTaskManagerAPI.clearEmptyWaypoints ( )

◆ createAssignment()

AssignmentInfo com.fs.starfarer.api.combat.CombatTaskManagerAPI.createAssignment ( CombatAssignmentType  type,
AssignmentTargetAPI  target,
boolean  useCommandPoint 
)

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

Parameters
type
target
useCommandPointIfNeeded
Returns

◆ getAllAssignments()

List< AssignmentInfo > com.fs.starfarer.api.combat.CombatTaskManagerAPI.getAllAssignments ( )

◆ getAssignmentFor()

AssignmentInfo com.fs.starfarer.api.combat.CombatTaskManagerAPI.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

◆ getCommandPointsLeft()

int com.fs.starfarer.api.combat.CombatTaskManagerAPI.getCommandPointsLeft ( )

◆ getCommandPointsStat()

MutableStat com.fs.starfarer.api.combat.CombatTaskManagerAPI.getCommandPointsStat ( )

◆ getCPInterval()

float com.fs.starfarer.api.combat.CombatTaskManagerAPI.getCPInterval ( )

◆ getCPRateModifier()

MutableStat com.fs.starfarer.api.combat.CombatTaskManagerAPI.getCPRateModifier ( )

◆ getCPRateMult()

float com.fs.starfarer.api.combat.CombatTaskManagerAPI.getCPRateMult ( )

◆ getSecondsUntilNextPoint()

float com.fs.starfarer.api.combat.CombatTaskManagerAPI.getSecondsUntilNextPoint ( )

◆ giveAssignment()

void com.fs.starfarer.api.combat.CombatTaskManagerAPI.giveAssignment ( DeployedFleetMemberAPI  member,
AssignmentInfo  assignment,
boolean  useCommandPointIfNeeded 
)

◆ isFullAssault()

boolean com.fs.starfarer.api.combat.CombatTaskManagerAPI.isFullAssault ( )

◆ isInFullRetreat()

boolean com.fs.starfarer.api.combat.CombatTaskManagerAPI.isInFullRetreat ( )

◆ isPreventFullRetreat()

boolean com.fs.starfarer.api.combat.CombatTaskManagerAPI.isPreventFullRetreat ( )

◆ orderFullRetreat()

void com.fs.starfarer.api.combat.CombatTaskManagerAPI.orderFullRetreat ( )

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

◆ orderRetreat()

void com.fs.starfarer.api.combat.CombatTaskManagerAPI.orderRetreat ( DeployedFleetMemberAPI  member,
boolean  useCommandPointIfNeeded,
boolean  direct 
)

◆ orderSearchAndDestroy() [1/2]

void com.fs.starfarer.api.combat.CombatTaskManagerAPI.orderSearchAndDestroy ( )

Cancels all assignments. New assignments can still be created.

◆ orderSearchAndDestroy() [2/2]

void com.fs.starfarer.api.combat.CombatTaskManagerAPI.orderSearchAndDestroy ( DeployedFleetMemberAPI  member,
boolean  useCommandPointIfNeeded 
)

◆ removeAssignment()

void com.fs.starfarer.api.combat.CombatTaskManagerAPI.removeAssignment ( AssignmentInfo  info)

◆ setFullAssault()

void com.fs.starfarer.api.combat.CombatTaskManagerAPI.setFullAssault ( boolean  explicitSearchAndDestroy)

◆ setPreventFullRetreat()

void com.fs.starfarer.api.combat.CombatTaskManagerAPI.setPreventFullRetreat ( boolean  preventFullRetreat)

The documentation for this interface was generated from the following file: