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

Class BaseEventIntel

java.lang.Object

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

com.fs.starfarer.api.impl.campaign.intel.events.BaseEventIntel

All Implemented Interfaces:

IntelInfoPlugin, EconomyTickListener, EveryFrameScript, CommRelayEntityPlugin.CommSnifferReadableIntel, CallEvent.CallableEvent

Direct Known Subclasses:

HostileActivityEventIntel, HyperspaceTopographyEventIntel, TriTachyonCommerceRaiding

public class BaseEventIntel
extends BaseIntelPlugin
implements EconomyTickListener

For capital-E "Events" with a progress bar, Outcomes, contributing factors, and so on. Large UI; takes up the map area of the intel screen.

Author:

Alex Copyright 2022 Fractal Softworks, LLC

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BaseEventIntel.EventStageData
static class	BaseEventIntel.EventStageDisplayData	Just a data holder for display purposes in the BaseEventIntel UI.
static enum	BaseEventIntel.RandomizedStageType
static enum	BaseEventIntel.StageIconSize

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 InteractionDialogAPI	addingFactorDialog	Adds factor's progress to event progress if it's a one-time factor.
protected List<EventFactor>	factors
protected int	maxProgress
protected boolean	prevProgressDeltaWasPositive
protected int	progress
protected float	progressDeltaRemainder
protected Random	random
static final String	RANDOM_EVENT_NONE	Assigned to EventStageData.rollData when no random event was rolled.
protected IntelInfoPlugin.IntelSortTier	sortTier
protected List<BaseEventIntel.EventStageData>	stages
protected float	uiWidth

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

Method Summary

Modifier and Type	Method	Description
protected boolean	addEventFactorBulletPoints(TooltipMakerAPI info, IntelInfoPlugin.ListInfoMode mode, boolean isUpdate, Color tc, float initPad)
void	addFactor(EventFactor factor)
void	addFactor(EventFactor factor, InteractionDialogAPI dialog)
void	addStage(Object id, int progress)
void	addStage(Object id, int progress, boolean isOneOffEvent)
void	addStage(Object id, int progress, boolean isOneOffEvent, BaseEventIntel.StageIconSize iconSize)
void	addStage(Object id, int progress, BaseEventIntel.StageIconSize iconSize)
void	addStageDescriptionText(TooltipMakerAPI info, float width, Object stageId)
void	addStageDescriptionWithImage(TooltipMakerAPI main, Object stageId)
protected void	advanceImpl(float amount)
void	afterStageDescriptions(TooltipMakerAPI main)
BaseEventIntel.EventStageDisplayData	createDisplayData(Object stageId)
void	createIntelInfo(TooltipMakerAPI info, IntelInfoPlugin.ListInfoMode mode)
void	createLargeDescription(CustomPanelAPI panel, float width, float height)
Color	getBarBracketColor()
Color	getBarColor()
float	getBarHeight()
Color	getBarProgressIndicatorColor()
float	getBarProgressIndicatorHeight()
Color	getBarProgressIndicatorLabelColor()
float	getBarProgressIndicatorWidth()
TooltipMakerAPI.TooltipCreator	getBarTooltip()
float	getBarWidth()
protected Color	getBaseStageColor(Object stageId)
String	getCommMessageSound()
protected Color	getDarkStageColor(Object stageId)
BaseEventIntel.EventStageData	getDataFor(Object stageId)
EventFactor	getFactorOfClass(Class c)
List<EventFactor>	getFactors()
float	getImageIndentForStageDesc(Object stageId)
float	getImageSizeForStageDesc(Object stageId)
Set<String>	getIntelTags(SectorMapAPI map)	Method NEEDS to handle map being null gracefully.
BaseEventIntel.EventStageData	getLastActiveStage(boolean includeOneOffEvents)
int	getMaxMonthlyProgress()
int	getMaxProgress()
int	getMonthlyProgress()
int	getProgress()
Color	getProgressColor(int delta)
float	getProgressFraction()
Random	getRandom()
int	getRequiredProgress(Object stageId)
IntelInfoPlugin.IntelSortTier	getSortTier()
protected String	getSoundForOneTimeFactorUpdate(EventFactor factor)
protected String	getSoundForOtherUpdate(Object param)
protected String	getSoundForStageReachedUpdate(Object stageId)
protected Color	getStageColor(Object stageId)
protected float	getStageDownLineLength(Object stageId)
protected String	getStageIcon(Object stageId)
protected Color	getStageIconColor(Object stageId)
protected String	getStageIconImpl(Object stageId)
protected float	getStageIconSize(Object stageId)
protected int	getStageImportance(Object stageId)
protected String	getStageLabel(Object stageId)
protected Color	getStageLabelColor(Object stageId)
List<BaseEventIntel.EventStageData>	getStages()
TooltipMakerAPI.TooltipCreator	getStageTooltip(Object stageId)
TooltipMakerAPI.TooltipCreator	getStageTooltipImpl(Object stageId)
TextPanelAPI	getTextPanelForStageChange()
boolean	hasLargeDescription()
boolean	hasSmallDescription()
boolean	isEventProgressANegativeThingForThePlayer()
boolean	isStageActive(Object stageId)
boolean	isStageActiveAndLast(Object stageId)
boolean	isStageActiveAndLast(Object stageId, boolean includeOneOffEvents)
boolean	isStageOrOneOffEventReached(Object stageId)
protected void	notifyEnded()
protected void	notifyEnding()
protected void	notifyStageReached(BaseEventIntel.EventStageData stage)
boolean	putBarProgressIndicatorLabelOnRight()
void	removeFactor(EventFactor factor)
void	removeFactorOfClass(Class<EventFactor> c)
void	reportEconomyMonthEnd()
void	reportEconomyTick(int iterIndex)
void	resetRandomizedStage(BaseEventIntel.EventStageData stage)
void	rollRandomizedStage(BaseEventIntel.EventStageData stage)
void	setHideStageWhenPastIt(Object stageId)
void	setMaxProgress(int maxProgress)
void	setProgress(int progress)
void	setRandom(Random random)
void	setRandomized(Object stageId, BaseEventIntel.RandomizedStageType type, int resetAt, int rollAt, boolean sendUpdateWhenReached)
void	setRandomized(Object stageId, BaseEventIntel.RandomizedStageType type, int resetAt, int rollAt, boolean sendUpdateWhenReached, boolean repeatable)
void	setSortTier(IntelInfoPlugin.IntelSortTier sortTier)
boolean	withMonthlyFactors()
boolean	withOneTimeFactors()

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, autoAddCampaignMessage, bullet, buttonPressCancelled, buttonPressConfirmed, callEvent, canMakeVisible, canMakeVisibleToCommSniffer, canMakeVisibleToPlayer, canTurnImportantOff, createConfirmationPrompt, createDeleteConfirmationPrompt, createSmallDescription, doesButtonHaveConfirmDialog, endAfterDelay, endAfterDelay, endImmediately, forceAddNextFrame, getArrowData, getBackgroundGlowColor, getBaseDaysAfterEnd, getBulletColorForMode, getButtonStoryPointActionDelegate, getCancelText, getCircleBorderColorOverride, getCommRelayRange, getConfirmationPromptWidth, getConfirmText, getDays, getDaysSincePlayerVisible, getDaysString, getFactionForUIColors, getIcon, getImportantIcon, getListInfoParam, getMapLocation, getName, getPlayerVisibleTimestamp, getPostingLocation, getPostingRangeLY, getSmallDescriptionTitle, getSortString, getSortStringNewestFirst, getSortStringNewestFirst, getSoundColonyThreat, getSoundLogUpdate, getSoundMajorPosting, getSoundMinorMessage, getSoundStandardPosting, getSoundStandardUpdate, getTagsForSort, getTimeRemainingFraction, getTitleColor, hasImportantButton, indent, isDone, isEnded, isEnding, isHidden, isImportant, isNew, isPlayerVisible, isSendingUpdate, 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

RANDOM_EVENT_NONE

public static final String RANDOM_EVENT_NONE

Assigned to EventStageData.rollData when no random event was rolled.

See Also:

• Constant Field Values

progress

protected int progress

maxProgress

protected int maxProgress

stages

protected List<BaseEventIntel.EventStageData> stages

sortTier

protected IntelInfoPlugin.IntelSortTier sortTier

factors

protected List<EventFactor> factors

random

protected Random random

progressDeltaRemainder

protected float progressDeltaRemainder

uiWidth

protected transient float uiWidth

addingFactorDialog

protected transient InteractionDialogAPI addingFactorDialog

Adds factor's progress to event progress if it's a one-time factor. If dialog is passed in, it'll be visible to notifyStageReached() via addingFactorDialog, in case that needs to print an update there.

prevProgressDeltaWasPositive

protected transient boolean prevProgressDeltaWasPositive

Constructor Details

BaseEventIntel

public BaseEventIntel()

Method Details

advanceImpl

protected void advanceImpl(float amount)

Overrides:

advanceImpl in class BaseIntelPlugin

createIntelInfo

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

Specified by:

createIntelInfo in interface IntelInfoPlugin

Overrides:

createIntelInfo in class BaseIntelPlugin

addEventFactorBulletPoints

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

createLargeDescription

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

Specified by:

createLargeDescription in interface IntelInfoPlugin

Overrides:

createLargeDescription in class BaseIntelPlugin

getBarTooltip

public TooltipMakerAPI.TooltipCreator getBarTooltip()

getStageTooltip

public TooltipMakerAPI.TooltipCreator getStageTooltip(Object stageId)

getStageTooltipImpl

public TooltipMakerAPI.TooltipCreator getStageTooltipImpl(Object stageId)

getImageSizeForStageDesc

public float getImageSizeForStageDesc(Object stageId)

getImageIndentForStageDesc

public float getImageIndentForStageDesc(Object stageId)

afterStageDescriptions

public void afterStageDescriptions(TooltipMakerAPI main)

addStageDescriptionWithImage

public void addStageDescriptionWithImage(TooltipMakerAPI main,
 Object stageId)

addStageDescriptionText

public void addStageDescriptionText(TooltipMakerAPI info,
 float width,
 Object stageId)

createDisplayData

public BaseEventIntel.EventStageDisplayData createDisplayData(Object stageId)

getStageIcon

protected String getStageIcon(Object stageId)

getStageIconImpl

protected String getStageIconImpl(Object stageId)

getStageIconSize

protected float getStageIconSize(Object stageId)

getStageDownLineLength

protected float getStageDownLineLength(Object stageId)

getBarWidth

public float getBarWidth()

getBarHeight

public float getBarHeight()

putBarProgressIndicatorLabelOnRight

public boolean putBarProgressIndicatorLabelOnRight()

getBarProgressIndicatorHeight

public float getBarProgressIndicatorHeight()

getBarProgressIndicatorWidth

public float getBarProgressIndicatorWidth()

getBarProgressIndicatorLabelColor

public Color getBarProgressIndicatorLabelColor()

getBarProgressIndicatorColor

public Color getBarProgressIndicatorColor()

getBarBracketColor

public Color getBarBracketColor()

getBarColor

public Color getBarColor()

getBaseStageColor

protected Color getBaseStageColor(Object stageId)

getDarkStageColor

protected Color getDarkStageColor(Object stageId)

getStageColor

protected Color getStageColor(Object stageId)

getStageIconColor

protected Color getStageIconColor(Object stageId)

getStageImportance

protected int getStageImportance(Object stageId)

getStageLabel

protected String getStageLabel(Object stageId)

getStageLabelColor

protected Color getStageLabelColor(Object stageId)

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

Overrides:

getIntelTags in class BaseIntelPlugin

Returns:

hasSmallDescription

public boolean hasSmallDescription()

Specified by:

hasSmallDescription in interface IntelInfoPlugin

Overrides:

hasSmallDescription in class BaseIntelPlugin

hasLargeDescription

public boolean hasLargeDescription()

Specified by:

hasLargeDescription in interface IntelInfoPlugin

Overrides:

hasLargeDescription in class BaseIntelPlugin

getMaxProgress

public int getMaxProgress()

setMaxProgress

public void setMaxProgress(int maxProgress)

getStages

public List<BaseEventIntel.EventStageData> getStages()

isStageOrOneOffEventReached

public boolean isStageOrOneOffEventReached(Object stageId)

isStageActiveAndLast

public boolean isStageActiveAndLast(Object stageId)

isStageActiveAndLast

public boolean isStageActiveAndLast(Object stageId,
 boolean includeOneOffEvents)

addStage

public void addStage(Object id,
 int progress)

addStage

public void addStage(Object id,
 int progress,
 BaseEventIntel.StageIconSize iconSize)

addStage

public void addStage(Object id,
 int progress,
 boolean isOneOffEvent)

addStage

public void addStage(Object id,
 int progress,
 boolean isOneOffEvent,
 BaseEventIntel.StageIconSize iconSize)

isStageActive

public boolean isStageActive(Object stageId)

getLastActiveStage

public BaseEventIntel.EventStageData getLastActiveStage(boolean includeOneOffEvents)

getDataFor

public BaseEventIntel.EventStageData getDataFor(Object stageId)

getRequiredProgress

public int getRequiredProgress(Object stageId)

setSortTier

public void setSortTier(IntelInfoPlugin.IntelSortTier sortTier)

getSortTier

public IntelInfoPlugin.IntelSortTier getSortTier()

Specified by:

getSortTier in interface IntelInfoPlugin

Overrides:

getSortTier in class BaseIntelPlugin

notifyEnded

protected void notifyEnded()

Overrides:

notifyEnded in class BaseIntelPlugin

notifyEnding

protected void notifyEnding()

Overrides:

notifyEnding in class BaseIntelPlugin

addFactor

public void addFactor(EventFactor factor)

addFactor

public void addFactor(EventFactor factor,
 InteractionDialogAPI dialog)

getTextPanelForStageChange

public TextPanelAPI getTextPanelForStageChange()

getFactors

public List<EventFactor> getFactors()

getFactorOfClass

public EventFactor getFactorOfClass(Class c)

removeFactor

public void removeFactor(EventFactor factor)

removeFactorOfClass

public void removeFactorOfClass(Class<EventFactor> c)

isEventProgressANegativeThingForThePlayer

public boolean isEventProgressANegativeThingForThePlayer()

getMaxMonthlyProgress

public int getMaxMonthlyProgress()

getMonthlyProgress

public int getMonthlyProgress()

reportEconomyTick

public void reportEconomyTick(int iterIndex)

Specified by:

reportEconomyTick in interface EconomyTickListener

getProgress

public int getProgress()

setProgress

public void setProgress(int progress)

getSoundForStageReachedUpdate

protected String getSoundForStageReachedUpdate(Object stageId)

getSoundForOneTimeFactorUpdate

protected String getSoundForOneTimeFactorUpdate(EventFactor factor)

getSoundForOtherUpdate

protected String getSoundForOtherUpdate(Object param)

getCommMessageSound

public String getCommMessageSound()

Specified by:

getCommMessageSound in interface IntelInfoPlugin

Overrides:

getCommMessageSound in class BaseIntelPlugin

notifyStageReached

protected void notifyStageReached(BaseEventIntel.EventStageData stage)

reportEconomyMonthEnd

public void reportEconomyMonthEnd()

Specified by:

reportEconomyMonthEnd in interface EconomyTickListener

getProgressColor

public Color getProgressColor(int delta)

setHideStageWhenPastIt

public void setHideStageWhenPastIt(Object stageId)

setRandomized

public void setRandomized(Object stageId,
 BaseEventIntel.RandomizedStageType type,
 int resetAt,
 int rollAt,
 boolean sendUpdateWhenReached)

setRandomized

public void setRandomized(Object stageId,
 BaseEventIntel.RandomizedStageType type,
 int resetAt,
 int rollAt,
 boolean sendUpdateWhenReached,
 boolean repeatable)

getRandom

public Random getRandom()

setRandom

public void setRandom(Random random)

resetRandomizedStage

public void resetRandomizedStage(BaseEventIntel.EventStageData stage)

rollRandomizedStage

public void rollRandomizedStage(BaseEventIntel.EventStageData stage)

getProgressFraction

public float getProgressFraction()

withMonthlyFactors

public boolean withMonthlyFactors()

withOneTimeFactors

public boolean withOneTimeFactors()