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 and Description
static float	DEFAULT_DURATION
static java.lang.Object	DISCOVERED_PARAM
protected java.lang.Float	duration
protected java.lang.String	icon
protected java.lang.String	iconId
protected java.lang.Boolean	keepExploredDebrisField
protected java.lang.Boolean	removeSurveyedPlanet
protected SectorEntityToken	removeTrigger
protected java.lang.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 and Description
FleetLogIntel()
FleetLogIntel(float duration)

Method Summary

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

DISCOVERED_PARAM

public static java.lang.Object DISCOVERED_PARAM

DEFAULT_DURATION

public static float DEFAULT_DURATION

duration

protected java.lang.Float duration

removeTrigger

protected SectorEntityToken removeTrigger

keepExploredDebrisField

protected java.lang.Boolean keepExploredDebrisField

removeSurveyedPlanet

protected java.lang.Boolean removeSurveyedPlanet

icon

protected java.lang.String icon

iconId

protected java.lang.String iconId

sound

protected java.lang.String sound

Constructor Detail

FleetLogIntel

public FleetLogIntel()

FleetLogIntel

public FleetLogIntel(float duration)

Method Detail

setDefaultExpiration

public void setDefaultExpiration()

setDuration

public void setDuration(float days)

getSortString

public java.lang.String getSortString()

Specified by:

getSortString in interface IntelInfoPlugin

Overrides:

getSortString in class BaseIntelPlugin

getKeepExploredDebrisField

public java.lang.Boolean getKeepExploredDebrisField()

setKeepExploredDebrisField

public void setKeepExploredDebrisField(java.lang.Boolean keepExploredDebrisField)

getRemoveSurveyedPlanet

public java.lang.Boolean getRemoveSurveyedPlanet()

setRemoveSurveyedPlanet

public void setRemoveSurveyedPlanet(java.lang.Boolean removeSurveyedPlanet)

shouldRemoveIntel

public boolean shouldRemoveIntel()

Specified by:

shouldRemoveIntel in interface IntelInfoPlugin

Overrides:

shouldRemoveIntel in class BaseIntelPlugin

getIconId

public java.lang.String getIconId()

setIconId

public void setIconId(java.lang.String iconId)

setIcon

public void setIcon(java.lang.String icon)

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:

getRemoveTrigger

public SectorEntityToken getRemoveTrigger()

setRemoveTrigger

public void setRemoveTrigger(SectorEntityToken removeTrigger)

getSound

public java.lang.String getSound()

setSound

public void setSound(java.lang.String sound)

getCommMessageSound

public java.lang.String getCommMessageSound()

Specified by:

getCommMessageSound in interface IntelInfoPlugin

Overrides:

getCommMessageSound in class BaseIntelPlugin