Inheritance diagram for com.fs.starfarer.api.impl.campaign.intel.MessageIntel:

Collaboration diagram for com.fs.starfarer.api.impl.campaign.intel.MessageIntel:

Classes
class	MessageLineData

Public Member Functions
	MessageIntel ()

	MessageIntel (String text)

	MessageIntel (String text, Color color)

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

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, ListInfoMode mode)

String	getIcon ()

void	setIcon (String icon)

String	getSound ()

void	setSound (String sound)

String	getCommMessageSound ()

String	getExtra ()

void	setExtra (String extra)

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 ()

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

boolean	hasLargeDescription ()

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

Color	getBackgroundGlowColor ()

boolean	shouldRemoveIntel ()

Set< String >	getIntelTags (SectorMapAPI map)

boolean	isImportant ()

void	setImportant (Boolean important)

FactionAPI	getFactionForUIColors ()

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 ()

String	getSortString ()

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 ()

SectorEntityToken	getMapLocation (SectorMapAPI map)

String	getSmallDescriptionTitle ()

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 Attributes
List< MessageLineData >	lines = new ArrayList<MessageLineData>()

String	icon

String	sound

String	extra

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

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)

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

String	getName ()

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)

Detailed Description

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

Definition at line 21 of file MessageIntel.java.

Constructor & Destructor Documentation

◆ MessageIntel() [1/4]

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

Definition at line 57 of file MessageIntel.java.

◆ MessageIntel() [2/4]

com.fs.starfarer.api.impl.campaign.intel.MessageIntel.MessageIntel ( String text )

Definition at line 61 of file MessageIntel.java.

◆ MessageIntel() [3/4]

com.fs.starfarer.api.impl.campaign.intel.MessageIntel.MessageIntel	(	String	text,
		Color	color )

Definition at line 64 of file MessageIntel.java.

◆ MessageIntel() [4/4]

com.fs.starfarer.api.impl.campaign.intel.MessageIntel.MessageIntel	(	String	text,
		Color	color,
		String[]	highlights,
		Color ...	colors )

Definition at line 67 of file MessageIntel.java.

Member Function Documentation

◆ addLine() [1/3]

void com.fs.starfarer.api.impl.campaign.intel.MessageIntel.addLine ( String text )

Definition at line 71 of file MessageIntel.java.

◆ addLine() [2/3]

void com.fs.starfarer.api.impl.campaign.intel.MessageIntel.addLine	(	String	text,
		Color	color )

Definition at line 74 of file MessageIntel.java.

◆ addLine() [3/3]

void com.fs.starfarer.api.impl.campaign.intel.MessageIntel.addLine	(	String	text,
		Color	color,
		String[]	highlights,
		Color ...	colors )

Definition at line 77 of file MessageIntel.java.

◆ clearLines()

void com.fs.starfarer.api.impl.campaign.intel.MessageIntel.clearLines ( )

Definition at line 82 of file MessageIntel.java.

◆ createIntelInfo()

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

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

Definition at line 87 of file MessageIntel.java.

◆ getCommMessageSound()

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

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

Definition at line 138 of file MessageIntel.java.

◆ getExtra()

String com.fs.starfarer.api.impl.campaign.intel.MessageIntel.getExtra ( )

Definition at line 145 of file MessageIntel.java.

◆ getIcon()

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

40x40, no icon if null.

Returns

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

Definition at line 121 of file MessageIntel.java.

◆ getSound()

String com.fs.starfarer.api.impl.campaign.intel.MessageIntel.getSound ( )

Definition at line 129 of file MessageIntel.java.

◆ setExtra()

void com.fs.starfarer.api.impl.campaign.intel.MessageIntel.setExtra ( String extra )

Definition at line 149 of file MessageIntel.java.

◆ setIcon()

void com.fs.starfarer.api.impl.campaign.intel.MessageIntel.setIcon ( String icon )

Definition at line 125 of file MessageIntel.java.

◆ setSound()

void com.fs.starfarer.api.impl.campaign.intel.MessageIntel.setSound ( String sound )

Definition at line 133 of file MessageIntel.java.

Member Data Documentation

◆ extra

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

protected

Definition at line 55 of file MessageIntel.java.

◆ icon

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

protected

Definition at line 53 of file MessageIntel.java.

◆ lines

List<MessageLineData> com.fs.starfarer.api.impl.campaign.intel.MessageIntel.lines = new ArrayList<MessageLineData>()

protected

Definition at line 52 of file MessageIntel.java.

◆ sound

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

protected

Definition at line 54 of file MessageIntel.java.

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

src/com/fs/starfarer/api/impl/campaign/intel/MessageIntel.java

Classes

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MessageIntel() [1/4]

◆ MessageIntel() [2/4]

◆ MessageIntel() [3/4]

◆ MessageIntel() [4/4]

Member Function Documentation

◆ addLine() [1/3]

◆ addLine() [2/3]

◆ addLine() [3/3]

◆ clearLines()

◆ createIntelInfo()

◆ getCommMessageSound()

◆ getExtra()

◆ getIcon()

◆ getSound()

◆ setExtra()

◆ setIcon()

◆ setSound()

Member Data Documentation

◆ extra

◆ icon

◆ lines

◆ sound