com.fs.starfarer.api.impl.campaign.ghosts

Class GBIGenerateSlipstream

java.lang.Object

com.fs.starfarer.api.impl.campaign.ghosts.BaseGhostBehaviorInterrupt

com.fs.starfarer.api.impl.campaign.ghosts.GBIGenerateSlipstream

All Implemented Interfaces:

EveryFrameScript, GhostBehaviorInterrupt

public class GBIGenerateSlipstream
extends BaseGhostBehaviorInterrupt
implements EveryFrameScript

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GBIGenerateSlipstream.GhostBehaviorWithSlipstream

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	addedScript
protected GhostBehavior	behavior
protected int	burnLevel
protected float	duration
protected SensorGhost	ghost
protected int	maxSegments
protected float	maxWidth
protected float	minWidth
protected SlipstreamTerrainPlugin2	plugin
protected org.lwjgl.util.vector.Vector2f	prev
protected CampaignTerrainAPI	slipstream
protected float	widenRate

Fields inherited from class com.fs.starfarer.api.impl.campaign.ghosts.BaseGhostBehaviorInterrupt

delay

Constructor Summary

Constructors

Constructor and Description
GBIGenerateSlipstream(float minWidth, float maxWidth, int burnLevel, float widenRate, int maxSegments, float duration)

Method Summary

Modifier and Type	Method and Description
void	advance(float amount) Use SectorAPI.getClock() to convert to campaign days.
void	advance(float amount, SensorGhost ghost, GhostBehavior behavior)
boolean	isDone()
boolean	runWhilePaused()
boolean	shouldInterruptBehavior(SensorGhost ghost, GhostBehavior behavior)

Methods inherited from class com.fs.starfarer.api.impl.campaign.ghosts.BaseGhostBehaviorInterrupt

hasDelayRemaining

Methods inherited from class java.lang.Object

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

Field Detail

addedScript

protected boolean addedScript

minWidth

protected float minWidth

maxWidth

protected float maxWidth

burnLevel

protected int burnLevel

ghost

protected SensorGhost ghost

behavior

protected GhostBehavior behavior

widenRate

protected float widenRate

maxSegments

protected int maxSegments

duration

protected float duration

slipstream

protected CampaignTerrainAPI slipstream

plugin

protected SlipstreamTerrainPlugin2 plugin

prev

protected org.lwjgl.util.vector.Vector2f prev

Constructor Detail

GBIGenerateSlipstream

public GBIGenerateSlipstream(float minWidth,
                             float maxWidth,
                             int burnLevel,
                             float widenRate,
                             int maxSegments,
                             float duration)

Method Detail

shouldInterruptBehavior

public boolean shouldInterruptBehavior(SensorGhost ghost,
                                       GhostBehavior behavior)

Specified by:

shouldInterruptBehavior in interface GhostBehaviorInterrupt

Overrides:

shouldInterruptBehavior in class BaseGhostBehaviorInterrupt

advance

public void advance(float amount,
                    SensorGhost ghost,
                    GhostBehavior behavior)

Specified by:

advance in interface GhostBehaviorInterrupt

Overrides:

advance in class BaseGhostBehaviorInterrupt

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.

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.