com.fs.starfarer.api.util

Class DelayedActionScript

java.lang.Object

com.fs.starfarer.api.util.DelayedActionScript

All Implemented Interfaces:

EveryFrameScript

Direct Known Subclasses:

DelayedBlueprintLearnScript, KantaCMD.DelayedInstallItemScript

public abstract class DelayedActionScript
extends java.lang.Object
implements EveryFrameScript

Field Summary

Fields

Modifier and Type	Field and Description
protected float	daysLeft
protected java.lang.Boolean	done

Constructor Summary

Constructors

Constructor and Description
DelayedActionScript(float daysLeft)

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

daysLeft

protected float daysLeft

done

protected java.lang.Boolean done

Constructor Detail

DelayedActionScript

public DelayedActionScript(float daysLeft)

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.

doAction

public abstract void doAction()

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.