com.fs.starfarer.api.impl.campaign

Class CoreScript

java.lang.Object

com.fs.starfarer.api.campaign.BaseCampaignEventListener

com.fs.starfarer.api.impl.campaign.CoreScript

All Implemented Interfaces:

CampaignEventListener, EveryFrameScript

public class CoreScript
extends BaseCampaignEventListener
implements EveryFrameScript

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CoreScript.ExportCommodityGroupData

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

CampaignEventListener.FleetDespawnReason

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	log
protected java.util.Random	prodRandom
static java.lang.String	SHARED_DATA_KEY

Constructor Summary

Constructors

Constructor and Description
CoreScript()

Method Summary

Modifier and Type	Method and Description
protected void	addExportsGroupedByCommodity(MonthlyReport report, MonthlyReport.FDNode parent, MarketAPI market, float f)
static void	addMiscToDropData(SalvageEntityGenDataSpec.DropData data, FleetMemberAPI member, boolean weapons, boolean mods, boolean fighters)
void	advance(float amount) Use SectorAPI.getClock() to convert to campaign days.
void	doCustomProduction()
static void	generateOrAddToDebrisFieldFromBattle(CampaignFleetAPI primaryWinner, BattleAPI battle)
static java.util.Set<java.lang.String>	getCargoCommodities(CargoAPI cargo)
boolean	isDone()
static void	markSystemAsEntered(StarSystemAPI system, boolean withMessages)
void	reportBattleOccurred(CampaignFleetAPI primaryWinner, BattleAPI battle) Once for each autoresolve round for AI vs AI.
void	reportEconomyMonthEnd()
void	reportEconomyTick(int iterIndex)
void	reportFleetJumped(CampaignFleetAPI fleet, SectorEntityToken from, JumpPointAPI.JumpDestination to) from is generally a JumpPointAPI, but doesn't *have* to be.
void	reportPlayerDidNotTakeCargo(CargoAPI cargo)
void	reportPlayerDumpedCargo(CargoAPI cargo)
void	reportPlayerMarketTransaction(PlayerMarketTransaction transaction)
void	reportPlayerOpenedMarket(MarketAPI market)
void	reportPlayerReputationChange(PersonAPI person, float delta)
void	reportPlayerReputationChange(java.lang.String faction, float delta)
boolean	runWhilePaused()

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

reportBattleFinished, reportEncounterLootGenerated, reportFleetDespawned, reportFleetReachedEntity, reportFleetSpawned, reportPlayerActivatedAbility, reportPlayerClosedMarket, reportPlayerDeactivatedAbility, reportPlayerEngagement, reportPlayerOpenedMarketAndCargoUpdated, reportShownInteractionDialog, reRegister

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

SHARED_DATA_KEY

public static final java.lang.String SHARED_DATA_KEY

See Also:

Constant Field Values

prodRandom

protected java.util.Random prodRandom

Constructor Detail

CoreScript

public CoreScript()

Method Detail

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.

reportPlayerReputationChange

public void reportPlayerReputationChange(java.lang.String faction,
                                         float delta)

Specified by:

reportPlayerReputationChange in interface CampaignEventListener

Overrides:

reportPlayerReputationChange in class BaseCampaignEventListener

reportPlayerReputationChange

public void reportPlayerReputationChange(PersonAPI person,
                                         float delta)

Specified by:

reportPlayerReputationChange in interface CampaignEventListener

Overrides:

reportPlayerReputationChange in class BaseCampaignEventListener

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.

reportPlayerMarketTransaction

public void reportPlayerMarketTransaction(PlayerMarketTransaction transaction)

Specified by:

reportPlayerMarketTransaction in interface CampaignEventListener

Overrides:

reportPlayerMarketTransaction in class BaseCampaignEventListener

reportPlayerOpenedMarket

public void reportPlayerOpenedMarket(MarketAPI market)

Specified by:

reportPlayerOpenedMarket in interface CampaignEventListener

Overrides:

reportPlayerOpenedMarket 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

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

Overrides:

reportFleetJumped in class BaseCampaignEventListener

markSystemAsEntered

public static void markSystemAsEntered(StarSystemAPI system,
                                       boolean withMessages)

addMiscToDropData

public static void addMiscToDropData(SalvageEntityGenDataSpec.DropData data,
                                     FleetMemberAPI member,
                                     boolean weapons,
                                     boolean mods,
                                     boolean fighters)

getCargoCommodities

public static java.util.Set<java.lang.String> getCargoCommodities(CargoAPI cargo)

generateOrAddToDebrisFieldFromBattle

public static void generateOrAddToDebrisFieldFromBattle(CampaignFleetAPI primaryWinner,
                                                        BattleAPI battle)

reportPlayerDumpedCargo

public void reportPlayerDumpedCargo(CargoAPI cargo)

Specified by:

reportPlayerDumpedCargo in interface CampaignEventListener

Overrides:

reportPlayerDumpedCargo in class BaseCampaignEventListener

reportPlayerDidNotTakeCargo

public void reportPlayerDidNotTakeCargo(CargoAPI cargo)

Specified by:

reportPlayerDidNotTakeCargo in interface CampaignEventListener

Overrides:

reportPlayerDidNotTakeCargo in class BaseCampaignEventListener

doCustomProduction

public void doCustomProduction()

reportEconomyMonthEnd

public void reportEconomyMonthEnd()

Specified by:

reportEconomyMonthEnd in interface CampaignEventListener

Overrides:

reportEconomyMonthEnd in class BaseCampaignEventListener

reportEconomyTick

public void reportEconomyTick(int iterIndex)

Specified by:

reportEconomyTick in interface CampaignEventListener

Overrides:

reportEconomyTick in class BaseCampaignEventListener

addExportsGroupedByCommodity

protected void addExportsGroupedByCommodity(MonthlyReport report,
                                            MonthlyReport.FDNode parent,
                                            MarketAPI market,
                                            float f)