Package com.csse3200.game.components

Class SoundComponent

java.lang.Object

com.csse3200.game.components.Component

com.csse3200.game.components.SoundComponent

public class SoundComponent
extends Component

This component can be used to trigger sounds by an entity to play.

Field Summary

Fields inherited from class com.csse3200.game.components.Component

enabled, entity

Constructor Summary

Constructors

Constructor	Description
SoundComponent(SoundsConfig soundsConfig)	Creates a new SoundComponent using the sounds specified in the soundsConfig file.

Method Summary

Modifier and Type	Method	Description
void	create()	Loads the sounds specified in the config file into a hashmap for later use.
void	loopSound(String soundName)	Loops the sound which soundName maps to if it exists.
void	playSound(String soundName)	Plays the sound which soundName maps to if it exists.
void	stopSound(String soundName)	Stops the sound which soundName maps to if it exists.

Methods inherited from class com.csse3200.game.components.Component

dispose, earlyUpdate, getEntity, setEnabled, setEntity, toString, triggerEarlyUpdate, triggerUpdate, update

Methods inherited from class java.lang.Object

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

Constructor Details

SoundComponent

public SoundComponent(SoundsConfig soundsConfig)

Creates a new SoundComponent using the sounds specified in the soundsConfig file.

Parameters:

soundsConfig - - the config file containing the sounds which can be played.

Method Details

create

public void create()

Loads the sounds specified in the config file into a hashmap for later use.

Overrides:

create in class Component

playSound

public void playSound(String soundName)

Plays the sound which soundName maps to if it exists. If soundName does not map to a loaded sound, nothing happens.

Parameters:

soundName - - the name of the sound to play as specified in the config file.

loopSound

public void loopSound(String soundName)

Loops the sound which soundName maps to if it exists. If soundName does not map to a loaded sound, nothing happens.

Parameters:

soundName - - the name of the sound to loop as specified in the config file.

stopSound

public void stopSound(String soundName)

Stops the sound which soundName maps to if it exists. If soundName does not map to a loaded sound, nothing happens. If the specified sound is not playing, nothing happens.

Parameters:

soundName - - the name of the sound to stop as specified in the config file.