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

Class BaseMissionIntel

java.lang.Object

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

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

All Implemented Interfaces:

IntelInfoPlugin, EveryFrameScript, CommRelayEntityPlugin.CommSnifferReadableIntel, CallEvent.CallableEvent

Direct Known Subclasses:

AnalyzeEntityMissionIntel, DeliveryMissionIntel, FactionCommissionIntel, ProcurementMissionIntel, SurveyPlanetMissionIntel

public abstract class BaseMissionIntel
extends BaseIntelPlugin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseMissionIntel.MissionResult
static class	BaseMissionIntel.MissionState

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 and Description
static java.lang.String	BUTTON_ABANDON
static java.lang.String	BUTTON_ACCEPT
protected java.lang.Float	duration
protected float	elapsedDays
protected BaseMissionIntel.MissionResult	missionResult
protected BaseMissionIntel.MissionState	missionState
protected IntervalUtil	randomCancel
protected java.lang.Float	randomCancelProb

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 and Description
BaseMissionIntel()

Method Summary

Modifier and Type	Method and Description
protected void	addAbandonButton(TooltipMakerAPI info, float width)
protected void	addAbandonButton(TooltipMakerAPI info, float width, java.lang.String abandon)
protected void	addAcceptButton(TooltipMakerAPI info, float width)
protected void	addAcceptButton(TooltipMakerAPI info, float width, java.lang.String accept)
protected void	addAcceptOrAbandonButton(TooltipMakerAPI info, float width)
protected void	addAcceptOrAbandonButton(TooltipMakerAPI info, float width, java.lang.String accept, java.lang.String abandon)
protected void	addGenericMissionState(TooltipMakerAPI info)
void	advanceImpl(float amount)
abstract void	advanceMission(float amount)
void	buttonPressConfirmed(java.lang.Object buttonId, IntelUIAPI ui)
boolean	canAbandonWithoutPenalty()
protected void	cancel()
protected abstract BaseMissionIntel.MissionResult	createAbandonedResult(boolean withPenalty)
protected BaseMissionIntel.MissionResult	createCancelledResult()
void	createConfirmationPrompt(java.lang.Object buttonId, TooltipMakerAPI prompt)
protected abstract BaseMissionIntel.MissionResult	createTimeRanOutFailedResult()
boolean	doesButtonHaveConfirmDialog(java.lang.Object buttonId)
abstract void	endMission()
java.lang.Float	getDuration()
float	getElapsedDays()
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.
BaseMissionIntel.MissionResult	getMissionResult()
BaseMissionIntel.MissionState	getMissionState()
protected java.lang.String	getMissionTypeNoun()
protected float	getNoPenaltyAbandonDays()
java.lang.String	getPostfixForState()
float	getTimeRemainingFraction() Should return 0 if the concept doesn't apply.
protected void	initRandomCancel()
protected void	initRandomCancel(float prob)
boolean	isAbandoned()
boolean	isAccepted()
boolean	isCancelled()
boolean	isCompleted()
boolean	isFailed()
boolean	isPosted()
abstract void	missionAccepted()
void	setDuration(java.lang.Float duration)
void	setElapsedDays(float elapsedDays)
void	setMissionResult(BaseMissionIntel.MissionResult missionResult)
void	setMissionState(BaseMissionIntel.MissionState missionState)
boolean	shouldRemoveIntel()

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, callEvent, canMakeVisible, canMakeVisibleToCommSniffer, canMakeVisibleToPlayer, canTurnImportantOff, createDeleteConfirmationPrompt, createIntelInfo, createLargeDescription, createSmallDescription, endAfterDelay, endAfterDelay, endImmediately, forceAddNextFrame, getArrowData, getBackgroundGlowColor, getBaseDaysAfterEnd, getBulletColorForMode, getButtonStoryPointActionDelegate, getCancelText, getCircleBorderColorOverride, getCommMessageSound, getCommRelayRange, getConfirmationPromptWidth, getConfirmText, getDays, getDaysSincePlayerVisible, getDaysString, getFactionForUIColors, getIcon, getListInfoParam, getMapLocation, getName, getPlayerVisibleTimestamp, getPostingLocation, getPostingRangeLY, getSmallDescriptionTitle, getSortString, getSortStringNewestFirst, getSortStringNewestFirst, getSortTier, getSoundColonyThreat, getSoundLogUpdate, getSoundMajorPosting, getSoundMinorMessage, getSoundStandardPosting, getSoundStandardUpdate, getTagsForSort, 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, storyActionConfirmed, tableRowClicked, unindent

Methods inherited from class java.lang.Object

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

Field Detail

BUTTON_ACCEPT

public static java.lang.String BUTTON_ACCEPT

BUTTON_ABANDON

public static java.lang.String BUTTON_ABANDON

randomCancel

protected IntervalUtil randomCancel

randomCancelProb

protected java.lang.Float randomCancelProb

missionResult

protected BaseMissionIntel.MissionResult missionResult

missionState

protected BaseMissionIntel.MissionState missionState

duration

protected java.lang.Float duration

elapsedDays

protected float elapsedDays

Constructor Detail

BaseMissionIntel

public BaseMissionIntel()

Method Detail

initRandomCancel

protected void initRandomCancel()

initRandomCancel

protected void initRandomCancel(float prob)

cancel

protected void cancel()

advanceImpl

public void advanceImpl(float amount)

Overrides:

advanceImpl in class BaseIntelPlugin

getTimeRemainingFraction

public float getTimeRemainingFraction()

Description copied from interface: IntelInfoPlugin

Should return 0 if the concept doesn't apply.

Specified by:

getTimeRemainingFraction in interface IntelInfoPlugin

Overrides:

getTimeRemainingFraction in class BaseIntelPlugin

Returns:

isPosted

public boolean isPosted()

isCancelled

public boolean isCancelled()

isFailed

public boolean isFailed()

isCompleted

public boolean isCompleted()

isAccepted

public boolean isAccepted()

isAbandoned

public boolean isAbandoned()

canAbandonWithoutPenalty

public boolean canAbandonWithoutPenalty()

getNoPenaltyAbandonDays

protected float getNoPenaltyAbandonDays()

getImportantIcon

public java.lang.String getImportantIcon()

Description copied from interface: IntelInfoPlugin

20x20, if null will use default.

Specified by:

getImportantIcon in interface IntelInfoPlugin

Overrides:

getImportantIcon in class BaseIntelPlugin

Returns:

endMission

public abstract void endMission()

advanceMission

public abstract void advanceMission(float amount)

missionAccepted

public abstract void missionAccepted()

createTimeRanOutFailedResult

protected abstract BaseMissionIntel.MissionResult createTimeRanOutFailedResult()

createAbandonedResult

protected abstract BaseMissionIntel.MissionResult createAbandonedResult(boolean withPenalty)

createCancelledResult

protected BaseMissionIntel.MissionResult createCancelledResult()

getMissionTypeNoun

protected java.lang.String getMissionTypeNoun()

buttonPressConfirmed

public void buttonPressConfirmed(java.lang.Object buttonId,
                                 IntelUIAPI ui)

Specified by:

buttonPressConfirmed in interface IntelInfoPlugin

Overrides:

buttonPressConfirmed in class BaseIntelPlugin

createConfirmationPrompt

public void createConfirmationPrompt(java.lang.Object buttonId,
                                     TooltipMakerAPI prompt)

Specified by:

createConfirmationPrompt in interface IntelInfoPlugin

Overrides:

createConfirmationPrompt in class BaseIntelPlugin

doesButtonHaveConfirmDialog

public boolean doesButtonHaveConfirmDialog(java.lang.Object buttonId)

Specified by:

doesButtonHaveConfirmDialog in interface IntelInfoPlugin

Overrides:

doesButtonHaveConfirmDialog in class BaseIntelPlugin

getIntelTags

public java.util.Set<java.lang.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:

addGenericMissionState

protected void addGenericMissionState(TooltipMakerAPI info)

getPostfixForState

public java.lang.String getPostfixForState()

addAcceptOrAbandonButton

protected void addAcceptOrAbandonButton(TooltipMakerAPI info,
                                        float width)

addAcceptOrAbandonButton

protected void addAcceptOrAbandonButton(TooltipMakerAPI info,
                                        float width,
                                        java.lang.String accept,
                                        java.lang.String abandon)

addAcceptButton

protected void addAcceptButton(TooltipMakerAPI info,
                               float width)

addAcceptButton

protected void addAcceptButton(TooltipMakerAPI info,
                               float width,
                               java.lang.String accept)

addAbandonButton

protected void addAbandonButton(TooltipMakerAPI info,
                                float width)

addAbandonButton

protected void addAbandonButton(TooltipMakerAPI info,
                                float width,
                                java.lang.String abandon)

getMissionResult

public BaseMissionIntel.MissionResult getMissionResult()

setMissionResult

public void setMissionResult(BaseMissionIntel.MissionResult missionResult)

getMissionState

public BaseMissionIntel.MissionState getMissionState()

setMissionState

public void setMissionState(BaseMissionIntel.MissionState missionState)

getDuration

public java.lang.Float getDuration()

setDuration

public void setDuration(java.lang.Float duration)

getElapsedDays

public float getElapsedDays()

setElapsedDays

public void setElapsedDays(float elapsedDays)

shouldRemoveIntel

public boolean shouldRemoveIntel()

Specified by:

shouldRemoveIntel in interface IntelInfoPlugin

Overrides:

shouldRemoveIntel in class BaseIntelPlugin