Legacy Documentation: Version 5.0
Animation Curves on Imported Clips
Selecting a Root Motion Node

Animation Events on Imported Clips

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Animation events can be attached to imported animation clips in the Animations tab of the Animation Import Settings.

These events allow you to add additional data to an imported clip which determines when certain actions should occur in time with the animation. For example, for an animated character you might want to add events to walk and run cycles indicating when the footstep sounds should play.

To add an event to an imported animation, first select the imported animation file in your project view, then in the import settings in the inspector, select the Animations button.

View the Animations section of the Import Settings for your animation file
View the Animations section of the Import Settings for your animation file

Then scroll all the way to the bottom of the inspector to find the Events heading, among the four fold-out headings as shown:

The Events fold-out heading, along with the Curves, Masks, and Motion headings
The Events fold-out heading, along with the Curves, Masks, and Motion headings

Expand the events heading to reveal the events timeline for the current imported animation clip. To the left of the timeline is the Add Event button. Click it to add a new event to the timeline.

The events timeline for the current imported animation clip
The events timeline for the current imported animation clip

When adding an event, the event needs a name, which will be the name of the function that is called when the event is triggered. For any Gameobject which uses this animation in its animator, you should make sure the Gameobject has a corresponding script attached that contains a function whose name matches the event name. Below, you can see a footstep event set up to call the “Footstep” function in a script attached to the Player Gameobject.

The event dialog box shown when adding or editing an event on an imported animation
The event dialog box shown when adding or editing an event on an imported animation

You can optionally choose to specify a parameter which is also sent to the function called by the event. There are four different parameter types you can use, Float, Int, String or Object.

By filling out a value in one of these fields, and implementing your receiver function to accept a parameter of that type, you can have the value specified in the event passed through to your function in the script. For example, you could pass a float value to specify how loud the footstep should be - allowing you to have quiet footstep events on a walking loop and loud footstep events on a running loop. Or you could pass a reference to an effect prefab, allowing your script to instantiate different effects at certain points during your animation.

Animation Curves on Imported Clips
Selecting a Root Motion Node