com.fs.starfarer.api.impl.campaign.fleets

Class BaseRouteFleetManager

java.lang.Object

com.fs.starfarer.api.impl.campaign.fleets.BaseRouteFleetManager

All Implemented Interfaces:

EveryFrameScript, RouteManager.RouteFleetSpawner

Direct Known Subclasses:

EconomyFleetRouteManager, MercFleetManagerV2, MiscFleetRouteManager, PilgrimageFleetRouteManager, RuinsFleetRouteManager

public abstract class BaseRouteFleetManager
extends java.lang.Object
implements EveryFrameScript, RouteManager.RouteFleetSpawner

Field Summary

Fields

Modifier and Type	Field and Description
protected IntervalUtil	interval

Constructor Summary

Constructors

Constructor and Description
BaseRouteFleetManager(float minInterval, float maxInterval)

Method Summary

Modifier and Type	Method and Description
protected abstract void	addRouteFleetIfPossible()
void	advance(float amount) Use SectorAPI.getClock() to convert to campaign days.
protected abstract int	getMaxFleets()
protected abstract java.lang.String	getRouteSourceId()
boolean	isDone()
boolean	runWhilePaused()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.fs.starfarer.api.impl.campaign.fleets.RouteManager.RouteFleetSpawner

reportAboutToBeDespawnedByRouteManager, shouldCancelRouteAfterDelayCheck, shouldRepeat, spawnFleet

Field Detail

interval

protected IntervalUtil interval

Constructor Detail

BaseRouteFleetManager

public BaseRouteFleetManager(float minInterval,
                             float maxInterval)

Method Detail

getRouteSourceId

protected abstract java.lang.String getRouteSourceId()

getMaxFleets

protected abstract int getMaxFleets()

addRouteFleetIfPossible

protected abstract void addRouteFleetIfPossible()

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.

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.