Animation events in Unity

Introduction

Animation events let you run code at specific times during an animation. This helps your game react exactly when something happens in the animation.

You want to play a sound exactly when a character's foot hits the ground.

You want to trigger a particle effect when a sword swing hits an enemy.

You want to change a game state right when an animation finishes.

You want to call a function to spawn an object during an animation.

You want to sync gameplay actions with animation frames.

Syntax

Unity

void FunctionName() {
    // Your code here
}

// In Unity Editor, add an Animation Event to call FunctionName at a specific frame

Animation events call functions in the script attached to the animated GameObject.

The function must be public or private and have zero or one parameter (float, int, string, or AnimationEvent).

Examples

This function can be called by an animation event to play a footstep sound.

Unity

public void PlayFootstepSound() {
    Debug.Log("Footstep sound played");
}

This function takes a string parameter from the animation event to spawn a named effect.

Unity

public void SpawnEffect(string effectName) {
    Debug.Log($"Spawn effect: {effectName}");
}

Sample Program

This script has a function that can be called by an animation event. When the animation reaches the event frame, it prints a message to the console.

Unity

using UnityEngine;

public class AnimationEventExample : MonoBehaviour {
    public void OnAnimationHit() {
        Debug.Log("Animation hit event triggered!");
    }
}

Important Notes

You add animation events inside the Animation window in Unity by selecting a frame and clicking the Add Event button.

Make sure the function name in the event matches exactly the function in your script.

Animation events only work on animations controlled by the Animator component.

Summary

Animation events let you run code at exact moments during animations.

Functions called by animation events can have zero or one parameter.

Add animation events in the Unity Animation window on specific frames.

Practice

1. What is the main purpose of animation events in Unity?

easy

A. To run code at specific times during an animation

B. To change the animation speed dynamically

C. To create new animations automatically

D. To export animations to other software

Solution

1. Step 1: Understand animation events

   Animation events allow you to trigger code at exact moments in an animation timeline.

2. Step 2: Compare options

   Only To run code at specific times during an animation describes running code at specific times, which matches the purpose of animation events.

3. Final Answer:

   To run code at specific times during an animation -> Option A

4. Quick Check:

   Animation events = run code at specific times [OK]

Hint: Animation events trigger code during animation playback [OK]

Common Mistakes:

• Confusing animation events with animation speed control
• Thinking animation events create animations
• Assuming animation events export animations

2. Which of the following is the correct way to declare a method that can be called by an animation event in Unity?

easy

A. public string PlaySound(int volume, string soundName)

B. private int PlaySound(string soundName)

C. public void PlaySound()

D. void PlaySound(float speed, int count)

Solution

1. Step 1: Recall animation event method rules

   Methods called by animation events must be public and have zero or one parameter.

2. Step 2: Analyze options

   public void PlaySound() is public with zero parameters, valid for animation events. Others have wrong access or multiple parameters.

3. Final Answer:

   public void PlaySound() -> Option C

4. Quick Check:

   Animation event methods = public + 0 or 1 parameter [OK]

Hint: Animation event methods are public with max one parameter [OK]

Common Mistakes:

• Using private methods for animation events
• Adding multiple parameters to the method
• Returning a value from the method

3. Given this code snippet attached to an animation event:

public void PrintMessage(float message) {
    Debug.Log(message);
}

What will be printed if the animation event calls PrintMessage with parameter 42?

medium

A. Error: Missing parameter

B. PrintMessage

C. null

D. 42

Solution

1. Step 1: Understand the method behavior

   The method prints the float passed as the parameter to the console.

2. Step 2: Analyze the animation event call

   The event calls PrintMessage with 42, so Debug.Log prints 42.

3. Final Answer:

   42 -> Option D

4. Quick Check:

   Animation event calls method with 42 = prints 42 [OK]

Hint: Animation event passes parameter to method, which prints it [OK]

Common Mistakes:

• Assuming method name prints instead of parameter
• Expecting null if parameter is missing
• Thinking it causes an error without parameter

4. What is wrong with this animation event method?

private void TriggerEffect() {
    Debug.Log("Effect triggered");
}

medium

A. Method must be public to be called by animation events

B. Method has too many parameters

C. Method returns a value which is not allowed

D. Method name cannot start with a lowercase letter

Solution

1. Step 1: Check method access modifier

   Animation event methods must be public to be called by Unity's animation system.

2. Step 2: Analyze the method signature

   The method is private, so Unity cannot call it from an animation event.

3. Final Answer:

   Method must be public to be called by animation events -> Option A

4. Quick Check:

   Animation event methods = public access [OK]

Hint: Animation event methods must be public, not private [OK]

Common Mistakes:

• Using private instead of public methods
• Thinking method name casing matters
• Assuming return type causes error

5. You want to trigger a sound effect exactly when a character's foot touches the ground in an animation. How do you use animation events to achieve this?

hard

A. Use a coroutine to wait for the animation length then play sound

B. Add an animation event on the foot contact frame calling a public method that plays the sound

C. Add a script to the character that checks foot position every frame

D. Modify the animation clip to include the sound audio track

Solution

1. Step 1: Identify the correct use of animation events

   Animation events let you call code at exact frames, perfect for triggering sounds on foot contact.

2. Step 2: Apply the method

   Add an event on the frame where the foot touches ground, calling a public method that plays the sound effect.

3. Final Answer:

   Add an animation event on the foot contact frame calling a public method that plays the sound -> Option B

4. Quick Check:

   Animation event on frame triggers sound method [OK]

Hint: Place animation event on exact frame to call sound method [OK]

Common Mistakes:

• Using frame checks in Update instead of animation events
• Waiting full animation length instead of exact frame
• Embedding sound in animation clip instead of code