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

Class BaseIntelPlugin

java.lang.Object

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

All Implemented Interfaces:

IntelInfoPlugin, EveryFrameScript, CommRelayEntityPlugin.CommSnifferReadableIntel, CallEvent.CallableEvent

Direct Known Subclasses:

BaseBarEventIntel, BaseEventIntel, BaseHistorianOffer, BaseHubMission, BaseMissionIntel, CommSnifferIntel, ContactIntel, DecivIntel, FactionHostilityIntel, FleetGroupIntel, FleetLogIntel, GateHaulerIntel, GateIntel, GensHannanMachinations, IntelMarkerIntel, LuddicChurchImmigrationDeal, LuddicPathBaseIntel, LuddicPathCellsIntel, LuddicShrineIntel, MessageIntel, NewMessagesIntel, PerseanLeagueMembership, PersonBountyIntel, PirateActivityIntel, PirateBaseIntel, PlanetaryShieldIntel, PLIntel, PromoteOfficerIntel, RaidIntel, SalvorsTallyIntel, ScientistAICoreIntel, SindrianDiktatFuelDeal, SystemBountyIntel, TradeFleetDepartureIntel, TriTachLoanIntel, TriTachyonDeal, TutorialMissionIntel, WarningBeaconIntel

public class BaseIntelPlugin
extends Object
implements IntelInfoPlugin, CallEvent.CallableEvent, EveryFrameScript, CommRelayEntityPlugin.CommSnifferReadableIntel

Author:

Alex Mosolov 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	Description
static final String	BULLET
static String	BUTTON_DELETE
protected Boolean	ended
protected Boolean	ending
protected Float	endingTimeRemaining
protected Boolean	forceAdd
protected Boolean	hidden
protected Boolean	important
static final String	INDENT
protected Object	listInfoParam
protected Boolean	neverClicked
protected SectorEntityToken	postingLocation
protected Float	postingRangeLY
protected Set<String>	tagsForSort
protected Long	timestamp

Fields inherited from interface com.fs.starfarer.api.campaign.comm.IntelInfoPlugin

LIST_ITEM_TEXT_WIDTH, NEW_DAYS

Constructor Summary

Constructors

Constructor	Description
BaseIntelPlugin()

Method Summary

Modifier and Type	Method	Description
protected void	addBulletPoints(TooltipMakerAPI info, IntelInfoPlugin.ListInfoMode mode)
protected void	addBulletPoints(TooltipMakerAPI info, IntelInfoPlugin.ListInfoMode mode, boolean isUpdate, Color tc, float initPad)
protected void	addDays(TooltipMakerAPI info, String after, float days)
protected void	addDays(TooltipMakerAPI info, String after, float days, Color c)
protected void	addDays(TooltipMakerAPI info, String after, float days, Color c, float pad)
protected void	addDays(TooltipMakerAPI info, String before, String after, float days, Color c, float pad)
protected void	addDeleteButton(TooltipMakerAPI info, float width)
protected void	addDeleteButton(TooltipMakerAPI info, float width, String delete)
ButtonAPI	addGenericButton(TooltipMakerAPI info, float width, Color tc, Color bg, String text, Object data)
ButtonAPI	addGenericButton(TooltipMakerAPI info, float width, String text, Object data)
void	addLogTimestamp(TooltipMakerAPI info, Color tc, float opad)
static void	addMarketTable(TooltipMakerAPI info, Color base, Color dark, Color bright, List<MarketAPI> markets, float width, float pad)
static void	addMarketToList(TooltipMakerAPI info, MarketAPI market, float pad)
static void	addMarketToList(TooltipMakerAPI info, MarketAPI market, float pad, Color tc)
void	advance(float amount)	Use SectorAPI.getClock() to convert to campaign days.
protected void	advanceImpl(float amount)
boolean	autoAddCampaignMessage()
protected void	bullet(TooltipMakerAPI info)
void	buttonPressCancelled(Object buttonId, IntelUIAPI ui)
void	buttonPressConfirmed(Object buttonId, IntelUIAPI ui)
boolean	callEvent(String ruleId, InteractionDialogAPI dialog, List<Misc.Token> params, Map<String,MemoryAPI> memoryMap)
boolean	canMakeVisible(boolean playerInRelayRange, LocationAPI conLoc, org.lwjgl.util.vector.Vector2f hyperLoc, boolean commSniffer)
boolean	canMakeVisibleToCommSniffer(boolean playerInRelayRange, SectorEntityToken relay)
boolean	canMakeVisibleToPlayer(boolean playerInRelayRange)	Only checked if adding using IntelManager.queueIntel().
boolean	canTurnImportantOff()
void	createConfirmationPrompt(Object buttonId, TooltipMakerAPI prompt)
protected void	createDeleteConfirmationPrompt(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(Object buttonId)
void	endAfterDelay()
void	endAfterDelay(float days)
void	endImmediately()
boolean	forceAddNextFrame()
List<IntelInfoPlugin.ArrowData>	getArrowData(SectorMapAPI map)
Color	getBackgroundGlowColor()
protected float	getBaseDaysAfterEnd()
protected Color	getBulletColorForMode(IntelInfoPlugin.ListInfoMode mode)
StoryPointActionDelegate	getButtonStoryPointActionDelegate(Object buttonId)
String	getCancelText(Object buttonId)
Color	getCircleBorderColorOverride()
String	getCommMessageSound()
protected float	getCommRelayRange()
float	getConfirmationPromptWidth(Object buttonId)
String	getConfirmText(Object buttonId)
protected String	getDays(float days)
float	getDaysSincePlayerVisible()
static String	getDaysString(float days)
FactionAPI	getFactionForUIColors()
String	getIcon()	40x40, no icon if null.
String	getImportantIcon()	20x20, if null will use default.
Set<String>	getIntelTags(SectorMapAPI map)	Method NEEDS to handle map being null gracefully.
Object	getListInfoParam()	Call from createMessageListInfo() to figure out what type of update to create.
SectorEntityToken	getMapLocation(SectorMapAPI map)
protected String	getName()
Long	getPlayerVisibleTimestamp()
SectorEntityToken	getPostingLocation()
Float	getPostingRangeLY()
String	getSmallDescriptionTitle()
String	getSortString()
String	getSortStringNewestFirst()
String	getSortStringNewestFirst(String prefix)
IntelInfoPlugin.IntelSortTier	getSortTier()
static String	getSoundColonyThreat()
static String	getSoundLogUpdate()
static String	getSoundMajorPosting()
static String	getSoundMinorMessage()
static String	getSoundStandardPosting()
static String	getSoundStandardUpdate()
Set<String>	getTagsForSort()
float	getTimeRemainingFraction()	Should return 0 if the concept doesn't apply.
Color	getTitleColor(IntelInfoPlugin.ListInfoMode mode)
boolean	hasImportantButton()
boolean	hasLargeDescription()
boolean	hasSmallDescription()
protected void	indent(TooltipMakerAPI info)
boolean	isDone()
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()
boolean	isPlayerVisible()
boolean	isSendingUpdate()
protected void	notifyEnded()
protected void	notifyEnding()
void	notifyPlayerAboutToOpenIntelScreen()
void	reportMadeVisibleToPlayer()
void	reportPlayerClickedOn()
void	reportRemovedIntel()
boolean	runWhilePaused()
void	sendUpdate(Object listInfoParam, TextPanelAPI textPanel)
void	sendUpdateIfPlayerHasIntel(Object listInfoParam, boolean onlyIfImportant)
void	sendUpdateIfPlayerHasIntel(Object listInfoParam, boolean onlyIfImportant, boolean sendIfHidden)
void	sendUpdateIfPlayerHasIntel(Object listInfoParam, TextPanelAPI textPanel)
void	setForceAddNextFrame(boolean add)
void	setHidden(boolean hidden)
void	setImportant(Boolean important)
void	setListInfoParam(Object listInfoParam)
void	setNew(boolean isNew)
void	setPlayerVisibleTimestamp(Long timestamp)
void	setPostingLocation(SectorEntityToken postingLocation)
void	setPostingRangeLY(Float postingRangeLY)
void	setPostingRangeLY(Float postingRangeLY, boolean ensureVisibleOutsideSystem)
void	setTagsForSort(Set<String> tagsForSort)
boolean	shouldRemoveIntel()
void	storyActionConfirmed(Object buttonId, IntelUIAPI ui)
void	tableRowClicked(IntelUIAPI ui, IntelInfoPlugin.TableRowClickData data)
protected void	unindent(TooltipMakerAPI info)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

BULLET

public static final String BULLET

See Also:

• Constant Field Values

INDENT

public static final String INDENT

See Also:

• Constant Field Values

BUTTON_DELETE

public static String BUTTON_DELETE

important

protected Boolean important

timestamp

protected Long timestamp

neverClicked

protected Boolean neverClicked

listInfoParam

protected transient Object listInfoParam

ended

protected Boolean ended

ending

protected Boolean ending

endingTimeRemaining

protected Float endingTimeRemaining

postingLocation

protected SectorEntityToken postingLocation

postingRangeLY

protected Float postingRangeLY

tagsForSort

protected transient Set<String> tagsForSort

hidden

protected Boolean hidden

forceAdd

protected Boolean forceAdd

Constructor Details

BaseIntelPlugin

public BaseIntelPlugin()

Method Details

advance

public void advance(float amount)

Description copied from interface: EveryFrameScript

Use SectorAPI.getClock() to convert to campaign days.

Specified by:

advance in interface EveryFrameScript

Parameters:

amount - seconds elapsed during the last frame.

notifyPlayerAboutToOpenIntelScreen

public void notifyPlayerAboutToOpenIntelScreen()

Specified by:

notifyPlayerAboutToOpenIntelScreen in interface IntelInfoPlugin

advanceImpl

protected void advanceImpl(float amount)

notifyEnding

protected void notifyEnding()

notifyEnded

protected void notifyEnded()

endImmediately

public void endImmediately()

endAfterDelay

public void endAfterDelay()

endAfterDelay

public void endAfterDelay(float days)

getBaseDaysAfterEnd

protected float getBaseDaysAfterEnd()

isDone

public boolean isDone()

Specified by:

isDone in interface EveryFrameScript

Returns:

true when the script is finished and can be cleaned up by the engine.

runWhilePaused

public boolean runWhilePaused()

Specified by:

runWhilePaused in interface EveryFrameScript

Returns:

whether advance() should be called while the campaign engine is paused.

isEnding

public boolean isEnding()

Specified by:

isEnding in interface IntelInfoPlugin

isEnded

public boolean isEnded()

Specified by:

isEnded in interface IntelInfoPlugin

getListInfoParam

public Object getListInfoParam()

Call from createMessageListInfo() to figure out what type of update to create. Call from getCommMesageSound() to pick sound to play.

Returns:

setListInfoParam

public void setListInfoParam(Object listInfoParam)

isSendingUpdate

public boolean isSendingUpdate()

sendUpdate

public void sendUpdate(Object listInfoParam,
 TextPanelAPI textPanel)

sendUpdateIfPlayerHasIntel

public void sendUpdateIfPlayerHasIntel(Object listInfoParam,
 TextPanelAPI textPanel)

sendUpdateIfPlayerHasIntel

public void sendUpdateIfPlayerHasIntel(Object listInfoParam,
 boolean onlyIfImportant)

sendUpdateIfPlayerHasIntel

public void sendUpdateIfPlayerHasIntel(Object listInfoParam,
 boolean onlyIfImportant,
 boolean sendIfHidden)

canTurnImportantOff

public boolean canTurnImportantOff()

Specified by:

canTurnImportantOff in interface IntelInfoPlugin

getImportantIcon

public String getImportantIcon()

Description copied from interface: IntelInfoPlugin

20x20, if null will use default.

Specified by:

getImportantIcon in interface IntelInfoPlugin

Returns:

hasImportantButton

public boolean hasImportantButton()

Specified by:

hasImportantButton in interface IntelInfoPlugin

addBulletPoints

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

addBulletPoints

protected void addBulletPoints(TooltipMakerAPI info,
 IntelInfoPlugin.ListInfoMode mode,
 boolean isUpdate,
 Color tc,
 float initPad)

createIntelInfo

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

Specified by:

createIntelInfo in interface IntelInfoPlugin

getName

protected String getName()

hasSmallDescription

public boolean hasSmallDescription()

Specified by:

hasSmallDescription in interface IntelInfoPlugin

createSmallDescription

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

Specified by:

createSmallDescription in interface IntelInfoPlugin

hasLargeDescription

public boolean hasLargeDescription()

Specified by:

hasLargeDescription in interface IntelInfoPlugin

createLargeDescription

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

Specified by:

createLargeDescription in interface IntelInfoPlugin

getIcon

public String getIcon()

Description copied from interface: IntelInfoPlugin

40x40, no icon if null.

Specified by:

getIcon in interface IntelInfoPlugin

Returns:

getBackgroundGlowColor

public Color getBackgroundGlowColor()

Specified by:

getBackgroundGlowColor in interface IntelInfoPlugin

shouldRemoveIntel

public boolean shouldRemoveIntel()

Specified by:

shouldRemoveIntel in interface IntelInfoPlugin

getIntelTags

public Set<String> getIntelTags(SectorMapAPI map)

Description copied from interface: IntelInfoPlugin

Method NEEDS to handle map being null gracefully.

Specified by:

getIntelTags in interface IntelInfoPlugin

Returns:

isImportant

public boolean isImportant()

Specified by:

isImportant in interface IntelInfoPlugin

setImportant

public void setImportant(Boolean important)

Specified by:

setImportant in interface IntelInfoPlugin

getFactionForUIColors

public FactionAPI getFactionForUIColors()

Specified by:

getFactionForUIColors in interface IntelInfoPlugin

doesButtonHaveConfirmDialog

public boolean doesButtonHaveConfirmDialog(Object buttonId)

Specified by:

doesButtonHaveConfirmDialog in interface IntelInfoPlugin

getConfirmationPromptWidth

public float getConfirmationPromptWidth(Object buttonId)

Specified by:

getConfirmationPromptWidth in interface IntelInfoPlugin

createDeleteConfirmationPrompt

protected void createDeleteConfirmationPrompt(TooltipMakerAPI prompt)

createConfirmationPrompt

public void createConfirmationPrompt(Object buttonId,
 TooltipMakerAPI prompt)

Specified by:

createConfirmationPrompt in interface IntelInfoPlugin

getConfirmText

public String getConfirmText(Object buttonId)

Specified by:

getConfirmText in interface IntelInfoPlugin

getCancelText

public String getCancelText(Object buttonId)

Specified by:

getCancelText in interface IntelInfoPlugin

addDeleteButton

protected void addDeleteButton(TooltipMakerAPI info,
 float width)

addDeleteButton

protected void addDeleteButton(TooltipMakerAPI info,
 float width,
 String delete)

buttonPressConfirmed

public void buttonPressConfirmed(Object buttonId,
 IntelUIAPI ui)

Specified by:

buttonPressConfirmed in interface IntelInfoPlugin

buttonPressCancelled

public void buttonPressCancelled(Object buttonId,
 IntelUIAPI ui)

Specified by:

buttonPressCancelled in interface IntelInfoPlugin

isPlayerVisible

public boolean isPlayerVisible()

getPlayerVisibleTimestamp

public Long getPlayerVisibleTimestamp()

Specified by:

getPlayerVisibleTimestamp in interface IntelInfoPlugin

setPlayerVisibleTimestamp

public void setPlayerVisibleTimestamp(Long timestamp)

Specified by:

setPlayerVisibleTimestamp in interface IntelInfoPlugin

getDaysSincePlayerVisible

public float getDaysSincePlayerVisible()

reportPlayerClickedOn

public void reportPlayerClickedOn()

Specified by:

reportPlayerClickedOn in interface IntelInfoPlugin

isNew

public boolean isNew()

Specified by:

isNew in interface IntelInfoPlugin

setNew

public void setNew(boolean isNew)

Specified by:

setNew in interface IntelInfoPlugin

getSortTier

public IntelInfoPlugin.IntelSortTier getSortTier()

Specified by:

getSortTier in interface IntelInfoPlugin

getSortString

public String getSortString()

Specified by:

getSortString in interface IntelInfoPlugin

autoAddCampaignMessage

public boolean autoAddCampaignMessage()

Specified by:

autoAddCampaignMessage in interface IntelInfoPlugin

getCommMessageSound

public String getCommMessageSound()

Specified by:

getCommMessageSound in interface IntelInfoPlugin

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

Returns:

setHidden

public void setHidden(boolean hidden)

Specified by:

setHidden in interface IntelInfoPlugin

reportMadeVisibleToPlayer

public void reportMadeVisibleToPlayer()

Specified by:

reportMadeVisibleToPlayer in interface IntelInfoPlugin

getCommRelayRange

protected float getCommRelayRange()

canMakeVisibleToPlayer

public boolean canMakeVisibleToPlayer(boolean playerInRelayRange)

Description copied from interface: IntelInfoPlugin

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

Specified by:

canMakeVisibleToPlayer in interface IntelInfoPlugin

Returns:

canMakeVisibleToCommSniffer

public boolean canMakeVisibleToCommSniffer(boolean playerInRelayRange,
 SectorEntityToken relay)

Specified by:

canMakeVisibleToCommSniffer in interface CommRelayEntityPlugin.CommSnifferReadableIntel

canMakeVisible

public boolean canMakeVisible(boolean playerInRelayRange,
 LocationAPI conLoc,
 org.lwjgl.util.vector.Vector2f hyperLoc,
 boolean commSniffer)

getPostingLocation

public SectorEntityToken getPostingLocation()

setPostingLocation

public void setPostingLocation(SectorEntityToken postingLocation)

getPostingRangeLY

public Float getPostingRangeLY()

setPostingRangeLY

public void setPostingRangeLY(Float postingRangeLY)

setPostingRangeLY

public void setPostingRangeLY(Float postingRangeLY,
 boolean ensureVisibleOutsideSystem)

reportRemovedIntel

public void reportRemovedIntel()

Specified by:

reportRemovedIntel in interface IntelInfoPlugin

getMapLocation

public SectorEntityToken getMapLocation(SectorMapAPI map)

Specified by:

getMapLocation in interface IntelInfoPlugin

bullet

protected void bullet(TooltipMakerAPI info)

indent

protected void indent(TooltipMakerAPI info)

unindent

protected void unindent(TooltipMakerAPI info)

addDays

protected void addDays(TooltipMakerAPI info,
 String after,
 float days)

addDays

protected void addDays(TooltipMakerAPI info,
 String after,
 float days,
 Color c)

addDays

protected void addDays(TooltipMakerAPI info,
 String after,
 float days,
 Color c,
 float pad)

addDays

protected void addDays(TooltipMakerAPI info,
 String before,
 String after,
 float days,
 Color c,
 float pad)

getDays

protected String getDays(float days)

getDaysString

public static String getDaysString(float days)

getSmallDescriptionTitle

public String getSmallDescriptionTitle()

Specified by:

getSmallDescriptionTitle in interface IntelInfoPlugin

getTitleColor

public Color getTitleColor(IntelInfoPlugin.ListInfoMode mode)

getBulletColorForMode

protected Color getBulletColorForMode(IntelInfoPlugin.ListInfoMode mode)

callEvent

public boolean callEvent(String ruleId,
 InteractionDialogAPI dialog,
 List<Misc.Token> params,
 Map<String,MemoryAPI> memoryMap)

Specified by:

callEvent in interface CallEvent.CallableEvent

getSoundStandardPosting

public static String getSoundStandardPosting()

getSoundStandardUpdate

public static String getSoundStandardUpdate()

getSoundMajorPosting

public static String getSoundMajorPosting()

getSoundColonyThreat

public static String getSoundColonyThreat()

getSoundLogUpdate

public static String getSoundLogUpdate()

getSoundMinorMessage

public static String getSoundMinorMessage()

getArrowData

public List<IntelInfoPlugin.ArrowData> getArrowData(SectorMapAPI map)

Specified by:

getArrowData in interface IntelInfoPlugin

getTimeRemainingFraction

public float getTimeRemainingFraction()

Description copied from interface: IntelInfoPlugin

Should return 0 if the concept doesn't apply.

Specified by:

getTimeRemainingFraction in interface IntelInfoPlugin

Returns:

addGenericButton

public ButtonAPI addGenericButton(TooltipMakerAPI info,
 float width,
 String text,
 Object data)

addGenericButton

public ButtonAPI addGenericButton(TooltipMakerAPI info,
 float width,
 Color tc,
 Color bg,
 String text,
 Object data)

forceAddNextFrame

public boolean forceAddNextFrame()

Specified by:

forceAddNextFrame in interface IntelInfoPlugin

setForceAddNextFrame

public void setForceAddNextFrame(boolean add)

Specified by:

setForceAddNextFrame in interface IntelInfoPlugin

addMarketToList

public static void addMarketToList(TooltipMakerAPI info,
 MarketAPI market,
 float pad)

addMarketToList

public static void addMarketToList(TooltipMakerAPI info,
 MarketAPI market,
 float pad,
 Color tc)

addMarketTable

public static void addMarketTable(TooltipMakerAPI info,
 Color base,
 Color dark,
 Color bright,
 List<MarketAPI> markets,
 float width,
 float pad)

getButtonStoryPointActionDelegate

public StoryPointActionDelegate getButtonStoryPointActionDelegate(Object buttonId)

Specified by:

getButtonStoryPointActionDelegate in interface IntelInfoPlugin

storyActionConfirmed

public void storyActionConfirmed(Object buttonId,
 IntelUIAPI ui)

Specified by:

storyActionConfirmed in interface IntelInfoPlugin

getCircleBorderColorOverride

public Color getCircleBorderColorOverride()

Specified by:

getCircleBorderColorOverride in interface IntelInfoPlugin

tableRowClicked

public void tableRowClicked(IntelUIAPI ui,
 IntelInfoPlugin.TableRowClickData data)

Specified by:

tableRowClicked in interface IntelInfoPlugin

addLogTimestamp

public void addLogTimestamp(TooltipMakerAPI info,
 Color tc,
 float opad)

getSortStringNewestFirst

public String getSortStringNewestFirst()

getSortStringNewestFirst

public String getSortStringNewestFirst(String prefix)

getTagsForSort

public Set<String> getTagsForSort()

Specified by:

getTagsForSort in interface IntelInfoPlugin

setTagsForSort

public void setTagsForSort(Set<String> tagsForSort)

Specified by:

setTagsForSort in interface IntelInfoPlugin