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

Class NearbyEventsEvent

java.lang.Object

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

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

All Implemented Interfaces:

CampaignEventListener, CampaignEventPlugin, RouteManager.RouteFleetSpawner, CallEvent.CallableEvent

public class NearbyEventsEvent
extends BaseEventPlugin
implements RouteManager.RouteFleetSpawner

Author:

Alex Mosolov Copyright 2014 Fractal Softworks, LLC

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	NearbyEventsEvent.DistressEventType
static class	NearbyEventsEvent.NESpawnData

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 float	DERELICT_SKIP_PROB
static float	DERELICT_SKIP_PROB_ABYSS
protected IntervalUtil	derelictShipInterval
static float	DISTRESS_ALREADY_WAS_NEARBY_TIMEOUT
static float	DISTRESS_MAX_CHECK_INTERVAL
static float	DISTRESS_MAX_PROB
static float	DISTRESS_MIN_CHECK_INTERVAL
static float	DISTRESS_MIN_SINCE_PLAYER_IN_SYSTEM
static float	DISTRESS_PROB_PER_SYSTEM
static float	DISTRESS_REPEAT_TIMEOUT
static Set<String>	distressCallAllowedThemes
protected IntervalUtil	distressCallInterval
protected TimeoutTracker<String>	skipForDistressCalls
static boolean	TEST_MODE

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

Method Summary

Modifier and Type	Method	Description
protected void	adjustRep(float repChangePercent, RepLevel limit, FactionAPI faction, PersonAPI person, TextPanelAPI text)
void	advance(float amount)
boolean	callEvent(String ruleId, InteractionDialogAPI dialog, List<Misc.Token> params, Map<String,MemoryAPI> memoryMap)	Called by the CallEvent command (called from rules.csv).
protected void	generateDistressCallAmbush(StarSystemAPI system)
protected void	generateDistressCallAmbushTrap(StarSystemAPI system)
protected void	generateDistressCallNormal(StarSystemAPI system)
protected void	generateDistressDerelictShip(StarSystemAPI system)
CampaignEventPlugin.CampaignEventCategory	getEventCategory()
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.
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()
static void	main(String[] args)
protected void	maybeSpawnDerelictShip()
protected void	maybeSpawnDistressCall()
void	reportAboutToBeDespawnedByRouteManager(RouteManager.RouteData route)
boolean	shouldCancelRouteAfterDelayCheck(RouteManager.RouteData route)
boolean	shouldRepeat(RouteManager.RouteData route)
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.
CampaignFleetAPI	spawnFleet(RouteManager.RouteData route)
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 Details

DISTRESS_REPEAT_TIMEOUT

public static float DISTRESS_REPEAT_TIMEOUT

DISTRESS_ALREADY_WAS_NEARBY_TIMEOUT

public static float DISTRESS_ALREADY_WAS_NEARBY_TIMEOUT

DISTRESS_MIN_SINCE_PLAYER_IN_SYSTEM

public static float DISTRESS_MIN_SINCE_PLAYER_IN_SYSTEM

DISTRESS_MIN_CHECK_INTERVAL

public static float DISTRESS_MIN_CHECK_INTERVAL

DISTRESS_MAX_CHECK_INTERVAL

public static float DISTRESS_MAX_CHECK_INTERVAL

DISTRESS_PROB_PER_SYSTEM

public static float DISTRESS_PROB_PER_SYSTEM

DISTRESS_MAX_PROB

public static float DISTRESS_MAX_PROB

DERELICT_SKIP_PROB

public static float DERELICT_SKIP_PROB

DERELICT_SKIP_PROB_ABYSS

public static float DERELICT_SKIP_PROB_ABYSS

derelictShipInterval

protected IntervalUtil derelictShipInterval

distressCallInterval

protected IntervalUtil distressCallInterval

skipForDistressCalls

protected TimeoutTracker<String> skipForDistressCalls

TEST_MODE

public static boolean TEST_MODE

distressCallAllowedThemes

public static Set<String> distressCallAllowedThemes

Constructor Details

NearbyEventsEvent

public NearbyEventsEvent()

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

maybeSpawnDerelictShip

protected void maybeSpawnDerelictShip()

maybeSpawnDistressCall

protected void maybeSpawnDistressCall()

generateDistressDerelictShip

protected void generateDistressDerelictShip(StarSystemAPI system)

generateDistressCallAmbushTrap

protected void generateDistressCallAmbushTrap(StarSystemAPI system)

generateDistressCallAmbush

protected void generateDistressCallAmbush(StarSystemAPI system)

generateDistressCallNormal

protected void generateDistressCallNormal(StarSystemAPI system)

reportAboutToBeDespawnedByRouteManager

public void reportAboutToBeDespawnedByRouteManager(RouteManager.RouteData route)

Specified by:

reportAboutToBeDespawnedByRouteManager in interface RouteManager.RouteFleetSpawner

shouldCancelRouteAfterDelayCheck

public boolean shouldCancelRouteAfterDelayCheck(RouteManager.RouteData route)

Specified by:

shouldCancelRouteAfterDelayCheck in interface RouteManager.RouteFleetSpawner

shouldRepeat

public boolean shouldRepeat(RouteManager.RouteData route)

Specified by:

shouldRepeat in interface RouteManager.RouteFleetSpawner

spawnFleet

public CampaignFleetAPI spawnFleet(RouteManager.RouteData route)

Specified by:

spawnFleet in interface RouteManager.RouteFleetSpawner

callEvent

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

Description copied from interface: CampaignEventPlugin

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

Specified by:

callEvent in interface CallEvent.CallableEvent

Specified by:

callEvent in interface CampaignEventPlugin

Overrides:

callEvent in class BaseEventPlugin

adjustRep

protected void adjustRep(float repChangePercent,
 RepLevel limit,
 FactionAPI faction,
 PersonAPI person,
 TextPanelAPI text)

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

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:

main

public static void main(String[] args)
                 throws ParseException

Throws:

ParseException