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

Class SourceBasedFleetManager

java.lang.Object

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

All Implemented Interfaces:

FleetEventListener, EveryFrameScript

Direct Known Subclasses:

RemnantStationFleetManager, RogueMinerMiscFleetManager

public abstract class SourceBasedFleetManager
extends Object
implements FleetEventListener, EveryFrameScript

Up to a configurable number of fleets. Instant despawn when player is far enough. New fleets generated after respawnDelay if some are destroyed.

Author:

Alex Mosolov Copyright 2017 Fractal Softworks, LLC

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	DEBUG
static float	DESPAWN_MIN_DIST_LY
static float	DESPAWN_THRESHOLD_PAD_LY
protected float	destroyed
protected List<CampaignFleetAPI>	fleets
protected int	maxFleets
protected int	minFleets
protected float	respawnDelay
protected SectorEntityToken	source
protected org.lwjgl.util.vector.Vector2f	sourceLocation
protected float	thresholdLY

Constructor Summary

Constructors

Constructor	Description
SourceBasedFleetManager(SectorEntityToken source, float thresholdLY, int minFleets, int maxFleets, float respawnDelay)

Method Summary

Modifier and Type	Method	Description
void	advance(float amount)	Use SectorAPI.getClock() to convert to campaign days.
SectorEntityToken	getSource()
float	getThresholdLY()
boolean	isDone()
void	reportBattleOccurred(CampaignFleetAPI fleet, CampaignFleetAPI primaryWinner, BattleAPI battle)	"fleet" will be null if the listener is registered with the ListenerManager, and non-null if the listener is added directly to a fleet.
void	reportFleetDespawnedToListener(CampaignFleetAPI fleet, CampaignEventListener.FleetDespawnReason reason, Object param)
boolean	runWhilePaused()
void	setDone(boolean done)
protected abstract CampaignFleetAPI	spawnFleet()

Methods inherited from class java.lang.Object

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

Field Details

DESPAWN_THRESHOLD_PAD_LY

public static float DESPAWN_THRESHOLD_PAD_LY

DESPAWN_MIN_DIST_LY

public static float DESPAWN_MIN_DIST_LY

fleets

protected List<CampaignFleetAPI> fleets

thresholdLY

protected float thresholdLY

source

protected SectorEntityToken source

DEBUG

public static boolean DEBUG

minFleets

protected int minFleets

maxFleets

protected int maxFleets

respawnDelay

protected float respawnDelay

destroyed

protected float destroyed

sourceLocation

protected org.lwjgl.util.vector.Vector2f sourceLocation

Constructor Details

SourceBasedFleetManager

public SourceBasedFleetManager(SectorEntityToken source,
 float thresholdLY,
 int minFleets,
 int maxFleets,
 float respawnDelay)

Method Details

getThresholdLY

public float getThresholdLY()

getSource

public SectorEntityToken getSource()

spawnFleet

protected abstract CampaignFleetAPI spawnFleet()

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.

setDone

public void setDone(boolean done)

runWhilePaused

public boolean runWhilePaused()

Specified by:

runWhilePaused in interface EveryFrameScript

Returns:

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

reportFleetDespawnedToListener

public void reportFleetDespawnedToListener(CampaignFleetAPI fleet,
 CampaignEventListener.FleetDespawnReason reason,
 Object param)

Specified by:

reportFleetDespawnedToListener in interface FleetEventListener

reportBattleOccurred

public void reportBattleOccurred(CampaignFleetAPI fleet,
 CampaignFleetAPI primaryWinner,
 BattleAPI battle)

Description copied from interface: FleetEventListener

"fleet" will be null if the listener is registered with the ListenerManager, and non-null if the listener is added directly to a fleet.

Specified by:

reportBattleOccurred in interface FleetEventListener