Merge pull request #11 from batonPiotr/release/0.3.0

batonPiotr · web-flow · commit 524d59ad8ac2 · 2021-12-14T22:41:17.000+01:00
Release/0.3.0
diff --git a/Editor/AbilitiesDrawers/BaseAbilityDrawer.cs b/Editor/AbilitiesDrawers/BaseAbilityDrawer.cs
@@ -65,7 +65,7 @@ public override void OnGUI(Rect position, SerializedProperty property, GUIConten
             {
                 var togglePosition = RectLayout.VerticalRect(position, 0);
                 togglePosition.x += position.width - 22.0f;
-                var value = ability.Enabled;
+                var value = ability.IsEnabled;
                 var newValue = EditorGUI.Toggle(togglePosition, enabledProperty.boolValue);
                 if(newValue != enabledProperty.boolValue)
                 {
@@ -79,7 +79,7 @@ public override void OnGUI(Rect position, SerializedProperty property, GUIConten
                     enabledProperty.boolValue = newValue;
                 }
             }
-            
+
             foldout[ability] = EditorGUI.Foldout(RectLayout.VerticalRect(position, 0), shouldFoldout, ability.Name);
 
 
diff --git a/Runtime/Ability/Ability.cs b/Runtime/Ability/Ability.cs
@@ -14,7 +14,7 @@ public class Ability : IAbility
         public bool IsActive => _IsActive;
         [SerializeField]
         private bool _Enabled = true;
-        public bool Enabled => _Enabled;
+        public bool IsEnabled => _Enabled;
 
 
         public event System.Action<IAbility> OnDidActivate;
@@ -24,7 +24,7 @@ public class Ability : IAbility
 
         public void Disable()
         {
-            if(!Enabled)
+            if(!IsEnabled)
                 return;
             _Enabled = false;
             if(Agent == null)
@@ -37,7 +37,7 @@ public void Disable()
 
         public void Enable()
         {
-            if(Enabled)
+            if(IsEnabled)
                 return;
             _Enabled = true;
 
@@ -59,24 +59,24 @@ protected virtual void OnStop(StopReason reason) {}
 
         public virtual bool ShouldStopMyselfDueToActivatingAbility(IAbility abilityThatBlocks) => false;
 
-        public bool TryToAdd(IAgent agent)
+        protected virtual bool ShouldBeAddedToAgent(IAgent agent) => true;
+        protected virtual bool ShouldBeActivated() => true;
+
+        bool IAbility.TryToAdd(IAgent agent)
         {
             if(Agent != null)
                 return false;
             if(agent == null)
                 return false;
-            if(!ValidateAgent(agent))
+            if(!ShouldBeAddedToAgent(agent))
                 return false;
             _Agent = agent;
             return true;
         }
 
-        protected virtual bool ValidateAgent(IAgent agent) => true;
-        protected virtual bool ShouldBeActivated() => true;
-
-        public bool TryToActivate()
+        bool IAbility.TryToActivate()
         {
-            if(!IsActive && Enabled && Agent != null && ShouldBeActivated())
+            if(!IsActive && IsEnabled && Agent != null && ShouldBeActivated())
             {
                 _IsActive = true;
                 OnDidActivate?.Invoke(this);
@@ -92,7 +92,7 @@ public void Stop()
 
         public virtual void Dispose() {}
 
-        public void DetachFromAgent()
+        void IAbility.DetachFromAgent()
         {
             Stop();
             _Agent = null;
diff --git a/Runtime/Ability/Animator/ChangeSpeed.cs b/Runtime/Ability/Animator/ChangeSpeed.cs
@@ -13,7 +13,7 @@ public class ChangeSpeed : Ability, IChangeSpeedAbility
 
         public void SetSpeedMultiplier(float multiplier)
         {
-            if(!Enabled)
+            if(!IsEnabled)
                 return;
             if(!IsActive)
             {
@@ -24,7 +24,7 @@ public void SetSpeedMultiplier(float multiplier)
             Complete();
         }
 
-        protected override bool ValidateAgent(IAgent agent)
+        protected override bool ShouldBeAddedToAgent(IAgent agent)
         {
             movementProperties = agent.GetProperties<MovementProperties>();
             if(movementProperties == null)
diff --git a/Runtime/Ability/Animator/MoveAbility.cs b/Runtime/Ability/Animator/MoveAbility.cs
@@ -74,7 +74,7 @@ public void SetInputVector(Vector2 input)
                 Complete();
         }
 
-        protected override bool ValidateAgent(IAgent agent)
+        protected override bool ShouldBeAddedToAgent(IAgent agent)
         {
             animator = agent.GameObject.GetComponent<Animator>();
             UpdateHashes();
diff --git a/Runtime/Ability/Animator/StrafeAbility.cs b/Runtime/Ability/Animator/StrafeAbility.cs
@@ -56,7 +56,7 @@ public void SetInput(float value)
                 Complete();
         }
 
-        protected override bool ValidateAgent(IAgent agent)
+        protected override bool ShouldBeAddedToAgent(IAgent agent)
         {
             animator = agent.GameObject.GetComponent<Animator>();
             UpdateHashes();
diff --git a/Runtime/Ability/Generic/FollowAbility.cs b/Runtime/Ability/Generic/FollowAbility.cs
@@ -33,7 +33,7 @@ public float UpdateTargetPositionInterval
 
         private object currentScheduledTask = null;
 
-        override protected bool ValidateAgent(IAgent agent)
+        override protected bool ShouldBeAddedToAgent(IAgent agent)
         {
             goToAbility = agent.GetAbility<IGoToAbility>();
 
diff --git a/Runtime/Ability/Generic/GoToAbility.cs b/Runtime/Ability/Generic/GoToAbility.cs
@@ -12,7 +12,7 @@ public class GoToAbility : Ability, IGoToAbility, IUpdate
         private IMoveAbility moveAbility;
         private NavMeshAgent navMeshAgent;
 
-        override protected bool ValidateAgent(IAgent agent)
+        override protected bool ShouldBeAddedToAgent(IAgent agent)
         {
             moveAbility = agent.GetAbility<IMoveAbility>();
             navMeshAgent = agent.GameObject.GetComponent<NavMeshAgent>();
diff --git a/Runtime/Ability/IAbility.cs b/Runtime/Ability/IAbility.cs
@@ -29,6 +29,8 @@ public enum StopReason
         Completion
     }
 
+    internal interface IInternal {}
+
     public interface IAbility: IDisposable
     {
         /// <summary>
@@ -65,7 +67,7 @@ public interface IAbility: IDisposable
         /// <summary>
         /// Tells if this ability can be activated
         /// </summary>
-        bool Enabled { get; }
+        bool IsEnabled { get; }
 
         /// <summary>
         /// Turns on the ability. It does not activate it, it just allows to run.
@@ -102,17 +104,20 @@ public interface IAbility: IDisposable
         /// Called when this ability is being added to the agent. It analyzes if the agent contains required components.
         /// </summary>
         /// <param name="agent">Agent to validate</param>
-        bool TryToAdd(IAgent agent);
+        internal bool TryToAdd(IAgent agent);
 
-        void DetachFromAgent();
+        /// <summary>
+        /// It detaches the ability from the agent. It shouldn't be called directly, only through Agent.RemoveAbility(IAbility ability)
+        /// </summary>
+        internal void DetachFromAgent();
 
         /// <summary>
         /// Called if someone wants to activate this ability through agent. This ability has to meet following minimal requirements in order to be activated:
         /// - It must be enabled. All abilities are disabled upon creation
         /// - It must not be activated.
         /// - It must be assigned to an agent.
         /// </summary>
-        bool TryToActivate();
+        internal bool TryToActivate();
 
         /// <summary>
         /// It will end the ability with the reason 'Interruption'
diff --git a/Runtime/Ability/Rigidbody/RigidbodyMovement.cs b/Runtime/Ability/Rigidbody/RigidbodyMovement.cs
@@ -14,7 +14,7 @@ public class RigidbodyMovement : Ability, IMoveAbility, IFixedUpdate
         private float speedMultiplier = 1.0f;
         public float SpeedMultiplier { get => speedMultiplier; set => speedMultiplier = value; }
 
-        protected override bool ValidateAgent(IAgent agent)
+        protected override bool ShouldBeAddedToAgent(IAgent agent)
         {
             rigidbody = agent.GameObject.GetComponent<Rigidbody>();
             if(rigidbody == null)
@@ -35,7 +35,7 @@ public void FixedUpdate()
             }
             rigidbody.AddRelativeForce(new Vector3(inputVector.x, 0.0f, inputVector.y) * 100.0f * speedMultiplier);
             inputVector = Vector2.zero;
-            
+
             if(rigidbody.velocity.sqrMagnitude < 0.001f)
                 _IsActive = false;
         }
diff --git a/Runtime/Ability/Rigidbody/RigidbodyRotation.cs b/Runtime/Ability/Rigidbody/RigidbodyRotation.cs
@@ -10,7 +10,7 @@ public class RigidbodyRotation : Ability, IRotateAbility, IFixedUpdate
         private float rotationInput;
         private Rigidbody rigidbody;
 
-        protected override bool ValidateAgent(IAgent agent)
+        protected override bool ShouldBeAddedToAgent(IAgent agent)
         {
             rigidbody = agent.GameObject.GetComponent<Rigidbody>();
             if(rigidbody == null)
diff --git a/Runtime/Agent/Agent.cs b/Runtime/Agent/Agent.cs
@@ -49,7 +49,7 @@ public bool AddAbility(IAbility ability, bool enableOnAdd = true)
 
             if(enableOnAdd)
                 ability.Enable();
-                
+
             return true;
         }
 
@@ -77,7 +77,7 @@ public bool ActivateAbility(IAbility ability)
             if(!Abilities.Contains(ability))
                 return false;
 
-            if(!ability.Enabled)
+            if(!ability.IsEnabled)
                 return false;
 
             // Check if some running ability wants to prevent activating this ability
@@ -123,7 +123,7 @@ public void FixedUpdate()
         {
             foreach(var fixedUpdate in FixedUpdateAbilities)
             {
-                if(((IAbility)fixedUpdate).Enabled)
+                if(((IAbility)fixedUpdate).IsEnabled)
                     fixedUpdate.FixedUpdate();
             }
         }
@@ -132,7 +132,7 @@ public void Update()
         {
             foreach(var update in UpdateAbilities)
             {
-                if(((IAbility)update).Enabled)
+                if(((IAbility)update).IsEnabled)
                     update.Update();
             }
         }
diff --git a/Runtime/Agent/MonoAgent.cs b/Runtime/Agent/MonoAgent.cs
@@ -29,7 +29,7 @@ private void Awake()
             agent = new Agent(gameObject);
             foreach(var prop in properties)
                 agent.AddProperties(prop);
-            var abilitiesToEnable = abilities.Where(i => i.Enabled);
+            var abilitiesToEnable = abilities.Where(i => i.IsEnabled);
             foreach(var ability in abilities)
             {
                 if(!agent.AddAbility(ability, abilitiesToEnable.Contains(ability)))
diff --git a/Runtime/Agent/MonoAgentNewInputHandler.cs b/Runtime/Agent/MonoAgentNewInputHandler.cs
@@ -1,4 +1,4 @@
-namespace HandcraftedGames.AgentController
+namespace HandcraftedGames.AgentController.Abilities
 {
     using HandcraftedGames.AgentController.Abilities;
     using HandcraftedGames.Utils;
@@ -64,7 +64,7 @@ public void OnStrafe(InputAction.CallbackContext context)
                 return;
             lastStrafeValue = (float)context.ReadValueAsObject();
         }
-        
+
         private void Update()
         {
             if (moveAbility == null /*|| rotateAbility == null*/)
@@ -83,9 +83,9 @@ private void Update()
                     this.target.agent.AddAbility(inputHandlingAbility);
                 }
 
-                if(!inputHandlingAbility.IsActive && !inputHandlingAbility.TryToActivate())
+                if(!inputHandlingAbility.IsActive && !((IAbility)inputHandlingAbility).TryToActivate())
                     return;
-                
+
                 moveAbility.SetInputVector(lastInputVector);
                 strafeAbility.SetInput(lastStrafeValue);
             }
diff --git a/Runtime/Agent/MonoAgentSimpleInputHandler.cs b/Runtime/Agent/MonoAgentSimpleInputHandler.cs
@@ -23,7 +23,11 @@ public class MonoAgentSimpleInputHandler: MonoBehaviour
 
         float maxValue = 1.0f;
         float delay = 0.1f;
-        
+
+        private void OnEnable()
+        {
+        }
+
         #if ENABLE_LEGACY_INPUT_MANAGER
         private void Update()
         {
@@ -36,7 +40,7 @@ private void Update()
             else
             {
                 var rotationInput = 0.0f;
-                
+
                 if (Input.GetKeyDown(KeyCode.UpArrow))
                 {
                     forwardInputTween.Stop();
diff --git a/Tests/Editor/AbilityTests.cs b/Tests/Editor/AbilityTests.cs
diff --git a/Tests/Editor/AgentTests.cs b/Tests/Editor/AgentTests.cs
diff --git a/package.json b/package.json

Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,7 @@ public override void OnGUI(Rect position, SerializedProperty property, GUIConten`
`65`	`65`	`{`
`66`	`66`	`var togglePosition = RectLayout.VerticalRect(position, 0);`
`67`	`67`	`togglePosition.x += position.width - 22.0f;`
`68`		`- var value = ability.Enabled;`
	`68`	`+ var value = ability.IsEnabled;`
`69`	`69`	`var newValue = EditorGUI.Toggle(togglePosition, enabledProperty.boolValue);`
`70`	`70`	`if(newValue != enabledProperty.boolValue)`
`71`	`71`	`{`
`@@ -79,7 +79,7 @@ public override void OnGUI(Rect position, SerializedProperty property, GUIConten`
`79`	`79`	`enabledProperty.boolValue = newValue;`
`80`	`80`	`}`
`81`	`81`	`}`
`82`		`-`
	`82`	`+`
`83`	`83`	`foldout[ability] = EditorGUI.Foldout(RectLayout.VerticalRect(position, 0), shouldFoldout, ability.Name);`
`84`	`84`
`85`	`85`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ public class ChangeSpeed : Ability, IChangeSpeedAbility`
`13`	`13`
`14`	`14`	`public void SetSpeedMultiplier(float multiplier)`
`15`	`15`	`{`
`16`		`- if(!Enabled)`
	`16`	`+ if(!IsEnabled)`
`17`	`17`	`return;`
`18`	`18`	`if(!IsActive)`
`19`	`19`	`{`
`@@ -24,7 +24,7 @@ public void SetSpeedMultiplier(float multiplier)`
`24`	`24`	`Complete();`
`25`	`25`	`}`
`26`	`26`
`27`		`- protected override bool ValidateAgent(IAgent agent)`
	`27`	`+ protected override bool ShouldBeAddedToAgent(IAgent agent)`
`28`	`28`	`{`
`29`	`29`	`movementProperties = agent.GetProperties<MovementProperties>();`
`30`	`30`	`if(movementProperties == null)`
Original file line number	Diff line number	Diff line change
`@@ -74,7 +74,7 @@ public void SetInputVector(Vector2 input)`
`74`	`74`	`Complete();`
`75`	`75`	`}`
`76`	`76`
`77`		`- protected override bool ValidateAgent(IAgent agent)`
	`77`	`+ protected override bool ShouldBeAddedToAgent(IAgent agent)`
`78`	`78`	`{`
`79`	`79`	`animator = agent.GameObject.GetComponent<Animator>();`
`80`	`80`	`UpdateHashes();`
Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ public void SetInput(float value)`
`56`	`56`	`Complete();`
`57`	`57`	`}`
`58`	`58`
`59`		`- protected override bool ValidateAgent(IAgent agent)`
	`59`	`+ protected override bool ShouldBeAddedToAgent(IAgent agent)`
`60`	`60`	`{`
`61`	`61`	`animator = agent.GameObject.GetComponent<Animator>();`
`62`	`62`	`UpdateHashes();`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ public float UpdateTargetPositionInterval`
`33`	`33`
`34`	`34`	`private object currentScheduledTask = null;`
`35`	`35`
`36`		`- override protected bool ValidateAgent(IAgent agent)`
	`36`	`+ override protected bool ShouldBeAddedToAgent(IAgent agent)`
`37`	`37`	`{`
`38`	`38`	`goToAbility = agent.GetAbility<IGoToAbility>();`
`39`	`39`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ public class GoToAbility : Ability, IGoToAbility, IUpdate`
`12`	`12`	`private IMoveAbility moveAbility;`
`13`	`13`	`private NavMeshAgent navMeshAgent;`
`14`	`14`
`15`		`- override protected bool ValidateAgent(IAgent agent)`
	`15`	`+ override protected bool ShouldBeAddedToAgent(IAgent agent)`
`16`	`16`	`{`
`17`	`17`	`moveAbility = agent.GetAbility<IMoveAbility>();`
`18`	`18`	`navMeshAgent = agent.GameObject.GetComponent<NavMeshAgent>();`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ public class RigidbodyMovement : Ability, IMoveAbility, IFixedUpdate`
`14`	`14`	`private float speedMultiplier = 1.0f;`
`15`	`15`	`public float SpeedMultiplier { get => speedMultiplier; set => speedMultiplier = value; }`
`16`	`16`
`17`		`- protected override bool ValidateAgent(IAgent agent)`
	`17`	`+ protected override bool ShouldBeAddedToAgent(IAgent agent)`
`18`	`18`	`{`
`19`	`19`	`rigidbody = agent.GameObject.GetComponent<Rigidbody>();`
`20`	`20`	`if(rigidbody == null)`
`@@ -35,7 +35,7 @@ public void FixedUpdate()`
`35`	`35`	`}`
`36`	`36`	`rigidbody.AddRelativeForce(new Vector3(inputVector.x, 0.0f, inputVector.y) * 100.0f * speedMultiplier);`
`37`	`37`	`inputVector = Vector2.zero;`
`38`		`-`
	`38`	`+`
`39`	`39`	`if(rigidbody.velocity.sqrMagnitude < 0.001f)`
`40`	`40`	`_IsActive = false;`
`41`	`41`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ public class RigidbodyRotation : Ability, IRotateAbility, IFixedUpdate`
`10`	`10`	`private float rotationInput;`
`11`	`11`	`private Rigidbody rigidbody;`
`12`	`12`
`13`		`- protected override bool ValidateAgent(IAgent agent)`
	`13`	`+ protected override bool ShouldBeAddedToAgent(IAgent agent)`
`14`	`14`	`{`
`15`	`15`	`rigidbody = agent.GameObject.GetComponent<Rigidbody>();`
`16`	`16`	`if(rigidbody == null)`