🔸Simple Animation Player

This page explains how Simple Animation Player works.

Overview

This component is used to dynamically play animations from code:

• Use Animator — if true, animations will be played on top of existing Animator Controller.

• Default Clip Pose — this clip will be used as the default pose. It's only used when Use Animator is false.

Simple Animation Player is added to the same Game Object as the Animator component:

Use-cases

It's primarily used for animated props like weapons. Instead of creating Animator Controllers for every item, this component lets you play animations from code:

public bool PlayAnimation(AnimationAsset newAnimation, float startTime = 0f).

Tip: Animation Assets are used for more granular control over the clip speed and blending settings.

Here's an example code snippet that shows how Simple Animation Player can be used to play animations for a weapon:

WeaponExample.cs

[SerializedField] private AnimationClip weaponIdlePose;
private SimpleAnimationPlayer _animationPlayer;

private void Start()
{
    // 1. Try to get the animation player.
    _animationPlayer = GetComponent<SimpleAnimationPlayer>();
    
    // 2. Play weapon base pose
    if(_animationPlayer != null) _animationPlayer.PlayBasePlayable(weaponIdlePose);
    
}

private void PlayReloadAnimation(AnimationAsset reloadAnimation)
{
    // 3. Play custom animations on demand.
    if(_animationPlayer != null) _animationPlayer.PlayAnimation(reloadAnimation);
}