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

Class SystemBountyIntel

java.lang.Object

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

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

All Implemented Interfaces:

IntelInfoPlugin, FleetEventListener, EveryFrameScript, CommRelayEntityPlugin.CommSnifferReadableIntel, CallEvent.CallableEvent

public class SystemBountyIntel
extends BaseIntelPlugin
implements EveryFrameScript, FleetEventListener

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SystemBountyIntel.SystemBountyResult

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 float	baseBounty
protected boolean	commerceMode
protected float	duration
protected float	elapsedDays
protected FactionAPI	enemyFaction
protected FactionAPI	faction
protected SystemBountyIntel.SystemBountyResult	latestResult
protected LocationAPI	location
static org.apache.log4j.Logger	log
protected MarketAPI	market
static float	MAX_DURATION
protected MilitaryResponseScript	script

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
SystemBountyIntel(MarketAPI market)
SystemBountyIntel(MarketAPI market, int baseReward, boolean commerceMode)

Method Summary

Modifier and Type	Method and Description
protected void	addBulletPoints(TooltipMakerAPI info, IntelInfoPlugin.ListInfoMode mode)
protected void	advanceImpl(float amount)
void	createIntelInfo(TooltipMakerAPI info, IntelInfoPlugin.ListInfoMode mode)
void	createSmallDescription(TooltipMakerAPI info, float width, float height)
void	createSmallDescription(TooltipMakerAPI info, float width, float height, boolean forMarketConditionTooltip)
float	getBaseBounty()
float	getDuration()
float	getElapsedDays()
FactionAPI	getFactionForUIColors()
java.lang.String	getIcon() 40x40, no icon if null.
java.util.Set<java.lang.String>	getIntelTags(SectorMapAPI map) Method NEEDS to handle map being null gracefully.
LocationAPI	getLocation()
SectorEntityToken	getMapLocation(SectorMapAPI map)
MarketAPI	getMarket()
java.lang.String	getName()
java.lang.String	getSmallDescriptionTitle()
java.lang.String	getSortString()
float	getTimeRemainingFraction() Should return 0 if the concept doesn't apply.
boolean	isCommerceMode()
protected void	notifyEnding()
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)
void	reportMadeVisibleToPlayer()
void	reset()
boolean	runWhilePaused()
void	setBaseBounty(float baseBounty)
void	setCommerceMode(boolean commerceMode)
void	setDuration(float duration)
void	setElapsedDays(float elapsedDays)

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, getArrowData, 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, isHidden, isImportant, isNew, isPlayerVisible, isSendingUpdate, notifyEnded, notifyPlayerAboutToOpenIntelScreen, 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

log

public static org.apache.log4j.Logger log

MAX_DURATION

public static float MAX_DURATION

market

protected MarketAPI market

location

protected LocationAPI location

elapsedDays

protected float elapsedDays

duration

protected float duration

baseBounty

protected float baseBounty

faction

protected FactionAPI faction

enemyFaction

protected FactionAPI enemyFaction

latestResult

protected SystemBountyIntel.SystemBountyResult latestResult

commerceMode

protected boolean commerceMode

script

protected MilitaryResponseScript script

Constructor Detail

SystemBountyIntel

public SystemBountyIntel(MarketAPI market)

SystemBountyIntel

public SystemBountyIntel(MarketAPI market,
                         int baseReward,
                         boolean commerceMode)

Method Detail

reportMadeVisibleToPlayer

public void reportMadeVisibleToPlayer()

Specified by:

reportMadeVisibleToPlayer in interface IntelInfoPlugin

Overrides:

reportMadeVisibleToPlayer in class BaseIntelPlugin

getElapsedDays

public float getElapsedDays()

setElapsedDays

public void setElapsedDays(float elapsedDays)

reset

public void reset()

getMarket

public MarketAPI getMarket()

advanceImpl

protected void advanceImpl(float amount)

Overrides:

advanceImpl in class BaseIntelPlugin

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

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

createSmallDescription

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

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

getDuration

public float getDuration()

setDuration

public void setDuration(float duration)

getBaseBounty

public float getBaseBounty()

setBaseBounty

public void setBaseBounty(float baseBounty)

isCommerceMode

public boolean isCommerceMode()

setCommerceMode

public void setCommerceMode(boolean commerceMode)

getLocation

public LocationAPI getLocation()