Changeset 10898 for code/branches/campaignHS15/src/orxonox/controllers/FightingController.h

Timestamp:

Nov 30, 2015, 4:04:16 PM (9 years ago)

Author:

gania

Message:

commented some stuff

File:

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

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

@@ -35 +35 @@
 namespace orxonox
 {
+    /**
+    @brief
+        FightingController stores all the fighting methods and member variables of AI.
+        Main methods here are maneuver() and dodge().
+    */
     class _OrxonoxExport FightingController : public FlyingController
     {
@@ -49 +54 @@
             ControllableEntity* getTarget() const
                 { return this->target_; }
-            bool bKeepFormation_;
+            bool bKeepFormation_;   //even if action_ == FIGHT, you might still want to keep formation if far enough form the target
            
         protected:
-            void setTarget(ControllableEntity* target);
+            void setTarget(ControllableEntity* target); //set a target to shoot at
 
-            void setPositionOfTarget(const Vector3& target);
-            void setOrientationOfTarget(const Quaternion& orient);
-            void stopLookingAtTarget();
-            void startLookingAtTarget();
-            void lookAtTarget(float dt);
+            void setPositionOfTarget(const Vector3& target);    //good to know where target is
+            void setOrientationOfTarget(const Quaternion& orient);  //I don't really use that
+            void stopLookingAtTarget();     //<! target dead -> you need to be able to fly
+            void startLookingAtTarget();    //<! if close to target, no need to fly, just rotate yourself
+            void lookAtTarget(float dt);    //<! rotate yourself towards target
 
-            void maneuver();
-            void dodge(const Vector3& thisPosition, Vector3& diffUnit);
-            void dodgeTowards (Vector3& position);
-            bool canFire();
-            void doFire();
+            void maneuver(); //<! sets this->targetPosition_, which is a Vector3 of where this ship flies. Decision is made based on
+                             //<! the distance to enemy, if being attacked, dodge() is called, otherwise ship just flies towards this->target_.
+            void dodge(const Vector3& thisPosition, Vector3& diffUnit); //<! choose a random Vector3 perpendicular to the difference vector between
+                                                                        //<! this and target_ plus or minus some amount in difference vector direction,
+                                                                        //<! depending on whether it is better to close up or survive.
+            void dodgeTowards (Vector3& position);  //fly towards position and awoid being hit
+            bool canFire(); //<! check if target_ is in radius and if this is looking at target_
+            void doFire();  //<! choose weapon, set aim at target_ and fire
             WeakPtr<ControllableEntity> target_;
             void setClosestTarget();