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

Class MapMarkerIntel

java.lang.Object

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

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

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

All Implemented Interfaces:

IntelInfoPlugin, EveryFrameScript, CommRelayEntityPlugin.CommSnifferReadableIntel, CallEvent.CallableEvent

Direct Known Subclasses:

CryosleeperIntel, HypershuntIntel, RemnantNexusIntel, WormholeIntel

public class MapMarkerIntel
extends FleetLogIntel

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 java.lang.String	BUTTON_EDIT
protected SectorEntityToken	copy
protected java.lang.String	discoveredPrefixOverride
protected SectorEntityToken	entity
protected java.lang.String	text
protected java.lang.String	title

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

DEFAULT_DURATION, DISCOVERED_PARAM, duration, icon, iconId, keepExploredDebrisField, removeSurveyedPlanet, removeTrigger, 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
MapMarkerIntel()
MapMarkerIntel(SectorEntityToken entity, java.lang.String title, java.lang.String text, java.lang.String icon, boolean withDesc)

Method Summary

Modifier and Type	Method and Description
protected void	addBulletPoints(TooltipMakerAPI info, IntelInfoPlugin.ListInfoMode mode)
protected void	addCustomDescription(TooltipMakerAPI info, float width, float height)
protected void	addCustomVisual(TooltipMakerAPI info, float width, float height)
protected void	addExtraBulletPoints(TooltipMakerAPI info, java.awt.Color tc, float initPad, IntelInfoPlugin.ListInfoMode mode)
protected void	addPostDescriptionSection(TooltipMakerAPI info, float width, float height, float opad)
void	buttonPressConfirmed(java.lang.Object buttonId, IntelUIAPI ui)
void	createIntelInfo(TooltipMakerAPI info, IntelInfoPlugin.ListInfoMode mode)
void	createSmallDescription(TooltipMakerAPI info, float width, float height)
boolean	doesButtonHaveConfirmDialog(java.lang.Object buttonId)
protected boolean	endsInPunct(java.lang.String str, boolean forBulletPoint)
java.lang.String	getDiscoveredPrefixOverride()
SectorEntityToken	getEntity()
FactionAPI	getFactionForUIColors()
java.util.Set<java.lang.String>	getIntelTags(SectorMapAPI map) Method NEEDS to handle map being null gracefully.
SectorEntityToken	getMapLocation(SectorMapAPI map)
java.lang.String	getName()
java.lang.String	getSmallDescriptionTitle()
java.lang.String	getSortString()
java.lang.String	getText()
java.lang.String	getTitle()
protected void	init(SectorEntityToken entity, java.lang.String title, java.lang.String text, java.lang.String icon, boolean withDesc)
protected void	init(SectorEntityToken entity, java.lang.String title, java.lang.String text, java.lang.String icon, boolean withDesc, TextPanelAPI textPanel)
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	isWithDeleteButton()
boolean	isWithDesc()
boolean	isWithTimestamp()
static SectorEntityToken	makeDoubleWithSameOrbit(SectorEntityToken entity)
void	reportRemovedIntel()
void	setDiscoveredPrefixOverride(java.lang.String discoveredPrefixOverride)
void	setEntity(SectorEntityToken entity)
void	setText(java.lang.String text)
void	setTitle(java.lang.String title)
void	setWithDeleteButton(boolean withDeleteButton)
void	setWithDesc(boolean withDesc)
void	setWithTimestamp(boolean withTimestamp)
boolean	shouldRemoveIntel()
protected boolean	withCustomDescription()
protected boolean	withCustomVisual()
protected boolean	withTextInDesc()

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

getCommMessageSound, getIcon, getIconId, getKeepExploredDebrisField, getRemoveSurveyedPlanet, getRemoveTrigger, getSound, setDefaultExpiration, setDuration, setIcon, setIconId, setKeepExploredDebrisField, setRemoveSurveyedPlanet, setRemoveTrigger, setSound

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, advanceImpl, autoAddCampaignMessage, bullet, buttonPressCancelled, callEvent, canMakeVisible, canMakeVisibleToCommSniffer, canMakeVisibleToPlayer, canTurnImportantOff, createConfirmationPrompt, createDeleteConfirmationPrompt, createLargeDescription, endAfterDelay, endAfterDelay, endImmediately, forceAddNextFrame, getArrowData, getBackgroundGlowColor, getBaseDaysAfterEnd, getBulletColorForMode, getButtonStoryPointActionDelegate, getCancelText, getCircleBorderColorOverride, getCommRelayRange, getConfirmationPromptWidth, getConfirmText, getDays, getDaysSincePlayerVisible, getDaysString, getImportantIcon, getListInfoParam, getPlayerVisibleTimestamp, getPostingLocation, getPostingRangeLY, getSortStringNewestFirst, getSortStringNewestFirst, getSortTier, getSoundColonyThreat, getSoundLogUpdate, getSoundMajorPosting, getSoundMinorMessage, getSoundStandardPosting, getSoundStandardUpdate, getTagsForSort, getTimeRemainingFraction, getTitleColor, hasImportantButton, hasLargeDescription, hasSmallDescription, indent, isDone, isEnded, isEnding, isImportant, isNew, isPlayerVisible, isSendingUpdate, notifyEnded, notifyEnding, notifyPlayerAboutToOpenIntelScreen, reportMadeVisibleToPlayer, reportPlayerClickedOn, 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

BUTTON_EDIT

public static java.lang.String BUTTON_EDIT

entity

protected SectorEntityToken entity

copy

protected SectorEntityToken copy

title

protected java.lang.String title

text

protected java.lang.String text

discoveredPrefixOverride

protected transient java.lang.String discoveredPrefixOverride

Constructor Detail

MapMarkerIntel

public MapMarkerIntel()

MapMarkerIntel

public MapMarkerIntel(SectorEntityToken entity,
                      java.lang.String title,
                      java.lang.String text,
                      java.lang.String icon,
                      boolean withDesc)

Method Detail

init

protected void init(SectorEntityToken entity,
                    java.lang.String title,
                    java.lang.String text,
                    java.lang.String icon,
                    boolean withDesc)

init

protected void init(SectorEntityToken entity,
                    java.lang.String title,
                    java.lang.String text,
                    java.lang.String icon,
                    boolean withDesc,
                    TextPanelAPI textPanel)

reportRemovedIntel

public void reportRemovedIntel()

Specified by:

reportRemovedIntel in interface IntelInfoPlugin

Overrides:

reportRemovedIntel in class BaseIntelPlugin

makeDoubleWithSameOrbit

public static SectorEntityToken makeDoubleWithSameOrbit(SectorEntityToken entity)

getTitle

public java.lang.String getTitle()

setTitle

public void setTitle(java.lang.String title)

getEntity

public SectorEntityToken getEntity()

setEntity

public void setEntity(SectorEntityToken entity)

getText

public java.lang.String getText()

setText

public void setText(java.lang.String text)

isWithDesc

public boolean isWithDesc()

setWithDesc

public void setWithDesc(boolean withDesc)

createIntelInfo

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

Specified by:

createIntelInfo in interface IntelInfoPlugin

Overrides:

createIntelInfo in class BaseIntelPlugin

addBulletPoints

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

Overrides:

addBulletPoints in class BaseIntelPlugin

addExtraBulletPoints

protected void addExtraBulletPoints(TooltipMakerAPI info,
                                    java.awt.Color tc,
                                    float initPad,
                                    IntelInfoPlugin.ListInfoMode mode)

endsInPunct

protected boolean endsInPunct(java.lang.String str,
                              boolean forBulletPoint)

withTextInDesc

protected boolean withTextInDesc()

withCustomVisual

protected boolean withCustomVisual()

withCustomDescription

protected boolean withCustomDescription()

addCustomVisual

protected void addCustomVisual(TooltipMakerAPI info,
                               float width,
                               float height)

addCustomDescription

protected void addCustomDescription(TooltipMakerAPI info,
                                    float width,
                                    float height)

addPostDescriptionSection

protected void addPostDescriptionSection(TooltipMakerAPI info,
                                         float width,
                                         float height,
                                         float opad)

isWithDeleteButton

public boolean isWithDeleteButton()

setWithDeleteButton

public void setWithDeleteButton(boolean withDeleteButton)

isWithTimestamp

public boolean isWithTimestamp()

setWithTimestamp

public void setWithTimestamp(boolean withTimestamp)

createSmallDescription

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

Specified by:

createSmallDescription in interface IntelInfoPlugin

Overrides:

createSmallDescription in class BaseIntelPlugin

buttonPressConfirmed

public void buttonPressConfirmed(java.lang.Object buttonId,
                                 IntelUIAPI ui)

Specified by:

buttonPressConfirmed in interface IntelInfoPlugin

Overrides:

buttonPressConfirmed in class BaseIntelPlugin

doesButtonHaveConfirmDialog

public boolean doesButtonHaveConfirmDialog(java.lang.Object buttonId)

Specified by:

doesButtonHaveConfirmDialog in interface IntelInfoPlugin

Overrides:

doesButtonHaveConfirmDialog in class BaseIntelPlugin

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 FleetLogIntel

Returns:

getSortString

public java.lang.String getSortString()

Specified by:

getSortString in interface IntelInfoPlugin

Overrides:

getSortString in class FleetLogIntel

getDiscoveredPrefixOverride

public java.lang.String getDiscoveredPrefixOverride()

setDiscoveredPrefixOverride

public void setDiscoveredPrefixOverride(java.lang.String discoveredPrefixOverride)

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

getMapLocation

public SectorEntityToken getMapLocation(SectorMapAPI map)

Specified by:

getMapLocation in interface IntelInfoPlugin

Overrides:

getMapLocation in class BaseIntelPlugin

shouldRemoveIntel

public boolean shouldRemoveIntel()

Specified by:

shouldRemoveIntel in interface IntelInfoPlugin

Overrides:

shouldRemoveIntel in class FleetLogIntel

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: