Added AnimationEvents (OnFootstep and OnFootLand plays audio)

Author: Daxode

Assets/Samples/Character Controller/1.1.0-exp.10/Standard Characters/ThirdPerson/Scripts/ThirdPersonCharacterSystems.cs

@@ -6,6 +6,7 @@
 using Unity.CharacterController;
 using Unity.Mathematics;
 using UnityEngine;
+using Random = UnityEngine.Random;
 
 [Serializable]
 public struct ThirdPersonCharacterData : IComponentData
@@ -70,12 +71,19 @@ struct KyleAnimationData : IComponentData
     // Read-Only Properties
     public float SpeedChangeRate;
     public float FallTimeout;
+    public float FootstepAudioVolume;
 
     // Read-Write Properties
     public float MotionBlend;
     public float FallTimeoutDelta;
 }
 
+public class KyleAnimationManagedData : IComponentData
+{
+    public AudioClip LandingAudioClip;
+    public AudioClip[] FootstepAudioClips;
+}
+
 [UpdateInGroup(typeof(SimulationSystemGroup))]
 [UpdateAfter(typeof(FixedStepSimulationSystemGroup))]
 [UpdateAfter(typeof(ThirdPersonPlayerVariableStepControlSystem))]
@@ -126,6 +134,7 @@ public void OnUpdate(ref SystemState state)
             ref var animationData = ref SystemAPI.GetComponentRW<KyleAnimationData>(characterData.AnimationEntity).ValueRW;
             var characterInput = characterAspect.CharacterInput.ValueRO;
             var characterBody = characterAspect.CharacterAspect.CharacterBody.ValueRO;
+            var localTransform = characterAspect.CharacterAspect.LocalTransform.ValueRO;
             var targetSpeed = characterInput.SprintIsHeld ? characterData.SprintSpeed : characterData.WalkSpeed;
 
             // Update Motion Blend
@@ -152,6 +161,23 @@ public void OnUpdate(ref SystemState state)
                 else
                     animator.SetBool(AnimIDFreeFall, true);
             }
+            
+            // Handle Animation Events
+            var animatorEvents = SystemAPI.ManagedAPI.GetComponent<KyleAnimatorEvents>(characterData.AnimationEntity);
+            var managedData = SystemAPI.ManagedAPI.GetComponent<KyleAnimationManagedData>(characterData.AnimationEntity);
+            while (animatorEvents.MoveNextFootstep())
+            {
+                if (managedData.FootstepAudioClips.Length > 0)
+                {
+                    var index = Random.Range(0, managedData.FootstepAudioClips.Length);
+                    AudioSource.PlayClipAtPoint(managedData.FootstepAudioClips[index], localTransform.Position, animationData.FootstepAudioVolume);
+                }
+            }
+            
+            while (animatorEvents.MoveNextLand())
+            {
+                AudioSource.PlayClipAtPoint(managedData.LandingAudioClip, localTransform.Position, animationData.FootstepAudioVolume);
+            }
         }
     }
 }

Assets/Scenes/Playground/Overworld.unity

@@ -188,6 +188,19 @@ MonoBehaviour:
   m_EditorClassIdentifier: 
   SpeedChangeRate: 10
   FallTimeout: 0.15
+  LandingAudioClip: {fileID: 8300000, guid: ff697d3070687ce4583faa0561a145a2, type: 3}
+  FootstepAudioClips:
+  - {fileID: 8300000, guid: 72f526a6a9890f643a88e85a61c86c8a, type: 3}
+  - {fileID: 8300000, guid: 85016e0f2b01da248b9663dd49a161b0, type: 3}
+  - {fileID: 8300000, guid: 186de84b3207156479abe98f4958fed0, type: 3}
+  - {fileID: 8300000, guid: 1a91fcd19acf1e54bba0945d9f390849, type: 3}
+  - {fileID: 8300000, guid: 14e8a8d2158bec840b56c54f5266e692, type: 3}
+  - {fileID: 8300000, guid: 29841e7d5bbfb5b419c9ad16ca8bc4c1, type: 3}
+  - {fileID: 8300000, guid: dd1af302b8902684d9381de1f2d3a5af, type: 3}
+  - {fileID: 8300000, guid: 67c8b33e424ccdc4486edf538ab91c5a, type: 3}
+  - {fileID: 8300000, guid: 274649b0e221539409070ebf6c18918b, type: 3}
+  - {fileID: 8300000, guid: a3194b8bbc96ef84fab1f98f4b7dae3e, type: 3}
+  FootstepAudioVolume: 0.5
 --- !u!1001 &1529753646
 PrefabInstance:
   m_ObjectHideFlags: 0
@@ -324,11 +337,11 @@ PrefabInstance:
       objectReference: {fileID: 0}
     - target: {fileID: 6689285571920954877, guid: 5fbcc801dea8fd640a004697d22ed448, type: 3}
       propertyPath: WalkSpeed
-      value: 8
+      value: 6
       objectReference: {fileID: 0}
     - target: {fileID: 6689285571920954877, guid: 5fbcc801dea8fd640a004697d22ed448, type: 3}
       propertyPath: SprintSpeed
-      value: 15
+      value: 11
       objectReference: {fileID: 0}
     - target: {fileID: 6689285571920954877, guid: 5fbcc801dea8fd640a004697d22ed448, type: 3}
       propertyPath: ControlledCamera

Assets/Scripts/Runtime/AnimatorSystem.cs

@@ -3,6 +3,8 @@
 using Unity.Transforms;
 using UnityEngine;
 
+public interface IAddMonoBehaviourToEntityOnAnimatorInstantiation {}
+
 struct AnimatorInstantiationData : IComponentData
 {
     public UnityObjectRef<GameObject> AnimatorGameObject;
@@ -30,12 +32,19 @@ public void OnUpdate(ref SystemState state)
                      .Build().ToEntityArray(state.WorldUpdateAllocator))
         {
             var data = SystemAPI.GetComponent<AnimatorInstantiationData>(entity);
-            var spawnedAnimator = Object.Instantiate(data.AnimatorGameObject.Value).GetComponent<Animator>();
+            var spawnedGameObject = Object.Instantiate(data.AnimatorGameObject.Value);
+            var spawnedAnimator = spawnedGameObject.GetComponent<Animator>();
             state.EntityManager.AddComponentObject(entity, spawnedAnimator);
             state.EntityManager.AddComponentData(entity, new AnimatorCleanup
             {
                 DestroyThisAnimator = spawnedAnimator
             });
+
+            foreach (var mb in spawnedGameObject.GetComponents<IAddMonoBehaviourToEntityOnAnimatorInstantiation>())
+            {
+                if (mb is MonoBehaviour monoBehaviour)
+                    state.EntityManager.AddComponentObject(entity, monoBehaviour);
+            }
         }
 
         // Sync the Animator's transform with the LocalToWorld

Assets/UnityTechnologies/StarterAssets/ThirdPersonController/Scripts/KyleAnimatorAuthor.cs

@@ -4,8 +4,15 @@
 [RequireComponent(typeof(AnimatorAuthor))]
 public class KyleAnimatorAuthor : MonoBehaviour
 {
+    [Header("Kyle Animator Settings")]
     public float SpeedChangeRate = 10.0f;
     public float FallTimeout = 0.15f;
+    
+    [Header("Kyle Animator Event Settings")]
+    public AudioClip LandingAudioClip;
+    public AudioClip[] FootstepAudioClips;
+    [Range(0, 1)] public float FootstepAudioVolume = 0.5f;
+    
     class KyleAnimatorAuthorBaker : Baker<KyleAnimatorAuthor>
     {
         public override void Bake(KyleAnimatorAuthor authoring)
@@ -14,7 +21,13 @@ public override void Bake(KyleAnimatorAuthor authoring)
             AddComponent(entity, new KyleAnimationData
             {
                 SpeedChangeRate = authoring.SpeedChangeRate,
-                FallTimeout = authoring.FallTimeout
+                FallTimeout = authoring.FallTimeout,
+                FootstepAudioVolume = authoring.FootstepAudioVolume
+            });
+            AddComponentObject(entity, new KyleAnimationManagedData
+            {
+                FootstepAudioClips = authoring.FootstepAudioClips,
+                LandingAudioClip = authoring.LandingAudioClip
             });
         }
     }

Assets/UnityTechnologies/StarterAssets/ThirdPersonController/Scripts/KyleAnimatorEvents.cs

@@ -1,19 +1,26 @@
 using UnityEngine;
 
-public class KyleAnimatorEvents : MonoBehaviour
+public class KyleAnimatorEvents : MonoBehaviour, IAddMonoBehaviourToEntityOnAnimatorInstantiation
 {
-    void Start()
+    // Count footsteps triggered
+    int m_FootstepTriggerCount;
+    public bool MoveNextFootstep()
     {
-        
+        if (m_FootstepTriggerCount <= 0) 
+            return false;
+        m_FootstepTriggerCount--;
+        return true;
     }
+    void OnFootstep(AnimationEvent animationEvent) => m_FootstepTriggerCount++;
 
-    void OnFootstep(AnimationEvent animationEvent)
+    // Count landings triggered
+    int m_LandTriggerCount;
+    public bool MoveNextLand()
     {
-        
-    }
-
-    void OnLand(AnimationEvent animationEvent)
-    {
-        
+        if (m_LandTriggerCount <= 0) 
+            return false;
+        m_LandTriggerCount--;
+        return true;
     }
+    void OnLand(AnimationEvent animationEvent) => m_LandTriggerCount++;
 }

Assets/UnityTechnologies/StarterAssets/ThirdPersonController/Scripts/ThirdPersonController.cs

@@ -347,25 +347,5 @@ private void OnDrawGizmosSelected()
                 new Vector3(transform.position.x, transform.position.y - GroundedOffset, transform.position.z),
                 GroundedRadius);
         }
-
-        public void OnFootstep(float weight)
-        {
-            if (weight > 0.5f)
-            {
-                if (FootstepAudioClips.Length > 0)
-                {
-                    var index = Random.Range(0, FootstepAudioClips.Length);
-                    AudioSource.PlayClipAtPoint(FootstepAudioClips[index], transform.TransformPoint(_controller.center), FootstepAudioVolume);
-                }
-            }
-        }
-
-        public void OnLand(float weight)
-        {
-            if (weight > 0.5f)
-            {
-                AudioSource.PlayClipAtPoint(LandingAudioClip, transform.TransformPoint(_controller.center), FootstepAudioVolume);
-            }
-        }
     }
 }