Package com.fs.starfarer.api.campaign

Class BaseCampaignEventListener

java.lang.Object

com.fs.starfarer.api.campaign.BaseCampaignEventListener

All Implemented Interfaces:

CampaignEventListener

Direct Known Subclasses:

BaseCampaignEventListenerAndScript, CoreEventProbabilityManager, CoreScript, PatrolFleetManager, PatrolFleetManagerV2, StarSystemActivityTracker

public class BaseCampaignEventListener
extends Object
implements CampaignEventListener

Nested Class Summary

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

CampaignEventListener.FleetDespawnReason

Constructor Summary

Constructors

Constructor	Description
BaseCampaignEventListener(boolean permaRegister)

Method Summary

Modifier and Type	Method	Description
void	reportBattleFinished(CampaignFleetAPI primaryWinner, BattleAPI battle)
void	reportBattleOccurred(CampaignFleetAPI primaryWinner, BattleAPI battle)	Once for each autoresolve round for AI vs AI.
void	reportEconomyMonthEnd()
void	reportEconomyTick(int iterIndex)
void	reportEncounterLootGenerated(FleetEncounterContextPlugin plugin, CargoAPI loot)
void	reportFleetDespawned(CampaignFleetAPI fleet, CampaignEventListener.FleetDespawnReason reason, Object param)	Could be destroyed or simply reached a despawn location.
void	reportFleetJumped(CampaignFleetAPI fleet, SectorEntityToken from, JumpPointAPI.JumpDestination to)	from is generally a JumpPointAPI, but doesn't *have* to be.
void	reportFleetReachedEntity(CampaignFleetAPI fleet, SectorEntityToken entity)	Planets/stations/etc that are the target of a fleet's assignment.
void	reportFleetSpawned(CampaignFleetAPI fleet)
void	reportPlayerActivatedAbility(AbilityPlugin ability, Object param)
void	reportPlayerClosedMarket(MarketAPI market)
void	reportPlayerDeactivatedAbility(AbilityPlugin ability, Object param)
void	reportPlayerDidNotTakeCargo(CargoAPI cargo)
void	reportPlayerDumpedCargo(CargoAPI cargo)
void	reportPlayerEngagement(EngagementResultAPI result)
void	reportPlayerMarketTransaction(PlayerMarketTransaction transaction)
void	reportPlayerOpenedMarket(MarketAPI market)
void	reportPlayerOpenedMarketAndCargoUpdated(MarketAPI market)
void	reportPlayerReputationChange(PersonAPI person, float delta)
void	reportPlayerReputationChange(String faction, float delta)
void	reportShownInteractionDialog(InteractionDialogAPI dialog)
void	reRegister(float daysToKeep)

Methods inherited from class java.lang.Object

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

Constructor Details

BaseCampaignEventListener

public BaseCampaignEventListener(boolean permaRegister)

Method Details

reRegister

public void reRegister(float daysToKeep)

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

reportBattleFinished

public void reportBattleFinished(CampaignFleetAPI primaryWinner,
 BattleAPI battle)

Specified by:

reportBattleFinished in interface CampaignEventListener

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

reportFleetJumped

public void reportFleetJumped(CampaignFleetAPI fleet,
 SectorEntityToken from,
 JumpPointAPI.JumpDestination to)

Description copied from interface: CampaignEventListener

from is generally a JumpPointAPI, but doesn't *have* to be.

Specified by:

reportFleetJumped in interface CampaignEventListener

reportFleetReachedEntity

public void reportFleetReachedEntity(CampaignFleetAPI fleet,
 SectorEntityToken entity)

Description copied from interface: CampaignEventListener

Planets/stations/etc that are the target of a fleet's assignment.

Specified by:

reportFleetReachedEntity in interface CampaignEventListener

reportPlayerMarketTransaction

public void reportPlayerMarketTransaction(PlayerMarketTransaction transaction)

Specified by:

reportPlayerMarketTransaction in interface CampaignEventListener

reportShownInteractionDialog

public void reportShownInteractionDialog(InteractionDialogAPI dialog)

Specified by:

reportShownInteractionDialog in interface CampaignEventListener

reportPlayerOpenedMarket

public void reportPlayerOpenedMarket(MarketAPI market)

Specified by:

reportPlayerOpenedMarket in interface CampaignEventListener

reportPlayerReputationChange

public void reportPlayerReputationChange(String faction,
 float delta)

Specified by:

reportPlayerReputationChange in interface CampaignEventListener

reportPlayerEngagement

public void reportPlayerEngagement(EngagementResultAPI result)

Specified by:

reportPlayerEngagement in interface CampaignEventListener

reportFleetSpawned

public void reportFleetSpawned(CampaignFleetAPI fleet)

Specified by:

reportFleetSpawned in interface CampaignEventListener

reportPlayerOpenedMarketAndCargoUpdated

public void reportPlayerOpenedMarketAndCargoUpdated(MarketAPI market)

Specified by:

reportPlayerOpenedMarketAndCargoUpdated in interface CampaignEventListener

reportEncounterLootGenerated

public void reportEncounterLootGenerated(FleetEncounterContextPlugin plugin,
 CargoAPI loot)

Specified by:

reportEncounterLootGenerated in interface CampaignEventListener

reportPlayerClosedMarket

public void reportPlayerClosedMarket(MarketAPI market)

Specified by:

reportPlayerClosedMarket in interface CampaignEventListener

reportPlayerReputationChange

public void reportPlayerReputationChange(PersonAPI person,
 float delta)

Specified by:

reportPlayerReputationChange in interface CampaignEventListener

reportPlayerActivatedAbility

public void reportPlayerActivatedAbility(AbilityPlugin ability,
 Object param)

Specified by:

reportPlayerActivatedAbility in interface CampaignEventListener

reportPlayerDeactivatedAbility

public void reportPlayerDeactivatedAbility(AbilityPlugin ability,
 Object param)

Specified by:

reportPlayerDeactivatedAbility in interface CampaignEventListener

reportPlayerDumpedCargo

public void reportPlayerDumpedCargo(CargoAPI cargo)

Specified by:

reportPlayerDumpedCargo in interface CampaignEventListener

reportPlayerDidNotTakeCargo

public void reportPlayerDidNotTakeCargo(CargoAPI cargo)

Specified by:

reportPlayerDidNotTakeCargo in interface CampaignEventListener

reportEconomyMonthEnd

public void reportEconomyMonthEnd()

Specified by:

reportEconomyMonthEnd in interface CampaignEventListener

reportEconomyTick

public void reportEconomyTick(int iterIndex)

Specified by:

reportEconomyTick in interface CampaignEventListener