Ticket #3748: UnitAI_set_isIdle_on_INDIVIDUAL.IDLE.enter_v2.patch

binaries/data/mods/public/simulation/components/UnitAI.js

@@ -1438 +1438 @@
                     if (cmpFormation)
                         animationName = cmpFormation.GetFormationAnimation(this.entity, animationName);
                 }
                 this.SelectAnimation(animationName);
 
-                // If we have some orders, it is because we are in an intermediary state
-                // from FinishOrder (SetNextState("IDLE") is only executed when we get
-                // a ProcessMessage), and thus we should not start another order which could
-                // put us in a weird state
                 if (this.orderQueue.length > 0 && !this.IsGarrisoned())
-                    return false;
+                    warn("INDIVIDUAL.IDLE.enter while having orders and not being garrisoned!");
 
                 // If the unit is guarding/escorting, go back to its duty
                 if (this.isGuardOf)
                 {
                     this.Guard(this.isGuardOf, false);
                     return true;
                 }
 
-                // The GUI and AI want to know when a unit is idle, but we don't
-                // want to send frequent spurious messages if the unit's only
-                // idle for an instant and will quickly go off and do something else.
-                // So we'll set a timer here and only report the idle event if we
-                // remain idle
-                this.StartTimer(1000);
-
                 // If a unit can heal and attack we first want to heal wounded units,
                 // so check if we are a healer and find whether there's anybody nearby to heal.
                 // (If anyone approaches later it'll be handled via LosHealRangeUpdate.)
                 // If anyone in sight gets hurt that will be handled via LosHealRangeUpdate.
                 if (this.IsHealer() && this.FindNewHealTargets())
@@ -1472 +1461 @@
                 // so immediately check whether there's anybody nearby to attack.
                 // (If anyone approaches later, it'll be handled via LosRangeUpdate.)
                 if (this.FindNewTargets())
                     return true; // (abort the FSM transition since we may have already switched state)
 
+                if (this.isIdle)
+                    warn("INDIVIDUAL.IDLE.enter while isIdle!");
+
                 // Nobody to attack - stay in idle
+                this.isIdle = true;
+                Engine.PostMessage(this.entity, MT_UnitIdleChanged, { "idle": true });
                 return false;
             },
 
             "leave": function() {
                 var cmpRangeManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_RangeManager);
                 if (this.losRangeQuery)
                     cmpRangeManager.DisableActiveQuery(this.losRangeQuery);
                 if (this.losHealRangeQuery)
                     cmpRangeManager.DisableActiveQuery(this.losHealRangeQuery);
 
-                this.StopTimer();
+                if (!this.isIdle)
+                    warn("INDIVIDUAL.IDLE.leave while not isIdle!");
 
-                if (this.isIdle)
-                {
-                    this.isIdle = false;
-                    Engine.PostMessage(this.entity, MT_UnitIdleChanged, { "idle": this.isIdle });
-                }
+                this.isIdle = false;
+                Engine.PostMessage(this.entity, MT_UnitIdleChanged, { "idle": false });
             },
 
             "LosRangeUpdate": function(msg) {
                 if (this.GetStance().targetVisibleEnemies)
                 {
@@ -1511 +1503 @@
             },
 
             "MoveCompleted": function() {
                 this.SelectAnimation("idle");
             },
-
-            "Timer": function(msg) {
-                if (!this.isIdle)
-                {
-                    this.isIdle = true;
-                    Engine.PostMessage(this.entity, MT_UnitIdleChanged, { "idle": this.isIdle });
-                }
-            },
         },
 
         "WALKING": {
             "enter": function () {
                 this.SelectAnimation("move");