Skip to main content

AnimationEvent

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

Members

Properties

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

Constructor

NameDescription
AnimationEvent()Creates a new animation event.

Extra Detail

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.