Changeset 5898 in orxonox.OLD

Timestamp:

Dec 3, 2005, 5:37:17 PM (18 years ago)

Author:

bensch

Message:

controll documentation

Location:

branches/spaceshipcontrol/src/world_entities

Files:

• playable.cc (modified) (5 diffs)
• playable.h (modified) (3 diffs)

branches/spaceshipcontrol/src/world_entities/playable.cc

@@ -38 +38 @@
 }
 
+/**
+ * initializes this Playable
+ */
 void Playable::init()
 {
   this->setClassID(CL_PLAYABLE, "Playable");
   PRINTF(4)("PLAYABLE INIT\n");
+
   this->weaponMan = new WeaponManager(this);
 
+  // the reference to the Current Player is NULL, because we dont have one at the beginning.
   this->currentPlayer = NULL;
 }
@@ -49 +54 @@
 /**
  * subscribe to all events the controllable needs
+ * @param player the player that shall controll this Playable
  */
 bool Playable::subscribePlayer(Player* player)
@@ -71 +77 @@
 
 /**
- * subscribe to all events the controllable needs
+ * unsubscribe from all events the controllable needs
+ * @param player the Player, that controlled this Ship.
  */
 bool Playable::unsubscribePlayer(Player* player)
@@ -95 +102 @@
 
 /**
- * add an event to the event list
+ * add an event to the event list of events this Playable can capture
+ * @param eventType the Type of event to add
  */
 void Playable::registerEvent(int eventType)
@@ -106 +114 @@
 
 /**
- * add an event to the event list
+ * remove an event to the event list this Playable can capture.
+ * @param event the event to unregister.
  */
 void Playable::unregisterEvent(int eventType)

branches/spaceshipcontrol/src/world_entities/playable.h

@@ -25 +25 @@
     virtual ~Playable();
 
-    void init();
 
     virtual void addWeapon(Weapon* weapon )  {}//= 0;
@@ -34 +33 @@
     bool unsubscribePlayer(Player* player);
 
-    virtual void process(const Event &event) {} //= 0;
+    virtual void process(const Event &event) = 0;
+
+
+    /** @return a List of Events in PEV_* sytle */
     inline const std::list<int>& getEventList() { return this->events; };
 
@@ -42 +44 @@
 
   private:
+    void init();
 
+  private:
     WeaponManager*        weaponMan;          //!< the weapon manager: managing a list of weapon to wepaon-slot mapping
-    std::list<int>        events;
+    std::list<int>        events;             //!< A list of Events, that are captured for this playable
 
-    Player*               currentPlayer;
+    Player*               currentPlayer;      //!< The Player currently connected to this Playable (the one that has controll) otherwise NULL
 
 };