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

Class MessageIntel

java.lang.Object

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

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

All Implemented Interfaces:

IntelInfoPlugin, EveryFrameScript, CommRelayEntityPlugin.CommSnifferReadableIntel, CallEvent.CallableEvent

public class MessageIntel
extends BaseIntelPlugin

For campaign messages that show up in the lower-left corner, but are not tied to an actual piece of intel. E.G. "fleet member finished repairs" or "got a monthly income report".

Author:

Alex Mosolov Copyright 2018 Fractal Softworks, LLC

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MessageIntel.MessageLineData

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
protected String	extra
protected String	icon
protected List<MessageIntel.MessageLineData>	lines
protected String	sound

Fields inherited from class com.fs.starfarer.api.impl.campaign.intel.BaseIntelPlugin

BULLET, BUTTON_DELETE, ended, ending, endingTimeRemaining, forceAdd, hidden, important, INDENT, listInfoParam, neverClicked, postingLocation, postingRangeLY, tagsForSort, timestamp

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

LIST_ITEM_TEXT_WIDTH, NEW_DAYS

Constructor Summary

Constructors

Constructor	Description
MessageIntel()
MessageIntel(String text)
MessageIntel(String text, Color color)
MessageIntel(String text, Color color, String[] highlights, Color... colors)

Method Summary

Modifier and Type	Method	Description
void	addLine(String text)
void	addLine(String text, Color color)
void	addLine(String text, Color color, String[] highlights, Color... colors)
void	clearLines()
void	createIntelInfo(TooltipMakerAPI info, IntelInfoPlugin.ListInfoMode mode)
String	getCommMessageSound()
String	getExtra()
String	getIcon()	40x40, no icon if null.
String	getSound()
void	setExtra(String extra)
void	setIcon(String icon)
void	setSound(String sound)

Methods inherited from class com.fs.starfarer.api.impl.campaign.intel.BaseIntelPlugin

addBulletPoints, addBulletPoints, addDays, addDays, addDays, addDays, addDeleteButton, addDeleteButton, addGenericButton, addGenericButton, addLogTimestamp, addMarketTable, addMarketToList, addMarketToList, advance, advanceImpl, autoAddCampaignMessage, bullet, buttonPressCancelled, buttonPressConfirmed, callEvent, canMakeVisible, canMakeVisibleToCommSniffer, canMakeVisibleToPlayer, canTurnImportantOff, createConfirmationPrompt, createDeleteConfirmationPrompt, createLargeDescription, createSmallDescription, doesButtonHaveConfirmDialog, endAfterDelay, endAfterDelay, endImmediately, forceAddNextFrame, getArrowData, getBackgroundGlowColor, getBaseDaysAfterEnd, getBulletColorForMode, getButtonStoryPointActionDelegate, getCancelText, getCircleBorderColorOverride, getCommRelayRange, getConfirmationPromptWidth, getConfirmText, getDays, getDaysSincePlayerVisible, getDaysString, getFactionForUIColors, getImportantIcon, getIntelTags, getListInfoParam, getMapLocation, getName, getPlayerVisibleTimestamp, getPostingLocation, getPostingRangeLY, getSmallDescriptionTitle, getSortString, getSortStringNewestFirst, getSortStringNewestFirst, getSortTier, getSoundColonyThreat, getSoundLogUpdate, getSoundMajorPosting, getSoundMinorMessage, getSoundStandardPosting, getSoundStandardUpdate, getTagsForSort, getTimeRemainingFraction, getTitleColor, hasImportantButton, hasLargeDescription, hasSmallDescription, indent, isDone, isEnded, isEnding, isHidden, isImportant, isNew, isPlayerVisible, isSendingUpdate, notifyEnded, notifyEnding, notifyPlayerAboutToOpenIntelScreen, reportMadeVisibleToPlayer, reportPlayerClickedOn, reportRemovedIntel, runWhilePaused, sendUpdate, sendUpdateIfPlayerHasIntel, sendUpdateIfPlayerHasIntel, sendUpdateIfPlayerHasIntel, setForceAddNextFrame, setHidden, setImportant, setListInfoParam, setNew, setPlayerVisibleTimestamp, setPostingLocation, setPostingRangeLY, setPostingRangeLY, setTagsForSort, shouldRemoveIntel, storyActionConfirmed, tableRowClicked, unindent

Methods inherited from class java.lang.Object

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

Field Details

lines

protected List<MessageIntel.MessageLineData> lines

icon

protected String icon

sound

protected String sound

extra

protected String extra

Constructor Details

MessageIntel

public MessageIntel()

MessageIntel

public MessageIntel(String text)

MessageIntel

public MessageIntel(String text,
 Color color)

MessageIntel

public MessageIntel(String text,
 Color color,
 String[] highlights,
 Color... colors)

Method Details

addLine

public void addLine(String text)

addLine

public void addLine(String text,
 Color color)

addLine

public void addLine(String text,
 Color color,
 String[] highlights,
 Color... colors)

clearLines

public void clearLines()

createIntelInfo

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

Specified by:

createIntelInfo in interface IntelInfoPlugin

Overrides:

createIntelInfo in class BaseIntelPlugin

getIcon

public String getIcon()

Description copied from interface: IntelInfoPlugin

40x40, no icon if null.

Specified by:

getIcon in interface IntelInfoPlugin

Overrides:

getIcon in class BaseIntelPlugin

Returns:

setIcon

public void setIcon(String icon)

getSound

public String getSound()

setSound

public void setSound(String sound)

getCommMessageSound

public String getCommMessageSound()

Specified by:

getCommMessageSound in interface IntelInfoPlugin

Overrides:

getCommMessageSound in class BaseIntelPlugin

getExtra

public String getExtra()

setExtra

public void setExtra(String extra)