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

Class SeededFleetManager

java.lang.Object

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

All Implemented Interfaces:

FleetEventListener, EveryFrameScript

Direct Known Subclasses:

RemnantSeededFleetManager

public abstract class SeededFleetManager
extends java.lang.Object
implements FleetEventListener, EveryFrameScript

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SeededFleetManager.SeededFleet

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEBUG
static float	DESPAWN_PAD_LY
protected java.util.List<SeededFleetManager.SeededFleet>	fleets
protected float	inflateRangeLY
protected StarSystemAPI	system

Constructor Summary

Constructors

Constructor and Description
SeededFleetManager(StarSystemAPI system, float inflateRangeLY)

Method Summary

Modifier and Type	Method and Description
void	addSeed(long seed)
void	advance(float amount) Use SectorAPI.getClock() to convert to campaign days.
float	getInflateRangeLY()
StarSystemAPI	getSystem()
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, java.lang.Object param)
boolean	runWhilePaused()
protected abstract CampaignFleetAPI	spawnFleet(long seed)

Methods inherited from class java.lang.Object

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

Field Detail

DESPAWN_PAD_LY

public static float DESPAWN_PAD_LY

fleets

protected java.util.List<SeededFleetManager.SeededFleet> fleets

inflateRangeLY

protected float inflateRangeLY

system

protected StarSystemAPI system

DEBUG

public static boolean DEBUG

Constructor Detail

SeededFleetManager

public SeededFleetManager(StarSystemAPI system,
                          float inflateRangeLY)

Method Detail

addSeed

public void addSeed(long seed)

getInflateRangeLY

public float getInflateRangeLY()

getSystem

public StarSystemAPI getSystem()

spawnFleet

protected abstract CampaignFleetAPI spawnFleet(long seed)

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.

reportFleetDespawnedToListener

public void reportFleetDespawnedToListener(CampaignFleetAPI fleet,
                                           CampaignEventListener.FleetDespawnReason reason,
                                           java.lang.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