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

Class FactionHostilityEvent

java.lang.Object

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

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

All Implemented Interfaces:

CampaignEventListener, CampaignEventPlugin, CallEvent.CallableEvent

public class FactionHostilityEvent
extends BaseEventPlugin

Author:

Alex Mosolov Copyright 2015 Fractal Softworks, LLC

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FactionHostilityEvent.FactionHostilityPairKey

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
protected float	duration
protected float	elapsedDays
protected boolean	ended
static final float	HOSTILITY_PENALTY
static org.apache.log4j.Logger	log
protected FactionAPI	one
protected float	prevRel
protected float	prevRelOne
protected float	prevRelTwo
protected FactionHostilityEvent.FactionHostilityPairKey	target
protected FactionAPI	two

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

Method Summary

Modifier and Type	Method	Description
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	endEvent()
String	getEventName()
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()
void	startEvent()	Called when the event starts.
protected void	startHostilities()

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

addFactionNameTokens, addPersonTokens, addTokensToList, allowMultipleOngoingForSameTarget, cleanup, findMatchingMarkets, findNearestMarket, getCurrentImage, getCurrentMessageIcon, getDefaultPriority, getEventCategory, getEventIcon, getEventTarget, getEventType, getHighlightColors, 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, showAllMessagesIfOngoing, showLatestMessageIfOngoing, startEvent, useEventNameAsId

Methods inherited from class java.lang.Object

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

Field Details

HOSTILITY_PENALTY

public static final float HOSTILITY_PENALTY

See Also:

• Constant Field Values

log

public static org.apache.log4j.Logger log

elapsedDays

protected float elapsedDays

duration

protected float duration

target

protected FactionHostilityEvent.FactionHostilityPairKey target

one

protected FactionAPI one

two

protected FactionAPI two

ended

protected boolean ended

prevRel

protected float prevRel

prevRelOne

protected float prevRelOne

prevRelTwo

protected float prevRelTwo

Constructor Details

FactionHostilityEvent

public FactionHostilityEvent()

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

startHostilities

protected void startHostilities()

advance

public void advance(float amount)

Specified by:

advance in interface CampaignEventPlugin

Overrides:

advance in class BaseEventPlugin

endEvent

protected void endEvent()

getEventName

public String getEventName()

Specified by:

getEventName in interface CampaignEventPlugin

Overrides:

getEventName in class BaseEventPlugin

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

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:

isDone

public boolean isDone()

Specified by:

isDone in interface CampaignEventPlugin

Overrides:

isDone in class BaseEventPlugin