com.fs.starfarer.api.impl.campaign.rulecmd.missions

Class BarCMD.BarAmbiencePlayer

java.lang.Object

com.fs.starfarer.api.impl.campaign.rulecmd.missions.BarCMD.BarAmbiencePlayer

All Implemented Interfaces:

EveryFrameScript

Enclosing class:

BarCMD

public static class BarCMD.BarAmbiencePlayer
extends java.lang.Object
implements EveryFrameScript

Field Summary

Fields

Modifier and Type	Field and Description
boolean	done
FaderUtil	fader
MarketAPI	market
float	musicSuppression
float	pitch
java.lang.String	soundId
float	volume

Constructor Summary

Constructors

Constructor and Description
BarCMD.BarAmbiencePlayer(MarketAPI market)

Method Summary

Methods

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

Methods inherited from class java.lang.Object

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

Field Detail

market

public MarketAPI market

soundId

public java.lang.String soundId

pitch

public float pitch

volume

public float volume

musicSuppression

public float musicSuppression

done

public boolean done

fader

public FaderUtil fader

Constructor Detail

BarCMD.BarAmbiencePlayer

public BarCMD.BarAmbiencePlayer(MarketAPI market)

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.

stop

public void stop()