com.fs.starfarer.api.campaign.events

Interface CampaignEventManagerAPI

public interface CampaignEventManagerAPI

Method Summary

Modifier and Type	Method and Description
void	endEvent(CampaignEventPlugin event)
int	getNumOngoing(java.lang.String eventType)
CampaignEventPlugin	getOngoingEvent(CampaignEventTarget eventTarget, java.lang.String eventType)
java.util.List<CampaignEventPlugin>	getOngoingEvents()
EventProbabilityAPI	getProbability(java.lang.String eventType, CampaignEventTarget target)
EventProbabilityAPI	getProbability(java.lang.String eventType, LocationAPI eventTargetLocation)
EventProbabilityAPI	getProbability(java.lang.String eventType, MarketAPI market)
EventProbabilityAPI	getProbability(java.lang.String eventType, java.lang.Object custom)
EventProbabilityAPI	getProbability(java.lang.String eventType, SectorEntityToken eventTargetEntity)
boolean	isOngoing(CampaignEventTarget eventTarget, java.lang.String eventType)
boolean	isOngoing(EventProbabilityAPI ep) Whether an event associated with this probability is already ongoing.
CampaignEventPlugin	primeEvent(CampaignEventTarget eventTarget, java.lang.String eventType, java.lang.Object param) Initialize the event plugin, but don't actually start the event.
void	startEvent(CampaignEventPlugin primedEvent) Start an event previously created with primeEvent()
CampaignEventPlugin	startEvent(CampaignEventTarget eventTarget, java.lang.String eventType, java.lang.Object param) Starts an event immediately, bypassing any probability checks.

Method Detail

getProbability

EventProbabilityAPI getProbability(java.lang.String eventType,
                                   SectorEntityToken eventTargetEntity)

getProbability

EventProbabilityAPI getProbability(java.lang.String eventType,
                                   LocationAPI eventTargetLocation)

getProbability

EventProbabilityAPI getProbability(java.lang.String eventType,
                                   CampaignEventTarget target)

getProbability

EventProbabilityAPI getProbability(java.lang.String eventType,
                                   MarketAPI market)

getProbability

EventProbabilityAPI getProbability(java.lang.String eventType,
                                   java.lang.Object custom)

isOngoing

boolean isOngoing(EventProbabilityAPI ep)

Whether an event associated with this probability is already ongoing. Only one event of a given type can occur at a time for a given event target.

Parameters:

ep -

Returns:

isOngoing

boolean isOngoing(CampaignEventTarget eventTarget,
                  java.lang.String eventType)

startEvent

CampaignEventPlugin startEvent(CampaignEventTarget eventTarget,
                               java.lang.String eventType,
                               java.lang.Object param)

Starts an event immediately, bypassing any probability checks. Returns null if failed to start the event because there's already an ongoing event of the same type, or the event plugin otherwise. param gets passed in to the event via CampaignEventPlugin.setParam().

Parameters:

eventTarget - can be null if the event doesn't have a specific target.

eventType -

param -

Returns:

getOngoingEvent

CampaignEventPlugin getOngoingEvent(CampaignEventTarget eventTarget,
                                    java.lang.String eventType)

endEvent

void endEvent(CampaignEventPlugin event)

primeEvent

CampaignEventPlugin primeEvent(CampaignEventTarget eventTarget,
                               java.lang.String eventType,
                               java.lang.Object param)

Initialize the event plugin, but don't actually start the event. Useful if the event is needed for doing token replacement in reports, for example, but it's not desired for the event to start. Will return null if the event can't be created for any reason - for example, if another event of the same type is ongoing for this target and the event doesn't allow multiple ongoing at the same time.

Parameters:

eventTarget -

eventType -

param -

Returns:

startEvent

void startEvent(CampaignEventPlugin primedEvent)

Start an event previously created with primeEvent()

Parameters:

primedEvent -

getNumOngoing

int getNumOngoing(java.lang.String eventType)

getOngoingEvents

java.util.List<CampaignEventPlugin> getOngoingEvents()