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

Class FleetLogEvent

java.lang.Object

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

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

All Implemented Interfaces:

CampaignEventListener, CampaignEventPlugin, CallEvent.CallableEvent

public class FleetLogEvent
extends BaseEventPlugin

NOT ACTUALLY USED - see FleetLog.java instead.

Author:

Alex Mosolov Copyright 2014 Fractal Softworks, LLC

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.events.CampaignEventPlugin

CampaignEventPlugin.CampaignEventCategory, CampaignEventPlugin.PriceUpdatePlugin

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

CampaignEventListener.FleetDespawnReason

Field Summary

Fields

Modifier and Type	Field and Description
static Logger	log

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 and Description
FleetLogEvent()

Method Summary

Methods

Modifier and Type	Method and Description
void	advance(float amount)
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).
CampaignEventPlugin.CampaignEventCategory	getEventCategory()
CampaignEventTarget	getEventTarget()
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.util.Map<java.lang.String,java.lang.String>	getTokenReplacements() Token values for filling out descriptions from reports.csv.
void	init(java.lang.String type, CampaignEventTarget eventTarget) Called when the EventProbability for this event is accessed.
boolean	isDone()
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.
void	startEvent() Called when the event starts.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

log

public static Logger log

Constructor Detail

FleetLogEvent

public FleetLogEvent()

Method Detail

init

public void init(java.lang.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

callEvent

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

Description copied from interface: CampaignEventPlugin

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

Specified by:

callEvent in interface CampaignEventPlugin

Specified by:

callEvent in interface CallEvent.CallableEvent

Overrides:

callEvent in class BaseEventPlugin

getTokenReplacements

public java.util.Map<java.lang.String,java.lang.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:

getHighlights

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

getHighlightColors

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

getEventTarget

public CampaignEventTarget getEventTarget()

Specified by:

getEventTarget in interface CampaignEventPlugin

Overrides:

getEventTarget in class BaseEventPlugin

isDone

public boolean isDone()

Specified by:

isDone in interface CampaignEventPlugin

Overrides:

isDone in class BaseEventPlugin

getEventCategory

public CampaignEventPlugin.CampaignEventCategory getEventCategory()

Specified by:

getEventCategory in interface CampaignEventPlugin

Overrides:

getEventCategory in class BaseEventPlugin

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

Overrides:

showAllMessagesIfOngoing in class BaseEventPlugin

Returns: