Package com.fs.starfarer.api.impl.campaign.missions.hub

Class TriggerFleetAssignmentAI

java.lang.Object

com.fs.starfarer.api.impl.campaign.missions.hub.TriggerFleetAssignmentAI

All Implemented Interfaces:

EveryFrameScript

public class TriggerFleetAssignmentAI
extends Object
implements EveryFrameScript

Field Summary

Fields

Modifier and Type	Field	Description
protected SectorEntityToken	currTarget
protected float	elapsedWaitingForDespawn
protected CampaignFleetAPI	fleet
protected HubMission	mission
protected List<SectorEntityToken>	patrolPoints
protected String	patrolText
protected LocationAPI	system
protected String	travelText

Constructor Summary

Constructors

Constructor	Description
TriggerFleetAssignmentAI(String travelText, String patrolText, HubMission mission, LocationAPI system, boolean randomLocation, CampaignFleetAPI fleet, SectorEntityToken... patrolPoints)

Method Summary

Modifier and Type	Method	Description
void	advance(float amount)	Use SectorAPI.getClock() to convert to campaign days.
protected void	giveInitialAssignments(boolean randomLocation)
boolean	isDone()
boolean	isMissionEnded()
protected void	pickNext()
protected SectorEntityToken	pickPatrolPoint()
boolean	runWhilePaused()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

fleet

protected CampaignFleetAPI fleet

system

protected LocationAPI system

patrolPoints

protected List<SectorEntityToken> patrolPoints

elapsedWaitingForDespawn

protected float elapsedWaitingForDespawn

mission

protected HubMission mission

patrolText

protected String patrolText

travelText

protected String travelText

currTarget

protected SectorEntityToken currTarget

Constructor Details

TriggerFleetAssignmentAI

public TriggerFleetAssignmentAI(String travelText,
 String patrolText,
 HubMission mission,
 LocationAPI system,
 boolean randomLocation,
 CampaignFleetAPI fleet,
 SectorEntityToken... patrolPoints)

Method Details

giveInitialAssignments

protected void giveInitialAssignments(boolean randomLocation)

pickPatrolPoint

protected SectorEntityToken pickPatrolPoint()

pickNext

protected void pickNext()

advance

public void advance(float amount)

Description copied from interface: EveryFrameScript

Use SectorAPI.getClock() to convert to campaign days.

Specified by:

advance in interface EveryFrameScript

Parameters:

amount - seconds elapsed during the last frame.

isMissionEnded

public boolean isMissionEnded()

isDone

public boolean isDone()

Specified by:

isDone in interface EveryFrameScript

Returns:

true when the script is finished and can be cleaned up by the engine.

runWhilePaused

public boolean runWhilePaused()

Specified by:

runWhilePaused in interface EveryFrameScript

Returns:

whether advance() should be called while the campaign engine is paused.