Animation scripts

IntermediateProgrammer

Animations are controlled using scripts.

You can add an AnimationComponent to an entity and set up its parameters in Game Studio. The AnimationComponent class is designed to be used mainly from a script.

The more useful properties include:

PropertyDescription
AnimationsGets the animation clips associated with this AnimationComponent
BlendTreeBuilderGets or sets animation blend tree builder. Note you can create custom blend trees; for more information, see Custom blend tree
PlayingAnimationsGets the list of active animations. Use it to customize your startup animations. The playing animations are updated automatically by the animation processor, so be careful when changing the list or keeping a reference to a playing animation
Note

Animation clips you reference in scripts must be added to the same entity under the AnimationComponent.

Animations added to component

For more information, see Set up animations.

Use the pre-built AnimationStart script

Xenko includes a pre-built AnimationStart script. You can use this script as a template to write your own animation scripts.

To use the AnimationStart script:

  • In the Asset View (bottom pane by default), click Add asset.

  • Choose Add asset > Scripts > Animation start.

Add animation script

  • Specify a name for the script and click Create script.

Create script

3a. If Game Studio asks if you want to save your script, click Save script.

3b. If Game Studio asks if you want to reload the assemblies, click Reload assemblies.

  • Edit the script as necessary and save it.

Example animation script

This sample script assigns a simple animation to a character based on its walking speed.

  1. using Xenko.Engine;
  3. namespace AdditiveAnimation
  4. {
  5.     public class AnimationClipExample : SyncScript
  6.     {
  7.         public float MovementSpeed { get; set; } = 0f;
  9.         private float walkingSpeedLimit = 1.0f;
  11.         // Assuming the script is attached to an entity which has an animation component
  12.         private AnimationComponent animationComponent;
  14.         public override void Start()
  15.         {
  16.             // Cache some variables we'll need later
  17.             animationComponent = Entity.Get<AnimationComponent>();
  18.             animationComponent.Play("Idle");
  19.         }
  21.         protected void PlayAnimation(string name)
  22.         {
  23.             if (!animationComponent.IsPlaying(name))
  24.                 animationComponent.Play(name);
  25.         }
  27.         public override void Update()
  28.         {
  29.             if (MovementSpeed <= 0)
  30.             {
  31.                 PlayAnimation("Idle");
  32.             }
  33.             else if (MovementSpeed <= walkingSpeedLimit)
  34.             {
  35.                 PlayAnimation("Walk");
  36.             }
  37.             else 
  38.             {
  39.                 PlayAnimation("Run");
  40.             }
  41.         }
  42.     }
  43. }

Override the animation blend tree

You an also override the animation blend tree and do all animation blending in the script. The templates First-person shooter, Third-person platformer and Top-down RPG, which use some advanced techniques, are examples of how to do this. For more information, see custom blend trees.

See also