vooga.engine.resource.modules
Class SoundModule

java.lang.Object
  extended by vooga.engine.resource.modules.ResourceModule
      extended by vooga.engine.resource.modules.SoundModule

public class SoundModule
extends ResourceModule

ResourceModule designed to track file paths for sound files.


Constructor Summary
SoundModule()
           
 
Method Summary
 void clearElements()
          Clears the current resource map.
static java.lang.String getSound(java.lang.String key)
          Returns the String associated with the given Sound label.
 void loadElements(java.util.Collection<org.w3c.dom.Element> elements)
          Adds Elements to the resource map.
 void loadSound(java.lang.String key, java.io.File file)
          Puts a new entry into this Resources's soundMap, with a String key and a String value.
 void loadSound(java.lang.String key, java.lang.String filePath)
          Puts a new entry into this Resources's soundMap, with a String key and a String value.
 
Methods inherited from class vooga.engine.resource.modules.ResourceModule
getDefaultPath, getGame, setDefaultPath, setGame
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SoundModule

public SoundModule()
Method Detail

clearElements

public void clearElements()
Description copied from class: ResourceModule
Clears the current resource map. Resource maps should be cleared when they are full of currently unneeded resources and the game is starting to use too much memory.

Specified by:
clearElements in class ResourceModule

loadElements

public void loadElements(java.util.Collection<org.w3c.dom.Element> elements)
Description copied from class: ResourceModule
Adds Elements to the resource map. Presumably, these elements are part of a Document from parsing an XML file using the Document Object Model

Specified by:
loadElements in class ResourceModule
Parameters:
elements - Elements of the parsed XML document to be added

loadSound

public void loadSound(java.lang.String key,
                      java.io.File file)
Puts a new entry into this Resources's soundMap, with a String key and a String value.


loadSound

public void loadSound(java.lang.String key,
                      java.lang.String filePath)
Puts a new entry into this Resources's soundMap, with a String key and a String value.


getSound

public static java.lang.String getSound(java.lang.String key)
Returns the String associated with the given Sound label.