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

Class SpeedReduction

java.lang.Object

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

All Implemented Interfaces:

EveryFrameScript

public class SpeedReduction
extends java.lang.Object
implements EveryFrameScript

Field Summary

Fields

Modifier and Type	Field and Description
protected float	durationSeconds
protected float	elapsed
protected float	speedReductionRate
protected SectorEntityToken	target

Constructor Summary

Constructors

Constructor and Description
SpeedReduction(SectorEntityToken target, float speedReductionFraction)
SpeedReduction(SectorEntityToken target, float speedReductionFraction, float durationSeconds)

Method Summary

Modifier and Type	Method and Description
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

elapsed

protected float elapsed

target

protected SectorEntityToken target

speedReductionRate

protected float speedReductionRate

durationSeconds

protected float durationSeconds

Constructor Detail

SpeedReduction

public SpeedReduction(SectorEntityToken target,
                      float speedReductionFraction)

SpeedReduction

public SpeedReduction(SectorEntityToken target,
                      float speedReductionFraction,
                      float durationSeconds)

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.

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.