Changeset 5498 in orxonox.OLD for trunk/src/world_entities/weapons/projectile.h

Timestamp:

Nov 7, 2005, 10:43:22 PM (18 years ago)

Author:

bensch

Message:

orxonox/trunk: redocumented the WorldEntity and Weapon classes

File:

• trunk/src/world_entities/weapons/projectile.h (modified) (3 diffs)

trunk/src/world_entities/weapons/projectile.h

@@ -1 +1 @@
 /*!
  * @file projectile.h
-  *  a projectile, that is been shooted by a weapon
-
-    You can use this class to make some shoots, but this isn't the real idea. If you want to just test, if the
-    shooting funcions work, use the Projectile class. But if you want to implement your own shoots its
-    different:<br>
-    Make a new class and derive it from Projectile. To have a weapon work well, reimplement the functions
-    - void tick()
-    - void draw()
-    - void hit() (only if you have working collision detection)
-    When you have implemented these functions you have just to add the projectiles to your weapon. You ll want
-    to make this by looking into the function
-    - Weapon::fire()
-    there you just change the line:
-    Projectile* pj = new Projectile();    TO     Projectile* pj = new MyOwnProjectileClass();
-    and schwups it works... :)
-*/
+ * a projectile, that is been shooted by a weapon
+ *
+ * You can use this class to make some Projectiles/Bullets/Lasers/Rockets/etc.
+ *
+ */
 
 #ifndef _PROJECTILE_H
@@ -22 +11 @@
 
 #include "world_entity.h"
-
-class FastFactory;
 
 class Projectile : public WorldEntity
@@ -57 +44 @@
   protected:
     // energy
-    float                 energyMin;
-    float                 energyMax;
+    float                 energyMin;                 //!< The minimal Energy a Projectile needs to be emitted.
+    float                 energyMax;                 //!< The maximal Energy a Projectile can take, before being emitted.
     bool                  bChargeable;               //!< if the Projectile is Charegeable