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

Class CampaignTutorialScript

java.lang.Object

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

All Implemented Interfaces:

EveryFrameScript

public class CampaignTutorialScript
extends Object
implements EveryFrameScript

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CampaignTutorialScript.CampaignTutorialStage

Field Summary

Fields

Modifier and Type	Field	Description
protected PlanetAPI	ancyra
protected boolean	askedPlayerToSave
protected boolean	charTabWasOpen
protected CampaignTerrainAPI	debrisField
protected SectorEntityToken	derinkuyu
protected CampaignFleetAPI	detachment
protected float	elapsed
protected TutorialMissionIntel	intel
protected float	lastCheckDistToAncyra
protected boolean	orbitalResetDone
protected CampaignFleetAPI	pirateFleet
protected boolean	playerSaved
protected CampaignTutorialScript.CampaignTutorialStage	quickSaveFrom
protected CampaignTutorialScript.CampaignTutorialStage	stage
protected StarSystemAPI	system
static final String	USE_TUTORIAL_RESPAWN

Constructor Summary

Constructors

Constructor	Description
CampaignTutorialScript(StarSystemAPI system)

Method Summary

Modifier and Type	Method	Description
protected void	addFleets()
protected void	addPirateFleet()
protected void	addSecurityDetachment()
void	advance(float amount)	Use SectorAPI.getClock() to convert to campaign days.
boolean	isDone()
protected void	leashToStartLocation()
protected boolean	quickSaveNag(CampaignTutorialScript.CampaignTutorialStage nagStage, CampaignTutorialScript.CampaignTutorialStage next, float timeout)
protected Object	readResolve()
boolean	runWhilePaused()
protected void	startTutorialMissionEvent()
protected Object	writeReplace()

Methods inherited from class java.lang.Object

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

Field Details

USE_TUTORIAL_RESPAWN

public static final String USE_TUTORIAL_RESPAWN

See Also:

• Constant Field Values

askedPlayerToSave

protected boolean askedPlayerToSave

playerSaved

protected boolean playerSaved

elapsed

protected float elapsed

lastCheckDistToAncyra

protected float lastCheckDistToAncyra

system

protected StarSystemAPI system

ancyra

protected PlanetAPI ancyra

derinkuyu

protected SectorEntityToken derinkuyu

stage

protected CampaignTutorialScript.CampaignTutorialStage stage

orbitalResetDone

protected boolean orbitalResetDone

debrisField

protected CampaignTerrainAPI debrisField

pirateFleet

protected CampaignFleetAPI pirateFleet

detachment

protected CampaignFleetAPI detachment

intel

protected TutorialMissionIntel intel

quickSaveFrom

protected CampaignTutorialScript.CampaignTutorialStage quickSaveFrom

charTabWasOpen

protected boolean charTabWasOpen

Constructor Details

CampaignTutorialScript

public CampaignTutorialScript(StarSystemAPI system)

Method Details

readResolve

protected Object readResolve()

writeReplace

protected Object writeReplace()

quickSaveNag

protected boolean quickSaveNag(CampaignTutorialScript.CampaignTutorialStage nagStage,
 CampaignTutorialScript.CampaignTutorialStage next,
 float timeout)

leashToStartLocation

protected void leashToStartLocation()

advance

public void advance(float amount)

Description copied from interface: EveryFrameScript

Use SectorAPI.getClock() to convert to campaign days.

Specified by:

advance in interface EveryFrameScript

Parameters:

amount - seconds elapsed during the last frame.

addFleets

protected void addFleets()

startTutorialMissionEvent

protected void startTutorialMissionEvent()

addPirateFleet

protected void addPirateFleet()

addSecurityDetachment

protected void addSecurityDetachment()

isDone

public boolean isDone()

Specified by:

isDone in interface EveryFrameScript

Returns:

true when the script is finished and can be cleaned up by the engine.

runWhilePaused

public boolean runWhilePaused()

Specified by:

runWhilePaused in interface EveryFrameScript

Returns:

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