com.fs.starfarer.api.campaign.comm

Interface IntelInfoPlugin

All Known Implementing Classes:

AFavorForKanta, AnalyzeEntityMissionIntel, ANewHope, BaseBarEventIntel, BaseCustomBounty, BaseDisruptIndustry, BaseEventIntel, BaseHistorianOffer, BaseHistorianOfferWithLocation, BaseHubMission, BaseIntelPlugin, BaseMissionIntel, BasicExampleGADataFromRuins, BlockadeFGI, BlueprintIntel, BreadcrumbIntel, CargoPodsIntel, CheapCommodityMission, CommodityProductionMission, CommSnifferIntel, ContactIntel, CustomProductionContract, DeadDropMission, DecivIntel, DelayedFleetEncounter, DeliveryMissionIntel, DisruptCompetitorMission, DisruptHeavyIndustry, DisruptSpaceport, DistressCallIntel, DonationOffer, ExtractionMission, FactionCommissionIntel, FactionHostilityIntel, FighterBlueprintOffer, FleetCreatorMission, FleetGroupIntel, FleetLogIntel, GAAtTheGates, GABaseMission, GABuyArtifact, GACelestialObject, GADataFromRuins, GADeliverVIP, GADerelictArtifact, GAFindingCoureuse, GAIntro, GAIntro2, GAKallichore, GAOutpost, GAProbePackage, GAProjectZiggurat, GARansomResearcher, GAReturnHamatsu, GATalkToBaird, GATalkToSebestyen, GateHaulerIntel, GateIntel, GATransverseJump, GenericRaidFGI, GensHannanMachinations, HandMeDownFreighter, HegemonyInspectionIntel, HijackingMission, HostileActivityEventIntel, HubMissionWithBarEvent, HubMissionWithSearch, HubMissionWithTriggers, HyperspaceTopographyEventIntel, IntelMarkerIntel, JailbreakMission, KnightsOfLuddTakeoverExpedition, LostOutpostCrewReturnLuddicFind, LuddicChurchImmigrationDeal, LuddicKnightErrant, LuddicPathBaseIntel, LuddicPathCellsIntel, LuddicPilgrimsPath, LuddicPilgrimTransport, LuddicShrineIntel, MessageIntel, MilitaryCustomBounty, NewMessagesIntel, PerseanLeagueBlockade, PerseanLeagueMembership, PerseanLeaguePunitiveExpedition, PersonBountyIntel, PirateActivityIntel, PirateBaseIntel, PirateSystemBounty, PlanetaryShieldIntel, PLIntel, ProcurementMission, ProcurementMissionIntel, ProductionReportIntel, PromoteOfficerIntel, PunitiveExpeditionIntel, RaidIntel, RaidSecretOutpostMission, RecoverAPlanetkiller, RuinsDataSwapMission, ScientistAICoreIntel, SecurityCodes, ShipBlueprintOffer, SindrianDiktatFuelDeal, SindrianDiktatPunitiveExpedition, SmugglingMission, SpecialItemOffer, SpySatDeployment, SurplusShipHull, SurveyPlanetMissionIntel, SwordOfEventide, SystemBountyIntel, TacticallyBombardColony, TestFleetGroupIntel, TheUsurpers, TradeFleetDepartureIntel, TriTachLoanIntel, TriTachyonCommerceRaiding, TriTachyonDeal, TTMercenaryAttack, TTMercenaryReversedAttack, TutorialMissionIntel, UnderworldCustomBounty, WarningBeaconIntel, WeaponBlueprintOffer

public interface IntelInfoPlugin

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IntelInfoPlugin.ArrowData
static class	IntelInfoPlugin.IntelSortTier Lower-tier shown first.
static class	IntelInfoPlugin.ListInfoMode
static class	IntelInfoPlugin.TableRowClickData

Field Summary

Fields

Modifier and Type	Field and Description
static float	LIST_ITEM_TEXT_WIDTH
static float	NEW_DAYS

Method Summary

Methods

Modifier and Type	Method and Description
boolean	autoAddCampaignMessage()
void	buttonPressCancelled(java.lang.Object buttonId, IntelUIAPI ui)
void	buttonPressConfirmed(java.lang.Object buttonId, IntelUIAPI ui)
boolean	canMakeVisibleToPlayer(boolean playerInRelayRange) Only checked if adding using IntelManager.queueIntel().
boolean	canTurnImportantOff()
void	createConfirmationPrompt(java.lang.Object buttonId, TooltipMakerAPI prompt)
void	createIntelInfo(TooltipMakerAPI info, IntelInfoPlugin.ListInfoMode mode)
void	createLargeDescription(CustomPanelAPI panel, float width, float height)
void	createSmallDescription(TooltipMakerAPI info, float width, float height)
boolean	doesButtonHaveConfirmDialog(java.lang.Object buttonId)
boolean	forceAddNextFrame()
java.util.List<IntelInfoPlugin.ArrowData>	getArrowData(SectorMapAPI map)
java.awt.Color	getBackgroundGlowColor()
StoryPointActionDelegate	getButtonStoryPointActionDelegate(java.lang.Object buttonId)
java.lang.String	getCancelText(java.lang.Object buttonId)
java.awt.Color	getCircleBorderColorOverride()
java.lang.String	getCommMessageSound()
float	getConfirmationPromptWidth(java.lang.Object buttonId)
java.lang.String	getConfirmText(java.lang.Object buttonId)
FactionAPI	getFactionForUIColors()
java.lang.String	getIcon() 40x40, no icon if null.
java.lang.String	getImportantIcon() 20x20, if null will use default.
java.util.Set<java.lang.String>	getIntelTags(SectorMapAPI map) Method NEEDS to handle map being null gracefully.
SectorEntityToken	getMapLocation(SectorMapAPI map)
java.lang.Long	getPlayerVisibleTimestamp()
java.lang.String	getSmallDescriptionTitle()
java.lang.String	getSortString()
IntelInfoPlugin.IntelSortTier	getSortTier()
float	getTimeRemainingFraction() Should return 0 if the concept doesn't apply.
boolean	hasImportantButton()
boolean	hasLargeDescription()
boolean	hasSmallDescription()
boolean	isEnded()
boolean	isEnding()
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	isImportant()
boolean	isNew()
void	notifyPlayerAboutToOpenIntelScreen()
void	reportMadeVisibleToPlayer()
void	reportPlayerClickedOn()
void	reportRemovedIntel()
void	setForceAddNextFrame(boolean add)
void	setHidden(boolean hidden)
void	setImportant(java.lang.Boolean important)
void	setNew(boolean isNew)
void	setPlayerVisibleTimestamp(java.lang.Long timestamp)
boolean	shouldRemoveIntel()
void	storyActionConfirmed(java.lang.Object buttonId, IntelUIAPI ui)
void	tableRowClicked(IntelUIAPI ui, IntelInfoPlugin.TableRowClickData data)

Field Detail

LIST_ITEM_TEXT_WIDTH

static final float LIST_ITEM_TEXT_WIDTH

See Also:

Constant Field Values

NEW_DAYS

static final float NEW_DAYS

See Also:

Constant Field Values

Method Detail

getIcon

java.lang.String getIcon()

40x40, no icon if null.

Returns:

getImportantIcon

java.lang.String getImportantIcon()

20x20, if null will use default.

Returns:

hasImportantButton

boolean hasImportantButton()

canTurnImportantOff

boolean canTurnImportantOff()

getBackgroundGlowColor

java.awt.Color getBackgroundGlowColor()

createIntelInfo

void createIntelInfo(TooltipMakerAPI info,
                   IntelInfoPlugin.ListInfoMode mode)

hasSmallDescription

boolean hasSmallDescription()

getSmallDescriptionTitle

java.lang.String getSmallDescriptionTitle()

createSmallDescription

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

hasLargeDescription

boolean hasLargeDescription()

createLargeDescription

void createLargeDescription(CustomPanelAPI panel,
                          float width,
                          float height)

notifyPlayerAboutToOpenIntelScreen

void notifyPlayerAboutToOpenIntelScreen()

shouldRemoveIntel

boolean shouldRemoveIntel()

getIntelTags

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

Method NEEDS to handle map being null gracefully.

Parameters:

map -

Returns:

isImportant

boolean isImportant()

setImportant

void setImportant(java.lang.Boolean important)

getMapLocation

SectorEntityToken getMapLocation(SectorMapAPI map)

getArrowData

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

doesButtonHaveConfirmDialog

boolean doesButtonHaveConfirmDialog(java.lang.Object buttonId)

getButtonStoryPointActionDelegate

StoryPointActionDelegate getButtonStoryPointActionDelegate(java.lang.Object buttonId)

getConfirmationPromptWidth

float getConfirmationPromptWidth(java.lang.Object buttonId)

createConfirmationPrompt

void createConfirmationPrompt(java.lang.Object buttonId,
                            TooltipMakerAPI prompt)

getConfirmText

java.lang.String getConfirmText(java.lang.Object buttonId)

getCancelText

java.lang.String getCancelText(java.lang.Object buttonId)

getFactionForUIColors

FactionAPI getFactionForUIColors()

buttonPressConfirmed

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

buttonPressCancelled

void buttonPressCancelled(java.lang.Object buttonId,
                        IntelUIAPI ui)

storyActionConfirmed

void storyActionConfirmed(java.lang.Object buttonId,
                        IntelUIAPI ui)

setPlayerVisibleTimestamp

void setPlayerVisibleTimestamp(java.lang.Long timestamp)

getPlayerVisibleTimestamp

java.lang.Long getPlayerVisibleTimestamp()

autoAddCampaignMessage

boolean autoAddCampaignMessage()

getCommMessageSound

java.lang.String getCommMessageSound()

canMakeVisibleToPlayer

boolean canMakeVisibleToPlayer(boolean playerInRelayRange)

Only checked if adding using IntelManager.queueIntel(). addIntel() bypasses this and all other checks.

Parameters:

playerInRelayRange -

Returns:

reportMadeVisibleToPlayer

void reportMadeVisibleToPlayer()

reportPlayerClickedOn

void reportPlayerClickedOn()

reportRemovedIntel

void reportRemovedIntel()

isNew

boolean isNew()

setNew

void setNew(boolean isNew)

getSortTier

IntelInfoPlugin.IntelSortTier getSortTier()

getSortString

java.lang.String getSortString()

isHidden

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. Something can have "reportMadeVisibleToPlayer" called on it but still be hidden.

Returns:

setHidden

void setHidden(boolean hidden)

getTimeRemainingFraction

float getTimeRemainingFraction()

Should return 0 if the concept doesn't apply.

Returns:

getCircleBorderColorOverride

java.awt.Color getCircleBorderColorOverride()

forceAddNextFrame

boolean forceAddNextFrame()

setForceAddNextFrame

void setForceAddNextFrame(boolean add)

isEnded

boolean isEnded()

isEnding

boolean isEnding()

tableRowClicked

void tableRowClicked(IntelUIAPI ui,
                   IntelInfoPlugin.TableRowClickData data)