com.fs.starfarer.api.impl.campaign.abilities

Class GenerateSlipsurgeAbility.SlipsurgeEffectScript

java.lang.Object

com.fs.starfarer.api.impl.campaign.abilities.GenerateSlipsurgeAbility.SlipsurgeEffectScript

All Implemented Interfaces:

EveryFrameScript

Enclosing class:

GenerateSlipsurgeAbility

public static class GenerateSlipsurgeAbility.SlipsurgeEffectScript
extends java.lang.Object
implements EveryFrameScript

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	didTempCleanup
protected boolean	done
protected float	elapsed
protected CampaignFleetAPI	fleet
protected SlipstreamTerrainPlugin2	plugin
protected boolean	triggered

Constructor Summary

Constructors

Constructor and Description
SlipsurgeEffectScript(CampaignFleetAPI fleet, SlipstreamTerrainPlugin2 plugin)

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

fleet

protected CampaignFleetAPI fleet

triggered

protected boolean triggered

done

protected boolean done

didTempCleanup

protected boolean didTempCleanup

elapsed

protected float elapsed

plugin

protected SlipstreamTerrainPlugin2 plugin

Constructor Detail

SlipsurgeEffectScript

public SlipsurgeEffectScript(CampaignFleetAPI fleet,
                             SlipstreamTerrainPlugin2 plugin)

Method Detail

abort

public void abort()

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.

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.