Changeset 4450 in orxonox.OLD for orxonox/trunk/src/util/event/event_def.h

Timestamp:

Jun 1, 2005, 11:05:23 PM (19 years ago)

Author:

patrick

Message:

orxonox/trunk: commented the event handler and event class

File:

• orxonox/trunk/src/util/event/event_def.h (modified) (2 diffs)

orxonox/trunk/src/util/event/event_def.h

@@ -17 +17 @@
 #define DEFAULT_KEYBIND_FILE "~/.orxonox/orxonox.conf"
 
+
 #define EVENT_QUEUE_LENGTH 32
 
-
+//! these are the extended event types, that are not included in SDL_keysym
 typedef enum extEventTyes
   {
@@ -38 +39 @@
   };
 
-
-
+//! this is an enumeration of all states of the event_handler/game
 typedef enum elState
   {
-    ES_GAME,
-    ES_GAME_MENU,
-    ES_MENU,
+    ES_GAME,           //!< the state during the game plays
+    ES_GAME_MENU,      //!< state when the menu is called during game
+    ES_MENU,           //!< orxonox menu state
 
-    ES_ALL,
+    ES_ALL,            //!< you want to register events for all states
 
-    ES_NUMBER,
+    ES_NUMBER,         //!< the number of states
   };