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

Class BaseLimitedFleetManager

java.lang.Object

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

All Implemented Interfaces:

FleetEventListener, EveryFrameScript

Direct Known Subclasses:

LuddicPathFleetManager, PirateFleetManager, PlayerVisibleFleetManager

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

Default spawn rate is on average one fleet every month. Deriving classes should boost this as necessary via getSpawnRateMult().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseLimitedFleetManager.ManagedFleetData

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<BaseLimitedFleetManager.ManagedFleetData>	active
static org.apache.log4j.Logger	log
protected IntervalUtil	tracker

Constructor Summary

Constructors

Constructor and Description
BaseLimitedFleetManager()

Method Summary

Modifier and Type	Method and Description
void	advance(float amount) Use SectorAPI.getClock() to convert to campaign days.
protected abstract int	getMaxFleets()
protected float	getNextInterval()
protected float	getSpawnRateMult()
boolean	isDone()
protected java.lang.Object	readResolve()
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	reportFleetDespawned(CampaignFleetAPI fleet, CampaignEventListener.FleetDespawnReason reason, java.lang.Object param)
void	reportFleetDespawnedToListener(CampaignFleetAPI fleet, CampaignEventListener.FleetDespawnReason reason, java.lang.Object param)
boolean	runWhilePaused()
protected abstract CampaignFleetAPI	spawnFleet()

Methods inherited from class java.lang.Object

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

Field Detail

log

public static org.apache.log4j.Logger log

active

protected java.util.List<BaseLimitedFleetManager.ManagedFleetData> active

tracker

protected IntervalUtil tracker

Constructor Detail

BaseLimitedFleetManager

public BaseLimitedFleetManager()

Method Detail

readResolve

protected java.lang.Object readResolve()

getMaxFleets

protected abstract int getMaxFleets()

spawnFleet

protected abstract CampaignFleetAPI spawnFleet()

getNextInterval

protected float getNextInterval()

getSpawnRateMult

protected float getSpawnRateMult()

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.

reportFleetDespawned

public void reportFleetDespawned(CampaignFleetAPI fleet,
                                 CampaignEventListener.FleetDespawnReason reason,
                                 java.lang.Object param)

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

reportFleetDespawnedToListener

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

Specified by:

reportFleetDespawnedToListener in interface FleetEventListener