Changeset 6767 for code/branches/sound5/src/orxonox/MoodManager.h

Timestamp:

Apr 20, 2010, 8:31:12 PM (15 years ago)

Author:

youngk

Message:

Added descriptions and missing documentation to the classes I edited last semester. Thanks!

File:

• code/branches/sound5/src/orxonox/MoodManager.h (modified) (1 diff)

code/branches/sound5/src/orxonox/MoodManager.h

@@ -38 +38 @@
 namespace orxonox
 {
+    /**
+     * The MoodManager class enables the game to set different themes, i.e. audio themes, each
+     * with a set of different audio files. A theme (called mood) is set by the server and applies to
+     * all clients. Existing moods are currently hard-coded in function checkMoodValidity(). Each mood
+     * needs to have a folder with its name in "data_extern/audo/ambient/" containing sound files named like
+     * the ones in mood "default".
+     */
     class _OrxonoxExport MoodListener : virtual public OrxonoxClass
     {