Changeset 8855 for code/trunk/src/modules/weapons/projectiles/ParticleProjectile.cc

Timestamp:

Aug 22, 2011, 3:05:26 PM (13 years ago)

Author:

dafrick

Message:

Cleaning up game immersion. Roughly documenting weapons module.

File:

• code/trunk/src/modules/weapons/projectiles/ParticleProjectile.cc (modified) (3 diffs)

code/trunk/src/modules/weapons/projectiles/ParticleProjectile.cc

@@ -27 +27 @@
  */
 
+/**
+    @file ParticleProjectile.h
+    @brief Implementation of the ParticleProjectile class.
+*/
+
 #include "ParticleProjectile.h"
 
 #include <OgreParticleEmitter.h>
+#include "core/CoreIncludes.h"
 #include "tools/ParticleInterface.h"
-#include "core/CoreIncludes.h"
 #include "Scene.h"
 
@@ -44 +49 @@
         if (GameMode::showsGraphics())
         {
+            // Create the particles.
             this->particles_ = new ParticleInterface(this->getScene()->getSceneManager(), "Orxonox/shot3_small", LODParticle::Normal);
             this->attachOgreObject(this->particles_->getParticleSystem());
@@ -63 +69 @@
     }
 
+    /**
+    @brief
+        Is called when the visibility of the ParticleProjectile has changed.
+    */
     void ParticleProjectile::changedVisibility()
     {
         SUPER(ParticleProjectile, changedVisibility);
 
+        // Change the visibility of the particles.
         if (this->particles_)
             this->particles_->setEnabled(this->isVisible());