Work in progress

The content of this page was not yet updated for Godot 4.2 and may be outdated. If you know how to improve this page or you can confirm that it’s up to date, feel free to open a pull request.

Character animation

In this final lesson, we’ll use Godot’s built-in animation tools to make our characters float and flap. You’ll learn to design animations in the editor and use code to make your game feel alive.

image0

We’ll start with an introduction to using the animation editor.

Using the animation editor

The engine comes with tools to author animations in the editor. You can then use the code to play and control them at runtime.

Open the player scene, select the Player node, and add an AnimationPlayer node.

The Animation dock appears in the bottom panel.

image1

It features a toolbar and the animation drop-down menu at the top, a track editor in the middle that’s currently empty, and filter, snap, and zoom options at the bottom.

Let’s create an animation. Click on Animation -> New.

image2

Name the animation “float”.

image3

Once you’ve created the animation, the timeline appears with numbers representing time in seconds.

image4

We want the animation to start playback automatically at the start of the game. Also, it should loop.

To do so, you can click the button with an “A+” icon in the animation toolbar and the looping arrows, respectively.

image5

You can also pin the animation editor by clicking the pin icon in the top-right. This prevents it from folding when you click on the viewport and deselect the nodes.

image6

Set the animation duration to 1.2 seconds in the top-right of the dock.

image7

You should see the gray ribbon widen a bit. It shows you the start and end of your animation and the vertical blue line is your time cursor.

image8

You can click and drag the slider in the bottom-right to zoom in and out of the timeline.

image9

The float animation

With the animation player node, you can animate most properties on as many nodes as you need. Notice the key icon next to properties in the Inspector. You can click any of them to create a keyframe, a time and value pair for the corresponding property. The keyframe gets inserted where your time cursor is in the timeline.

Let’s insert our first keys. Here, we will animate both the position and the rotation of the Character node.

Select the Character and in the Inspector expand the Transform section. Click the key icon next to Position, and Rotation.

image10

../../_images/curves.webp

For this tutorial, just create RESET Track(s) which is the default choice

Two tracks appear in the editor with a diamond icon representing each keyframe.

image11

You can click and drag on the diamonds to move them in time. Move the position key to 0.3 seconds and the rotation key to 0.1 seconds.

image12

Move the time cursor to 0.5 seconds by clicking and dragging on the gray timeline.

../../_images/timeline_05_click.webp

In the Inspector, set the Position‘s Y axis to 0.65 meters and the Rotation‘ X axis to 8.

image13

Create a keyframe for both properties

../../_images/second_keys_both.webp

Now, move the position keyframe to 0.7 seconds by dragging it on the timeline.

image14

Note

A lecture on the principles of animation is beyond the scope of this tutorial. Just note that you don’t want to time and space everything evenly. Instead, animators play with timing and spacing, two core animation principles. You want to offset and contrast in your character’s motion to make them feel alive.

Move the time cursor to the end of the animation, at 1.2 seconds. Set the Y position to about 0.35 and the X rotation to -9 degrees. Once again, create a key for both properties.

../../_images/animation_final_keyframes.webp

You can preview the result by clicking the play button or pressing Shift + D. Click the stop button or press S to stop playback.

image15

You can see that the engine interpolates between your keyframes to produce a continuous animation. At the moment, though, the motion feels very robotic. This is because the default interpolation is linear, causing constant transitions, unlike how living things move in the real world.

We can control the transition between keyframes using easing curves.

Click and drag around the first two keys in the timeline to box select them.

image16

You can edit the properties of both keys simultaneously in the Inspector, where you can see an Easing property.

image17

Click and drag on the curve, pulling it towards the left. This will make it ease-out, that is to say, transition fast initially and slow down as the time cursor reaches the next keyframe.

image18

Play the animation again to see the difference. The first half should already feel a bit bouncier.

Apply an ease-out to the second keyframe in the rotation track.

image19

Do the opposite for the second position keyframe, dragging it to the right.

image20

Your animation should look something like this.

image21

Note

Animations update the properties of the animated nodes every frame, overriding initial values. If we directly animated the Player node, it would prevent us from moving it in code. This is where the Pivot node comes in handy: even though we animated the Character, we can still move and rotate the Pivot and layer changes on top of the animation in a script.

If you play the game, the player’s creature will now float!

If the creature is a little too close to the floor, you can move the Pivot up to offset it.

Controlling the animation in code

We can use code to control the animation playback based on the player’s input. Let’s change the animation speed when the character is moving.

Open the Player‘s script by clicking the script icon next to it.

image22

In _physics_process(), after the line where we check the direction vector, add the following code.

GDScriptC#

  1. func _physics_process(delta):
  2.     #...
  3.     if direction != Vector3.ZERO:
  4.         #...
  5.         $AnimationPlayer.speed_scale = 4
  6.     else:
  7.         $AnimationPlayer.speed_scale = 1
  1. public override void _PhysicsProcess(double delta)
  2. {
  3.     // ...
  4.     if (direction != Vector3.Zero)
  5.     {
  6.         // ...
  7.         GetNode<AnimationPlayer>("AnimationPlayer").SpeedScale = 4;
  8.     }
  9.     else
  10.     {
  11.         GetNode<AnimationPlayer>("AnimationPlayer").SpeedScale = 1;
  12.     }
  13. }

This code makes it so when the player moves, we multiply the playback speed by 4. When they stop, we reset it to normal.

We mentioned that the Pivot could layer transforms on top of the animation. We can make the character arc when jumping using the following line of code. Add it at the end of _physics_process().

GDScriptC#

  1. func _physics_process(delta):
  2.     #...
  3.     $Pivot.rotation.x = PI / 6 * velocity.y / jump_impulse
  1. public override void _PhysicsProcess(double delta)
  2. {
  3.     // ...
  4.     var pivot = GetNode<Node3D>("Pivot");
  5.     pivot.Rotation = new Vector3(Mathf.Pi / 6.0f * Velocity.Y / JumpImpulse, pivot.Rotation.Y, pivot.Rotation.Z);
  6. }

Animating the mobs

Here’s another nice trick with animations in Godot: as long as you use a similar node structure, you can copy them to different scenes.

For example, both the Mob and the Player scenes have a Pivot and a Character node, so we can reuse animations between them.

Open the Player scene, select the AnimationPlayer node and open the “float” animation. Next, click on Animation > Copy. Then open mob.tscn, create an AnimationPlayer child node and select it. Click Animation > Paste and make sure that the button with an “A+” icon (Autoplay on Load) and the looping arrows (Animation looping) are also turned on in the animation editor in the bottom panel. That’s it; all monsters will now play the float animation.

We can change the playback speed based on the creature’s random_speed. Open the Mob‘s script and at the end of the initialize() function, add the following line.

GDScriptC#

  1. func initialize(start_position, player_position):
  2.     #...
  3.     $AnimationPlayer.speed_scale = random_speed / min_speed
  1. public void Initialize(Vector3 startPosition, Vector3 playerPosition)
  2. {
  3.     // ...
  4.     GetNode<AnimationPlayer>("AnimationPlayer").SpeedScale = randomSpeed / MinSpeed;
  5. }

And with that, you finished coding your first complete 3D game.

Congratulations!

In the next part, we’ll quickly recap what you learned and give you some links to keep learning more. But for now, here are the complete Player.gd and Mob.gd so you can check your code against them.

Here’s the Player script.

GDScriptC#

  1. extends CharacterBody3D
  3. signal hit
  5. # How fast the player moves in meters per second.
  6. @export var speed = 14
  7. # The downward acceleration while in the air, in meters per second squared.
  8. @export var fall_acceleration = 75
  9. # Vertical impulse applied to the character upon jumping in meters per second.
  10. @export var jump_impulse = 20
  11. # Vertical impulse applied to the character upon bouncing over a mob
  12. # in meters per second.
  13. @export var bounce_impulse = 16
  15. var target_velocity = Vector3.ZERO
  18. func _physics_process(delta):
  19.     # We create a local variable to store the input direction
  20.     var direction = Vector3.ZERO
  22.     # We check for each move input and update the direction accordingly
  23.     if Input.is_action_pressed("move_right"):
  24.         direction.x = direction.x + 1
  25.     if Input.is_action_pressed("move_left"):
  26.         direction.x = direction.x - 1
  27.     if Input.is_action_pressed("move_back"):
  28.         # Notice how we are working with the vector's x and z axes.
  29.         # In 3D, the XZ plane is the ground plane.
  30.         direction.z = direction.z + 1
  31.     if Input.is_action_pressed("move_forward"):
  32.         direction.z = direction.z - 1
  34.     # Prevent diagonal movement being very fast
  35.     if direction != Vector3.ZERO:
  36.         direction = direction.normalized()
  37.         $Pivot.look_at(position + direction,Vector3.UP)
  38.         $AnimationPlayer.speed_scale = 4
  39.     else:
  40.         $AnimationPlayer.speed_scale = 1
  42.     # Ground Velocity
  43.     target_velocity.x = direction.x * speed
  44.     target_velocity.z = direction.z * speed
  46.     # Vertical Velocity
  47.     if not is_on_floor(): # If in the air, fall towards the floor
  48.         target_velocity.y = target_velocity.y - (fall_acceleration * delta)
  50.     # Jumping.
  51.     if is_on_floor() and Input.is_action_just_pressed("jump"):
  52.         target_velocity.y = jump_impulse
  54.     # Iterate through all collisions that occurred this frame
  55.     # in C this would be for(int i = 0; i < collisions.Count; i++)
  56.     for index in range(get_slide_collision_count()):
  57.         # We get one of the collisions with the player
  58.         var collision = get_slide_collision(index)
  60.         # If the collision is with ground
  61.         if collision.get_collider() == null:
  62.             continue
  64.         # If the collider is with a mob
  65.         if collision.get_collider().is_in_group("mob"):
  66.             var mob = collision.get_collider()
  67.             # we check that we are hitting it from above.
  68.             if Vector3.UP.dot(collision.get_normal()) > 0.1:
  69.                 # If so, we squash it and bounce.
  70.                 mob.squash()
  71.                 target_velocity.y = bounce_impulse
  72.                 # Prevent further duplicate calls.
  73.                 break
  75.     # Moving the Character
  76.     velocity = target_velocity
  77.     move_and_slide()
  79.     $Pivot.rotation.x = PI / 6 * velocity.y / jump_impulse
  81. # And this function at the bottom.
  82. func die():
  83.     hit.emit()
  84.     queue_free()
  86. func _on_mob_detector_body_entered(body):
  87.     die()
  1. using Godot;
  3. public partial class Player : CharacterBody3D
  4. {
  5.     // Emitted when the player was hit by a mob.
  6.     [Signal]
  7.     public delegate void HitEventHandler();
  9.     // How fast the player moves in meters per second.
  10.     [Export]
  11.     public int Speed { get; set; } = 14;
  12.     // The downward acceleration when in the air, in meters per second squared.
  13.     [Export]
  14.     public int FallAcceleration { get; set; } = 75;
  15.     // Vertical impulse applied to the character upon jumping in meters per second.
  16.     [Export]
  17.     public int JumpImpulse { get; set; } = 20;
  18.     // Vertical impulse applied to the character upon bouncing over a mob in meters per second.
  19.     [Export]
  20.     public int BounceImpulse { get; set; } = 16;
  22.     private Vector3 _targetVelocity = Vector3.Zero;
  24.     public override void _PhysicsProcess(double delta)
  25.     {
  26.         // We create a local variable to store the input direction.
  27.         var direction = Vector3.Zero;
  29.         // We check for each move input and update the direction accordingly.
  30.         if (Input.IsActionPressed("move_right"))
  31.         {
  32.             direction.X += 1.0f;
  33.         }
  34.         if (Input.IsActionPressed("move_left"))
  35.         {
  36.             direction.X -= 1.0f;
  37.         }
  38.         if (Input.IsActionPressed("move_back"))
  39.         {
  40.             // Notice how we are working with the vector's X and Z axes.
  41.             // In 3D, the XZ plane is the ground plane.
  42.             direction.Z += 1.0f;
  43.         }
  44.         if (Input.IsActionPressed("move_forward"))
  45.         {
  46.             direction.Z -= 1.0f;
  47.         }
  49.         // Prevent diagonal movement being very fast.
  50.         if (direction != Vector3.Zero)
  51.         {
  52.             direction = direction.Normalized();
  53.             GetNode<Node3D>("Pivot").LookAt(Position + direction, Vector3.Up);
  54.             GetNode<AnimationPlayer>("AnimationPlayer").PlaybackSpeed = 4;
  55.         }
  56.         else
  57.         {
  58.             GetNode<AnimationPlayer>("AnimationPlayer").PlaybackSpeed = 1;
  59.         }
  61.         // Ground velocity
  62.         _targetVelocity.X = direction.X * Speed;
  63.         _targetVelocity.Z = direction.Z * Speed;
  65.         // Vertical velocity
  66.         if (!IsOnFloor())
  67.         {
  68.             _targetVelocity.Y -= FallAcceleration * (float)delta;
  69.         }
  71.         // Jumping.
  72.         if (IsOnFloor() && Input.IsActionJustPressed("jump"))
  73.         {
  74.             _targetVelocity.Y += JumpImpulse;
  75.         }
  77.         // Iterate through all collisions that occurred this frame.
  78.         for (int index = 0; index < GetSlideCollisionCount(); index++)
  79.         {
  80.             // We get one of the collisions with the player.
  81.             KinematicCollision3D collision = GetSlideCollision(index);
  83.             // If the collision is with a mob.
  84.             if (collision.GetCollider() is Mob mob)
  85.             {
  86.                 // We check that we are hitting it from above.
  87.                 if (Vector3.Up.Dot(collision.GetNormal()) > 0.1f)
  88.                 {
  89.                     // If so, we squash it and bounce.
  90.                     mob.Squash();
  91.                     _targetVelocity.Y = BounceImpulse;
  92.                     // Prevent further duplicate calls.
  93.                     break;
  94.                 }
  95.             }
  96.         }
  98.         // Moving the character
  99.         Velocity = _targetVelocity;
  100.         MoveAndSlide();
  102.         var pivot = GetNode<Node3D>("Pivot");
  103.         pivot.Rotation = new Vector3(Mathf.Pi / 6.0f * Velocity.Y / JumpImpulse, pivot.Rotation.Y, pivot.Rotation.Z);
  104.     }
  106.     private void Die()
  107.     {
  108.         EmitSignal(SignalName.Hit);
  109.         QueueFree();
  110.     }
  112.     private void OnMobDetectorBodyEntered(Node body)
  113.     {
  114.         Die();
  115.     }
  116. }

And the Mob‘s script.

GDScriptC#

  1. extends CharacterBody3D
  3. # Minimum speed of the mob in meters per second.
  4. @export var min_speed = 10
  5. # Maximum speed of the mob in meters per second.
  6. @export var max_speed = 18
  8. # Emitted when the player jumped on the mob
  9. signal squashed
  11. func _physics_process(_delta):
  12.     move_and_slide()
  14. # This function will be called from the Main scene.
  15. func initialize(start_position, player_position):
  16.     # We position the mob by placing it at start_position
  17.     # and rotate it towards player_position, so it looks at the player.
  18.     look_at_from_position(start_position, player_position, Vector3.UP)
  19.     # Rotate this mob randomly within range of -90 and +90 degrees,
  20.     # so that it doesn't move directly towards the player.
  21.     rotate_y(randf_range(-PI / 4, PI / 4))
  23.     # We calculate a random speed (integer)
  24.     var random_speed = randi_range(min_speed, max_speed)
  25.     # We calculate a forward velocity that represents the speed.
  26.     velocity = Vector3.FORWARD * random_speed
  27.     # We then rotate the velocity vector based on the mob's Y rotation
  28.     # in order to move in the direction the mob is looking.
  29.     velocity = velocity.rotated(Vector3.UP, rotation.y)
  31.     $AnimationPlayer.speed_scale = random_speed / min_speed
  33. func _on_visible_on_screen_notifier_3d_screen_exited():
  34.     queue_free()
  36. func squash():
  37.     squashed.emit()
  38.     queue_free() # Destroy this node
  1. using Godot;
  3. public partial class Mob : CharacterBody3D
  4. {
  5.     // Emitted when the played jumped on the mob.
  6.     [Signal]
  7.     public delegate void SquashedEventHandler();
  9.     // Minimum speed of the mob in meters per second
  10.     [Export]
  11.     public int MinSpeed { get; set; } = 10;
  12.     // Maximum speed of the mob in meters per second
  13.     [Export]
  14.     public int MaxSpeed { get; set; } = 18;
  16.     public override void _PhysicsProcess(double delta)
  17.     {
  18.         MoveAndSlide();
  19.     }
  21.     // This function will be called from the Main scene.
  22.     public void Initialize(Vector3 startPosition, Vector3 playerPosition)
  23.     {
  24.         // We position the mob by placing it at startPosition
  25.         // and rotate it towards playerPosition, so it looks at the player.
  26.         LookAtFromPosition(startPosition, playerPosition, Vector3.Up);
  27.         // Rotate this mob randomly within range of -90 and +90 degrees,
  28.         // so that it doesn't move directly towards the player.
  29.         RotateY((float)GD.RandRange(-Mathf.Pi / 4.0, Mathf.Pi / 4.0));
  31.         // We calculate a random speed (integer).
  32.         int randomSpeed = GD.RandRange(MinSpeed, MaxSpeed);
  33.         // We calculate a forward velocity that represents the speed.
  34.         Velocity = Vector3.Forward * randomSpeed;
  35.         // We then rotate the velocity vector based on the mob's Y rotation
  36.         // in order to move in the direction the mob is looking.
  37.         Velocity = Velocity.Rotated(Vector3.Up, Rotation.Y);
  39.         GetNode<AnimationPlayer>("AnimationPlayer").SpeedScale = randomSpeed / MinSpeed;
  40.     }
  42.     public void Squash()
  43.     {
  44.         EmitSignal(SignalName.Squashed);
  45.         QueueFree(); // Destroy this node
  46.     }
  48.     private void OnVisibilityNotifierScreenExited()
  49.     {
  50.         QueueFree();
  51.     }
  52. }

Previous Next

© Copyright 2014-present Juan Linietsky, Ariel Manzur and the Godot community (CC BY 3.0). Revision 53e837c6.

Built with Sphinx using a theme provided by Read the Docs.