com.fs.starfarer.api.impl.campaign

Class SmugglingScanScript

java.lang.Object

com.fs.starfarer.api.impl.campaign.SmugglingScanScript

All Implemented Interfaces:

EveryFrameScript

public class SmugglingScanScript
extends java.lang.Object
implements EveryFrameScript

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MARKET_TIMEOUT_KEY
static java.lang.String	SCAN_COMPLETE_KEY

Constructor Summary

Constructors

Constructor and Description
SmugglingScanScript()

Method Summary

Modifier and Type	Method and Description
void	advance(float amount) Use SectorAPI.getClock() to convert to campaign days.
protected void	cleanUpCurr()
boolean	isDone()
void	maintainOngoingScan(float days)
boolean	runWhilePaused()

Methods inherited from class java.lang.Object

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

Field Detail

SCAN_COMPLETE_KEY

public static final java.lang.String SCAN_COMPLETE_KEY

See Also:

Constant Field Values

MARKET_TIMEOUT_KEY

public static final java.lang.String MARKET_TIMEOUT_KEY

See Also:

Constant Field Values

Constructor Detail

SmugglingScanScript

public SmugglingScanScript()

Method Detail

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.

maintainOngoingScan

public void maintainOngoingScan(float days)

cleanUpCurr

protected void cleanUpCurr()

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.