Changeset 10955 for code/branches/campaignHS15/src/orxonox/controllers/ActionpointController.cc

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/ActionpointController.cc (modified) (19 diffs)

code/branches/campaignHS15/src/orxonox/controllers/ActionpointController.cc

@@ -78 +78 @@
             return;
 
+        //count ticks, ticks_ is unsigned, so overflow is not a problem
         ++this->ticks_;
         if (this->ticks_ == 1)
         {
+            //those vectors are in reversed order after being set by XML.
             std::reverse(parsedActionpoints_.begin(), parsedActionpoints_.end());
             std::reverse(actionpoints_.begin(), actionpoints_.end());
-            if (this->parsedActionpoints_.empty())
-            {
-                this->action_ = Action::FIGHTALL;
-            }
-        }
-
-        if (!this || !this->getControllableEntity())
-            return;
+        }
+
+        if (!this || !this->getControllableEntity())
+            return;
+        //fly
+        if (this->bHasTargetPosition_)
+        {
+            this->moveToTargetPosition(dt);
+        }//or just rotate
+        else if (this->bLookAtTarget_)
+        {
+            this->lookAtTarget(dt);
+        }
         
-        if (this->bHasTargetPosition_)
-        {
-            this->moveToTargetPosition(dt);
-        }
-        else if (this->bLookAtTarget_)
-        {
-            this->lookAtTarget(dt);
-        }
-        
-
-        if (!this || !this->getControllableEntity())
-            return;
-
+
+        if (!this || !this->getControllableEntity())
+            return;
+        //don't fire rocket each tick
         if (timeout_ <= 0)
         {    
@@ -116 +114 @@
         if (!this || !this->getControllableEntity())
             return;
-
+        //sometimes dodge, sometimes attack
         if (this->ticks_ % 80 <= 10)
         {
@@ -128 +126 @@
         if (!this || !this->getControllableEntity())
             return;
+        //fire if you can
+        if (this->bShooting_)
+        {
+            this->doFire();
+        }
+        SUPER(ActionpointController, tick, dt);
+    }
      
-        if (this->bShooting_)
-        {
-            this->doFire();
-        }
-        SUPER(ActionpointController, tick, dt);
-    }
-     
-
+    /**
+    @brief
+        action() manages the state machine.
+    */
 
     void ActionpointController::action()
@@ -143 +144 @@
             return;
 
+        //deltaHp is used to know if this got attacked
         this->deltaHp = orxonox_cast<Pawn*> (this->getControllableEntity())->getHealth() - this->previousHp;
         this->previousHp = orxonox_cast<Pawn*> (this->getControllableEntity())->getHealth();
+
+        //look out for enemies
         if (this->bDefaultPatrol_ || (this->action_ != Action::FLY && this->action_ != Action::NONE))
         {
@@ -155 +159 @@
         if (this->action_ == Action::NONE || this->bTakenOver_)
         {
+            //if default behaviour is fighting all, push it onto the stack
             if (this->parsedActionpoints_.empty() && this->loopActionpoints_.empty() && this->bDefaultFightAll_)
             {
@@ -296 +301 @@
 
     }
+    /**
+    @brief
+        if action is protect, this follows protect_ and fights enemies that are close
+    */
     void ActionpointController::setProtect (ControllableEntity* protect)
     {
@@ -306 +315 @@
         return this->protect_;
     }
+    //XML method
     void ActionpointController::addActionpoint(WorldEntity* actionpoint)
     {
@@ -360 +370 @@
             this->actionpoints_.push_back(actionpoint);
     }
+    //XML method
     WorldEntity* ActionpointController::getActionpoint(unsigned int index) const
     {
@@ -367 +378 @@
             return 0;
     }
-
+    //XML method
     Action::Value ActionpointController::getAction ()
     {
         return this->action_;
     }
+    //XML method
     std::string ActionpointController::getActionName()
     {
@@ -393 +405 @@
         }
     }
+    //XML method
     void ActionpointController::setAction (Action::Value action)
     {
         this->action_ = action;
     }
+    //set action and target/protect
     void ActionpointController::setAction (Action::Value action, ControllableEntity* target)
     {
@@ -413 +427 @@
         }
     }
+    //set action and target position
     void ActionpointController::setAction (Action::Value action, const Vector3& target)
     {
@@ -423 +438 @@
         }
     }
+    //set action and target position and orientation
     void ActionpointController::setAction (Action::Value action, const Vector3& target,  const Quaternion& orient )
     {
@@ -590 +606 @@
     }
 
-    
+    //calculate where in world coordinates this ship has to be, so that it keeps distance to protect_, and fly there
     void ActionpointController::stayNearProtect()
     {
@@ -612 +628 @@
         this->setTargetOrientation(this->getProtect()->getWorldOrientation());
     }
+    //remove current point from the stack
     void ActionpointController::nextActionpoint()
     {
@@ -638 +655 @@
         this->bHasTargetPosition_ = false;
     }
+    //if looping, instead of erasing point, move it to the top (back is what gets executed, so it's kinda reversed stack)
     void ActionpointController::moveBackToTop()
     {
@@ -649 +667 @@
         std::reverse (loopActionpoints_.begin(), loopActionpoints_.end());
     }
+    //POST: moves all consecutive points that are in loop to the loop stack
     void ActionpointController::fillLoop()
     {
@@ -667 +686 @@
         }
     }
-    
+    //copy other ship's stacks so that if it dies, this can finish that ship's actions
     void ActionpointController::takeActionpoints (const std::vector<Point>& vector, const std::vector<Point>& loop, bool b)
     {
@@ -679 +698 @@
         this->bTakenOver_ = true;
     }
+    //attack closest target
     void ActionpointController::setClosestTarget()
     {
         this->setTarget (static_cast<ControllableEntity*>( closestTarget() ) ); 
     }
+    //find closest target
     Pawn* ActionpointController::closestTarget()
     {
@@ -711 +732 @@
         return 0;  
     }
+    //push action FIGHT to the stack and set target to the closest enemy
     void ActionpointController::startAttackingEnemiesThatAreClose()
     {