com.fs.starfarer.api.impl.campaign.intel.bases

Class PirateBaseIntel

java.lang.Object

com.fs.starfarer.api.impl.campaign.intel.BaseIntelPlugin

com.fs.starfarer.api.impl.campaign.intel.bases.PirateBaseIntel

All Implemented Interfaces:

IntelInfoPlugin, EconomyAPI.EconomyUpdateListener, FleetEventListener, EveryFrameScript, CommRelayEntityPlugin.CommSnifferReadableIntel, RaidIntel.RaidDelegate, CallEvent.CallableEvent

public class PirateBaseIntel
extends BaseIntelPlugin
implements EveryFrameScript, FleetEventListener, EconomyAPI.EconomyUpdateListener, RaidIntel.RaidDelegate

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PirateBaseIntel.BaseBountyData
static class	PirateBaseIntel.PirateBaseTier

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

IntelInfoPlugin.ArrowData, IntelInfoPlugin.IntelSortTier, IntelInfoPlugin.ListInfoMode, IntelInfoPlugin.TableRowClickData

Field Summary

Fields

Modifier and Type	Field and Description
protected CampaignFleetAPI	addedListenerTo
protected PersonAPI	baseCommander
static java.lang.Object	BOUNTY_EXPIRED_PARAM
protected PirateBaseIntel.BaseBountyData	bountyData
static java.lang.Object	DEAL_BROKEN_PARAM
static java.lang.Object	DEAL_CANCELLED_PARAM
static java.lang.Object	DEAL_MADE_PARAM
static java.lang.Object	DISCOVERED_PARAM
protected float	duration
protected float	elapsedDays
protected SectorEntityToken	entity
protected StarSystemAPI	forceTarget
static java.lang.String	HAS_DEAL_WITH_BASE_COMMANDER
static org.apache.log4j.Logger	log
protected MarketAPI	market
protected PirateBaseIntel.PirateBaseTier	matchedStationToTier
static java.lang.String	MEM_FLAG
protected IntervalUtil	monthlyInterval
protected int	monthsAtCurrentTier
protected int	monthsWithSameTarget
static java.lang.String	PIRATE_BASE_COMMANDER
protected int	raidTimeoutMonths
protected PersonBountyIntel.BountyResult	result
protected boolean	sentBountyUpdate
protected StarSystemAPI	system
protected StarSystemAPI	target
protected boolean	targetPlayerColoniesOnly
protected PirateBaseIntel.PirateBaseTier	tier

Fields inherited from class com.fs.starfarer.api.impl.campaign.intel.BaseIntelPlugin

BULLET, BUTTON_DELETE, ended, ending, endingTimeRemaining, forceAdd, hidden, important, INDENT, listInfoParam, neverClicked, postingLocation, postingRangeLY, tagsForSort, timestamp

Fields inherited from interface com.fs.starfarer.api.campaign.comm.IntelInfoPlugin

LIST_ITEM_TEXT_WIDTH, NEW_DAYS

Constructor Summary

Constructors

Constructor and Description
PirateBaseIntel(StarSystemAPI system, java.lang.String factionId, PirateBaseIntel.PirateBaseTier tier)

Method Summary

Modifier and Type	Method and Description
protected void	addBulletPoints(TooltipMakerAPI info, IntelInfoPlugin.ListInfoMode mode)
protected void	advanceImpl(float amount)
boolean	affectsMarket(MarketAPI market)
protected void	checkForTierChange()
protected void	clearTarget()
void	commodityUpdated(java.lang.String commodityId)
void	createIntelInfo(TooltipMakerAPI info, IntelInfoPlugin.ListInfoMode mode)
void	createSmallDescription(TooltipMakerAPI info, float width, float height)
void	economyUpdated()
protected void	endBounty()
protected java.lang.String	generateName()
float	getAccessibilityPenalty()
CampaignFleetAPI	getAddedListenerTo()
java.util.List<MarketAPI>	getAffectedMarkets(StarSystemAPI system)
java.util.List<IntelInfoPlugin.ArrowData>	getArrowData(SectorMapAPI map)
PersonAPI	getBaseCommander()
float	getBaseRaidFP()
SectorEntityToken	getEntity()
FactionAPI	getFactionForUIColors()
StarSystemAPI	getForceTarget()
java.lang.String	getIcon() 40x40, no icon if null.
static PirateBaseIntel	getIntelFor(MarketAPI market)
static PirateBaseIntel	getIntelFor(SectorEntityToken station)
static PirateBaseIntel	getIntelFor(StarSystemAPI system)
java.util.Set<java.lang.String>	getIntelTags(SectorMapAPI map) Method NEEDS to handle map being null gracefully.
SectorEntityToken	getMapLocation(SectorMapAPI map)
MarketAPI	getMarket()
java.lang.String	getName()
protected PirateBaseIntel.PirateBaseTier	getNextTier(PirateBaseIntel.PirateBaseTier tier)
protected PirateBaseIntel.PirateBaseTier	getPrevTier(PirateBaseIntel.PirateBaseTier tier)
float	getRaidFP()
java.lang.String	getSmallDescriptionTitle()
java.lang.String	getSortString()
float	getStabilityPenalty()
protected Industry	getStationIndustry()
StarSystemAPI	getSystem()
StarSystemAPI	getTarget()
PirateBaseIntel.PirateBaseTier	getTier()
float	getTimeRemainingFraction() Should return 0 if the concept doesn't apply.
boolean	isEconomyListenerExpired()
boolean	isHidden() Whether to actually show this piece of intel in the intel screen/show messages or updates for it, despite it being technically known to the player.
boolean	isTargetPlayerColoniesOnly()
void	makeKnown()
void	makeKnown(TextPanelAPI text)
protected void	notifyEnded()
protected void	notifyEnding()
void	notifyRaidEnded(RaidIntel raid, RaidIntel.RaidStageStatus status)
protected java.lang.String	pickPostfix()
protected java.lang.String	pickStationType()
protected StarSystemAPI	pickTarget()
boolean	playerHasDealWithBaseCommander()
void	reportBattleOccurred(CampaignFleetAPI fleet, CampaignFleetAPI primaryWinner, BattleAPI battle) "fleet" will be null if the listener is registered with the ListenerManager, and non-null if the listener is added directly to a fleet.
void	reportFleetDespawnedToListener(CampaignFleetAPI fleet, CampaignEventListener.FleetDespawnReason reason, java.lang.Object param)
boolean	runWhilePaused()
void	setBaseCommander(PersonAPI baseCommander)
protected void	setBounty()
void	setForceTarget(StarSystemAPI forceTarget)
void	setPlayerHasDealWithBaseCommander(boolean hasDeal)
void	setTargetPlayerColoniesOnly(boolean targetPlayerColonies)
void	startRaid(StarSystemAPI target, float raidFP)
protected void	updateStationIfNeeded()
void	updateTarget()

Methods inherited from class com.fs.starfarer.api.impl.campaign.intel.BaseIntelPlugin

addBulletPoints, addDays, addDays, addDays, addDays, addDeleteButton, addDeleteButton, addGenericButton, addGenericButton, addLogTimestamp, addMarketTable, addMarketToList, addMarketToList, advance, autoAddCampaignMessage, bullet, buttonPressCancelled, buttonPressConfirmed, callEvent, canMakeVisible, canMakeVisibleToCommSniffer, canMakeVisibleToPlayer, canTurnImportantOff, createConfirmationPrompt, createDeleteConfirmationPrompt, createLargeDescription, doesButtonHaveConfirmDialog, endAfterDelay, endAfterDelay, endImmediately, forceAddNextFrame, getBackgroundGlowColor, getBaseDaysAfterEnd, getBulletColorForMode, getButtonStoryPointActionDelegate, getCancelText, getCircleBorderColorOverride, getCommMessageSound, getCommRelayRange, getConfirmationPromptWidth, getConfirmText, getDays, getDaysSincePlayerVisible, getDaysString, getImportantIcon, getListInfoParam, getPlayerVisibleTimestamp, getPostingLocation, getPostingRangeLY, getSortStringNewestFirst, getSortStringNewestFirst, getSortTier, getSoundColonyThreat, getSoundLogUpdate, getSoundMajorPosting, getSoundMinorMessage, getSoundStandardPosting, getSoundStandardUpdate, getTagsForSort, getTitleColor, hasImportantButton, hasLargeDescription, hasSmallDescription, indent, isDone, isEnded, isEnding, isImportant, isNew, isPlayerVisible, isSendingUpdate, notifyPlayerAboutToOpenIntelScreen, reportMadeVisibleToPlayer, reportPlayerClickedOn, reportRemovedIntel, sendUpdate, sendUpdateIfPlayerHasIntel, sendUpdateIfPlayerHasIntel, sendUpdateIfPlayerHasIntel, setForceAddNextFrame, setHidden, setImportant, setListInfoParam, setNew, setPlayerVisibleTimestamp, setPostingLocation, setPostingRangeLY, setPostingRangeLY, setTagsForSort, shouldRemoveIntel, storyActionConfirmed, tableRowClicked, unindent

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.fs.starfarer.api.EveryFrameScript

advance, isDone

Field Detail

PIRATE_BASE_COMMANDER

public static final java.lang.String PIRATE_BASE_COMMANDER

See Also:

Constant Field Values

HAS_DEAL_WITH_BASE_COMMANDER

public static final java.lang.String HAS_DEAL_WITH_BASE_COMMANDER

See Also:

Constant Field Values

MEM_FLAG

public static java.lang.String MEM_FLAG

DEAL_MADE_PARAM

public static java.lang.Object DEAL_MADE_PARAM

DEAL_BROKEN_PARAM

public static java.lang.Object DEAL_BROKEN_PARAM

DEAL_CANCELLED_PARAM

public static java.lang.Object DEAL_CANCELLED_PARAM

BOUNTY_EXPIRED_PARAM

public static java.lang.Object BOUNTY_EXPIRED_PARAM

DISCOVERED_PARAM

public static java.lang.Object DISCOVERED_PARAM

log

public static org.apache.log4j.Logger log

system

protected StarSystemAPI system

market

protected MarketAPI market

baseCommander

protected PersonAPI baseCommander

entity

protected SectorEntityToken entity

elapsedDays

protected float elapsedDays

duration

protected float duration

bountyData

protected PirateBaseIntel.BaseBountyData bountyData

tier

protected PirateBaseIntel.PirateBaseTier tier

matchedStationToTier

protected PirateBaseIntel.PirateBaseTier matchedStationToTier

monthlyInterval

protected IntervalUtil monthlyInterval

raidTimeoutMonths

protected int raidTimeoutMonths

addedListenerTo

protected CampaignFleetAPI addedListenerTo

result

protected PersonBountyIntel.BountyResult result

sentBountyUpdate

protected boolean sentBountyUpdate

monthsWithSameTarget

protected int monthsWithSameTarget

monthsAtCurrentTier

protected int monthsAtCurrentTier

target

protected StarSystemAPI target

targetPlayerColoniesOnly

protected boolean targetPlayerColoniesOnly

forceTarget

protected StarSystemAPI forceTarget

Constructor Detail

PirateBaseIntel

public PirateBaseIntel(StarSystemAPI system,
                       java.lang.String factionId,
                       PirateBaseIntel.PirateBaseTier tier)

Method Detail

getIntelFor

public static PirateBaseIntel getIntelFor(StarSystemAPI system)

getIntelFor

public static PirateBaseIntel getIntelFor(SectorEntityToken station)

getIntelFor

public static PirateBaseIntel getIntelFor(MarketAPI market)

playerHasDealWithBaseCommander

public boolean playerHasDealWithBaseCommander()

setPlayerHasDealWithBaseCommander

public void setPlayerHasDealWithBaseCommander(boolean hasDeal)

isHidden

public boolean isHidden()

Description copied from interface: IntelInfoPlugin

Whether to actually show this piece of intel in the intel screen/show messages or updates for it, despite it being technically known to the player. Something can have "reportMadeVisibleToPlayer" called on it but still be hidden.

Specified by:

isHidden in interface IntelInfoPlugin

Overrides:

isHidden in class BaseIntelPlugin

Returns:

getRaidFP

public float getRaidFP()

getBaseRaidFP

public float getBaseRaidFP()

notifyRaidEnded

public void notifyRaidEnded(RaidIntel raid,
                            RaidIntel.RaidStageStatus status)

Specified by:

notifyRaidEnded in interface RaidIntel.RaidDelegate

startRaid

public void startRaid(StarSystemAPI target,
                      float raidFP)

getSystem

public StarSystemAPI getSystem()

pickStationType

protected java.lang.String pickStationType()

getStationIndustry

protected Industry getStationIndustry()

updateStationIfNeeded

protected void updateStationIfNeeded()

getAddedListenerTo

public CampaignFleetAPI getAddedListenerTo()

advanceImpl

protected void advanceImpl(float amount)

Overrides:

advanceImpl in class BaseIntelPlugin

checkForTierChange

protected void checkForTierChange()

getNextTier

protected PirateBaseIntel.PirateBaseTier getNextTier(PirateBaseIntel.PirateBaseTier tier)

getPrevTier

protected PirateBaseIntel.PirateBaseTier getPrevTier(PirateBaseIntel.PirateBaseTier tier)

makeKnown

public void makeKnown()

makeKnown

public void makeKnown(TextPanelAPI text)

getTimeRemainingFraction

public float getTimeRemainingFraction()

Description copied from interface: IntelInfoPlugin

Should return 0 if the concept doesn't apply.

Specified by:

getTimeRemainingFraction in interface IntelInfoPlugin

Overrides:

getTimeRemainingFraction in class BaseIntelPlugin

Returns:

notifyEnding

protected void notifyEnding()

Overrides:

notifyEnding in class BaseIntelPlugin

notifyEnded

protected void notifyEnded()

Overrides:

notifyEnded in class BaseIntelPlugin

reportFleetDespawnedToListener

public void reportFleetDespawnedToListener(CampaignFleetAPI fleet,
                                           CampaignEventListener.FleetDespawnReason reason,
                                           java.lang.Object param)

Specified by:

reportFleetDespawnedToListener in interface FleetEventListener

reportBattleOccurred

public void reportBattleOccurred(CampaignFleetAPI fleet,
                                 CampaignFleetAPI primaryWinner,
                                 BattleAPI battle)

Description copied from interface: FleetEventListener

"fleet" will be null if the listener is registered with the ListenerManager, and non-null if the listener is added directly to a fleet.

Specified by:

reportBattleOccurred in interface FleetEventListener

runWhilePaused

public boolean runWhilePaused()

Specified by:

runWhilePaused in interface EveryFrameScript

Overrides:

runWhilePaused in class BaseIntelPlugin

Returns:

whether advance() should be called while the campaign engine is paused.

addBulletPoints

protected void addBulletPoints(TooltipMakerAPI info,
                               IntelInfoPlugin.ListInfoMode mode)

Overrides:

addBulletPoints in class BaseIntelPlugin

createIntelInfo

public void createIntelInfo(TooltipMakerAPI info,
                            IntelInfoPlugin.ListInfoMode mode)

Specified by:

createIntelInfo in interface IntelInfoPlugin

Overrides:

createIntelInfo in class BaseIntelPlugin

getSortString

public java.lang.String getSortString()

Specified by:

getSortString in interface IntelInfoPlugin

Overrides:

getSortString in class BaseIntelPlugin

getName

public java.lang.String getName()

Overrides:

getName in class BaseIntelPlugin

getFactionForUIColors

public FactionAPI getFactionForUIColors()

Specified by:

getFactionForUIColors in interface IntelInfoPlugin

Overrides:

getFactionForUIColors in class BaseIntelPlugin

getSmallDescriptionTitle

public java.lang.String getSmallDescriptionTitle()

Specified by:

getSmallDescriptionTitle in interface IntelInfoPlugin

Overrides:

getSmallDescriptionTitle in class BaseIntelPlugin

createSmallDescription

public void createSmallDescription(TooltipMakerAPI info,
                                   float width,
                                   float height)

Specified by:

createSmallDescription in interface IntelInfoPlugin

Overrides:

createSmallDescription in class BaseIntelPlugin

getIcon

public java.lang.String getIcon()

Description copied from interface: IntelInfoPlugin

40x40, no icon if null.

Specified by:

getIcon in interface IntelInfoPlugin

Overrides:

getIcon in class BaseIntelPlugin

Returns:

getIntelTags

public java.util.Set<java.lang.String> getIntelTags(SectorMapAPI map)

Description copied from interface: IntelInfoPlugin

Method NEEDS to handle map being null gracefully.

Specified by:

getIntelTags in interface IntelInfoPlugin

Overrides:

getIntelTags in class BaseIntelPlugin

Returns:

getMapLocation

public SectorEntityToken getMapLocation(SectorMapAPI map)

Specified by:

getMapLocation in interface IntelInfoPlugin

Overrides:

getMapLocation in class BaseIntelPlugin

generateName

protected java.lang.String generateName()

pickPostfix

protected java.lang.String pickPostfix()

commodityUpdated

public void commodityUpdated(java.lang.String commodityId)

Specified by:

commodityUpdated in interface EconomyAPI.EconomyUpdateListener

economyUpdated

public void economyUpdated()

Specified by:

economyUpdated in interface EconomyAPI.EconomyUpdateListener

isEconomyListenerExpired

public boolean isEconomyListenerExpired()

Specified by:

isEconomyListenerExpired in interface EconomyAPI.EconomyUpdateListener

getMarket

public MarketAPI getMarket()

setBounty

protected void setBounty()

endBounty

protected void endBounty()

updateTarget

public void updateTarget()

getTarget

public StarSystemAPI getTarget()

clearTarget

protected void clearTarget()

getAffectedMarkets

public java.util.List<MarketAPI> getAffectedMarkets(StarSystemAPI system)

affectsMarket

public boolean affectsMarket(MarketAPI market)

setTargetPlayerColoniesOnly

public void setTargetPlayerColoniesOnly(boolean targetPlayerColonies)

isTargetPlayerColoniesOnly

public boolean isTargetPlayerColoniesOnly()

getForceTarget

public StarSystemAPI getForceTarget()

setForceTarget

public void setForceTarget(StarSystemAPI forceTarget)

pickTarget

protected StarSystemAPI pickTarget()

getArrowData

public java.util.List<IntelInfoPlugin.ArrowData> getArrowData(SectorMapAPI map)

Specified by:

getArrowData in interface IntelInfoPlugin

Overrides:

getArrowData in class BaseIntelPlugin

getAccessibilityPenalty

public float getAccessibilityPenalty()

getStabilityPenalty

public float getStabilityPenalty()

getTier

public PirateBaseIntel.PirateBaseTier getTier()

getEntity

public SectorEntityToken getEntity()

getBaseCommander

public PersonAPI getBaseCommander()

setBaseCommander

public void setBaseCommander(PersonAPI baseCommander)