Legacy Documentation: Version 4.6(go to latest)
Language: English
  • C#
  • JS
  • Boo

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

AnimationEvent

Namespace: UnityEngine

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

Description

AnimationEvent lets you call a script function similar to SendMessage as part of playing back an animation.

Animation events support functions that take zero or one parameter. The parameter can be a float, an int, a string, an object reference, or an AnimationEvent.

Variables

animationState The animation state that fired this event (Read Only).
floatParameter Float parameter that is stored in the event and will be sent to the function.
functionName The name of the function that will be called.
intParameter Int parameter that is stored in the event and will be sent to the function.
messageOptions Function call options.
objectReferenceParameter Object reference parameter that is stored in the event and will be sent to the function.
stringParameter String parameter that is stored in the event and will be sent to the function.
time The time at which the event will be fired off.

Constructors

AnimationEvent Creates a new animation event.