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

Class TestEvent

java.lang.Object

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

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

All Implemented Interfaces:

CampaignEventListener, CampaignEventPlugin, CallEvent.CallableEvent

public class TestEvent
extends BaseEventPlugin

Nested Class Summary

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 inherited from class com.fs.starfarer.api.impl.campaign.events.BaseEventPlugin

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

Constructor Summary

Constructors

Constructor	Description
TestEvent()

Method Summary

Modifier and Type	Method	Description
void	advance(float amount)
boolean	allowMultipleOngoingForSameTarget()	DO NOT USE, DOES NOT WORK.
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).
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	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.
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	init(String type, CampaignEventTarget eventTarget)	Called when the EventProbability for this event is accessed.
boolean	isDone()
void	setParam(Object param)	Only called when an event is started via CampaignEventManagerAPI.startEvent().
void	startEvent()	Called when the event starts.

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

addFactionNameTokens, addPersonTokens, addTokensToList, callEvent, findMatchingMarkets, findNearestMarket, getCurrentImage, getCurrentMessageIcon, getDefaultPriority, getEventCategory, getEventIcon, getEventName, getId, getLoggingId, getMemory, getPriceUpdates, getRelatedCommodities, getStatModId, getTargetName, increaseRecentUnrest, init, isEventStarted, reportBattleFinished, reportBattleOccurred, reportEconomyMonthEnd, reportEconomyTick, reportEncounterLootGenerated, reportFleetDespawned, reportFleetJumped, reportFleetReachedEntity, reportFleetSpawned, reportPlayerActivatedAbility, reportPlayerClosedMarket, reportPlayerDeactivatedAbility, reportPlayerDidNotTakeCargo, reportPlayerDumpedCargo, reportPlayerEngagement, reportPlayerMarketTransaction, reportPlayerOpenedMarket, reportPlayerOpenedMarketAndCargoUpdated, reportPlayerReputationChange, reportPlayerReputationChange, reportShownInteractionDialog, setProbability, setTarget, showAllMessagesIfOngoing, showLatestMessageIfOngoing, startEvent, useEventNameAsId

Methods inherited from class java.lang.Object

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

Constructor Details

TestEvent

public TestEvent()

Method Details

init

public void init(String type,
 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

Overrides:

init in class BaseEventPlugin

startEvent

public void startEvent()

Description copied from interface: CampaignEventPlugin

Called when the event starts.

Specified by:

startEvent in interface CampaignEventPlugin

Overrides:

startEvent in class BaseEventPlugin

advance

public void advance(float amount)

Specified by:

advance in interface CampaignEventPlugin

Overrides:

advance in class BaseEventPlugin

isDone

public boolean isDone()

Specified by:

isDone in interface CampaignEventPlugin

Overrides:

isDone in class BaseEventPlugin

getEventTarget

public CampaignEventTarget getEventTarget()

Specified by:

getEventTarget in interface CampaignEventPlugin

Overrides:

getEventTarget in class BaseEventPlugin

getEventType

public String getEventType()

Specified by:

getEventType in interface CampaignEventPlugin

Overrides:

getEventType in class BaseEventPlugin

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

Overrides:

getTokenReplacements in class BaseEventPlugin

Returns:

getWarningWhenPossiblePriority

public MessagePriority getWarningWhenPossiblePriority()

Description copied from interface: CampaignEventPlugin

Message priority for the "event is possible" report.

Specified by:

getWarningWhenPossiblePriority in interface CampaignEventPlugin

Overrides:

getWarningWhenPossiblePriority in class BaseEventPlugin

Returns:

getWarningWhenLikelyPriority

public MessagePriority getWarningWhenLikelyPriority()

Description copied from interface: CampaignEventPlugin

Message priority for the "event is likely" report.

Specified by:

getWarningWhenLikelyPriority in interface CampaignEventPlugin

Overrides:

getWarningWhenLikelyPriority in class BaseEventPlugin

Returns:

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

Overrides:

getStageIdForLikely in class BaseEventPlugin

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

Overrides:

getStageIdForPossible in class BaseEventPlugin

Returns:

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

Overrides:

cleanup in class BaseEventPlugin

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

Overrides:

setParam in class BaseEventPlugin

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

Overrides:

allowMultipleOngoingForSameTarget in class BaseEventPlugin

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

Overrides:

getHighlightColors in class BaseEventPlugin

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

Overrides:

getHighlights in class BaseEventPlugin

Returns: