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

Class PatrolFleetManager

java.lang.Object

com.fs.starfarer.api.campaign.BaseCampaignEventListener

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

All Implemented Interfaces:

CampaignEventListener, EveryFrameScript

public class PatrolFleetManager
extends BaseCampaignEventListener
implements EveryFrameScript

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PatrolFleetManager.PatrolFleetData

Nested classes/interfaces inherited from interface com.fs.starfarer.api.campaign.CampaignEventListener

CampaignEventListener.FleetDespawnReason

Field Summary

Fields

Modifier and Type	Field	Description
static org.apache.log4j.Logger	log

Constructor Summary

Constructors

Constructor	Description
PatrolFleetManager(MarketAPI market)

Method Summary

Modifier and Type	Method	Description
void	advance(float amount)	Use SectorAPI.getClock() to convert to campaign days.
static CampaignFleetAPI	createPatrolFleet(FleetFactory.PatrolType type, MarketAPI market, String factionId, org.lwjgl.util.vector.Vector2f locInHyper, float losses)
boolean	isDone()
protected Object	readResolve()
void	reportBattleOccurred(CampaignFleetAPI primaryWinner, BattleAPI battle)	Once for each autoresolve round for AI vs AI.
void	reportFleetDespawned(CampaignFleetAPI fleet, CampaignEventListener.FleetDespawnReason reason, Object param)	Could be destroyed or simply reached a despawn location.
boolean	runWhilePaused()

Methods inherited from class com.fs.starfarer.api.campaign.BaseCampaignEventListener

reportBattleFinished, reportEconomyMonthEnd, reportEconomyTick, reportEncounterLootGenerated, reportFleetJumped, reportFleetReachedEntity, reportFleetSpawned, reportPlayerActivatedAbility, reportPlayerClosedMarket, reportPlayerDeactivatedAbility, reportPlayerDidNotTakeCargo, reportPlayerDumpedCargo, reportPlayerEngagement, reportPlayerMarketTransaction, reportPlayerOpenedMarket, reportPlayerOpenedMarketAndCargoUpdated, reportPlayerReputationChange, reportPlayerReputationChange, reportShownInteractionDialog, reRegister

Methods inherited from class java.lang.Object

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

Field Details

log

public static org.apache.log4j.Logger log

Constructor Details

PatrolFleetManager

public PatrolFleetManager(MarketAPI market)

Method Details

readResolve

protected Object readResolve()

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.

createPatrolFleet

public static CampaignFleetAPI createPatrolFleet(FleetFactory.PatrolType type,
 MarketAPI market,
 String factionId,
 org.lwjgl.util.vector.Vector2f locInHyper,
 float losses)

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,
 Object param)

Description copied from interface: CampaignEventListener

Could be destroyed or simply reached a despawn location. Or had too many accidents and lost all of its ships. Or told by other code to despawn itself.

Specified by:

reportFleetDespawned in interface CampaignEventListener

Overrides:

reportFleetDespawned in class BaseCampaignEventListener

reportBattleOccurred

public void reportBattleOccurred(CampaignFleetAPI primaryWinner,
 BattleAPI battle)

Description copied from interface: CampaignEventListener

Once for each autoresolve round for AI vs AI. Only once per player battle encounter.

Specified by:

reportBattleOccurred in interface CampaignEventListener

Overrides:

reportBattleOccurred in class BaseCampaignEventListener