public class BaseIntelPlugin extends java.lang.Object implements IntelInfoPlugin, CallEvent.CallableEvent, EveryFrameScript, CommRelayEntityPlugin.CommSnifferReadableIntel
IntelInfoPlugin.ArrowData, IntelInfoPlugin.IntelSortTier, IntelInfoPlugin.ListInfoMode, IntelInfoPlugin.TableRowClickData| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
BULLET |
static java.lang.String |
BUTTON_DELETE |
protected java.lang.Boolean |
ended |
protected java.lang.Boolean |
ending |
protected java.lang.Float |
endingTimeRemaining |
protected java.lang.Boolean |
forceAdd |
protected java.lang.Boolean |
hidden |
protected java.lang.Boolean |
important |
static java.lang.String |
INDENT |
protected java.lang.Object |
listInfoParam |
protected java.lang.Boolean |
neverClicked |
protected SectorEntityToken |
postingLocation |
protected java.lang.Float |
postingRangeLY |
protected java.util.Set<java.lang.String> |
tagsForSort |
protected java.lang.Long |
timestamp |
LIST_ITEM_TEXT_WIDTH, NEW_DAYS| Constructor and Description |
|---|
BaseIntelPlugin() |
| Modifier and Type | Method and Description |
|---|---|
protected void |
addBulletPoints(TooltipMakerAPI info,
IntelInfoPlugin.ListInfoMode mode) |
protected void |
addBulletPoints(TooltipMakerAPI info,
IntelInfoPlugin.ListInfoMode mode,
boolean isUpdate,
java.awt.Color tc,
float initPad) |
protected void |
addDays(TooltipMakerAPI info,
java.lang.String after,
float days) |
protected void |
addDays(TooltipMakerAPI info,
java.lang.String after,
float days,
java.awt.Color c) |
protected void |
addDays(TooltipMakerAPI info,
java.lang.String after,
float days,
java.awt.Color c,
float pad) |
protected void |
addDays(TooltipMakerAPI info,
java.lang.String before,
java.lang.String after,
float days,
java.awt.Color c,
float pad) |
protected void |
addDeleteButton(TooltipMakerAPI info,
float width) |
protected void |
addDeleteButton(TooltipMakerAPI info,
float width,
java.lang.String delete) |
ButtonAPI |
addGenericButton(TooltipMakerAPI info,
float width,
java.awt.Color tc,
java.awt.Color bg,
java.lang.String text,
java.lang.Object data) |
ButtonAPI |
addGenericButton(TooltipMakerAPI info,
float width,
java.lang.String text,
java.lang.Object data) |
void |
addLogTimestamp(TooltipMakerAPI info,
java.awt.Color tc,
float opad) |
static void |
addMarketTable(TooltipMakerAPI info,
java.awt.Color base,
java.awt.Color dark,
java.awt.Color bright,
java.util.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,
java.awt.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(java.lang.Object buttonId,
IntelUIAPI ui) |
void |
buttonPressConfirmed(java.lang.Object buttonId,
IntelUIAPI ui) |
boolean |
callEvent(java.lang.String ruleId,
InteractionDialogAPI dialog,
java.util.List<Misc.Token> params,
java.util.Map<java.lang.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(java.lang.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(java.lang.Object buttonId) |
void |
endAfterDelay() |
void |
endAfterDelay(float days) |
void |
endImmediately() |
boolean |
forceAddNextFrame() |
java.util.List<IntelInfoPlugin.ArrowData> |
getArrowData(SectorMapAPI map) |
java.awt.Color |
getBackgroundGlowColor() |
protected float |
getBaseDaysAfterEnd() |
protected java.awt.Color |
getBulletColorForMode(IntelInfoPlugin.ListInfoMode mode) |
StoryPointActionDelegate |
getButtonStoryPointActionDelegate(java.lang.Object buttonId) |
java.lang.String |
getCancelText(java.lang.Object buttonId) |
java.awt.Color |
getCircleBorderColorOverride() |
java.lang.String |
getCommMessageSound() |
protected float |
getCommRelayRange() |
float |
getConfirmationPromptWidth(java.lang.Object buttonId) |
java.lang.String |
getConfirmText(java.lang.Object buttonId) |
protected java.lang.String |
getDays(float days) |
float |
getDaysSincePlayerVisible() |
static java.lang.String |
getDaysString(float days) |
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.
|
java.lang.Object |
getListInfoParam()
Call from createMessageListInfo() to figure out what type of update to create.
|
SectorEntityToken |
getMapLocation(SectorMapAPI map) |
protected java.lang.String |
getName() |
java.lang.Long |
getPlayerVisibleTimestamp() |
SectorEntityToken |
getPostingLocation() |
java.lang.Float |
getPostingRangeLY() |
java.lang.String |
getSmallDescriptionTitle() |
java.lang.String |
getSortString() |
java.lang.String |
getSortStringNewestFirst() |
java.lang.String |
getSortStringNewestFirst(java.lang.String prefix) |
IntelInfoPlugin.IntelSortTier |
getSortTier() |
static java.lang.String |
getSoundColonyThreat() |
static java.lang.String |
getSoundLogUpdate() |
static java.lang.String |
getSoundMajorPosting() |
static java.lang.String |
getSoundMinorMessage() |
static java.lang.String |
getSoundStandardPosting() |
static java.lang.String |
getSoundStandardUpdate() |
java.util.Set<java.lang.String> |
getTagsForSort() |
float |
getTimeRemainingFraction()
Should return 0 if the concept doesn't apply.
|
java.awt.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(java.lang.Object listInfoParam,
TextPanelAPI textPanel) |
void |
sendUpdateIfPlayerHasIntel(java.lang.Object listInfoParam,
boolean onlyIfImportant) |
void |
sendUpdateIfPlayerHasIntel(java.lang.Object listInfoParam,
boolean onlyIfImportant,
boolean sendIfHidden) |
void |
sendUpdateIfPlayerHasIntel(java.lang.Object listInfoParam,
TextPanelAPI textPanel) |
void |
setForceAddNextFrame(boolean add) |
void |
setHidden(boolean hidden) |
void |
setImportant(java.lang.Boolean important) |
void |
setListInfoParam(java.lang.Object listInfoParam) |
void |
setNew(boolean isNew) |
void |
setPlayerVisibleTimestamp(java.lang.Long timestamp) |
void |
setPostingLocation(SectorEntityToken postingLocation) |
void |
setPostingRangeLY(java.lang.Float postingRangeLY) |
void |
setPostingRangeLY(java.lang.Float postingRangeLY,
boolean ensureVisibleOutsideSystem) |
void |
setTagsForSort(java.util.Set<java.lang.String> tagsForSort) |
boolean |
shouldRemoveIntel() |
void |
storyActionConfirmed(java.lang.Object buttonId,
IntelUIAPI ui) |
void |
tableRowClicked(IntelUIAPI ui,
IntelInfoPlugin.TableRowClickData data) |
protected void |
unindent(TooltipMakerAPI info) |
public static final java.lang.String BULLET
public static final java.lang.String INDENT
public static java.lang.String BUTTON_DELETE
protected java.lang.Boolean important
protected java.lang.Long timestamp
protected java.lang.Boolean neverClicked
protected transient java.lang.Object listInfoParam
protected java.lang.Boolean ended
protected java.lang.Boolean ending
protected java.lang.Float endingTimeRemaining
protected SectorEntityToken postingLocation
protected java.lang.Float postingRangeLY
protected transient java.util.Set<java.lang.String> tagsForSort
protected java.lang.Boolean hidden
protected java.lang.Boolean forceAdd
public BaseIntelPlugin()
public void advance(float amount)
EveryFrameScriptadvance in interface EveryFrameScriptamount - seconds elapsed during the last frame.public void notifyPlayerAboutToOpenIntelScreen()
notifyPlayerAboutToOpenIntelScreen in interface IntelInfoPluginprotected void advanceImpl(float amount)
protected void notifyEnding()
protected void notifyEnded()
public void endImmediately()
public void endAfterDelay()
public void endAfterDelay(float days)
protected float getBaseDaysAfterEnd()
public boolean isDone()
isDone in interface EveryFrameScriptpublic boolean runWhilePaused()
runWhilePaused in interface EveryFrameScriptpublic boolean isEnding()
isEnding in interface IntelInfoPluginpublic boolean isEnded()
isEnded in interface IntelInfoPluginpublic java.lang.Object getListInfoParam()
public void setListInfoParam(java.lang.Object listInfoParam)
public boolean isSendingUpdate()
public void sendUpdate(java.lang.Object listInfoParam, TextPanelAPI textPanel)
public void sendUpdateIfPlayerHasIntel(java.lang.Object listInfoParam, TextPanelAPI textPanel)
public void sendUpdateIfPlayerHasIntel(java.lang.Object listInfoParam, boolean onlyIfImportant)
public void sendUpdateIfPlayerHasIntel(java.lang.Object listInfoParam, boolean onlyIfImportant, boolean sendIfHidden)
public boolean canTurnImportantOff()
canTurnImportantOff in interface IntelInfoPluginpublic java.lang.String getImportantIcon()
IntelInfoPlugingetImportantIcon in interface IntelInfoPluginpublic boolean hasImportantButton()
hasImportantButton in interface IntelInfoPluginprotected void addBulletPoints(TooltipMakerAPI info, IntelInfoPlugin.ListInfoMode mode)
protected void addBulletPoints(TooltipMakerAPI info, IntelInfoPlugin.ListInfoMode mode, boolean isUpdate, java.awt.Color tc, float initPad)
public void createIntelInfo(TooltipMakerAPI info, IntelInfoPlugin.ListInfoMode mode)
createIntelInfo in interface IntelInfoPluginprotected java.lang.String getName()
public boolean hasSmallDescription()
hasSmallDescription in interface IntelInfoPluginpublic void createSmallDescription(TooltipMakerAPI info, float width, float height)
createSmallDescription in interface IntelInfoPluginpublic boolean hasLargeDescription()
hasLargeDescription in interface IntelInfoPluginpublic void createLargeDescription(CustomPanelAPI panel, float width, float height)
createLargeDescription in interface IntelInfoPluginpublic java.lang.String getIcon()
IntelInfoPlugingetIcon in interface IntelInfoPluginpublic java.awt.Color getBackgroundGlowColor()
getBackgroundGlowColor in interface IntelInfoPluginpublic boolean shouldRemoveIntel()
shouldRemoveIntel in interface IntelInfoPluginpublic java.util.Set<java.lang.String> getIntelTags(SectorMapAPI map)
IntelInfoPlugingetIntelTags in interface IntelInfoPluginpublic boolean isImportant()
isImportant in interface IntelInfoPluginpublic void setImportant(java.lang.Boolean important)
setImportant in interface IntelInfoPluginpublic FactionAPI getFactionForUIColors()
getFactionForUIColors in interface IntelInfoPluginpublic boolean doesButtonHaveConfirmDialog(java.lang.Object buttonId)
doesButtonHaveConfirmDialog in interface IntelInfoPluginpublic float getConfirmationPromptWidth(java.lang.Object buttonId)
getConfirmationPromptWidth in interface IntelInfoPluginprotected void createDeleteConfirmationPrompt(TooltipMakerAPI prompt)
public void createConfirmationPrompt(java.lang.Object buttonId, TooltipMakerAPI prompt)
createConfirmationPrompt in interface IntelInfoPluginpublic java.lang.String getConfirmText(java.lang.Object buttonId)
getConfirmText in interface IntelInfoPluginpublic java.lang.String getCancelText(java.lang.Object buttonId)
getCancelText in interface IntelInfoPluginprotected void addDeleteButton(TooltipMakerAPI info, float width)
protected void addDeleteButton(TooltipMakerAPI info, float width, java.lang.String delete)
public void buttonPressConfirmed(java.lang.Object buttonId, IntelUIAPI ui)
buttonPressConfirmed in interface IntelInfoPluginpublic void buttonPressCancelled(java.lang.Object buttonId, IntelUIAPI ui)
buttonPressCancelled in interface IntelInfoPluginpublic boolean isPlayerVisible()
public java.lang.Long getPlayerVisibleTimestamp()
getPlayerVisibleTimestamp in interface IntelInfoPluginpublic void setPlayerVisibleTimestamp(java.lang.Long timestamp)
setPlayerVisibleTimestamp in interface IntelInfoPluginpublic float getDaysSincePlayerVisible()
public void reportPlayerClickedOn()
reportPlayerClickedOn in interface IntelInfoPluginpublic boolean isNew()
isNew in interface IntelInfoPluginpublic void setNew(boolean isNew)
setNew in interface IntelInfoPluginpublic IntelInfoPlugin.IntelSortTier getSortTier()
getSortTier in interface IntelInfoPluginpublic java.lang.String getSortString()
getSortString in interface IntelInfoPluginpublic boolean autoAddCampaignMessage()
autoAddCampaignMessage in interface IntelInfoPluginpublic java.lang.String getCommMessageSound()
getCommMessageSound in interface IntelInfoPluginpublic boolean isHidden()
IntelInfoPluginisHidden in interface IntelInfoPluginpublic void setHidden(boolean hidden)
setHidden in interface IntelInfoPluginpublic void reportMadeVisibleToPlayer()
reportMadeVisibleToPlayer in interface IntelInfoPluginprotected float getCommRelayRange()
public boolean canMakeVisibleToPlayer(boolean playerInRelayRange)
IntelInfoPlugincanMakeVisibleToPlayer in interface IntelInfoPluginpublic boolean canMakeVisibleToCommSniffer(boolean playerInRelayRange, SectorEntityToken relay)
canMakeVisibleToCommSniffer in interface CommRelayEntityPlugin.CommSnifferReadableIntelpublic boolean canMakeVisible(boolean playerInRelayRange, LocationAPI conLoc, org.lwjgl.util.vector.Vector2f hyperLoc, boolean commSniffer)
public SectorEntityToken getPostingLocation()
public void setPostingLocation(SectorEntityToken postingLocation)
public java.lang.Float getPostingRangeLY()
public void setPostingRangeLY(java.lang.Float postingRangeLY)
public void setPostingRangeLY(java.lang.Float postingRangeLY, boolean ensureVisibleOutsideSystem)
public void reportRemovedIntel()
reportRemovedIntel in interface IntelInfoPluginpublic SectorEntityToken getMapLocation(SectorMapAPI map)
getMapLocation in interface IntelInfoPluginprotected void bullet(TooltipMakerAPI info)
protected void indent(TooltipMakerAPI info)
protected void unindent(TooltipMakerAPI info)
protected void addDays(TooltipMakerAPI info, java.lang.String after, float days)
protected void addDays(TooltipMakerAPI info, java.lang.String after, float days, java.awt.Color c)
protected void addDays(TooltipMakerAPI info, java.lang.String after, float days, java.awt.Color c, float pad)
protected void addDays(TooltipMakerAPI info, java.lang.String before, java.lang.String after, float days, java.awt.Color c, float pad)
protected java.lang.String getDays(float days)
public static java.lang.String getDaysString(float days)
public java.lang.String getSmallDescriptionTitle()
getSmallDescriptionTitle in interface IntelInfoPluginpublic java.awt.Color getTitleColor(IntelInfoPlugin.ListInfoMode mode)
protected java.awt.Color getBulletColorForMode(IntelInfoPlugin.ListInfoMode mode)
public boolean callEvent(java.lang.String ruleId, InteractionDialogAPI dialog, java.util.List<Misc.Token> params, java.util.Map<java.lang.String,MemoryAPI> memoryMap)
callEvent in interface CallEvent.CallableEventpublic static java.lang.String getSoundStandardPosting()
public static java.lang.String getSoundStandardUpdate()
public static java.lang.String getSoundMajorPosting()
public static java.lang.String getSoundColonyThreat()
public static java.lang.String getSoundLogUpdate()
public static java.lang.String getSoundMinorMessage()
public java.util.List<IntelInfoPlugin.ArrowData> getArrowData(SectorMapAPI map)
getArrowData in interface IntelInfoPluginpublic float getTimeRemainingFraction()
IntelInfoPlugingetTimeRemainingFraction in interface IntelInfoPluginpublic ButtonAPI addGenericButton(TooltipMakerAPI info, float width, java.lang.String text, java.lang.Object data)
public ButtonAPI addGenericButton(TooltipMakerAPI info, float width, java.awt.Color tc, java.awt.Color bg, java.lang.String text, java.lang.Object data)
public boolean forceAddNextFrame()
forceAddNextFrame in interface IntelInfoPluginpublic void setForceAddNextFrame(boolean add)
setForceAddNextFrame in interface IntelInfoPluginpublic static void addMarketToList(TooltipMakerAPI info, MarketAPI market, float pad)
public static void addMarketToList(TooltipMakerAPI info, MarketAPI market, float pad, java.awt.Color tc)
public static void addMarketTable(TooltipMakerAPI info, java.awt.Color base, java.awt.Color dark, java.awt.Color bright, java.util.List<MarketAPI> markets, float width, float pad)
public StoryPointActionDelegate getButtonStoryPointActionDelegate(java.lang.Object buttonId)
getButtonStoryPointActionDelegate in interface IntelInfoPluginpublic void storyActionConfirmed(java.lang.Object buttonId, IntelUIAPI ui)
storyActionConfirmed in interface IntelInfoPluginpublic java.awt.Color getCircleBorderColorOverride()
getCircleBorderColorOverride in interface IntelInfoPluginpublic void tableRowClicked(IntelUIAPI ui, IntelInfoPlugin.TableRowClickData data)
tableRowClicked in interface IntelInfoPluginpublic void addLogTimestamp(TooltipMakerAPI info, java.awt.Color tc, float opad)
public java.lang.String getSortStringNewestFirst()
public java.lang.String getSortStringNewestFirst(java.lang.String prefix)
public java.util.Set<java.lang.String> getTagsForSort()
getTagsForSort in interface IntelInfoPluginpublic void setTagsForSort(java.util.Set<java.lang.String> tagsForSort)
setTagsForSort in interface IntelInfoPlugin