com.fs.starfarer.api

Class BaseModPlugin

java.lang.Object

com.fs.starfarer.api.BaseModPlugin

All Implemented Interfaces:

ModPlugin

Direct Known Subclasses:

CoreLifecyclePluginImpl

public class BaseModPlugin
extends java.lang.Object
implements ModPlugin

Extend this class instead of implementing ModPlugin for convenience if you do not intend to implement all the methods. This will also help avoid your mod breaking when new methods are added to ModPlugin, since default implemenations will be added here and your implementation will inherit them.

While having a ModPlugin for your mod is not strictly necessary, it serves as an entry point for all kinds of useful things, such as faction initialization, adding custom scripts and picking AI plugins.

You need to instruct the game to load your implementation of this class by e.g. adding it to your mod_info.json: "modPlugin":"my.package.name.MyModBasePlugin"

Constructor Summary

Constructors

Constructor and Description
BaseModPlugin()

Method Summary

Modifier and Type	Method and Description
void	afterGameSave() Called after a game is saved.
void	beforeGameSave() Called before a game is saved.
void	configureXStream(com.thoughtworks.xstream.XStream x)
void	onAboutToLinkCodexEntries()
void	onAboutToStartGeneratingCodex()
void	onApplicationLoad() Called after all the core loading has finished and all the scripts have finished being compiled.
void	onCodexDataGenerated()
void	onDevModeF8Reload() Called after F8 is pressed in combat while in devMode.
void	onEnabled(boolean wasEnabledBefore) Called before onGameLoad() and only if this mod was not previously enabled for the loaded saved game, or if this is a new game.
void	onGameLoad(boolean newGame) Called after a game has been loaded.
void	onGameSaveFailed() Called if saving the game failed for some reason, such as running out of memory.
void	onNewGame() Called when a new game is being created.
void	onNewGameAfterEconomyLoad() Called after the economy is loaded from economy.json and the initial steps are taken.
void	onNewGameAfterProcGen()
void	onNewGameAfterTimePass() After the new game has stepped through its initial 2 months.
PluginPick<ShipAIPlugin>	pickDroneAI(ShipAPI drone, ShipAPI mothership, DroneLauncherShipSystemAPI system) Called to pick drone AI implementation.
PluginPick<MissileAIPlugin>	pickMissileAI(MissileAPI missile, ShipAPI launchingShip) Called to pick missile AI implementation.
PluginPick<ShipAIPlugin>	pickShipAI(FleetMemberAPI member, ShipAPI ship) Called to pick an AI implementation for a specific ship.
PluginPick<AutofireAIPlugin>	pickWeaponAutofireAI(WeaponAPI weapon) Called to pick an AI implementation for a specific weapon.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseModPlugin

public BaseModPlugin()

Method Detail

afterGameSave

public void afterGameSave()

Called after a game is saved. Code in here gets executed after the game gets saved. The main use for this is in combination with beforeGameSave. If you did clean-up code in beforeGameSave, you can re-add your stuff in here.

Example:

     
         Global.getSector().getListenerManager().addListener(new MyListener());
     
 

Specified by:

afterGameSave in interface ModPlugin

beforeGameSave

public void beforeGameSave()

Called before a game is saved. Code in here gets executed before the game gets saved. This is mainly useful for doing cleanup. Anything that is part of the sector gets serialized when the game is saved. If you, for instance, add custom listeners to the sector and the game gets saved, they are added to the save file. If you then later e.g. rename the class of those listeners, that will break mod compatibility and users won't be able to upgrade your mod in an ongoing campaign. Also, players won't be able to remove your mod from an ongoing campaign. To avoid this issue, you can simply clean up anything that you added to the sector that doesn't need to be saved in this method and then re-add it in the afterGameSave-method.

Example:

     
                        while (Global.getSector().getListenerManager().hasListenerOfClass(MyListener.class)){
             Global.getSector().getListenerManager().removeListenerOfClass(MyListener.class);
         }
     
 

Specified by:

beforeGameSave in interface ModPlugin

onGameSaveFailed

public void onGameSaveFailed()

Called if saving the game failed for some reason, such as running out of memory.

Specified by:

onGameSaveFailed in interface ModPlugin

onApplicationLoad

public void onApplicationLoad()
                       throws java.lang.Exception

Called after all the core loading has finished and all the scripts have finished being compiled. Gives the mod an opportunity to load its own data using the relevant SettingsAPI methods.

Specified by:

onApplicationLoad in interface ModPlugin

Throws:

java.lang.Exception

onEnabled

public void onEnabled(boolean wasEnabledBefore)

Called before onGameLoad() and only if this mod was not previously enabled for the loaded saved game, or if this is a new game.

Specified by:

onEnabled in interface ModPlugin

Parameters:

wasEnabledBefore - true if the mod was enabled for this saved game at some point in the past, though not immediately prior (or this method wouldn't be called at all).

onGameLoad

public void onGameLoad(boolean newGame)

Called after a game has been loaded. Also called when a new game is created, after the onNewGame() plugins for all the mods have been called.

In here, you should do all kinds of initialization logic, such as adding transient scripts, registering campaign plugins, adding custom sensor ghosts etc.

Specified by:

onGameLoad in interface ModPlugin

Parameters:

newGame - if true, a new campaign has just been started. Sector generation logic should only be executed if this is true.

onNewGame

public void onNewGame()

Called when a new game is being created. This is the preferred way to generate the contents of the Sector, and is meant to replace generators.csv (which remains used for backwards compatibility).

Specified by:

onNewGame in interface ModPlugin

onNewGameAfterEconomyLoad

public void onNewGameAfterEconomyLoad()

Called after the economy is loaded from economy.json and the initial steps are taken. At this point, calling get getMarket() on entities will return the proper market. The sequence of calls is: onNewGame(); // can add markets to the economy here programmatically //load economy and step it onNewGameAfterEconomyLoad();

Specified by:

onNewGameAfterEconomyLoad in interface ModPlugin

pickShipAI

public PluginPick<ShipAIPlugin> pickShipAI(FleetMemberAPI member,
                                           ShipAPI ship)

Called to pick an AI implementation for a specific ship. Here instead of in CampaignPlugin to support custom AI for missions.

Example:

     
                        if(ship.getVariant().getHullVariantId().equals("myVariantId")){
             return new PluginPick(new MyAi(), CampaignPlugin.PickPriority.MOD_GENERAL)
         }
         return null;
     
 

Specified by:

pickShipAI in interface ModPlugin

Parameters:

member - fleetMemeber of the ship in question. Can be used to inform your decision if/which AI to choose

ship - the ship in question

Returns:

a plugin pick containing the chosen ship AI, or simply null to use the default AI

pickWeaponAutofireAI

public PluginPick<AutofireAIPlugin> pickWeaponAutofireAI(WeaponAPI weapon)

Called to pick an AI implementation for a specific weapon. This code gets executed whenever the game selects an autofire AI for a weapon, which is usually at start of combat This is mainly relevant if your weapon has some quirks that the regular AI doesn't understand.

Example:

     
         if(weapon.getId().equals("myWeaponId")){
             return new PluginPick<>(new MyAi(), CampaignPlugin.PickPriority.MOD_GENERAL);
         }
         return null;
     
 

Specified by:

pickWeaponAutofireAI in interface ModPlugin

Parameters:

weapon - the weapon in question

Returns:

a plugin pick containing the chosen AI, or simply null to use the default

pickDroneAI

public PluginPick<ShipAIPlugin> pickDroneAI(ShipAPI drone,
                                            ShipAPI mothership,
                                            DroneLauncherShipSystemAPI system)

Description copied from interface: ModPlugin

Called to pick drone AI implementation.

Specified by:

pickDroneAI in interface ModPlugin

system - use getSpecJson() to get at the system spec, if needed.

Returns:

pickMissileAI

public PluginPick<MissileAIPlugin> pickMissileAI(MissileAPI missile,
                                                 ShipAPI launchingShip)

Called to pick missile AI implementation. This method is how you can assign custom AI to missiles. If you want to write your own missile AI, I would recommend having a look at the MagicMissileAI available in MagicLib for inspiration.

Example:

     
         if(missile.getProjectileSpecId().equals("myMissileProjId")){
             return new PluginPick<>(new MyAi(), CampaignPlugin.PickPriority.MOD_GENERAL);
         }
         return null;
     
 

Specified by:

pickMissileAI in interface ModPlugin

Parameters:

missile - the missile in question. This is usually the main deciding factor.

launchingShip - the ship that launched the missile. This can usually be ignored

Returns:

a plugin pick containing the chosen AI, or simply null to use the default

onNewGameAfterTimePass

public void onNewGameAfterTimePass()

After the new game has stepped through its initial 2 months.

Specified by:

onNewGameAfterTimePass in interface ModPlugin

configureXStream

public void configureXStream(com.thoughtworks.xstream.XStream x)

Specified by:

configureXStream in interface ModPlugin

onNewGameAfterProcGen

public void onNewGameAfterProcGen()

Specified by:

onNewGameAfterProcGen in interface ModPlugin

onDevModeF8Reload

public void onDevModeF8Reload()

Called after F8 is pressed in combat while in devMode. Note: the game becomes potentially unstable after an F8-dev mode reload. That is, crashes may occur that would not have occured otherwise and are not indicative of bugs.

Specified by:

onDevModeF8Reload in interface ModPlugin

onAboutToStartGeneratingCodex

public void onAboutToStartGeneratingCodex()

Specified by:

onAboutToStartGeneratingCodex in interface ModPlugin

onAboutToLinkCodexEntries

public void onAboutToLinkCodexEntries()

Specified by:

onAboutToLinkCodexEntries in interface ModPlugin

onCodexDataGenerated

public void onCodexDataGenerated()

Specified by:

onCodexDataGenerated in interface ModPlugin