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

Class MissionFleetAutoDespawn

java.lang.Object

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

All Implemented Interfaces:

EveryFrameScript

public class MissionFleetAutoDespawn
extends java.lang.Object
implements EveryFrameScript

Field Summary

Fields

Modifier and Type	Field and Description
protected float	elapsed
protected float	elapsedWaitingForDespawn
protected CampaignFleetAPI	fleet
protected int	framesWithNoAssignment
protected HubMission	mission

Constructor Summary

Constructors

Constructor and Description
MissionFleetAutoDespawn(HubMission mission, CampaignFleetAPI fleet)

Method Summary

Modifier and Type	Method and Description
void	advance(float amount) Use SectorAPI.getClock() to convert to campaign days.
boolean	isDone()
boolean	isMissionEnded()
boolean	runWhilePaused()

Methods inherited from class java.lang.Object

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

Field Detail

fleet

protected CampaignFleetAPI fleet

elapsedWaitingForDespawn

protected float elapsedWaitingForDespawn

elapsed

protected float elapsed

mission

protected HubMission mission

framesWithNoAssignment

protected int framesWithNoAssignment

Constructor Detail

MissionFleetAutoDespawn

public MissionFleetAutoDespawn(HubMission mission,
                               CampaignFleetAPI fleet)

Method Detail

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.