Merge pull request #378 from crashkonijn/feature/configurable-delta-time

crashkonijn · web-flow · commit 6d4e13b1e8c5 · 2025-12-11T12:38:27.000+01:00
Feature: Added configurable deltaTime
diff --git a/Package/Documentation/Classes/AgentBehaviourAndActionProvider.md b/Package/Documentation/Classes/AgentBehaviourAndActionProvider.md
@@ -59,6 +59,23 @@ Actions often have associated targets, indicating a position the agent should re
 
 Some actions might need the agent to perform tasks while moving. The `MoveMode` in the `ActionConfig` allows for such configurations.
 
+### Run In Unity Update
+When set to true will call `Run` from the `Update` method. When set to false you must call `Run()` or `Run(float deltaTime)` yourself.
+
+Calling the `Run` method manually gives you full control over the agent's update cycle.
+
+```csharp
+agentBehaviour.RunInUnityUpdate = false;
+agentBehaviour.Run(1f);
+
+// In actions
+public override IActionRunState Perform(IMonoAgent agent, Data data, IActionContext context)
+{
+    // Make sure to use the deltaTime provided in the context!
+    var deltaTime = context.DeltaTime;
+}
+```
+
 ### Distance Multiplier
 
 The primary objective of actions is to achieve goals swiftly. If the action's cost equates to its completion time, then the heuristic's distance value should be divided by the agent's movement speed. Using `SetDistanceMultiplierSpeed(float speed)` sets the agent's (max/average) speed, enabling the planner to more precisely ascertain the optimal action.
diff --git a/Package/Documentation/upgrade/upgrade-guide-3.0-3.1.md b/Package/Documentation/upgrade/upgrade-guide-3.0-3.1.md
@@ -33,3 +33,19 @@ public interface IGoapInjector
 ### AgenTypeFactory and CapabilityFactory can now be injected
 You can now inject into `AgentTypeFactoryBase` and `CapabilityFactoryBase` classes, similar to other actions, goals and sensors.
 
+### You can now manually call AgentBehaviour.Run() with custom deltaTimes
+This allows you to determine the rate at which agents are updated, for example agents further away from the player.
+
+Make sure to set `AgentBehaviour.RunInUnityUpdate` to false before calling `Run` yourself!
+
+```csharp
+agentBehaviour.RunInUnityUpdate = false;
+agentBehaviour.Run(1f);
+
+// In actions
+public override IActionRunState Perform(IMonoAgent agent, Data data, IActionContext context)
+{
+    // Make sure to use the deltaTime provided in the context!
+    var deltaTime = context.DeltaTime;
+}
+```
diff --git a/Package/Documentation/upgrading.meta b/Package/Documentation/upgrading.meta
diff --git a/Package/Documentation/upgrading/README.md b/Package/Documentation/upgrading/README.md
diff --git a/Package/Documentation/upgrading/README.md.meta b/Package/Documentation/upgrading/README.md.meta
diff --git a/Package/Editor/CrashKonijn.Goap.Editor/TypeDrawers/AgentEditor.cs b/Package/Editor/CrashKonijn.Goap.Editor/TypeDrawers/AgentEditor.cs
@@ -16,6 +16,7 @@ public override VisualElement CreateInspectorGUI()
             root.styleSheets.Add(AssetDatabase.LoadAssetAtPath<StyleSheet>($"{GoapEditorSettings.BasePath}/Styles/Generic.uss"));
 
             root.Add(new PropertyField(this.serializedObject.FindProperty("<ActionProviderBase>k__BackingField")));
+            root.Add(new PropertyField(this.serializedObject.FindProperty("<RunInUnityUpdate>k__BackingField")));
             root.Add(new PropertyField(this.serializedObject.FindProperty("isPaused")));
             root.Add(new PropertyField(this.serializedObject.FindProperty("<DistanceMultiplier>k__BackingField")));
             root.Add(new PropertyField(this.serializedObject.FindProperty("<LoggerConfig>k__BackingField")));
diff --git a/Package/Runtime/CrashKonijn.Agent.Core/Interfaces/IAgent.cs b/Package/Runtime/CrashKonijn.Agent.Core/Interfaces/IAgent.cs
@@ -4,7 +4,7 @@ namespace CrashKonijn.Agent.Core
 {
     public interface IAgent : IActionReceiver
     {
-        public bool IsPaused { get; set; }
+        bool RunInUnityUpdate { get; set; }
         AgentState State { get; }
         AgentMoveState MoveState { get; }
 
@@ -22,6 +22,7 @@ public interface IAgent : IActionReceiver
 
         void Initialize();
         void Run();
+        void Run(float deltaTime);
 
         void CompleteAction(bool resolveAction = true);
         void ResolveAction();
diff --git a/Package/Runtime/CrashKonijn.Agent.Runtime/ActionRunner.cs b/Package/Runtime/CrashKonijn.Agent.Runtime/ActionRunner.cs
@@ -16,18 +16,18 @@ public ActionRunner(IMonoAgent agent, IAgentProxy proxy)
             this.proxy = proxy;
         }
 
-        public void Run()
+        public void Run(float deltaTime)
         {
             if (!this.RunIsValid())
                 return;
 
             switch (this.agent.ActionState.Action.GetMoveMode(this.agent))
             {
                 case ActionMoveMode.MoveBeforePerforming:
-                    this.RunMoveBeforePerforming();
+                    this.RunMoveBeforePerforming(deltaTime);
                     break;
                 case ActionMoveMode.PerformWhileMoving:
-                    this.RunPerformWhileMoving();
+                    this.RunPerformWhileMoving(deltaTime);
                     break;
             }
         }
@@ -52,29 +52,29 @@ private bool RunIsValid()
             return true;
         }
 
-        private void RunPerformWhileMoving()
+        private void RunPerformWhileMoving(float deltaTime)
         {
             if (this.proxy.IsInRange())
             {
                 this.proxy.SetState(AgentState.PerformingAction);
                 this.proxy.SetMoveState(AgentMoveState.InRange);
-                this.PerformAction();
+                this.PerformAction(deltaTime);
                 return;
             }
 
             this.proxy.SetState(AgentState.MovingWhilePerformingAction);
             this.proxy.SetMoveState(AgentMoveState.NotInRange);
             this.Move();
-            this.PerformAction();
+            this.PerformAction(deltaTime);
         }
 
-        private void RunMoveBeforePerforming()
+        private void RunMoveBeforePerforming(float deltaTime)
         {
             if (this.proxy.IsInRange() || this.agent.State == AgentState.PerformingAction)
             {
                 this.proxy.SetState(AgentState.PerformingAction);
                 this.proxy.SetMoveState(AgentMoveState.InRange);
-                this.PerformAction();
+                this.PerformAction(deltaTime);
                 return;
             }
 
@@ -91,12 +91,12 @@ private void Move()
             this.agent.Events.Move(this.agent.CurrentTarget);
         }
 
-        private void PerformAction()
+        private void PerformAction(float deltaTime)
         {
             if (!this.ShouldContinue())
                 return;
 
-            this.context.DeltaTime = Time.deltaTime;
+            this.context.DeltaTime = deltaTime;
             this.context.IsInRange = this.proxy.IsInRange();
 
             if (!this.agent.ActionState.HasPerformed)
diff --git a/Package/Runtime/CrashKonijn.Agent.Runtime/AgentBehaviour.cs b/Package/Runtime/CrashKonijn.Agent.Runtime/AgentBehaviour.cs
@@ -9,6 +9,9 @@ public class AgentBehaviour : MonoBehaviour, IMonoAgent
         [field: SerializeField]
         public ActionProviderBase ActionProviderBase { get; set; }
 
+        [field: SerializeField]
+        public bool RunInUnityUpdate { get; set; } = true;
+        
         [SerializeField]
         private bool isPaused = false;
 
@@ -121,13 +124,22 @@ public void Initialize()
 
         private void Update()
         {
-            this.Run();
+            if (this.RunInUnityUpdate)
+                this.Run();
         }
-
+        
         /// <summary>
-        ///     Runs the current action. This is called in the Update method.
+        ///     Runs the current action.
         /// </summary>
         public void Run()
+        {
+            this.Run(Time.deltaTime);
+        }
+
+        /// <summary>
+        ///     Runs the current action with the given deltaTime
+        /// </summary>
+        public void Run(float deltaTime)
         {
             if (this.IsPaused)
                 return;
@@ -137,7 +149,7 @@ public void Run()
 
             this.UpdateTarget();
 
-            this.actionRunner.Run();
+            this.actionRunner.Run(deltaTime);
         }
 
         private void UpdateTarget()
diff --git a/Package/Tests/CrashKonijn.Goap.Tests/UnitTests/ActionRunnerTests.cs b/Package/Tests/CrashKonijn.Goap.Tests/UnitTests/ActionRunnerTests.cs
@@ -47,7 +47,7 @@ public void Run_WhenRunIsNotValid_ShouldStopAction()
             this.action.IsValid(this.agent, this.agent.ActionState.Data).Returns(false);
 
             // Act
-            this.actionRunner.Run();
+            this.actionRunner.Run(0f);
 
             // Assert
             this.agent.Received().StopAction();
@@ -61,7 +61,7 @@ public void MoveBeforePerforming_WhenInRange_ShouldSetStateToPerformingAction()
             this.action.GetMoveMode(this.agent).Returns(ActionMoveMode.MoveBeforePerforming);
 
             // Act
-            this.actionRunner.Run();
+            this.actionRunner.Run(0f);
 
             // Assert
             this.proxy.Received().SetState(AgentState.PerformingAction);
@@ -75,7 +75,7 @@ public void MoveBeforePerforming_WhenInRange_ShouldSetMoveStateToInRange()
             this.action.GetMoveMode(this.agent).Returns(ActionMoveMode.MoveBeforePerforming);
 
             // Act
-            this.actionRunner.Run();
+            this.actionRunner.Run(0f);
 
             // Assert
             this.proxy.Received().SetMoveState(AgentMoveState.InRange);
@@ -89,7 +89,7 @@ public void MoveBeforePerforming_WhenInRange_ShouldPerformAction()
             this.action.GetMoveMode(this.agent).Returns(ActionMoveMode.MoveBeforePerforming);
 
             // Act
-            this.actionRunner.Run();
+            this.actionRunner.Run(0f);
 
             // Assert
             this.action.Received().Perform(this.agent, this.agent.ActionState.Data, Arg.Any<IActionContext>());
@@ -103,7 +103,7 @@ public void MoveBeforePerforming_WhenNotInRange_ShouldSetStateToMovingToTarget()
             this.action.GetMoveMode(this.agent).Returns(ActionMoveMode.MoveBeforePerforming);
 
             // Act
-            this.actionRunner.Run();
+            this.actionRunner.Run(0f);
 
             // Assert
             this.proxy.Received().SetState(AgentState.MovingToTarget);
@@ -117,7 +117,7 @@ public void MoveBeforePerforming_WhenNotInRange_ShouldSetMoveStateToOutOfRange()
             this.action.GetMoveMode(this.agent).Returns(ActionMoveMode.MoveBeforePerforming);
 
             // Act
-            this.actionRunner.Run();
+            this.actionRunner.Run(0f);
 
             // Assert
             this.proxy.Received().SetMoveState(AgentMoveState.NotInRange);
@@ -131,7 +131,7 @@ public void MoveBeforePerforming_WhenNotInRange_ShouldMove()
             this.action.GetMoveMode(this.agent).Returns(ActionMoveMode.MoveBeforePerforming);
 
             // Act
-            this.actionRunner.Run();
+            this.actionRunner.Run(0f);
 
             // Assert
             this.agent.Events.Received().Move(this.agent.CurrentTarget);
@@ -146,7 +146,7 @@ public void MoveBeforePerforming_WhenNotInRangeAndStateIsPerformingAction_Should
             this.action.GetMoveMode(this.agent).Returns(ActionMoveMode.MoveBeforePerforming);
 
             // Act
-            this.actionRunner.Run();
+            this.actionRunner.Run(0f);
 
             // Assert
             this.proxy.DidNotReceive().SetState(AgentState.MovingToTarget);
@@ -160,7 +160,7 @@ public void PerformWhileMoving_WhenInRange_ShouldSetStateToPerformingAction()
             this.action.GetMoveMode(this.agent).Returns(ActionMoveMode.PerformWhileMoving);
 
             // Act
-            this.actionRunner.Run();
+            this.actionRunner.Run(0f);
 
             // Assert
             this.proxy.Received().SetState(AgentState.PerformingAction);
@@ -174,7 +174,7 @@ public void PerformWhileMoving_WhenInRange_ShouldSetMoveStateToInRange()
             this.action.GetMoveMode(this.agent).Returns(ActionMoveMode.PerformWhileMoving);
 
             // Act
-            this.actionRunner.Run();
+            this.actionRunner.Run(0f);
 
             // Assert
             this.proxy.Received().SetMoveState(AgentMoveState.InRange);
@@ -188,7 +188,7 @@ public void PerformWhileMoving_WhenInRange_ShouldPerformAction()
             this.action.GetMoveMode(this.agent).Returns(ActionMoveMode.PerformWhileMoving);
 
             // Act
-            this.actionRunner.Run();
+            this.actionRunner.Run(0f);
 
             // Assert
             this.action.Received().Perform(this.agent, this.agent.ActionState.Data, Arg.Any<IActionContext>());
@@ -202,7 +202,7 @@ public void PerformWhileMoving_WhenNotInRange_ShouldSetStateToMovingWhilePerform
             this.action.GetMoveMode(this.agent).Returns(ActionMoveMode.PerformWhileMoving);
 
             // Act
-            this.actionRunner.Run();
+            this.actionRunner.Run(0f);
 
             // Assert
             this.proxy.Received().SetState(AgentState.MovingWhilePerformingAction);
@@ -216,7 +216,7 @@ public void PerformWhileMoving_WhenNotInRange_ShouldSetMoveStateToOutOfRange()
             this.action.GetMoveMode(this.agent).Returns(ActionMoveMode.PerformWhileMoving);
 
             // Act
-            this.actionRunner.Run();
+            this.actionRunner.Run(0f);
 
             // Assert
             this.proxy.Received().SetMoveState(AgentMoveState.NotInRange);
@@ -230,7 +230,7 @@ public void PerformWhileMoving_WhenNotInRange_ShouldMove()
             this.action.GetMoveMode(this.agent).Returns(ActionMoveMode.PerformWhileMoving);
 
             // Act
-            this.actionRunner.Run();
+            this.actionRunner.Run(0f);
 
             // Assert
             this.agent.Events.Received().Move(this.agent.CurrentTarget);
@@ -244,7 +244,7 @@ public void PerformAction_NoRunState_ShouldPerformAction()
             this.action.GetMoveMode(this.agent).Returns(ActionMoveMode.PerformWhileMoving);
 
             // Act
-            this.actionRunner.Run();
+            this.actionRunner.Run(0f);
 
             // Assert
             this.action.Received().Perform(this.agent, this.agent.ActionState.Data, Arg.Any<IActionContext>());
@@ -259,7 +259,7 @@ public void PerformAction_IsCompletedRunState_ShouldNotPerformAction()
             this.action.GetMoveMode(this.agent).Returns(ActionMoveMode.PerformWhileMoving);
 
             // Act
-            this.actionRunner.Run();
+            this.actionRunner.Run(0f);
 
             // Assert
             this.action.DidNotReceive().Perform(this.agent, this.agent.ActionState.Data, Arg.Any<IActionContext>());
@@ -275,7 +275,7 @@ public void PerformAction_ShouldStopRunState_ShouldNotPerformAction()
             this.action.GetMoveMode(this.agent).Returns(ActionMoveMode.PerformWhileMoving);
 
             // Act
-            this.actionRunner.Run();
+            this.actionRunner.Run(0f);
 
             // Assert
             this.action.DidNotReceive().Perform(this.agent, this.agent.ActionState.Data, Arg.Any<IActionContext>());
@@ -291,7 +291,7 @@ public void PerformAction_ContinueRunState_ShouldPerformAction()
             this.action.GetMoveMode(this.agent).Returns(ActionMoveMode.PerformWhileMoving);
 
             // Act
-            this.actionRunner.Run();
+            this.actionRunner.Run(0f);
 
             // Assert
             this.action.Received().Perform(this.agent, this.agent.ActionState.Data, Arg.Any<IActionContext>());
@@ -307,7 +307,7 @@ public void PerformAction_ReturnedCompleteState_ShouldCompleteAction()
             this.action.Perform(this.agent, this.agent.ActionState.Data, Arg.Any<IActionContext>()).Returns(ActionRunState.Completed);
 
             // Act
-            this.actionRunner.Run();
+            this.actionRunner.Run(0f);
 
             // Assert
             this.agent.Received().CompleteAction();
@@ -323,7 +323,7 @@ public void PerformAction_ReturnedStopState_ShouldStopAction()
             this.action.Perform(this.agent, this.agent.ActionState.Data, Arg.Any<IActionContext>()).Returns(ActionRunState.Stop);
 
             // Act
-            this.actionRunner.Run();
+            this.actionRunner.Run(0f);
 
             // Assert
             this.agent.Received().StopAction();
@@ -342,7 +342,7 @@ public void PerformAction_ReturnedContinueState_ShouldContinueAction()
             this.action.Perform(this.agent, this.agent.ActionState.Data, Arg.Any<IActionContext>()).Returns(ActionRunState.Continue);
 
             // Act
-            this.actionRunner.Run();
+            this.actionRunner.Run(0f);
 
             // Assert
             this.agent.DidNotReceive().CompleteAction();

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ namespace CrashKonijn.Agent.Core`
`4`	`4`	`{`
`5`	`5`	`public interface IAgent : IActionReceiver`
`6`	`6`	`{`
`7`		`- public bool IsPaused { get; set; }`
	`7`	`+ bool RunInUnityUpdate { get; set; }`
`8`	`8`	`AgentState State { get; }`
`9`	`9`	`AgentMoveState MoveState { get; }`
`10`	`10`
`@@ -22,6 +22,7 @@ public interface IAgent : IActionReceiver`
`22`	`22`
`23`	`23`	`void Initialize();`
`24`	`24`	`void Run();`
	`25`	`+ void Run(float deltaTime);`
`25`	`26`
`26`	`27`	`void CompleteAction(bool resolveAction = true);`
`27`	`28`	`void ResolveAction();`
Original file line number	Diff line number	Diff line change
`@@ -16,18 +16,18 @@ public ActionRunner(IMonoAgent agent, IAgentProxy proxy)`
`16`	`16`	`this.proxy = proxy;`
`17`	`17`	`}`
`18`	`18`
`19`		`- public void Run()`
	`19`	`+ public void Run(float deltaTime)`
`20`	`20`	`{`
`21`	`21`	`if (!this.RunIsValid())`
`22`	`22`	`return;`
`23`	`23`
`24`	`24`	`switch (this.agent.ActionState.Action.GetMoveMode(this.agent))`
`25`	`25`	`{`
`26`	`26`	`case ActionMoveMode.MoveBeforePerforming:`
`27`		`- this.RunMoveBeforePerforming();`
	`27`	`+ this.RunMoveBeforePerforming(deltaTime);`
`28`	`28`	`break;`
`29`	`29`	`case ActionMoveMode.PerformWhileMoving:`
`30`		`- this.RunPerformWhileMoving();`
	`30`	`+ this.RunPerformWhileMoving(deltaTime);`
`31`	`31`	`break;`
`32`	`32`	`}`
`33`	`33`	`}`
`@@ -52,29 +52,29 @@ private bool RunIsValid()`
`52`	`52`	`return true;`
`53`	`53`	`}`
`54`	`54`
`55`		`- private void RunPerformWhileMoving()`
	`55`	`+ private void RunPerformWhileMoving(float deltaTime)`
`56`	`56`	`{`
`57`	`57`	`if (this.proxy.IsInRange())`
`58`	`58`	`{`
`59`	`59`	`this.proxy.SetState(AgentState.PerformingAction);`
`60`	`60`	`this.proxy.SetMoveState(AgentMoveState.InRange);`
`61`		`- this.PerformAction();`
	`61`	`+ this.PerformAction(deltaTime);`
`62`	`62`	`return;`
`63`	`63`	`}`
`64`	`64`
`65`	`65`	`this.proxy.SetState(AgentState.MovingWhilePerformingAction);`
`66`	`66`	`this.proxy.SetMoveState(AgentMoveState.NotInRange);`
`67`	`67`	`this.Move();`
`68`		`- this.PerformAction();`
	`68`	`+ this.PerformAction(deltaTime);`
`69`	`69`	`}`
`70`	`70`
`71`		`- private void RunMoveBeforePerforming()`
	`71`	`+ private void RunMoveBeforePerforming(float deltaTime)`
`72`	`72`	`{`
`73`	`73`	`if (this.proxy.IsInRange() \|\| this.agent.State == AgentState.PerformingAction)`
`74`	`74`	`{`
`75`	`75`	`this.proxy.SetState(AgentState.PerformingAction);`
`76`	`76`	`this.proxy.SetMoveState(AgentMoveState.InRange);`
`77`		`- this.PerformAction();`
	`77`	`+ this.PerformAction(deltaTime);`
`78`	`78`	`return;`
`79`	`79`	`}`
`80`	`80`
`@@ -91,12 +91,12 @@ private void Move()`
`91`	`91`	`this.agent.Events.Move(this.agent.CurrentTarget);`
`92`	`92`	`}`
`93`	`93`
`94`		`- private void PerformAction()`
	`94`	`+ private void PerformAction(float deltaTime)`
`95`	`95`	`{`
`96`	`96`	`if (!this.ShouldContinue())`
`97`	`97`	`return;`
`98`	`98`
`99`		`- this.context.DeltaTime = Time.deltaTime;`
	`99`	`+ this.context.DeltaTime = deltaTime;`
`100`	`100`	`this.context.IsInRange = this.proxy.IsInRange();`
`101`	`101`
`102`	`102`	`if (!this.agent.ActionState.HasPerformed)`