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

Class TutorialMissionEvent

java.lang.Object

com.fs.starfarer.api.impl.campaign.events.BaseEventPlugin

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

All Implemented Interfaces:

CampaignEventListener, CampaignEventPlugin, CallEvent.CallableEvent

public class TutorialMissionEvent
extends BaseEventPlugin

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TutorialMissionEvent.TutorialMissionStage

Nested classes/interfaces inherited from class com.fs.starfarer.api.impl.campaign.events.BaseEventPlugin

BaseEventPlugin.MarketFilter

Nested classes/interfaces inherited from interface com.fs.starfarer.api.campaign.CampaignEventListener

CampaignEventListener.FleetDespawnReason

Nested classes/interfaces inherited from interface com.fs.starfarer.api.campaign.events.CampaignEventPlugin

CampaignEventPlugin.CampaignEventCategory, CampaignEventPlugin.PriceUpdatePlugin

Field Summary

Fields

Modifier and Type	Field	Description
protected PlanetAPI	ancyra
protected PersonAPI	dataContact
protected SectorEntityToken	derinkuyu
protected SectorEntityToken	detachment
protected float	elapsedDays
protected boolean	ended
protected SectorEntityToken	fringe
protected SectorEntityToken	inner
protected PlanetAPI	jangala
protected PersonAPI	jangalaContact
protected PersonAPI	mainContact
protected PlanetAPI	pontus
protected SectorEntityToken	probe
static final String	REASON
protected SectorEntityToken	relay
protected TutorialMissionEvent.TutorialMissionStage	stage
protected StarSystemAPI	system
protected PlanetAPI	tetra
static final String	TUT_STAGE

Fields inherited from class com.fs.starfarer.api.impl.campaign.events.BaseEventPlugin

entity, eventTarget, eventType, faction, market, memory, started, startProbability, statModId

Constructor Summary

Constructors

Constructor	Description
TutorialMissionEvent()

Method Summary

Modifier and Type	Method	Description
void	addWeaponsToStorage()
void	advance(float amount)
boolean	callEvent(String ruleId, InteractionDialogAPI dialog, List<Misc.Token> params, Map<String,MemoryAPI> memoryMap)	Called by the CallEvent command (called from rules.csv).
static PersonAPI	createMainContact(PlanetAPI ancyra)
OnMessageDeliveryScript	createSetMessageLocationScript(SectorEntityToken entity)
protected void	endEvent()
static void	endGalatiaPortionOfMission()
String	getCurrentImage()	The larger image in the message detail.
CampaignEventPlugin.CampaignEventCategory	getEventCategory()
String	getEventIcon()	Override for the "image" normally specified in events.json.
String	getEventName()
Color[]	getHighlightColors(String stageId)	Since multiple reports (possibly from different channels) are possible per stage: 1) All reports must have the highlighted text occur in the same order, which is the order this method returns them in, and 2) Not all highlights have to occur in every report.
String[]	getHighlights(String stageId)	Since multiple reports (possibly from different channels) are possible per stage: 1) All reports must have the highlighted text occur in the same order, which is the order this method returns them in, and 2) Not all highlights have to occur in every report.
static PersonAPI	getJangalaContact()
PersonAPI	getMainContact()
Map<String,String>	getTokenReplacements()	Token values for filling out descriptions from reports.csv.
String	getWeaponForSlot(WeaponSlotAPI slot)
void	init(String type, CampaignEventTarget eventTarget)	Called when the EventProbability for this event is accessed.
boolean	isDone()
String	pick(String... strings)
protected void	saveNag()
void	setParam(Object param)	Only called when an event is started via CampaignEventManagerAPI.startEvent().
void	startEvent()	Called when the event starts.
protected void	updateStage(TutorialMissionEvent.TutorialMissionStage stage)

Methods inherited from class com.fs.starfarer.api.impl.campaign.events.BaseEventPlugin

addFactionNameTokens, addPersonTokens, addTokensToList, allowMultipleOngoingForSameTarget, cleanup, findMatchingMarkets, findNearestMarket, getCurrentMessageIcon, getDefaultPriority, getEventTarget, getEventType, getId, getLoggingId, getMemory, getPriceUpdates, getRelatedCommodities, getStageIdForLikely, getStageIdForPossible, getStatModId, getTargetName, getWarningWhenLikelyPriority, getWarningWhenPossiblePriority, increaseRecentUnrest, init, isEventStarted, reportBattleFinished, reportBattleOccurred, reportEconomyMonthEnd, reportEconomyTick, reportEncounterLootGenerated, reportFleetDespawned, reportFleetJumped, reportFleetReachedEntity, reportFleetSpawned, reportPlayerActivatedAbility, reportPlayerClosedMarket, reportPlayerDeactivatedAbility, reportPlayerDidNotTakeCargo, reportPlayerDumpedCargo, reportPlayerEngagement, reportPlayerMarketTransaction, reportPlayerOpenedMarket, reportPlayerOpenedMarketAndCargoUpdated, reportPlayerReputationChange, reportPlayerReputationChange, reportShownInteractionDialog, setProbability, setTarget, showAllMessagesIfOngoing, showLatestMessageIfOngoing, startEvent, useEventNameAsId

Methods inherited from class java.lang.Object

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

Field Details

TUT_STAGE

public static final String TUT_STAGE

See Also:

• Constant Field Values

REASON

public static final String REASON

See Also:

• Constant Field Values

elapsedDays

protected float elapsedDays

ended

protected boolean ended

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

stage

protected TutorialMissionEvent.TutorialMissionStage stage

Constructor Details

TutorialMissionEvent

public TutorialMissionEvent()

Method Details

init

public void init(String type,
 CampaignEventTarget eventTarget)

Description copied from interface: CampaignEventPlugin

Called when the EventProbability for this event is accessed. Doesn't mean the event will actually happen.

Specified by:

init in interface CampaignEventPlugin

Overrides:

init in class BaseEventPlugin

setParam

public void setParam(Object param)

Description copied from interface: CampaignEventPlugin

Only called when an event is started via CampaignEventManagerAPI.startEvent().

Specified by:

setParam in interface CampaignEventPlugin

Overrides:

setParam in class BaseEventPlugin

startEvent

public void startEvent()

Description copied from interface: CampaignEventPlugin

Called when the event starts.

Specified by:

startEvent in interface CampaignEventPlugin

Overrides:

startEvent in class BaseEventPlugin

createMainContact

public static PersonAPI createMainContact(PlanetAPI ancyra)

getJangalaContact

public static PersonAPI getJangalaContact()

getMainContact

public PersonAPI getMainContact()

updateStage

protected void updateStage(TutorialMissionEvent.TutorialMissionStage stage)

endEvent

protected void endEvent()

advance

public void advance(float amount)

Specified by:

advance in interface CampaignEventPlugin

Overrides:

advance in class BaseEventPlugin

callEvent

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

Description copied from interface: CampaignEventPlugin

Called by the CallEvent command (called from rules.csv).

Specified by:

callEvent in interface CallEvent.CallableEvent

Specified by:

callEvent in interface CampaignEventPlugin

Overrides:

callEvent in class BaseEventPlugin

endGalatiaPortionOfMission

public static void endGalatiaPortionOfMission()

saveNag

protected void saveNag()

addWeaponsToStorage

public void addWeaponsToStorage()

getWeaponForSlot

public String getWeaponForSlot(WeaponSlotAPI slot)

pick

public String pick(String... strings)

createSetMessageLocationScript

public OnMessageDeliveryScript createSetMessageLocationScript(SectorEntityToken entity)

getTokenReplacements

public Map<String,String> getTokenReplacements()

Description copied from interface: CampaignEventPlugin

Token values for filling out descriptions from reports.csv.

Specified by:

getTokenReplacements in interface CampaignEventPlugin

Overrides:

getTokenReplacements in class BaseEventPlugin

Returns:

getHighlights

public String[] getHighlights(String stageId)

Description copied from interface: CampaignEventPlugin

Since multiple reports (possibly from different channels) are possible per stage: 1) All reports must have the highlighted text occur in the same order, which is the order this method returns them in, and 2) Not all highlights have to occur in every report.

Specified by:

getHighlights in interface CampaignEventPlugin

Overrides:

getHighlights in class BaseEventPlugin

Returns:

getHighlightColors

public Color[] getHighlightColors(String stageId)

Description copied from interface: CampaignEventPlugin

Since multiple reports (possibly from different channels) are possible per stage: 1) All reports must have the highlighted text occur in the same order, which is the order this method returns them in, and 2) Not all highlights have to occur in every report.

Specified by:

getHighlightColors in interface CampaignEventPlugin

Overrides:

getHighlightColors in class BaseEventPlugin

Returns:

isDone

public boolean isDone()

Specified by:

isDone in interface CampaignEventPlugin

Overrides:

isDone in class BaseEventPlugin

getEventName

public String getEventName()

Specified by:

getEventName in interface CampaignEventPlugin

Overrides:

getEventName in class BaseEventPlugin

getEventCategory

public CampaignEventPlugin.CampaignEventCategory getEventCategory()

Specified by:

getEventCategory in interface CampaignEventPlugin

Overrides:

getEventCategory in class BaseEventPlugin

getEventIcon

public String getEventIcon()

Description copied from interface: CampaignEventPlugin

Override for the "image" normally specified in events.json. Small.

Specified by:

getEventIcon in interface CampaignEventPlugin

Overrides:

getEventIcon in class BaseEventPlugin

Returns:

getCurrentImage

public String getCurrentImage()

Description copied from interface: CampaignEventPlugin

The larger image in the message detail.

Specified by:

getCurrentImage in interface CampaignEventPlugin

Overrides:

getCurrentImage in class BaseEventPlugin

Returns: