Package mindustry.audio

Class SoundControl

java.lang.Object

mindustry.audio.SoundControl

public class SoundControl
extends Object

Controls playback of multiple audio tracks.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	SoundControl.SoundData

Field Summary

Fields

Modifier and Type	Field	Description
Seq<Music>	ambientMusic	normal, ambient music, plays at any time
Seq<Music>	bossMusic	music used explicitly after boss spawns
protected Music	current
Seq<Music>	darkMusic	darker music, used in times of conflict
protected float	fade
protected AudioFilter	filter
float	finTime
float	foutTime
protected Music	lastRandomPlayed
float	musicChance
float	musicInterval
float	musicWaveChance
protected boolean	silenced
protected ObjectMap<Sound,SoundControl.SoundData>	sounds
protected Interval	timer
protected AudioBus	uiBus
protected boolean	wasPlaying

Constructor Summary

Constructors

Constructor	Description
SoundControl()

Method Summary

Modifier and Type	Method	Description
protected boolean	isDark()	Whether to play dark music.
void	loop(Sound sound, float volume)
void	loop(Sound sound, Position pos, float volume)
protected void	play(Music music)	Plays and fades in a music track.
protected void	playOnce(Music music)	Plays a music track once and only once.
void	playRandom()	Plays a random track.
protected void	reload()
protected void	setupFilters()
protected boolean	shouldPlay()
protected void	silence()	Fades out the current track, unless it has already been silenced.
void	stop()
void	update()	Update and play the right music track.
protected void	updateLoops()

Methods inherited from class java.lang.Object

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

Field Details

finTime

public float finTime

foutTime

public float foutTime

musicInterval

public float musicInterval

musicChance

public float musicChance

musicWaveChance

public float musicWaveChance

ambientMusic

public Seq<Music> ambientMusic

normal, ambient music, plays at any time

darkMusic

public Seq<Music> darkMusic

darker music, used in times of conflict

bossMusic

public Seq<Music> bossMusic

music used explicitly after boss spawns

lastRandomPlayed

protected Music lastRandomPlayed

timer

protected Interval timer

current

@Nullable
protected Music current

fade

protected float fade

silenced

protected boolean silenced

uiBus

protected AudioBus uiBus

wasPlaying

protected boolean wasPlaying

filter

protected AudioFilter filter

sounds

protected ObjectMap<Sound,SoundControl.SoundData> sounds

Constructor Details

SoundControl

public SoundControl()

Method Details

setupFilters

protected void setupFilters()

reload

protected void reload()

loop

public void loop(Sound sound,
 float volume)

loop

public void loop(Sound sound,
 Position pos,
 float volume)

stop

public void stop()

update

public void update()

Update and play the right music track.

updateLoops

protected void updateLoops()

playRandom

public void playRandom()

Plays a random track.

isDark

protected boolean isDark()

Whether to play dark music.

play

protected void play(@Nullable
 Music music)

Plays and fades in a music track. This must be called every frame. If something is already playing, fades out that track and fades in this new music.

playOnce

protected void playOnce(Music music)

Plays a music track once and only once. If something is already playing, does nothing.

shouldPlay

protected boolean shouldPlay()

silence

protected void silence()

Fades out the current track, unless it has already been silenced.