Changeset 6153 in orxonox.OLD for trunk/src/story_entities/story_entity.h

Timestamp:

Dec 17, 2005, 7:05:52 PM (18 years ago)

Author:

bensch

Message:

docu

File:

• trunk/src/story_entities/story_entity.h (modified) (2 diffs)

trunk/src/story_entities/story_entity.h

@@ -19 +19 @@
   virtual ~StoryEntity ();
 
-
   // INIT AND LOAD //
+  /** @brief initializes a Story Entity to default Values */
+  virtual ErrorMessage init() {};
+  /** @brief called before loading */
   virtual ErrorMessage preLoad() {};
+  /** @brief called to load. */
   virtual ErrorMessage load() {};
+  /** @brief called right after loading */
   virtual ErrorMessage postLoad() {};
+  /** @brief called after postload to check for integrity. (optional) */
   virtual ErrorMessage check() {};
 
   // RUNNING //
+  /** @brief called shortly before starting the Entity */
   virtual ErrorMessage preStart() {};
+  /** @brief starts the Entity. Starts the main cycle */
   virtual ErrorMessage start() = 0;
+  /** @brief pauses the Entity. call to resume required to get it running again */
   virtual ErrorMessage pause() = 0;
+  /** @brief resumes the Entity after a stop/pause or suspend. */
+  virtual ErrorMessage resume() = 0;
+  /** @brief suspends the Entity detaches all mayor functions  (optional) */
+  virtual ErrorMessage suspend() {};
+  /** @brief rewinds to the beginning/last checkpoint */
   virtual ErrorMessage rewind() {};
-  virtual ErrorMessage suspend() {};
-  virtual ErrorMessage resume() = 0;
+  /** @brief leaves the Entity. Ends it */
+  virtual ErrorMessage preStop() {};
+  /** @brief Stops the entity. */
   virtual ErrorMessage stop() = 0;
+
+  // KILLING
+  /** @brief kills the Entity. should also calls prestop stop */
   virtual ErrorMessage destroy() {};
 
@@ -49 +66 @@
 
  private:
-  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
+    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
 };