Changeset 3238 in orxonox.OLD for orxonox/branches/nico/src/story_entity.h

Timestamp:

Dec 20, 2004, 2:42:54 AM (20 years ago)

Author:

bensch

Message:

orxonox/branches: updated branches: buerli, nico, sound. And moved bezierTrack to old.bezierTrack. Conflicts resolved in a usefull order.
Conflics mostly resolved in favor of trunk
merge.

File:

• orxonox/branches/nico/src/story_entity.h (modified) (1 diff)

orxonox/branches/nico/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
-#define STORY_ENTITY_H
+
+#ifndef _STORY_ENTITY_H
+#define _STORY_ENTITY_H
 
 #include "stdincl.h"
 #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();
-  virtual Error start(Uint32 storyID);
-  virtual Error start();
-  virtual Error stop();
-  virtual Error pause();
-  virtual Error resume();
+  virtual ErrorMessage init();
+  virtual ErrorMessage start(int storyID);
+  virtual ErrorMessage start();
+  virtual ErrorMessage stop();
+  virtual ErrorMessage pause();
+  virtual ErrorMessage resume();
 
   virtual void load();
+  virtual void destroy();
 
-  virtual void displayEntityScreen();
-  virtual void releaseEntityScreen();
+  virtual void displayLoadScreen();
+  virtual void releaseLoadScreen();
 
-  void setStoryID(Uint32 storyID);
+  void setStoryID(int storyID);
   int getStoryID();
 
-  void setNextStoryID(Uint32 nextStoryID);
-  Uint32 getNextStoryID();
+  void setNextStoryID(int nextStoryID);
+  int getNextStoryID();
 
 
  private:
-  Uint32 storyID;
-  Uint32 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
 };
 
-#endif
+#endif /* _STORY_ENTITY_H */