com.fs.starfarer.api.util.DelayedActionScript Class Reference

Inheritance diagram for com.fs.starfarer.api.util.DelayedActionScript:

Collaboration diagram for com.fs.starfarer.api.util.DelayedActionScript:

Public Member Functions
	DelayedActionScript (float daysLeft)
void	advance (float amount)
abstract void	doAction ()
boolean	isDone ()
boolean	runWhilePaused ()
Public Member Functions inherited from com.fs.starfarer.api.EveryFrameScript

Protected Attributes
float	daysLeft
Boolean	done = null

Detailed Description

Definition at line 6 of file DelayedActionScript.java.

Constructor & Destructor Documentation

DelayedActionScript()

com.fs.starfarer.api.util.DelayedActionScript.DelayedActionScript

(

float

daysLeft

)

Definition at line 10 of file DelayedActionScript.java.

Member Function Documentation

advance()

void com.fs.starfarer.api.util.DelayedActionScript.advance

(

float

amount

)

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

Parameters

amount

seconds elapsed during the last frame.

Implements com.fs.starfarer.api.EveryFrameScript.

Definition at line 14 of file DelayedActionScript.java.

doAction()

abstract void com.fs.starfarer.api.util.DelayedActionScript.doAction ( )

abstract

Reimplemented in com.fs.starfarer.api.impl.campaign.DelayedBlueprintLearnScript.

isDone()

boolean com.fs.starfarer.api.util.DelayedActionScript.isDone

(

)

Returns

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

Implements com.fs.starfarer.api.EveryFrameScript.

Definition at line 25 of file DelayedActionScript.java.

runWhilePaused()

boolean com.fs.starfarer.api.util.DelayedActionScript.runWhilePaused

(

)

Returns

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

Implements com.fs.starfarer.api.EveryFrameScript.

Definition at line 29 of file DelayedActionScript.java.

Member Data Documentation

daysLeft

float com.fs.starfarer.api.util.DelayedActionScript.daysLeft

protected

Definition at line 8 of file DelayedActionScript.java.

done

Boolean com.fs.starfarer.api.util.DelayedActionScript.done = null

protected

Definition at line 9 of file DelayedActionScript.java.

---

The documentation for this class was generated from the following file:

• src/com/fs/starfarer/api/util/DelayedActionScript.java