Package com.fs.starfarer.api.impl.campaign.events

Class OfficerManagerEvent

java.lang.Object

com.fs.starfarer.api.impl.campaign.events.BaseEventPlugin

com.fs.starfarer.api.impl.campaign.events.OfficerManagerEvent

All Implemented Interfaces:

CampaignEventListener, CampaignEventPlugin, ColonyInteractionListener, EveryFrameScript, CallEvent.CallableEvent

public class OfficerManagerEvent
extends BaseEventPlugin
implements CallEvent.CallableEvent, ColonyInteractionListener, EveryFrameScript

Author:

Alex Mosolov extends BaseEventPlugin for in-dev savefile compatibility reasons only Copyright 2019 Fractal Softworks, LLC

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OfficerManagerEvent.AvailableOfficer
static enum	OfficerManagerEvent.SkillPickPreference

Nested classes/interfaces inherited from class com.fs.starfarer.api.impl.campaign.events.BaseEventPlugin

BaseEventPlugin.MarketFilter

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

CampaignEventListener.FleetDespawnReason

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

CampaignEventPlugin.CampaignEventCategory, CampaignEventPlugin.PriceUpdatePlugin

Field Summary

Fields

Modifier and Type	Field	Description
protected List<OfficerManagerEvent.AvailableOfficer>	available
protected List<OfficerManagerEvent.AvailableOfficer>	availableAdmins
static boolean	DEBUG
static org.apache.log4j.Logger	log
protected TimeoutTracker<String>	recentlyChecked
protected IntervalUtil	removeTracker
protected long	seed

Fields inherited from class com.fs.starfarer.api.impl.campaign.events.BaseEventPlugin

entity, eventTarget, eventType, faction, market, memory, started, startProbability, statModId

Constructor Summary

Constructors

Constructor	Description
OfficerManagerEvent()

Method Summary

Modifier and Type	Method	Description
void	addAvailable(OfficerManagerEvent.AvailableOfficer officer)
void	addAvailableAdmin(OfficerManagerEvent.AvailableOfficer officer)
static void	addEliteSkills(PersonAPI person, int num, Random random)
void	advance(float amount)	Use SectorAPI.getClock() to convert to campaign days.
boolean	callEvent(String ruleId, InteractionDialogAPI dialog, List<Misc.Token> params, Map<String,MemoryAPI> memoryMap)	Called by the CallEvent command (called from rules.csv).
protected OfficerManagerEvent.AvailableOfficer	createAdmin(MarketAPI market, Random random)
static PersonAPI	createAdmin(FactionAPI faction, int tier, Random random)
static PersonAPI	createMercInternal(FactionAPI faction, int level, int numElite, boolean allowNonDoctrinePersonality, Random random)
protected OfficerManagerEvent.AvailableOfficer	createOfficer(boolean isMerc, MarketAPI market, Random random)
static PersonAPI	createOfficer(FactionAPI faction, int level)
static PersonAPI	createOfficer(FactionAPI faction, int level, boolean allowNonDoctrinePersonality)
static PersonAPI	createOfficer(FactionAPI faction, int level, OfficerManagerEvent.SkillPickPreference pref, boolean allowNonDoctrinePersonality, CampaignFleetAPI fleet, boolean allowAnyLevel, boolean withEliteSkills, int eliteSkillsNumOverride, Random random)
static PersonAPI	createOfficer(FactionAPI faction, int level, OfficerManagerEvent.SkillPickPreference pref, Random random)
static PersonAPI	createOfficerInternal(FactionAPI faction, int level, boolean allowNonDoctrinePersonality, Random random)
OfficerManagerEvent.AvailableOfficer	getAdmin(String personId)
OfficerManagerEvent.AvailableOfficer	getOfficer(String personId)
protected float	getOfficerDuration(Random random)
boolean	isDone()
static String	pickPortraitPreferNonDuplicate(FactionAPI faction, FullName.Gender gender)
static String	pickSkill(PersonAPI person, List<String> skills, OfficerManagerEvent.SkillPickPreference pref, int numSpec, Random random)
void	pruneFromRemovedMarkets()
void	removeAvailable(OfficerManagerEvent.AvailableOfficer officer)
void	reportPlayerClosedMarket(MarketAPI market)
void	reportPlayerMarketTransaction(PlayerMarketTransaction transaction)
void	reportPlayerOpenedMarket(MarketAPI market)
void	reportPlayerOpenedMarketAndCargoUpdated(MarketAPI market)
boolean	runWhilePaused()
protected void	setEventDataAndAddToMarket(OfficerManagerEvent.AvailableOfficer officer)

Methods inherited from class com.fs.starfarer.api.impl.campaign.events.BaseEventPlugin

addFactionNameTokens, addPersonTokens, addTokensToList, allowMultipleOngoingForSameTarget, cleanup, findMatchingMarkets, findNearestMarket, getCurrentImage, getCurrentMessageIcon, getDefaultPriority, getEventCategory, getEventIcon, getEventName, getEventTarget, getEventType, getHighlightColors, getHighlights, getId, getLoggingId, getMemory, getPriceUpdates, getRelatedCommodities, getStageIdForLikely, getStageIdForPossible, getStatModId, getTargetName, getTokenReplacements, getWarningWhenLikelyPriority, getWarningWhenPossiblePriority, increaseRecentUnrest, init, init, isEventStarted, reportBattleFinished, reportBattleOccurred, reportEconomyMonthEnd, reportEconomyTick, reportEncounterLootGenerated, reportFleetDespawned, reportFleetJumped, reportFleetReachedEntity, reportFleetSpawned, reportPlayerActivatedAbility, reportPlayerDeactivatedAbility, reportPlayerDidNotTakeCargo, reportPlayerDumpedCargo, reportPlayerEngagement, reportPlayerReputationChange, reportPlayerReputationChange, reportShownInteractionDialog, setParam, setProbability, setTarget, showAllMessagesIfOngoing, showLatestMessageIfOngoing, startEvent, startEvent, useEventNameAsId

Methods inherited from class java.lang.Object

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

Field Details

log

public static org.apache.log4j.Logger log

removeTracker

protected IntervalUtil removeTracker

available

protected List<OfficerManagerEvent.AvailableOfficer> available

availableAdmins

protected List<OfficerManagerEvent.AvailableOfficer> availableAdmins

recentlyChecked

protected TimeoutTracker<String> recentlyChecked

seed

protected long seed

DEBUG

public static boolean DEBUG

Constructor Details

OfficerManagerEvent

public OfficerManagerEvent()

Method Details

reportPlayerClosedMarket

public void reportPlayerClosedMarket(MarketAPI market)

Specified by:

reportPlayerClosedMarket in interface CampaignEventListener

Specified by:

reportPlayerClosedMarket in interface ColonyInteractionListener

Overrides:

reportPlayerClosedMarket in class BaseEventPlugin

reportPlayerOpenedMarket

public void reportPlayerOpenedMarket(MarketAPI market)

Specified by:

reportPlayerOpenedMarket in interface CampaignEventListener

Specified by:

reportPlayerOpenedMarket in interface ColonyInteractionListener

Overrides:

reportPlayerOpenedMarket in class BaseEventPlugin

getOfficerDuration

protected float getOfficerDuration(Random random)

advance

public void advance(float amount)

Description copied from interface: EveryFrameScript

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

Specified by:

advance in interface CampaignEventPlugin

Specified by:

advance in interface EveryFrameScript

Overrides:

advance in class BaseEventPlugin

Parameters:

amount - seconds elapsed during the last frame.

pruneFromRemovedMarkets

public void pruneFromRemovedMarkets()

addAvailable

public void addAvailable(OfficerManagerEvent.AvailableOfficer officer)

addAvailableAdmin

public void addAvailableAdmin(OfficerManagerEvent.AvailableOfficer officer)

setEventDataAndAddToMarket

protected void setEventDataAndAddToMarket(OfficerManagerEvent.AvailableOfficer officer)

removeAvailable

public void removeAvailable(OfficerManagerEvent.AvailableOfficer officer)

pickPortraitPreferNonDuplicate

public static String pickPortraitPreferNonDuplicate(FactionAPI faction,
 FullName.Gender gender)

createAdmin

protected OfficerManagerEvent.AvailableOfficer createAdmin(MarketAPI market,
 Random random)

createAdmin

public static PersonAPI createAdmin(FactionAPI faction,
 int tier,
 Random random)

createOfficer

protected OfficerManagerEvent.AvailableOfficer createOfficer(boolean isMerc,
 MarketAPI market,
 Random random)

createOfficerInternal

public static PersonAPI createOfficerInternal(FactionAPI faction,
 int level,
 boolean allowNonDoctrinePersonality,
 Random random)

createMercInternal

public static PersonAPI createMercInternal(FactionAPI faction,
 int level,
 int numElite,
 boolean allowNonDoctrinePersonality,
 Random random)

createOfficer

public static PersonAPI createOfficer(FactionAPI faction,
 int level)

createOfficer

public static PersonAPI createOfficer(FactionAPI faction,
 int level,
 boolean allowNonDoctrinePersonality)

createOfficer

public static PersonAPI createOfficer(FactionAPI faction,
 int level,
 OfficerManagerEvent.SkillPickPreference pref,
 Random random)

createOfficer

public static PersonAPI createOfficer(FactionAPI faction,
 int level,
 OfficerManagerEvent.SkillPickPreference pref,
 boolean allowNonDoctrinePersonality,
 CampaignFleetAPI fleet,
 boolean allowAnyLevel,
 boolean withEliteSkills,
 int eliteSkillsNumOverride,
 Random random)

addEliteSkills

public static void addEliteSkills(PersonAPI person,
 int num,
 Random random)

pickSkill

public static String pickSkill(PersonAPI person,
 List<String> skills,
 OfficerManagerEvent.SkillPickPreference pref,
 int numSpec,
 Random random)

callEvent

public boolean callEvent(String ruleId,
 InteractionDialogAPI dialog,
 List<Misc.Token> params,
 Map<String,MemoryAPI> memoryMap)

Description copied from interface: CampaignEventPlugin

Called by the CallEvent command (called from rules.csv).

Specified by:

callEvent in interface CallEvent.CallableEvent

Specified by:

callEvent in interface CampaignEventPlugin

Overrides:

callEvent in class BaseEventPlugin

getOfficer

public OfficerManagerEvent.AvailableOfficer getOfficer(String personId)

getAdmin

public OfficerManagerEvent.AvailableOfficer getAdmin(String personId)

reportPlayerMarketTransaction

public void reportPlayerMarketTransaction(PlayerMarketTransaction transaction)

Specified by:

reportPlayerMarketTransaction in interface CampaignEventListener

Specified by:

reportPlayerMarketTransaction in interface ColonyInteractionListener

Overrides:

reportPlayerMarketTransaction in class BaseEventPlugin

reportPlayerOpenedMarketAndCargoUpdated

public void reportPlayerOpenedMarketAndCargoUpdated(MarketAPI market)

Specified by:

reportPlayerOpenedMarketAndCargoUpdated in interface CampaignEventListener

Specified by:

reportPlayerOpenedMarketAndCargoUpdated in interface ColonyInteractionListener

Overrides:

reportPlayerOpenedMarketAndCargoUpdated in class BaseEventPlugin

runWhilePaused

public boolean runWhilePaused()

Specified by:

runWhilePaused in interface EveryFrameScript

Returns:

whether advance() should be called while the campaign engine is paused.

isDone

public boolean isDone()

Specified by:

isDone in interface CampaignEventPlugin

Specified by:

isDone in interface EveryFrameScript

Overrides:

isDone in class BaseEventPlugin

Returns:

true when the script is finished and can be cleaned up by the engine.