Changeset 10437 for code/trunk/src/orxonox/worldentities/pawns

Timestamp:

May 8, 2015, 12:17:03 AM (10 years ago)

Author:

fvultier

Message:

Removed unnecessary output to console in kump minigame. Added a small description to some classes often used by PPS students: Pawn, StaticEntity, MobileEntity, ControllableEntity.

Location:

code/trunk/src/orxonox/worldentities/pawns

Files:

• Pawn.h (modified) (1 diff)
• SpaceShip.h (modified) (1 diff)

code/trunk/src/orxonox/worldentities/pawns/Pawn.h

@@ -39 +39 @@
 
 namespace orxonox // tolua_export
-{ // tolua_export
+{
+    /**
+    @brief
+        Everything in Orxonoy that has a health attribute is a Pawn. After a Pawn is spawned its health is set to
+        its initial health. In every call of the Pawns tick function the game checks whether the pawns health is at
+        or below zero. If it is, the pawn gets killed.
+
+        Pawns can carry pickups and fire weapons. The can also have shields.
+
+        Notice that every Pawn is a ControllableEntity.
+    */
+
+    // tolua_export
     class _OrxonoxExport Pawn // tolua_export
         : public ControllableEntity, public RadarViewable, public PickupCarrier

code/trunk/src/orxonox/worldentities/pawns/SpaceShip.h

@@ -47 +47 @@
     @brief
         The SpaceShip is the principal entity through which the player interacts with the game. Its main function is to fly, however many things, such as @ref orxonox::Engine Engines or @ref orxonox::Weapon Weapons, can be attached to it.
+        The feature that you can add @ref orxonox::Engine Engines is new in this class. However adding @ref orxonox::Weapon Weapons is possible because every Spaceship is a Pawn (due to inheritance) and every Pawn can carry @ref orxonox::Weapon Weapons.
 
         There are several parameters that define the behavior of the SpaceShip>