API > AnimationEvent
AnimationEvent⚓︎
AnimationEvent lets you call a script function similar to SendMessage as part of playing back an animation.
Members⚓︎
Properties⚓︎
| Name | Description |
|---|---|
AnimationEvent.animationState |
The animation state that fired this event (Read Only). |
AnimationEvent.animatorClipInfo |
The animator clip info related to this event (Read Only). |
AnimationEvent.animatorStateInfo |
The animator state info related to this event (Read Only). |
AnimationEvent.floatParameter |
Float parameter that is stored in the event and will be sent to the function. |
AnimationEvent.functionName |
The name of the function that will be called. |
AnimationEvent.intParameter |
Int parameter that is stored in the event and will be sent to the function. |
AnimationEvent.isFiredByAnimator |
Returns true if this Animation event has been fired by an Animator component. |
AnimationEvent.isFiredByLegacy |
Returns true if this Animation event has been fired by an Animation component. |
AnimationEvent.messageOptions |
Function call options. |
AnimationEvent.objectReferenceParameter |
Object reference parameter that is stored in the event and will be sent to the function. |
AnimationEvent.stringParameter |
String parameter that is stored in the event and will be sent to the function. |
AnimationEvent.time |
The time at which the event will be fired off. |
Constructor⚓︎
| Name | Description |
|---|---|
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.