Changeset 10650 for code/trunk/src/orxonox/weaponsystem/Weapon.h

Timestamp:

Oct 12, 2015, 10:57:00 PM (9 years ago)

Author:

fvultier

Message:

There is now a spaceship that uses the gravity bomb. Minor documentation improvements.

File:

• code/trunk/src/orxonox/weaponsystem/Weapon.h (modified) (3 diffs)

code/trunk/src/orxonox/weaponsystem/Weapon.h

@@ -39 +39 @@
 namespace orxonox
 {
+    /**
+    @brief
+        A Weapon is a StaticEntity that can be attached to a WeaponSlot. A Weapon can shoot with different @ref orxonox::WeaponMode modes.
+        Imagine for example that a machine gun can shoot normal bullets, tracer bullets or even grenades.
+    */    
     class _OrxonoxExport Weapon : public StaticEntity
     {
@@ -53 +58 @@
             WeaponMode* getWeaponmode(unsigned int index) const;
 
+            /**
+            @brief
+                This function is called by a @ref orxonox::WeaponPack if this Weapon is added to the WeaponPack.
+            */
             inline void setWeaponPack(WeaponPack * weaponPack)
                 { this->weaponPack_ = weaponPack; this->notifyWeaponModes(); }
@@ -58 +67 @@
                 { return this->weaponPack_; }
 
+            /**
+            @brief
+                This function is called by a @ref orxonox::WeaponSlot if this Weapon gets attached to the WeaponSlot.
+            */
             inline void setWeaponSlot(WeaponSlot * wSlot)
                 { this->weaponSlot_ = wSlot; }