Changeset 10955 for code/branches/campaignHS15/src/orxonox/controllers/MasterController.h

Timestamp:

Dec 7, 2015, 10:24:20 PM (8 years ago)

Author:

gania

Message:

cleaned up a bit

File:

• code/branches/campaignHS15/src/orxonox/controllers/MasterController.h (modified) (2 diffs)

code/branches/campaignHS15/src/orxonox/controllers/MasterController.h

@@ -37 +37 @@
 namespace orxonox
 {
+    /**
+    @brief
+      calles action(), maneuver() and canFire() methods of all the ActionpointControllers in level.
+      Only one instance of MasterController is to be placed in level.
+      If no MasterController is initialized, none of ActionpointControllers will work.
+      Example:
+      <Pawn position = "100000, 100000, 100000">
+        <controller>
+          <MasterController>
+          </MasterController>
+        </controller>
+      </Pawn>
+    */
     class _OrxonoxExport MasterController : public FightingController, public Tickable
     {
@@ -54 +67 @@
           
         private:
-            std::vector<WeakPtr<FightingController> > controllers_;
-            size_t indexOfCurrentController_;
+            std::vector<WeakPtr<FightingController> > controllers_;  //<! vector of controllers, which action(), canFire() and maneuver() methods are to be called
+            size_t indexOfCurrentController_;                        //<! index of current controller
             unsigned int numberOfTicksPassedSinceLastActionCall_;
-            unsigned int ticks_;     //<! local tick counter            
+            unsigned int ticks_;                                     //<! local tick counter            
 
     };