Changeset 3221 in orxonox.OLD for orxonox/trunk/src/story_entity.h

Timestamp:

Dec 19, 2004, 10:44:35 PM (21 years ago)

Author:

patrick

Message:

orxonox/trunk: added doxy comments to class StoryEntity, little changes in the destructors of world/story entities. solved an issue with the destructor of WorldEntities. ALL SEGFAULT ERRORS SHOULD NOW BE REMOVED

File:

• orxonox/trunk/src/story_entity.h (modified) (3 diffs)

orxonox/trunk/src/story_entity.h

@@ +1 @@
+/*! 
+    \file story_entity.h
+    \brief holds the base class of everything that is playable - that is part of the story
+*/ 
+
 
 #ifndef STORY_ENTITY_H
@@ -6 +11 @@
 #include "story_def.h"
 
+//! A class that represents something to play in orxonox. it is a container for worlds, movies, mission briefings, etc...
 class StoryEntity {
 
  public:
   StoryEntity ();
-  ~StoryEntity ();
+  virtual ~StoryEntity ();
 
-  bool isInit;
-  bool isPaused;
+  bool isInit;  //! if the entity is initialized, this has to be true
+  bool isPaused; //! is true if the entity is paused
 
   virtual Error init();
@@ -36 +42 @@
 
  private:
-  int storyID;
-  int nextStoryID;
+  int storyID; //! this is the number of this entity, identifying it in a list/tree...
+  int nextStoryID; //! if this entity has finished, this entity shall be called
 };