Changeset 2077 in orxonox.OLD for orxonox/trunk/src/world_entity.h

Timestamp:

Jul 5, 2004, 9:51:48 PM (20 years ago)

Author:

patrick

Message:

/orxonox/trunk/src: making doxygen comments in worldentity, player, world; extending API of worldentity; inserting list.h in world - this version does not compile

File:

• orxonox/trunk/src/world_entity.h (modified) (4 diffs)

orxonox/trunk/src/world_entity.h

@@ +1 @@
+/*! 
+    \file world_entity.h
+    \brief A base class for all objects in the world
+    
+    This is the base class of all objects in the game-world. If you want to have an object in the world, that can realy interact with other objects and that is also dispbayable etc. you have to extend this class and override the needed functions.
+*/ 
+
+
 
 #ifndef WORLD_ENTITY_H
@@ -8 +16 @@
 class Ability;
 
+//! WorldEntity
+/**
+  A base class for all objects in the world
+
+  This is the base class of all objects in the game-world. If you want to have an object in the world, that can realy interact with other objects and that is also dispbayable etc. you have to extend this class and override the needed functions.
+*/
 class WorldEntity {
 
@@ -28 +42 @@
   void removeAbility(Ability* ability);
 
-  virtual void tick(float time);
+  virtual void tick(float dt);
   virtual void paint();
   /* virtual void actionEvent(Event* event); */
@@ -43 +57 @@
 
  private:
-  Vector* position;
-  Vector* orientation;
+  Vector* position;    //!< position of the entity
+  Vector* orientation; //!< orientation of the entity
   /* List of abilities */ 
-  float health;
-  float speed;
+  float health; //!< health of the entity, if any
+  float speed; //!< speed of the entity if any
   /* entity can be in the air or at ground: */
-  int airGround;
+  int airGround; //!< is it air or bound to the ground (ground=0, air=1)