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

Class TradeInfoUpdateEvent

java.lang.Object

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

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

All Implemented Interfaces:

CampaignEventListener, CampaignEventPlugin, CallEvent.CallableEvent

public class TradeInfoUpdateEvent
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

Modifier and Type	Field	Description
static org.apache.log4j.Logger	log
static final float	TIMEOUT

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
TradeInfoUpdateEvent()

Method Summary

Modifier and Type	Method	Description
void	advance(float amount)
CampaignEventPlugin.CampaignEventCategory	getEventCategory()
String	getEventName()
CampaignEventTarget	getEventTarget()
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.
protected void	getLocalUpdates(MarketAPI market)
List<CampaignEventPlugin.PriceUpdatePlugin>	getPriceUpdates()
List<String>	getRelatedCommodities()
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	reportPlayerClosedMarket(MarketAPI market)
void	reportPlayerOpenedMarket(MarketAPI market)
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, callEvent, cleanup, findMatchingMarkets, findNearestMarket, getCurrentImage, getCurrentMessageIcon, getDefaultPriority, getEventIcon, getEventType, getId, getLoggingId, getMemory, getStageIdForLikely, getStageIdForPossible, getStatModId, getTargetName, getWarningWhenLikelyPriority, getWarningWhenPossiblePriority, increaseRecentUnrest, init, isEventStarted, reportBattleFinished, reportBattleOccurred, reportEconomyMonthEnd, reportEconomyTick, reportEncounterLootGenerated, reportFleetDespawned, reportFleetJumped, reportFleetReachedEntity, reportFleetSpawned, reportPlayerActivatedAbility, reportPlayerDeactivatedAbility, reportPlayerDidNotTakeCargo, reportPlayerDumpedCargo, reportPlayerEngagement, reportPlayerMarketTransaction, 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 Details

TIMEOUT

public static final float TIMEOUT

See Also:

• Constant Field Values

log

public static org.apache.log4j.Logger log

Constructor Details

TradeInfoUpdateEvent

public TradeInfoUpdateEvent()

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

reportPlayerOpenedMarket

public void reportPlayerOpenedMarket(MarketAPI market)

Specified by:

reportPlayerOpenedMarket in interface CampaignEventListener

Overrides:

reportPlayerOpenedMarket in class BaseEventPlugin

reportPlayerClosedMarket

public void reportPlayerClosedMarket(MarketAPI market)

Specified by:

reportPlayerClosedMarket in interface CampaignEventListener

Overrides:

reportPlayerClosedMarket in class BaseEventPlugin

getLocalUpdates

protected void getLocalUpdates(MarketAPI market)

getPriceUpdates

public List<CampaignEventPlugin.PriceUpdatePlugin> getPriceUpdates()

Specified by:

getPriceUpdates in interface CampaignEventPlugin

Overrides:

getPriceUpdates in class BaseEventPlugin

getRelatedCommodities

public List<String> getRelatedCommodities()

Specified by:

getRelatedCommodities in interface CampaignEventPlugin

Overrides:

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

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:

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:

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

getEventName

public String getEventName()

Specified by:

getEventName in interface CampaignEventPlugin

Overrides:

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