Changeset 8855 for code/trunk/src/modules/weapons/projectiles/Projectile.h

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/Projectile.h (modified) (3 diffs)

code/trunk/src/modules/weapons/projectiles/Projectile.h

@@ -27 +27 @@
  */
 
+/**
+    @file Projectile.h
+    @brief Definition of the Projectile class.
+*/
+
 #ifndef _Projectile_H__
 #define _Projectile_H__
@@ -39 +44 @@
 namespace orxonox
 {
+
+    /**
+    @brief
+        Represents all 'standard' projectiles.
+
+    @author
+        Fabian 'x3n' Landau
+    @author
+        Simon Miescher
+    @ingroup WeaponsProjectiles
+    */
     class _WeaponsExport Projectile : public MovableEntity, public BasicProjectile
     {
@@ -46 +62 @@
 
             void setConfigValues();
-            void destroyObject();
 
             virtual void tick(float dt);
             virtual bool collidesAgainst(WorldEntity* otherObject, btManifoldPoint& contactPoint);
 
-            void setOwner(Pawn* owner);
-            inline Pawn* getOwner() const
-                { return this->owner_; }
-
-
         private:
-            WeakPtr<Pawn> owner_;
-            float lifetime_;
-            Timer destroyTimer_;
+            float lifetime_; //!< The time the projectile exists.
+            Timer destroyTimer_; //!< Timer to destroy the projectile after its lifetime has run out.
     };
 }