com.fs.starfarer.api.impl.campaign.world

Class MoteParticleScript

java.lang.Object

com.fs.starfarer.api.impl.campaign.world.MoteParticleScript

All Implemented Interfaces:

EveryFrameScript

public class MoteParticleScript
extends java.lang.Object
implements EveryFrameScript

Field Summary

Fields

Modifier and Type	Field and Description
protected SectorEntityToken	entity
protected IntervalUtil	moteSpawn
protected float	moteSpawnRate

Constructor Summary

Constructors

Constructor and Description
MoteParticleScript(SectorEntityToken entity, float moteSpawnRate)

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

moteSpawnRate

protected float moteSpawnRate

entity

protected SectorEntityToken entity

moteSpawn

protected IntervalUtil moteSpawn

Constructor Detail

MoteParticleScript

public MoteParticleScript(SectorEntityToken entity,
                          float moteSpawnRate)

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.

spawnMote

public static void spawnMote(SectorEntityToken from)

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.