Package 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 Object implements EveryFrameScript

  • Field Details

    • market

      public MarketAPI market

    • soundId

      public String soundId

    • pitch

      public float pitch

    • volume

      public float volume

    • musicSuppression

      public float musicSuppression

    • done

      public boolean done

    • fader

      public FaderUtil fader

  • Constructor Details

    • BarAmbiencePlayer

      public BarAmbiencePlayer(MarketAPI market)

  • Method Details

    • 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()