Legacy Documentation: Version 5.2
LanguageEnglish
  • C#
  • JS

Script language

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

AnimationEvent

class in 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

Switch to Manual

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

animationStateThe animation state that fired this event (Read Only).
animatorClipInfoThe animator clip info related to this event (Read Only).
animatorStateInfoThe animator state info related to this event (Read Only).
floatParameterFloat parameter that is stored in the event and will be sent to the function.
functionNameThe name of the function that will be called.
intParameterInt parameter that is stored in the event and will be sent to the function.
isFiredByAnimatorReturns true if this Animation event has been fired by an Animator component.
isFiredByLegacyReturns true if this Animation event has been fired by an Animation component.
messageOptionsFunction call options.
objectReferenceParameterObject reference parameter that is stored in the event and will be sent to the function.
stringParameterString parameter that is stored in the event and will be sent to the function.
timeThe time at which the event will be fired off.

Constructors

AnimationEventCreates a new animation event.