Package com.fs.starfarer.api.campaign.comm

Interface IntelInfoPlugin

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

  • Field Details

  • Method Details

    • getIcon

      String getIcon()
      40x40, no icon if null.
      Returns:

    • getImportantIcon

      String getImportantIcon()
      20x20, if null will use default.
      Returns:

    • hasImportantButton

      boolean hasImportantButton()

    • canTurnImportantOff

      boolean canTurnImportantOff()

    • getBackgroundGlowColor

      Color getBackgroundGlowColor()

    • createIntelInfo

      void createIntelInfo(TooltipMakerAPI info, IntelInfoPlugin.ListInfoMode mode)

    • hasSmallDescription

      boolean hasSmallDescription()

    • getSmallDescriptionTitle

      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

      Set<String> getIntelTags(SectorMapAPI map)
      Method NEEDS to handle map being null gracefully.
      Parameters:
      map -
      Returns:

    • isImportant

      boolean isImportant()

    • setImportant

      void setImportant(Boolean important)

    • getMapLocation

      SectorEntityToken getMapLocation(SectorMapAPI map)

    • getArrowData

      List<IntelInfoPlugin.ArrowData> getArrowData(SectorMapAPI map)

    • doesButtonHaveConfirmDialog

      boolean doesButtonHaveConfirmDialog(Object buttonId)

    • getButtonStoryPointActionDelegate

      StoryPointActionDelegate getButtonStoryPointActionDelegate(Object buttonId)

    • getConfirmationPromptWidth

      float getConfirmationPromptWidth(Object buttonId)

    • createConfirmationPrompt

      void createConfirmationPrompt(Object buttonId, TooltipMakerAPI prompt)

    • getConfirmText

      String getConfirmText(Object buttonId)

    • getCancelText

      String getCancelText(Object buttonId)

    • getFactionForUIColors

      FactionAPI getFactionForUIColors()

    • buttonPressConfirmed

      void buttonPressConfirmed(Object buttonId, IntelUIAPI ui)

    • buttonPressCancelled

      void buttonPressCancelled(Object buttonId, IntelUIAPI ui)

    • storyActionConfirmed

      void storyActionConfirmed(Object buttonId, IntelUIAPI ui)

    • setPlayerVisibleTimestamp

      void setPlayerVisibleTimestamp(Long timestamp)

    • getPlayerVisibleTimestamp

      Long getPlayerVisibleTimestamp()

    • autoAddCampaignMessage

      boolean autoAddCampaignMessage()

    • getCommMessageSound

      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

      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

      Color getCircleBorderColorOverride()

    • forceAddNextFrame

      boolean forceAddNextFrame()

    • setForceAddNextFrame

      void setForceAddNextFrame(boolean add)

    • isEnded

      boolean isEnded()

    • isEnding

      boolean isEnding()

    • tableRowClicked

      void tableRowClicked(IntelUIAPI ui, IntelInfoPlugin.TableRowClickData data)

    • getTagsForSort

      Set<String> getTagsForSort()

    • setTagsForSort

      void setTagsForSort(Set<String> tagsForSort)