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

Class FleetLogIntel

java.lang.Object

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

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

All Implemented Interfaces:

IntelInfoPlugin, EveryFrameScript, CommRelayEntityPlugin.CommSnifferReadableIntel, CallEvent.CallableEvent

Direct Known Subclasses:

BreadcrumbIntel, BreadcrumbIntelV2, CargoPodsIntel, CodexUpdateIntel, MapMarkerIntel, ProductionReportIntel, RemoteSurveyDataForPlanetIntel, SimUpdateIntel, SurveyDataForPlanetIntel

public class FleetLogIntel
extends BaseIntelPlugin

Implements EveryFrameScript because of deriving from BaseIntelPlugin, but not actually expected to be added as a script to anything unless that's necessary for the specific subclass. Copyright 2018 Fractal Softworks, LLC

Nested Class Summary

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	Description
static float	DEFAULT_DURATION
static Object	DISCOVERED_PARAM
protected Float	duration
protected String	icon
protected String	iconId
protected Boolean	keepExploredDebrisField
protected Boolean	removeSurveyedPlanet
protected SectorEntityToken	removeTrigger
protected String	sound

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	Description
FleetLogIntel()
FleetLogIntel(float duration)

Method Summary

Modifier and Type	Method	Description
String	getCommMessageSound()
String	getIcon()	40x40, no icon if null.
String	getIconId()
Set<String>	getIntelTags(SectorMapAPI map)	Method NEEDS to handle map being null gracefully.
Boolean	getKeepExploredDebrisField()
Boolean	getRemoveSurveyedPlanet()
SectorEntityToken	getRemoveTrigger()
String	getSortString()
String	getSound()
void	setDefaultExpiration()
void	setDuration(float days)
void	setIcon(String icon)
void	setIconId(String iconId)
void	setKeepExploredDebrisField(Boolean keepExploredDebrisField)
void	setRemoveSurveyedPlanet(Boolean removeSurveyedPlanet)
void	setRemoveTrigger(SectorEntityToken removeTrigger)
void	setSound(String sound)
boolean	shouldRemoveIntel()

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

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

Methods inherited from class java.lang.Object

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

Field Details

DISCOVERED_PARAM

public static Object DISCOVERED_PARAM

DEFAULT_DURATION

public static float DEFAULT_DURATION

duration

protected Float duration

removeTrigger

protected SectorEntityToken removeTrigger

keepExploredDebrisField

protected Boolean keepExploredDebrisField

removeSurveyedPlanet

protected Boolean removeSurveyedPlanet

icon

protected String icon

iconId

protected String iconId

sound

protected String sound

Constructor Details

FleetLogIntel

public FleetLogIntel()

FleetLogIntel

public FleetLogIntel(float duration)

Method Details

setDefaultExpiration

public void setDefaultExpiration()

setDuration

public void setDuration(float days)

getSortString

public String getSortString()

Specified by:

getSortString in interface IntelInfoPlugin

Overrides:

getSortString in class BaseIntelPlugin

getKeepExploredDebrisField

public Boolean getKeepExploredDebrisField()

setKeepExploredDebrisField

public void setKeepExploredDebrisField(Boolean keepExploredDebrisField)

getRemoveSurveyedPlanet

public Boolean getRemoveSurveyedPlanet()

setRemoveSurveyedPlanet

public void setRemoveSurveyedPlanet(Boolean removeSurveyedPlanet)

shouldRemoveIntel

public boolean shouldRemoveIntel()

Specified by:

shouldRemoveIntel in interface IntelInfoPlugin

Overrides:

shouldRemoveIntel in class BaseIntelPlugin

getIconId

public String getIconId()

setIconId

public void setIconId(String iconId)

setIcon

public void setIcon(String icon)

getIcon

public 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 Set<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:

getRemoveTrigger

public SectorEntityToken getRemoveTrigger()

setRemoveTrigger

public void setRemoveTrigger(SectorEntityToken removeTrigger)

getSound

public String getSound()

setSound

public void setSound(String sound)

getCommMessageSound

public String getCommMessageSound()

Specified by:

getCommMessageSound in interface IntelInfoPlugin

Overrides:

getCommMessageSound in class BaseIntelPlugin