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

Class InvestigationEvent

java.lang.Object

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

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

All Implemented Interfaces:

CampaignEventListener, CampaignEventPlugin, CallEvent.CallableEvent

Direct Known Subclasses:

InvestigationEventCommSniffer

public class InvestigationEvent
extends BaseEventPlugin

Should only be used if started directly (not via probability), as that's the only way the investigation parameters can be set. If using event probability, should subclass this for a new event instead, and set the parameters in startEvent() of the subclass. See SmugglingInvestigationEvent as example.

Author:

Alex Mosolov Copyright 2014 Fractal Softworks, LLC

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InvestigationEvent.InvestigationEventParams
static class	InvestigationEvent.InvestigationResult

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

Modifier and Type	Field	Description
static org.apache.log4j.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	Description
InvestigationEvent()

Method Summary

Modifier and Type	Method	Description
void	advance(float amount)
protected void	endEvent()
String	getEventName()
static float	getPlayerRepGuiltMult(FactionAPI faction)
Map<String,String>	getTokenReplacements()	Token values for filling out descriptions from reports.csv.
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, allowMultipleOngoingForSameTarget, callEvent, cleanup, findMatchingMarkets, findNearestMarket, getCurrentImage, getCurrentMessageIcon, getDefaultPriority, getEventCategory, getEventIcon, getEventTarget, getEventType, getHighlightColors, getHighlights, 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, setProbability, setTarget, showAllMessagesIfOngoing, showLatestMessageIfOngoing, startEvent, useEventNameAsId

Methods inherited from class java.lang.Object

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

Field Details

log

public static org.apache.log4j.Logger log

Constructor Details

InvestigationEvent

public InvestigationEvent()

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

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

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

getEventName

public String getEventName()

Specified by:

getEventName in interface CampaignEventPlugin

Overrides:

getEventName 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:

endEvent

protected void endEvent()

isDone

public boolean isDone()

Specified by:

isDone in interface CampaignEventPlugin

Overrides:

isDone in class BaseEventPlugin

getPlayerRepGuiltMult

public static float getPlayerRepGuiltMult(FactionAPI faction)