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

Class BaseEventPlugin

java.lang.Object

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

All Implemented Interfaces:

CampaignEventListener, CampaignEventPlugin, CallEvent.CallableEvent

Direct Known Subclasses:

CivilDisorder, FactionHostilityEvent, FleetLogEvent, FoodShortageEvent, InvestigationEvent, InvestigationEventGoodRepWithOther, InvestigationEventSmugglingV2, NearbyEventsEvent, OfficerManagerEvent, RecentUnrestEvent, RepTrackerEvent, TestEvent, TradeInfoUpdateEvent, TutorialMissionEvent

public class BaseEventPlugin
extends Object
implements CampaignEventPlugin, CampaignEventListener

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	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 SectorEntityToken	entity
protected CampaignEventTarget	eventTarget
protected String	eventType
protected FactionAPI	faction
protected MarketAPI	market
protected MemoryAPI	memory
protected boolean	started
protected float	startProbability
protected String	statModId

Constructor Summary

Constructors

Constructor	Description
BaseEventPlugin()

Method Summary

Modifier and Type	Method	Description
static void	addFactionNameTokens(Map<String,String> tokens, String prefix, FactionAPI faction)
static void	addPersonTokens(Map<String,String> tokens, String prefix, PersonAPI person)
void	addTokensToList(List<String> list, String... keys)
void	advance(float amount)
boolean	allowMultipleOngoingForSameTarget()	DO NOT USE, DOES NOT WORK.
boolean	callEvent(String ruleId, InteractionDialogAPI dialog, List<Misc.Token> params, Map<String,MemoryAPI> memoryMap)	Called by the CallEvent command (called from rules.csv).
void	cleanup()	Called when this instance of the event is removed from the event manager (either due to event being over, or due to event probability dropping to 0).
static List<MarketAPI>	findMatchingMarkets(BaseEventPlugin.MarketFilter filter)
static MarketAPI	findNearestMarket(MarketAPI from, BaseEventPlugin.MarketFilter filter)
String	getCurrentImage()	The larger image in the message detail.
String	getCurrentMessageIcon()	Will be called by SectorAPI.reportEventStage().
protected MessagePriority	getDefaultPriority()
CampaignEventPlugin.CampaignEventCategory	getEventCategory()
String	getEventIcon()	Override for the "image" normally specified in events.json.
String	getEventName()
CampaignEventTarget	getEventTarget()
String	getEventType()
Color[]	getHighlightColors(String stageId)	Since multiple reports (possibly from different channels) are possible per stage: 1) All reports must have the highlighted text occur in the same order, which is the order this method returns them in, and 2) Not all highlights have to occur in every report.
String[]	getHighlights(String stageId)	Since multiple reports (possibly from different channels) are possible per stage: 1) All reports must have the highlighted text occur in the same order, which is the order this method returns them in, and 2) Not all highlights have to occur in every report.
String	getId()	Unique ID for this instance of the event.
protected String	getLoggingId()
MemoryAPI	getMemory()
List<CampaignEventPlugin.PriceUpdatePlugin>	getPriceUpdates()
List<String>	getRelatedCommodities()
String	getStageIdForLikely()	event_stage for when the event is likely, but hasn't happened yet.
String	getStageIdForPossible()	event_stage for when the event is possible, but hasn't happened yet.
String	getStatModId()
String	getTargetName()
Map<String,String>	getTokenReplacements()	Token values for filling out descriptions from reports.csv.
MessagePriority	getWarningWhenLikelyPriority()	Message priority for the "event is likely" report.
MessagePriority	getWarningWhenPossiblePriority()	Message priority for the "event is possible" report.
void	increaseRecentUnrest(float stabilityChange)
void	init(String eventType, CampaignEventTarget eventTarget)	Called when the EventProbability for this event is accessed.
void	init(String eventType, CampaignEventTarget eventTarget, boolean addListener)
boolean	isDone()
protected boolean	isEventStarted()
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	setParam(Object param)	Only called when an event is started via CampaignEventManagerAPI.startEvent().
void	setProbability(float p)	The probability that the event had of happening, set right before startEvent() is called.
void	setTarget(CampaignEventTarget eventTarget)
boolean	showAllMessagesIfOngoing()	If true, messages for an ongoing event will be shown in the intel UI even if they don't meet the "last week/month/cycle" criteria.
boolean	showLatestMessageIfOngoing()
void	startEvent()	Called when the event starts.
void	startEvent(boolean addListener)
boolean	useEventNameAsId()

Methods inherited from class java.lang.Object

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

Field Details

eventType

protected String eventType

eventTarget

protected CampaignEventTarget eventTarget

market

protected MarketAPI market

entity

protected SectorEntityToken entity

faction

protected FactionAPI faction

statModId

protected String statModId

started

protected boolean started

memory

protected MemoryAPI memory

startProbability

protected float startProbability

Constructor Details

BaseEventPlugin

public BaseEventPlugin()

Method Details

init

public void init(String eventType,
 CampaignEventTarget eventTarget)

Description copied from interface: CampaignEventPlugin

Called when the EventProbability for this event is accessed. Doesn't mean the event will actually happen.

Specified by:

init in interface CampaignEventPlugin

init

public void init(String eventType,
 CampaignEventTarget eventTarget,
 boolean addListener)

setTarget

public void setTarget(CampaignEventTarget eventTarget)

getLoggingId

protected String getLoggingId()

cleanup

public void cleanup()

Description copied from interface: CampaignEventPlugin

Called when this instance of the event is removed from the event manager (either due to event being over, or due to event probability dropping to 0).

Specified by:

cleanup in interface CampaignEventPlugin

startEvent

public void startEvent()

Description copied from interface: CampaignEventPlugin

Called when the event starts.

Specified by:

startEvent in interface CampaignEventPlugin

startEvent

public void startEvent(boolean addListener)

isEventStarted

protected boolean isEventStarted()

advance

public void advance(float amount)

Specified by:

advance in interface CampaignEventPlugin

getEventTarget

public CampaignEventTarget getEventTarget()

Specified by:

getEventTarget in interface CampaignEventPlugin

getEventType

public String getEventType()

Specified by:

getEventType in interface CampaignEventPlugin

getStageIdForLikely

public String getStageIdForLikely()

Description copied from interface: CampaignEventPlugin

event_stage for when the event is likely, but hasn't happened yet.

Specified by:

getStageIdForLikely in interface CampaignEventPlugin

Returns:

getStageIdForPossible

public String getStageIdForPossible()

Description copied from interface: CampaignEventPlugin

event_stage for when the event is possible, but hasn't happened yet.

Specified by:

getStageIdForPossible in interface CampaignEventPlugin

Returns:

getTokenReplacements

public Map<String,String> getTokenReplacements()

Description copied from interface: CampaignEventPlugin

Token values for filling out descriptions from reports.csv.

Specified by:

getTokenReplacements in interface CampaignEventPlugin

Returns:

addFactionNameTokens

public static void addFactionNameTokens(Map<String,String> tokens,
 String prefix,
 FactionAPI faction)

addPersonTokens

public static void addPersonTokens(Map<String,String> tokens,
 String prefix,
 PersonAPI person)

getWarningWhenLikelyPriority

public MessagePriority getWarningWhenLikelyPriority()

Description copied from interface: CampaignEventPlugin

Message priority for the "event is likely" report.

Specified by:

getWarningWhenLikelyPriority in interface CampaignEventPlugin

Returns:

getWarningWhenPossiblePriority

public MessagePriority getWarningWhenPossiblePriority()

Description copied from interface: CampaignEventPlugin

Message priority for the "event is possible" report.

Specified by:

getWarningWhenPossiblePriority in interface CampaignEventPlugin

Returns:

isDone

public boolean isDone()

Specified by:

isDone in interface CampaignEventPlugin

setParam

public void setParam(Object param)

Description copied from interface: CampaignEventPlugin

Only called when an event is started via CampaignEventManagerAPI.startEvent().

Specified by:

setParam in interface CampaignEventPlugin

getTargetName

public String getTargetName()

findNearestMarket

public static MarketAPI findNearestMarket(MarketAPI from,
 BaseEventPlugin.MarketFilter filter)

findMatchingMarkets

public static List<MarketAPI> findMatchingMarkets(BaseEventPlugin.MarketFilter filter)

increaseRecentUnrest

public void increaseRecentUnrest(float stabilityChange)

reportPlayerMarketTransaction

public void reportPlayerMarketTransaction(PlayerMarketTransaction transaction)

Specified by:

reportPlayerMarketTransaction 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

allowMultipleOngoingForSameTarget

public boolean allowMultipleOngoingForSameTarget()

Description copied from interface: CampaignEventPlugin

DO NOT USE, DOES NOT WORK. Should always return false.

Specified by:

allowMultipleOngoingForSameTarget in interface CampaignEventPlugin

Returns:

getHighlights

public String[] getHighlights(String stageId)

Description copied from interface: CampaignEventPlugin

Since multiple reports (possibly from different channels) are possible per stage: 1) All reports must have the highlighted text occur in the same order, which is the order this method returns them in, and 2) Not all highlights have to occur in every report.

Specified by:

getHighlights in interface CampaignEventPlugin

Returns:

getHighlightColors

public Color[] getHighlightColors(String stageId)

Description copied from interface: CampaignEventPlugin

Since multiple reports (possibly from different channels) are possible per stage: 1) All reports must have the highlighted text occur in the same order, which is the order this method returns them in, and 2) Not all highlights have to occur in every report.

Specified by:

getHighlightColors in interface CampaignEventPlugin

Returns:

addTokensToList

public void addTokensToList(List<String> list,
 String... keys)

getEventName

public String getEventName()

Specified by:

getEventName in interface CampaignEventPlugin

getEventCategory

public CampaignEventPlugin.CampaignEventCategory getEventCategory()

Specified by:

getEventCategory in interface CampaignEventPlugin

getDefaultPriority

protected MessagePriority getDefaultPriority()

getRelatedCommodities

public List<String> getRelatedCommodities()

Specified by:

getRelatedCommodities in interface CampaignEventPlugin

getPriceUpdates

public List<CampaignEventPlugin.PriceUpdatePlugin> getPriceUpdates()

Specified by:

getPriceUpdates in interface CampaignEventPlugin

reportShownInteractionDialog

public void reportShownInteractionDialog(InteractionDialogAPI dialog)

Specified by:

reportShownInteractionDialog in interface CampaignEventListener

reportPlayerOpenedMarket

public void reportPlayerOpenedMarket(MarketAPI market)

Specified by:

reportPlayerOpenedMarket in interface CampaignEventListener

getCurrentMessageIcon

public String getCurrentMessageIcon()

Description copied from interface: CampaignEventPlugin

Will be called by SectorAPI.reportEventStage(). Can change between calls. The priority for icons is: 1) Icon configured in reports.csv for the specific report 2) Return value of this method 3) Event's icon (via getEventIcon() and then from events.json) 4) Channel's icon, if message isn't related to an event or the event has no icon.

Specified by:

getCurrentMessageIcon in interface CampaignEventPlugin

Returns:

getCurrentImage

public String getCurrentImage()

Description copied from interface: CampaignEventPlugin

The larger image in the message detail.

Specified by:

getCurrentImage in interface CampaignEventPlugin

Returns:

getEventIcon

public String getEventIcon()

Description copied from interface: CampaignEventPlugin

Override for the "image" normally specified in events.json. Small.

Specified by:

getEventIcon in interface CampaignEventPlugin

Returns:

showAllMessagesIfOngoing

public boolean showAllMessagesIfOngoing()

Description copied from interface: CampaignEventPlugin

If true, messages for an ongoing event will be shown in the intel UI even if they don't meet the "last week/month/cycle" criteria.

Specified by:

showAllMessagesIfOngoing in interface CampaignEventPlugin

Returns:

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

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

getMemory

public MemoryAPI getMemory()

Specified by:

getMemory in interface CampaignEventPlugin

getId

public String getId()

Description copied from interface: CampaignEventPlugin

Unique ID for this instance of the event.

Specified by:

getId in interface CampaignEventPlugin

Returns:

getStatModId

public String getStatModId()

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

reportBattleFinished

public void reportBattleFinished(CampaignFleetAPI primaryWinner,
 BattleAPI battle)

Specified by:

reportBattleFinished in interface CampaignEventListener

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

setProbability

public void setProbability(float p)

Description copied from interface: CampaignEventPlugin

The probability that the event had of happening, set right before startEvent() is called. Set to 1 by events started using CampaignEventManagerAPI.startEvent().

Specified by:

setProbability in interface CampaignEventPlugin

useEventNameAsId

public boolean useEventNameAsId()

Specified by:

useEventNameAsId in interface CampaignEventPlugin

showLatestMessageIfOngoing

public boolean showLatestMessageIfOngoing()

Specified by:

showLatestMessageIfOngoing in interface CampaignEventPlugin

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