Context Navigation

Changeset 6767 for code/branches

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!

Location:

code/branches/sound5/src/orxonox

Files:

-                      r6417
+                      r6767
 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
+    {

-                      r6674
+                      r6767
  *   Author:
  *      Reto Grieder
+ *
+ *   Co-authors:
  *      Kevin Young
- *   Co-authors:
- *      ...
+ *
  */
 …
+{
     /**
+     * The AmbientSound class is the base class for all sound file loader classes.
+     * It server as main interface to the OpenAL library.
+     * The AmbientSound class implements the non-3D sound, i.e. sound files that are used for atmospheric
+     * highlighting.
+     * It interfaces with BaseSound and is controllable by MoodManager.
+     * Ambient sounds are always cross-faded. New sounds are registered and activated/deactivated as needed.
+     *
      */

-                      r6562
+                      r6767
  *   Author:
  *       Erwin 'vaiursch' Herrsche
+ *
+ *   Co-authors:
  *       Kevin Young
  *       Reto Grieder
- *   Co-authors:
- *      ...
+ *
  */

-                      r6506
+                      r6767
  *   Author:
  *       Erwin 'vaiursch' Herrsche
+ *
+ *   Co-authors:
  *       Kevin Young
  *       Reto Grieder
- *   Co-authors:
- *      ...
  */

-                      r6417
+                      r6767
  *      Fabian 'x3n' Landau
  *   Co-authors:
  *      ...
+ *      Kevin Young
+ *
  */
 …
 namespace orxonox
+{
+    /**
+     * The WeaponMode class enables the developer, amongst other things, to attach a sound file
+     * to the firing event of a weapon. The default firing sound is chosen by each weapon (ex.
+     * HsW01), hard-coded for now.
+     */
     class _OrxonoxExport WeaponMode : public BaseObject
+    {

Note: See TracChangeset for help on using the changeset viewer.