Changeset 8766 for code/branches/ai2/src/orxonox/weaponsystem/WeaponSlot.h

Timestamp:

Jul 19, 2011, 10:27:15 PM (13 years ago)

Author:

jo

Message:

Backup before taking the next step.

File:

• code/branches/ai2/src/orxonox/weaponsystem/WeaponSlot.h (modified) (1 diff)

code/branches/ai2/src/orxonox/weaponsystem/WeaponSlot.h

@@ -35 +35 @@
 namespace orxonox
 {
+        /**
+        @brief
+            The a WeaponSlot defines where a @ref orxonox::Weapon "Weapon" is placed on a pawn. (A WeaponSlot is a StaticEntity)
+            In a WeaponSlot there can be only one "Weapon", but a Weapon can have several @ref orxonox::WeaponMode "WeaponModes".
+            A WeaponMode is what one intuitively imagines as weapon. (E.g. RocketFire, LightningGun, LaserFire are weaponmodes)
+
+            A WeaponSlot is created in XML (in a weaponsettings file), which can be done in the following fashion:
+            @code
+            <weaponslots>
+              <WeaponSlot position="-15.0,-1.5,0" />
+              <WeaponSlot position=" 15.0,-1.5,0" />
+              <WeaponSlot position="    0,   0,0" />
+            </weaponslots>
+
+        @author
+            Martin Polak
+
+        @ingroup Weaponsystem
+    */
     class _OrxonoxExport WeaponSlot : public StaticEntity
     {