com.fs.starfarer.api.campaign.events

Interface CampaignEventPlugin

All Superinterfaces:

CallEvent.CallableEvent

All Known Implementing Classes:

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

public interface CampaignEventPlugin
extends CallEvent.CallableEvent

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CampaignEventPlugin.CampaignEventCategory
static interface	CampaignEventPlugin.PriceUpdatePlugin

Method Summary

Methods

Modifier and Type	Method and Description
void	advance(float amount)
boolean	allowMultipleOngoingForSameTarget() Deprecated.
boolean	callEvent(java.lang.String ruleId, InteractionDialogAPI dialog, java.util.List<Misc.Token> params, java.util.Map<java.lang.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).
java.lang.String	getCurrentImage() The larger image in the message detail.
java.lang.String	getCurrentMessageIcon() Will be called by SectorAPI.reportEventStage().
CampaignEventPlugin.CampaignEventCategory	getEventCategory()
java.lang.String	getEventIcon() Override for the "image" normally specified in events.json.
java.lang.String	getEventName()
CampaignEventTarget	getEventTarget()
java.lang.String	getEventType()
java.awt.Color[]	getHighlightColors(java.lang.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.
java.lang.String[]	getHighlights(java.lang.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.
java.lang.String	getId() Unique ID for this instance of the event.
MemoryAPI	getMemory()
java.util.List<CampaignEventPlugin.PriceUpdatePlugin>	getPriceUpdates()
java.util.List<java.lang.String>	getRelatedCommodities()
java.lang.String	getStageIdForLikely() event_stage for when the event is likely, but hasn't happened yet.
java.lang.String	getStageIdForPossible() event_stage for when the event is possible, but hasn't happened yet.
java.util.Map<java.lang.String,java.lang.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	init(java.lang.String eventType, CampaignEventTarget eventTarget) Called when the EventProbability for this event is accessed.
boolean	isDone()
void	setParam(java.lang.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.
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.
boolean	useEventNameAsId()

Method Detail

getId

java.lang.String getId()

Unique ID for this instance of the event.

Returns:

init

void init(java.lang.String eventType,
        CampaignEventTarget eventTarget)

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

Parameters:

eventType -

eventTarget -

cleanup

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).

setProbability

void setProbability(float p)

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

Parameters:

p -

startEvent

void startEvent()

Called when the event starts.

advance

void advance(float amount)

isDone

boolean isDone()

getEventTarget

CampaignEventTarget getEventTarget()

getEventType

java.lang.String getEventType()

getTokenReplacements

java.util.Map<java.lang.String,java.lang.String> getTokenReplacements()

Token values for filling out descriptions from reports.csv.

Returns:

getHighlights

java.lang.String[] getHighlights(java.lang.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.

Parameters:

stageId -

Returns:

getHighlightColors

java.awt.Color[] getHighlightColors(java.lang.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.

Parameters:

stageId -

Returns:

getStageIdForPossible

java.lang.String getStageIdForPossible()

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

Returns:

getWarningWhenPossiblePriority

MessagePriority getWarningWhenPossiblePriority()

Message priority for the "event is possible" report.

Returns:

getStageIdForLikely

java.lang.String getStageIdForLikely()

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

Returns:

getWarningWhenLikelyPriority

MessagePriority getWarningWhenLikelyPriority()

Message priority for the "event is likely" report.

Returns:

setParam

void setParam(java.lang.Object param)

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

Parameters:

param -

allowMultipleOngoingForSameTarget

@Deprecated
boolean allowMultipleOngoingForSameTarget()

Deprecated.

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

Returns:

getEventName

java.lang.String getEventName()

useEventNameAsId

boolean useEventNameAsId()

getEventCategory

CampaignEventPlugin.CampaignEventCategory getEventCategory()

getRelatedCommodities

java.util.List<java.lang.String> getRelatedCommodities()

getPriceUpdates

java.util.List<CampaignEventPlugin.PriceUpdatePlugin> getPriceUpdates()

getCurrentMessageIcon

java.lang.String getCurrentMessageIcon()

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.

Returns:

getCurrentImage

java.lang.String getCurrentImage()

The larger image in the message detail.

Returns:

getEventIcon

java.lang.String getEventIcon()

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

Returns:

showAllMessagesIfOngoing

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.

Returns:

callEvent

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

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

Specified by:

callEvent in interface CallEvent.CallableEvent

Parameters:

memoryMap -

params -

getMemory

MemoryAPI getMemory()

showLatestMessageIfOngoing

boolean showLatestMessageIfOngoing()