com.fs.starfarer.api.impl.campaign.tutorial

Class TutorialMissionIntel

java.lang.Object

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

com.fs.starfarer.api.impl.campaign.tutorial.TutorialMissionIntel

All Implemented Interfaces:

IntelInfoPlugin, EveryFrameScript, CommRelayEntityPlugin.CommSnifferReadableIntel, CallEvent.CallableEvent

public class TutorialMissionIntel
extends BaseIntelPlugin
implements EveryFrameScript

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TutorialMissionIntel.TutorialMissionStage

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
protected PlanetAPI	ancyra
protected PersonAPI	dataContact
protected SectorEntityToken	derinkuyu
protected SectorEntityToken	detachment
protected float	elapsedDays
protected FactionAPI	faction
protected SectorEntityToken	fringe
protected SectorEntityToken	inner
protected PlanetAPI	jangala
protected PersonAPI	jangalaContact
protected PersonAPI	mainContact
protected PlanetAPI	pontus
protected int	preRecoverFleetSize
protected SectorEntityToken	probe
static java.lang.String	REASON
protected SectorEntityToken	relay
protected TutorialMissionIntel.TutorialMissionStage	stage
protected StarSystemAPI	system
protected PlanetAPI	tetra
static java.lang.String	TUT_STAGE

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

Method Summary

Modifier and Type	Method and Description
protected void	addBulletPoints(TooltipMakerAPI info, IntelInfoPlugin.ListInfoMode mode)
void	addWeaponsToStorage()
protected void	advanceImpl(float amount)
boolean	callEvent(java.lang.String ruleId, InteractionDialogAPI dialog, java.util.List<Misc.Token> params, java.util.Map<java.lang.String,MemoryAPI> memoryMap)
boolean	canTurnImportantOff()
void	createIntelInfo(TooltipMakerAPI info, IntelInfoPlugin.ListInfoMode mode)
static PersonAPI	createMainContact(PlanetAPI ancyra)
void	createSmallDescription(TooltipMakerAPI info, float width, float height)
protected void	endEvent()
static void	endGalatiaPortionOfMission(boolean withStipend, boolean didTutorial)
java.lang.String	getCommMessageSound()
FactionAPI	getFactionForUIColors()
java.lang.String	getIcon() 40x40, no icon if null.
java.util.Set<java.lang.String>	getIntelTags(SectorMapAPI map) Method NEEDS to handle map being null gracefully.
static PersonAPI	getJangalaContact()
protected java.lang.String	getJangalaContactPostName()
PersonAPI	getMainContact()
protected java.lang.String	getMainContactPostName()
SectorEntityToken	getMapLocation(SectorMapAPI map)
java.lang.String	getName()
java.lang.String	getSmallDescriptionTitle()
java.lang.String	getSortString()
IntelInfoPlugin.IntelSortTier	getSortTier()
java.lang.String	getWeaponForSlot(WeaponSlotAPI slot)
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.
static boolean	isTutorialInProgress() Either this or the tutorial script.
protected void	notifyEnded()
java.lang.String	pick(java.lang.String... strings)
boolean	runWhilePaused()
protected void	saveNag()
protected void	updateStage(TutorialMissionIntel.TutorialMissionStage stage, TextPanelAPI text)

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

addBulletPoints, addDays, addDays, addDays, addDays, addDeleteButton, addDeleteButton, addGenericButton, addGenericButton, addLogTimestamp, addMarketTable, addMarketToList, addMarketToList, advance, autoAddCampaignMessage, bullet, buttonPressCancelled, buttonPressConfirmed, canMakeVisible, canMakeVisibleToCommSniffer, canMakeVisibleToPlayer, createConfirmationPrompt, createDeleteConfirmationPrompt, createLargeDescription, doesButtonHaveConfirmDialog, endAfterDelay, endAfterDelay, endImmediately, forceAddNextFrame, getArrowData, getBackgroundGlowColor, getBaseDaysAfterEnd, getBulletColorForMode, getButtonStoryPointActionDelegate, getCancelText, getCircleBorderColorOverride, getCommRelayRange, getConfirmationPromptWidth, getConfirmText, getDays, getDaysSincePlayerVisible, getDaysString, getImportantIcon, getListInfoParam, getPlayerVisibleTimestamp, getPostingLocation, getPostingRangeLY, getSortStringNewestFirst, getSortStringNewestFirst, getSoundColonyThreat, getSoundLogUpdate, getSoundMajorPosting, getSoundMinorMessage, getSoundStandardPosting, getSoundStandardUpdate, getTagsForSort, getTimeRemainingFraction, getTitleColor, hasImportantButton, hasLargeDescription, hasSmallDescription, indent, isDone, isEnded, isEnding, isImportant, isNew, isPlayerVisible, isSendingUpdate, notifyEnding, notifyPlayerAboutToOpenIntelScreen, reportMadeVisibleToPlayer, reportPlayerClickedOn, reportRemovedIntel, 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

Methods inherited from interface com.fs.starfarer.api.EveryFrameScript

advance, isDone

Field Detail

TUT_STAGE

public static final java.lang.String TUT_STAGE

See Also:

Constant Field Values

REASON

public static final java.lang.String REASON

See Also:

Constant Field Values

elapsedDays

protected float elapsedDays

system

protected StarSystemAPI system

ancyra

protected PlanetAPI ancyra

pontus

protected PlanetAPI pontus

tetra

protected PlanetAPI tetra

derinkuyu

protected SectorEntityToken derinkuyu

probe

protected SectorEntityToken probe

inner

protected SectorEntityToken inner

fringe

protected SectorEntityToken fringe

detachment

protected SectorEntityToken detachment

relay

protected SectorEntityToken relay

mainContact

protected PersonAPI mainContact

dataContact

protected PersonAPI dataContact

jangalaContact

protected PersonAPI jangalaContact

jangala

protected PlanetAPI jangala

faction

protected FactionAPI faction

stage

protected TutorialMissionIntel.TutorialMissionStage stage

preRecoverFleetSize

protected int preRecoverFleetSize

Constructor Detail

TutorialMissionIntel

public TutorialMissionIntel()

Method Detail

isTutorialInProgress

public static boolean isTutorialInProgress()

Either this or the tutorial script. Returns false at the "deliver report to Jangala" stage.

Returns:

createMainContact

public static PersonAPI createMainContact(PlanetAPI ancyra)

getJangalaContact

public static PersonAPI getJangalaContact()

getMainContact

public PersonAPI getMainContact()

updateStage

protected void updateStage(TutorialMissionIntel.TutorialMissionStage stage,
                           TextPanelAPI text)

endEvent

protected void endEvent()

notifyEnded

protected void notifyEnded()

Overrides:

notifyEnded in class BaseIntelPlugin

advanceImpl

protected void advanceImpl(float amount)

Overrides:

advanceImpl in class BaseIntelPlugin

callEvent

public boolean callEvent(java.lang.String ruleId,
                         InteractionDialogAPI dialog,
                         java.util.List<Misc.Token> params,
                         java.util.Map<java.lang.String,MemoryAPI> memoryMap)

Specified by:

callEvent in interface CallEvent.CallableEvent

Overrides:

callEvent in class BaseIntelPlugin

endGalatiaPortionOfMission

public static void endGalatiaPortionOfMission(boolean withStipend,
                                              boolean didTutorial)

saveNag

protected void saveNag()

addWeaponsToStorage

public void addWeaponsToStorage()

getWeaponForSlot

public java.lang.String getWeaponForSlot(WeaponSlotAPI slot)

pick

public java.lang.String pick(java.lang.String... strings)

createIntelInfo

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

Specified by:

createIntelInfo in interface IntelInfoPlugin

Overrides:

createIntelInfo in class BaseIntelPlugin

addBulletPoints

protected void addBulletPoints(TooltipMakerAPI info,
                               IntelInfoPlugin.ListInfoMode mode)

Overrides:

addBulletPoints in class BaseIntelPlugin

getName

public java.lang.String getName()

Overrides:

getName in class BaseIntelPlugin

getFactionForUIColors

public FactionAPI getFactionForUIColors()

Specified by:

getFactionForUIColors in interface IntelInfoPlugin

Overrides:

getFactionForUIColors in class BaseIntelPlugin

getMainContactPostName

protected java.lang.String getMainContactPostName()

getJangalaContactPostName

protected java.lang.String getJangalaContactPostName()

getSmallDescriptionTitle

public java.lang.String getSmallDescriptionTitle()

Specified by:

getSmallDescriptionTitle in interface IntelInfoPlugin

Overrides:

getSmallDescriptionTitle in class BaseIntelPlugin

createSmallDescription

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

Specified by:

createSmallDescription in interface IntelInfoPlugin

Overrides:

createSmallDescription in class BaseIntelPlugin

getIcon

public java.lang.String getIcon()

Description copied from interface: IntelInfoPlugin

40x40, no icon if null.

Specified by:

getIcon in interface IntelInfoPlugin

Overrides:

getIcon in class BaseIntelPlugin

Returns:

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:

getCommMessageSound

public java.lang.String getCommMessageSound()

Specified by:

getCommMessageSound in interface IntelInfoPlugin

Overrides:

getCommMessageSound in class BaseIntelPlugin

getMapLocation

public SectorEntityToken getMapLocation(SectorMapAPI map)

Specified by:

getMapLocation in interface IntelInfoPlugin

Overrides:

getMapLocation in class BaseIntelPlugin

canTurnImportantOff

public boolean canTurnImportantOff()

Specified by:

canTurnImportantOff in interface IntelInfoPlugin

Overrides:

canTurnImportantOff in class BaseIntelPlugin

getSortTier

public IntelInfoPlugin.IntelSortTier getSortTier()

Specified by:

getSortTier in interface IntelInfoPlugin

Overrides:

getSortTier in class BaseIntelPlugin

getSortString

public java.lang.String getSortString()

Specified by:

getSortString in interface IntelInfoPlugin

Overrides:

getSortString in class BaseIntelPlugin

runWhilePaused

public boolean runWhilePaused()

Specified by:

runWhilePaused in interface EveryFrameScript

Overrides:

runWhilePaused in class BaseIntelPlugin

Returns:

whether advance() should be called while the campaign engine is paused.

isHidden

public boolean isHidden()

Description copied from interface: IntelInfoPlugin

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. Something can have "reportMadeVisibleToPlayer" called on it but still be hidden.

Specified by:

isHidden in interface IntelInfoPlugin

Overrides:

isHidden in class BaseIntelPlugin

Returns: