com.fs.starfarer.api.impl.campaign

Class AbyssalLightEntityPlugin.AbyssalLightSoundStopper

java.lang.Object

com.fs.starfarer.api.impl.campaign.AbyssalLightEntityPlugin.AbyssalLightSoundStopper

All Implemented Interfaces:

EveryFrameScript

Enclosing class:

AbyssalLightEntityPlugin

public static class AbyssalLightEntityPlugin.AbyssalLightSoundStopper
extends java.lang.Object
implements EveryFrameScript

Field Summary

Fields

Modifier and Type	Field and Description
protected float	elapsed
protected SoundAPI	sound

Constructor Summary

Constructors

Constructor and Description
AbyssalLightSoundStopper(SoundAPI sound)

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

sound

protected transient SoundAPI sound

elapsed

protected float elapsed

Constructor Detail

AbyssalLightSoundStopper

public AbyssalLightSoundStopper(SoundAPI sound)

Method Detail

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.