Manages all sounds. More...

Collaboration diagram for com.realtime.crossfire.jxclient.sound.SoundManager:

Public Member Functions
void	playClip (@NotNull final Sounds type, @Nullable final String name, @NotNull final String action)
	Plays a sound clip. More...

void	playMusic (@Nullable final String name)
	Plays a background music. More...

void	setEnabled (final boolean enabled)
	Sets whether the sound system is enabled. More...

void	shutdown ()
	Terminates all sounds and free resources. More...

	SoundManager (@NotNull final GuiStateManager guiStateManager, @Nullable final DebugWriter debugSound)
	Creates a new instance. More...

Private Member Functions
void	mute (@NotNull final Sounds type, final boolean mute)
	Mutes or unmutes sound effects. More...

void	muteMusic (final boolean muted)
	Mutes or unmutes background music. More...

Private Attributes
final ClipManager	clipManager
	The clip manager for playing sound effects. More...

final DebugWriter	debugSound
	The writer for logging sound related information or. More...

boolean	enabled
	Whether sound is enabled. More...

final GuiStateListener	guiStateListener
	The GuiStateListener for detecting established or dropped connections. More...

final MusicManager	musicManager
	The music manager for playing background music. More...

final Collection< Sounds >	mutedSounds = EnumSet.allOf(Sounds.class)
	The muted sounds. More...

Detailed Description

Manages all sounds.

Each sound has a sound type (Sounds) attached. Sound types can be disabled (by the user) or muted (by the application). A sound is played only if it is neither disabled nor muted.

Author: Andreas Kirschbaum

Definition at line 39 of file SoundManager.java.

Constructor & Destructor Documentation

◆ SoundManager()

com.realtime.crossfire.jxclient.sound.SoundManager.SoundManager	(	@NotNull final GuiStateManager	guiStateManager,
		@Nullable final DebugWriter	debugSound
	)

Creates a new instance.

Parameters

guiStateManager	the gui state manager to watch
debugSound	the writer for logging sound related information or null to not log

Definition at line 126 of file SoundManager.java.

References com.realtime.crossfire.jxclient.sound.SoundManager.debugSound, and com.realtime.crossfire.jxclient.sound.SoundManager.guiStateListener.

Member Function Documentation

◆ mute()

void com.realtime.crossfire.jxclient.sound.SoundManager.mute	(	@NotNull final Sounds	type,
		final boolean	mute
	)

private

Mutes or unmutes sound effects.

Parameters

type	the sound type to affect
mute	whether to mute ( true ) or unmute ( false )

Definition at line 179 of file SoundManager.java.

◆ muteMusic()

void com.realtime.crossfire.jxclient.sound.SoundManager.muteMusic ( final boolean muted )

private

Mutes or unmutes background music.

Parameters

muted

whether to mute (

true

) or unmute (

false

)

Definition at line 201 of file SoundManager.java.

References com.realtime.crossfire.jxclient.sound.MusicManager.setMuted().

Here is the call graph for this function:

◆ playClip()

void com.realtime.crossfire.jxclient.sound.SoundManager.playClip	(	@NotNull final Sounds	type,
		@Nullable final String	name,
		@NotNull final String	action
	)