Starsector API
Loading...
Searching...
No Matches
com.fs.starfarer.api.impl.campaign.intel.misc.WarningBeaconIntel Class Reference
Inheritance diagram for com.fs.starfarer.api.impl.campaign.intel.misc.WarningBeaconIntel:
[legend]
Collaboration diagram for com.fs.starfarer.api.impl.campaign.intel.misc.WarningBeaconIntel:
[legend]

Public Member Functions

 WarningBeaconIntel (SectorEntityToken beacon)
 
void createIntelInfo (TooltipMakerAPI info, ListInfoMode mode)
 
void createSmallDescription (TooltipMakerAPI info, float width, float height)
 
String getIcon ()
 
Set< String > getIntelTags (SectorMapAPI map)
 
String getSortString ()
 
String getName ()
 
FactionAPI getFactionForUIColors ()
 
String getSmallDescriptionTitle ()
 
SectorEntityToken getMapLocation (SectorMapAPI map)
 
boolean shouldRemoveIntel ()
 
String getCommMessageSound ()
 
- Public Member Functions inherited from com.fs.starfarer.api.impl.campaign.intel.BaseIntelPlugin
 BaseIntelPlugin ()
 
void advance (float amount)
 
void notifyPlayerAboutToOpenIntelScreen ()
 
void endImmediately ()
 
void endAfterDelay ()
 
void endAfterDelay (float days)
 
boolean isDone ()
 
boolean runWhilePaused ()
 
boolean isEnding ()
 
boolean isEnded ()
 
Object getListInfoParam ()
 
void setListInfoParam (Object listInfoParam)
 
boolean isSendingUpdate ()
 
void sendUpdate (Object listInfoParam, TextPanelAPI textPanel)
 
void sendUpdateIfPlayerHasIntel (Object listInfoParam, TextPanelAPI textPanel)
 
void sendUpdateIfPlayerHasIntel (Object listInfoParam, boolean onlyIfImportant)
 
void sendUpdateIfPlayerHasIntel (Object listInfoParam, boolean onlyIfImportant, boolean sendIfHidden)
 
boolean canTurnImportantOff ()
 
String getImportantIcon ()
 
boolean hasImportantButton ()
 
boolean hasSmallDescription ()
 
boolean hasLargeDescription ()
 
void createLargeDescription (CustomPanelAPI panel, float width, float height)
 
Color getBackgroundGlowColor ()
 
boolean isImportant ()
 
void setImportant (Boolean important)
 
boolean doesButtonHaveConfirmDialog (Object buttonId)
 
float getConfirmationPromptWidth (Object buttonId)
 
void createConfirmationPrompt (Object buttonId, TooltipMakerAPI prompt)
 
String getConfirmText (Object buttonId)
 
String getCancelText (Object buttonId)
 
void buttonPressConfirmed (Object buttonId, IntelUIAPI ui)
 
void buttonPressCancelled (Object buttonId, IntelUIAPI ui)
 
boolean isPlayerVisible ()
 
Long getPlayerVisibleTimestamp ()
 
void setPlayerVisibleTimestamp (Long timestamp)
 
float getDaysSincePlayerVisible ()
 
void reportPlayerClickedOn ()
 
boolean isNew ()
 
void setNew (boolean isNew)
 
IntelSortTier getSortTier ()
 
boolean autoAddCampaignMessage ()
 
boolean isHidden ()
 
void setHidden (boolean hidden)
 
void reportMadeVisibleToPlayer ()
 
boolean canMakeVisibleToPlayer (boolean playerInRelayRange)
 
boolean canMakeVisibleToCommSniffer (boolean playerInRelayRange, SectorEntityToken relay)
 
boolean canMakeVisible (boolean playerInRelayRange, LocationAPI conLoc, Vector2f hyperLoc, boolean commSniffer)
 
SectorEntityToken getPostingLocation ()
 
void setPostingLocation (SectorEntityToken postingLocation)
 
Float getPostingRangeLY ()
 
void setPostingRangeLY (Float postingRangeLY)
 
void setPostingRangeLY (Float postingRangeLY, boolean ensureVisibleOutsideSystem)
 
void reportRemovedIntel ()
 
Color getTitleColor (ListInfoMode mode)
 
boolean callEvent (String ruleId, InteractionDialogAPI dialog, List< Token > params, Map< String, MemoryAPI > memoryMap)
 
List< ArrowData > getArrowData (SectorMapAPI map)
 
float getTimeRemainingFraction ()
 
ButtonAPI addGenericButton (TooltipMakerAPI info, float width, String text, Object data)
 
ButtonAPI addGenericButton (TooltipMakerAPI info, float width, Color tc, Color bg, String text, Object data)
 
boolean forceAddNextFrame ()
 
void setForceAddNextFrame (boolean add)
 
StoryPointActionDelegate getButtonStoryPointActionDelegate (Object buttonId)
 
void storyActionConfirmed (Object buttonId, IntelUIAPI ui)
 
Color getCircleBorderColorOverride ()
 
void tableRowClicked (IntelUIAPI ui, TableRowClickData data)
 
void addLogTimestamp (TooltipMakerAPI info, Color tc, float opad)
 
String getSortStringNewestFirst ()
 
String getSortStringNewestFirst (String prefix)
 
Set< String > getTagsForSort ()
 
void setTagsForSort (Set< String > tagsForSort)
 
- Public Member Functions inherited from com.fs.starfarer.api.campaign.comm.IntelInfoPlugin
- Public Member Functions inherited from com.fs.starfarer.api.EveryFrameScript

Protected Member Functions

RemnantSystemType getRemnantType ()
 
boolean isLow ()
 
boolean isMedium ()
 
boolean isHigh ()
 
void addBulletPoints (TooltipMakerAPI info, ListInfoMode mode)
 
- Protected Member Functions inherited from com.fs.starfarer.api.impl.campaign.intel.BaseIntelPlugin
void advanceImpl (float amount)
 
void notifyEnding ()
 
void notifyEnded ()
 
float getBaseDaysAfterEnd ()
 
void addBulletPoints (TooltipMakerAPI info, ListInfoMode mode, boolean isUpdate, Color tc, float initPad)
 
void createDeleteConfirmationPrompt (TooltipMakerAPI prompt)
 
void addDeleteButton (TooltipMakerAPI info, float width)
 
void addDeleteButton (TooltipMakerAPI info, float width, String delete)
 
float getCommRelayRange ()
 
void bullet (TooltipMakerAPI info)
 
void indent (TooltipMakerAPI info)
 
void unindent (TooltipMakerAPI info)
 
void addDays (TooltipMakerAPI info, String after, float days)
 
void addDays (TooltipMakerAPI info, String after, float days, Color c)
 
void addDays (TooltipMakerAPI info, String after, float days, Color c, float pad)
 
void addDays (TooltipMakerAPI info, String before, String after, float days, Color c, float pad)
 
String getDays (float days)
 
Color getBulletColorForMode (ListInfoMode mode)
 

Protected Attributes

SectorEntityToken beacon
 
- Protected Attributes inherited from com.fs.starfarer.api.impl.campaign.intel.BaseIntelPlugin
Boolean important
 
Long timestamp
 
Boolean neverClicked = true
 
transient Object listInfoParam = null
 
Boolean ended = null
 
Boolean ending = null
 
Float endingTimeRemaining = null
 
SectorEntityToken postingLocation = null
 
Float postingRangeLY = null
 
transient Set< String > tagsForSort = null
 
Boolean hidden = null
 
Boolean forceAdd = null
 

Additional Inherited Members

- Static Public Member Functions inherited from com.fs.starfarer.api.impl.campaign.intel.BaseIntelPlugin
static String getDaysString (float days)
 
static String getSoundStandardPosting ()
 
static String getSoundStandardUpdate ()
 
static String getSoundMajorPosting ()
 
static String getSoundColonyThreat ()
 
static String getSoundLogUpdate ()
 
static String getSoundMinorMessage ()
 
static void addMarketToList (TooltipMakerAPI info, MarketAPI market, float pad)
 
static void addMarketToList (TooltipMakerAPI info, MarketAPI market, float pad, Color tc)
 
static void addMarketTable (TooltipMakerAPI info, Color base, Color dark, Color bright, List< MarketAPI > markets, float width, float pad)
 
- Static Public Attributes inherited from com.fs.starfarer.api.impl.campaign.intel.BaseIntelPlugin
static final String BULLET = " - "
 
static final String INDENT = " "
 
static String BUTTON_DELETE = "button_delete"
 
- Static Public Attributes inherited from com.fs.starfarer.api.campaign.comm.IntelInfoPlugin
static final float LIST_ITEM_TEXT_WIDTH = 261f
 
static final float NEW_DAYS = 5f
 

Detailed Description

Definition at line 20 of file WarningBeaconIntel.java.

Constructor & Destructor Documentation

◆ WarningBeaconIntel()

com.fs.starfarer.api.impl.campaign.intel.misc.WarningBeaconIntel.WarningBeaconIntel ( SectorEntityToken beacon)

Definition at line 24 of file WarningBeaconIntel.java.

Member Function Documentation

◆ addBulletPoints()

void com.fs.starfarer.api.impl.campaign.intel.misc.WarningBeaconIntel.addBulletPoints ( TooltipMakerAPI info,
ListInfoMode mode )
protected

◆ createIntelInfo()

void com.fs.starfarer.api.impl.campaign.intel.misc.WarningBeaconIntel.createIntelInfo ( TooltipMakerAPI info,
ListInfoMode mode )

◆ createSmallDescription()

void com.fs.starfarer.api.impl.campaign.intel.misc.WarningBeaconIntel.createSmallDescription ( TooltipMakerAPI info,
float width,
float height )

◆ getCommMessageSound()

String com.fs.starfarer.api.impl.campaign.intel.misc.WarningBeaconIntel.getCommMessageSound ( )

◆ getFactionForUIColors()

FactionAPI com.fs.starfarer.api.impl.campaign.intel.misc.WarningBeaconIntel.getFactionForUIColors ( )

◆ getIcon()

String com.fs.starfarer.api.impl.campaign.intel.misc.WarningBeaconIntel.getIcon ( )

40x40, no icon if null.

Returns

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

Definition at line 120 of file WarningBeaconIntel.java.

◆ getIntelTags()

Set< String > com.fs.starfarer.api.impl.campaign.intel.misc.WarningBeaconIntel.getIntelTags ( SectorMapAPI map)

Method NEEDS to handle map being null gracefully.

Parameters
map
Returns

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

Definition at line 132 of file WarningBeaconIntel.java.

◆ getMapLocation()

SectorEntityToken com.fs.starfarer.api.impl.campaign.intel.misc.WarningBeaconIntel.getMapLocation ( SectorMapAPI map)

◆ getName()

String com.fs.starfarer.api.impl.campaign.intel.misc.WarningBeaconIntel.getName ( )

◆ getRemnantType()

RemnantSystemType com.fs.starfarer.api.impl.campaign.intel.misc.WarningBeaconIntel.getRemnantType ( )
protected

Definition at line 29 of file WarningBeaconIntel.java.

◆ getSmallDescriptionTitle()

String com.fs.starfarer.api.impl.campaign.intel.misc.WarningBeaconIntel.getSmallDescriptionTitle ( )

◆ getSortString()

String com.fs.starfarer.api.impl.campaign.intel.misc.WarningBeaconIntel.getSortString ( )

◆ isHigh()

boolean com.fs.starfarer.api.impl.campaign.intel.misc.WarningBeaconIntel.isHigh ( )
protected

Definition at line 47 of file WarningBeaconIntel.java.

◆ isLow()

boolean com.fs.starfarer.api.impl.campaign.intel.misc.WarningBeaconIntel.isLow ( )
protected

Definition at line 41 of file WarningBeaconIntel.java.

◆ isMedium()

boolean com.fs.starfarer.api.impl.campaign.intel.misc.WarningBeaconIntel.isMedium ( )
protected

Definition at line 44 of file WarningBeaconIntel.java.

◆ shouldRemoveIntel()

boolean com.fs.starfarer.api.impl.campaign.intel.misc.WarningBeaconIntel.shouldRemoveIntel ( )

Member Data Documentation

◆ beacon

SectorEntityToken com.fs.starfarer.api.impl.campaign.intel.misc.WarningBeaconIntel.beacon
protected

Definition at line 22 of file WarningBeaconIntel.java.


The documentation for this class was generated from the following file: