CoreLifecyclePluginImpl

java.lang.Object
- com.fs.starfarer.api.BaseModPlugin
- - com.fs.starfarer.api.impl.campaign.CoreLifecyclePluginImpl

All Implemented Interfaces:: ModPlugin

public class CoreLifecyclePluginImpl
extends BaseModPlugin

Field Summary

Fields
Modifier and Type Field and Description

protected java.util.Map<SectorEntityToken,LocationAPI> asteroidList

protected java.util.Map<SectorEntityToken,LocationAPI> junkList

Fields
Modifier and Type	Field and Description
`protected java.util.Map<SectorEntityToken,LocationAPI>`	`asteroidList`
`protected java.util.Map<SectorEntityToken,LocationAPI>`	`junkList`

Constructor Summary

Constructors
Constructor and Description

CoreLifecyclePluginImpl()

Constructors
Constructor and Description
`CoreLifecyclePluginImpl()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addBarEvents()`
`protected void`	`addJunk()`
`static void`	`addJunk(MarketAPI market)`
`static void`	`addMissingPeople()`
`static void`	`addRuinsJunk(SectorEntityToken planet)`
`protected void`	`addScriptsIfNeeded()`
`static void`	`addSkillsAndAssignAdmin(MarketAPI market, PersonAPI admin)`
`void`	`afterGameSave()` Called after a game is saved.
`protected void`	`assignCustomAdmins()`
`void`	`beforeGameSave()` Called before a game is saved.
`void`	`configureXStream(com.thoughtworks.xstream.XStream x)`
`void`	`convertPersonSkillsTo0951a(PersonAPI person)`
`void`	`convertSkill(java.lang.String from, java.lang.String to, PersonAPI person)`
`void`	`convertTo0951aSkillSystemIfNeeded()`
`static void`	`createInitialPeople(MarketAPI market, java.util.Random random)`
`static void`	`dedupePortraits(java.util.List<PersonAPI> people)`
`static void`	`econPostSaveRestore()`
`protected void`	`econPreSaveCleanup()`
`static int`	`getPortraitCount(java.util.List<PersonAPI> people, PersonAPI person)`
`static boolean`	`hasDuplicatePortraits(java.util.List<PersonAPI> people)`
`void`	`markStoryCriticalMarketsEtc()`
`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`	`onNewGameAfterTimePass()` After the new game has stepped through its initial 2 months.
`PluginPick<ShipAIPlugin>`	`pickShipAI(FleetMemberAPI member, ShipAPI ship)` Called to pick an AI implementation for a specific ship.
`protected void`	`regenAsteroids()`
`static void`	`regenPortrait(PersonAPI person)`
`void`	`removeSkill(java.lang.String id, PersonAPI person)`
`protected void`	`restoreRemovedEntities()`
`void`	`tagLuddicShrines()`
`protected void`	`updateKnownPlanets()`
`static void`	`verifyFactionData()`
`static void`	`verifyFactionData(FactionAPI faction)`

Methods inherited from class com.fs.starfarer.api.BaseModPlugin
onAboutToLinkCodexEntries, onAboutToStartGeneratingCodex, onApplicationLoad, onCodexDataGenerated, onDevModeF8Reload, onEnabled, onNewGameAfterProcGen, pickDroneAI, pickMissileAI, pickWeaponAutofireAI

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - asteroidList
```
protected java.util.Map<SectorEntityToken,LocationAPI> asteroidList
```
  - junkList
```
protected java.util.Map<SectorEntityToken,LocationAPI> junkList
```
- Constructor Detail
  - CoreLifecyclePluginImpl
```
public CoreLifecyclePluginImpl()
```
- Method Detail
  - onGameLoad
```
public void onGameLoad(boolean newGame)
```
    Description copied from class: BaseModPlugin
    
    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
    
    Overrides:
    
    onGameLoad in class BaseModPlugin
    
    Parameters:
    
    newGame - if true, a new campaign has just been started. Sector generation logic should only be executed if this is true.
  - addMissingPeople
```
public static void addMissingPeople()
```
  - verifyFactionData
```
public static void verifyFactionData()
```
  - verifyFactionData
```
public static void verifyFactionData(FactionAPI faction)
```
  - addScriptsIfNeeded
```
protected void addScriptsIfNeeded()
```
  - addBarEvents
```
protected void addBarEvents()
```
  - onNewGame
```
public void onNewGame()
```
    Description copied from class: BaseModPlugin
    
    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
    
    Overrides:
    
    onNewGame in class BaseModPlugin
  - onNewGameAfterTimePass
```
public void onNewGameAfterTimePass()
```
    Description copied from class: BaseModPlugin
    
    After the new game has stepped through its initial 2 months.
    
    Specified by:
    
    onNewGameAfterTimePass in interface ModPlugin
    
    Overrides:
    
    onNewGameAfterTimePass in class BaseModPlugin
  - onNewGameAfterEconomyLoad
```
public void onNewGameAfterEconomyLoad()
```
    Description copied from class: BaseModPlugin
    
    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
    
    Overrides:
    
    onNewGameAfterEconomyLoad in class BaseModPlugin
  - markStoryCriticalMarketsEtc
```
public void markStoryCriticalMarketsEtc()
```
  - tagLuddicShrines
```
public void tagLuddicShrines()
```
  - updateKnownPlanets
```
protected void updateKnownPlanets()
```
  - addJunk
```
public static void addJunk(MarketAPI market)
```
  - addRuinsJunk
```
public static void addRuinsJunk(SectorEntityToken planet)
```
  - addJunk
```
protected void addJunk()
```
  - regenAsteroids
```
protected void regenAsteroids()
```
  - beforeGameSave
```
public void beforeGameSave()
```
    Description copied from class: BaseModPlugin
    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
    
    Overrides:
    
    beforeGameSave in class BaseModPlugin
  - econPreSaveCleanup
```
protected void econPreSaveCleanup()
```
  - econPostSaveRestore
```
public static void econPostSaveRestore()
```
  - afterGameSave
```
public void afterGameSave()
```
    Description copied from class: BaseModPlugin
    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
    
    Overrides:
    
    afterGameSave in class BaseModPlugin
  - onGameSaveFailed
```
public void onGameSaveFailed()
```
    Description copied from class: BaseModPlugin
    
    Called if saving the game failed for some reason, such as running out of memory.
    
    Specified by:
    
    onGameSaveFailed in interface ModPlugin
    
    Overrides:
    
    onGameSaveFailed in class BaseModPlugin
  - restoreRemovedEntities
```
protected void restoreRemovedEntities()
```
  - createInitialPeople
```
public static void createInitialPeople(MarketAPI market,
                                       java.util.Random random)
```
  - dedupePortraits
```
public static void dedupePortraits(java.util.List<PersonAPI> people)
```
  - regenPortrait
```
public static void regenPortrait(PersonAPI person)
```
  - getPortraitCount
```
public static int getPortraitCount(java.util.List<PersonAPI> people,
                                   PersonAPI person)
```
  - hasDuplicatePortraits
```
public static boolean hasDuplicatePortraits(java.util.List<PersonAPI> people)
```
  - assignCustomAdmins
```
protected void assignCustomAdmins()
```
  - addSkillsAndAssignAdmin
```
public static void addSkillsAndAssignAdmin(MarketAPI market,
                                           PersonAPI admin)
```
  - configureXStream
```
public void configureXStream(com.thoughtworks.xstream.XStream x)
```
    Specified by:
    
    configureXStream in interface ModPlugin
    
    Overrides:
    
    configureXStream in class BaseModPlugin
  - pickShipAI
```
public PluginPick<ShipAIPlugin> pickShipAI(FleetMemberAPI member,
                                           ShipAPI ship)
```
    Description copied from class: BaseModPlugin
    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
    
    Overrides:
    
    pickShipAI in class BaseModPlugin
    
    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
  - convertTo0951aSkillSystemIfNeeded
```
public void convertTo0951aSkillSystemIfNeeded()
```
  - convertPersonSkillsTo0951a
```
public void convertPersonSkillsTo0951a(PersonAPI person)
```
  - removeSkill
```
public void removeSkill(java.lang.String id,
                        PersonAPI person)
```
  - convertSkill
```
public void convertSkill(java.lang.String from,
                         java.lang.String to,
                         PersonAPI person)
```

Class CoreLifecyclePluginImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.fs.starfarer.api.BaseModPlugin

Methods inherited from class java.lang.Object

Field Detail

asteroidList

junkList

Constructor Detail

CoreLifecyclePluginImpl

Method Detail

onGameLoad

addMissingPeople

verifyFactionData

verifyFactionData

addScriptsIfNeeded

addBarEvents

onNewGame

onNewGameAfterTimePass

onNewGameAfterEconomyLoad

markStoryCriticalMarketsEtc

tagLuddicShrines

updateKnownPlanets

addJunk

addRuinsJunk

addJunk

regenAsteroids

beforeGameSave

econPreSaveCleanup

econPostSaveRestore

afterGameSave

onGameSaveFailed

restoreRemovedEntities

createInitialPeople

dedupePortraits

regenPortrait

getPortraitCount

hasDuplicatePortraits

assignCustomAdmins

addSkillsAndAssignAdmin

configureXStream

pickShipAI

convertTo0951aSkillSystemIfNeeded

convertPersonSkillsTo0951a

removeSkill

convertSkill