BaseCampaignEventListenerAndScript (Starfarer API)

java.lang.Object

com.fs.starfarer.api.campaign.BaseCampaignEventListener

com.fs.starfarer.api.campaign.BaseCampaignEventListenerAndScript

All Implemented Interfaces:: CampaignEventListener, EveryFrameScript

public class BaseCampaignEventListenerAndScript extends BaseCampaignEventListener implements EveryFrameScript

Nested Class Summary

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

Constructors

Constructor

Description

BaseCampaignEventListenerAndScript()

BaseCampaignEventListenerAndScript(float days)
Method Summary

Modifier and Type

Method

Description

void

advance(float amount)

Use SectorAPI.getClock() to convert to campaign days.

boolean

isDone()

boolean

runWhilePaused()

Methods inherited from class com.fs.starfarer.api.campaign.BaseCampaignEventListener
reportBattleFinished, reportBattleOccurred, reportEconomyMonthEnd, reportEconomyTick, reportEncounterLootGenerated, reportFleetDespawned, 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

Constructor Details
- BaseCampaignEventListenerAndScript
  
  public BaseCampaignEventListenerAndScript()
- BaseCampaignEventListenerAndScript
  
  public BaseCampaignEventListenerAndScript(float days)
Method Details
- 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.