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.

Killing the player

We can kill enemies by jumping on them, but the player still can’t die. Let’s fix this.

We want to detect being hit by an enemy differently from squashing them. We want the player to die when they’re moving on the floor, but not if they’re in the air. We could use vector math to distinguish the two kinds of collisions. Instead, though, we will use an Area3D node, which works well for hitboxes.

Hitbox with the Area node

Head back to the player.tscn scene and add a new child node Area3D. Name it MobDetector Add a CollisionShape3D node as a child of it.

image0

In the Inspector, assign a cylinder shape to it.

image1

Here is a trick you can use to make the collisions only happen when the player is on the ground or close to it. You can reduce the cylinder’s height and move it up to the top of the character. This way, when the player jumps, the shape will be too high up for the enemies to collide with it.

image2

You also want the cylinder to be wider than the sphere. This way, the player gets hit before colliding and being pushed on top of the monster’s collision box.

The wider the cylinder, the more easily the player will get killed.

Next, select the MobDetector node again, and in the Inspector, turn off its Monitorable property. This makes it so other physics nodes cannot detect the area. The complementary Monitoring property allows it to detect collisions. Then, remove the Collision -> Layer and set the mask to the “enemies” layer.

image3

When areas detect a collision, they emit signals. We’re going to connect one to the Player node. Select MobDetector and go to Inspector‘s Node tab, double-click the body_entered signal and connect it to the Player

image4

The MobDetector will emit body_entered when a CharacterBody3D or a RigidBody3D node enters it. As it only masks the “enemies” physics layers, it will only detect the Mob nodes.

Code-wise, we’re going to do two things: emit a signal we’ll later use to end the game and destroy the player. We can wrap these operations in a die() function that helps us put a descriptive label on the code.

GDScriptC#

  1. # Emitted when the player was hit by a mob.
  2. # Put this at the top of the script.
  3. signal hit
  6. # And this function at the bottom.
  7. func die():
  8.     hit.emit()
  9.     queue_free()
  12. func _on_mob_detector_body_entered(body):
  13.     die()
  1. // Don't forget to rebuild the project so the editor knows about the new signal.
  3. // Emitted when the player was hit by a mob.
  4. [Signal]
  5. public delegate void HitEventHandler();
  7. // ...
  9. private void Die()
  10. {
  11.     EmitSignal(SignalName.Hit);
  12.     QueueFree();
  13. }
  15. // We also specified this function name in PascalCase in the editor's connection window
  16. private void OnMobDetectorBodyEntered(Node3D body)
  17. {
  18.     Die();
  19. }

Try the game again by pressing F5. If everything is set up correctly, the character should die when an enemy runs into the collider. Note that without a Player, the following line

GDScriptC#

  1. var player_position = $Player.position
  1. Vector3 playerPosition = GetNode<Player>("Player").Position;

gives error because there is no $Player!

Also note that the enemy colliding with the player and dying depends on the size and position of the Player and the Mob‘s collision shapes. You may need to move them and resize them to achieve a tight game feel.

Ending the game

We can use the Player‘s hit signal to end the game. All we need to do is connect it to the Main node and stop the MobTimer in reaction.

Open main.tscn, select the Player node, and in the Node dock, connect its hit signal to the Main node.

image5

Get the timer, and stop it, in the _on_player_hit() function.

GDScriptC#

  1. func _on_player_hit():
  2.     $MobTimer.stop()
  1. // We also specified this function name in PascalCase in the editor's connection window
  2. private void OnPlayerHit()
  3. {
  4.     GetNode<Timer>("MobTimer").Stop();
  5. }

If you try the game now, the monsters will stop spawning when you die, and the remaining ones will leave the screen.

You can pat yourself in the back: you prototyped a complete 3D game, even if it’s still a bit rough.

From there, we’ll add a score, the option to retry the game, and you’ll see how you can make the game feel much more alive with minimalistic animations.

Code checkpoint

Here are the complete scripts for the Main, Mob, and Player nodes, for reference. You can use them to compare and check your code.

Starting with main.gd.

GDScriptC#

  1. extends Node
  3. @export var mob_scene: PackedScene
  6. func _on_mob_timer_timeout():
  7.     # Create a new instance of the Mob scene.
  8.     var mob = mob_scene.instantiate()
  10.     # Choose a random location on the SpawnPath.
  11.     # We store the reference to the SpawnLocation node.
  12.     var mob_spawn_location = get_node("SpawnPath/SpawnLocation")
  13.     # And give it a random offset.
  14.     mob_spawn_location.progress_ratio = randf()
  16.     var player_position = $Player.position
  17.     mob.initialize(mob_spawn_location.position, player_position)
  19.     # Spawn the mob by adding it to the Main scene.
  20.     add_child(mob)
  22. func _on_player_hit():
  23.     $MobTimer.stop()
  1. using Godot;
  3. public partial class Main : Node
  4. {
  5.     [Export]
  6.     public PackedScene MobScene { get; set; }
  8.     private void OnMobTimerTimeout()
  9.     {
  10.         // Create a new instance of the Mob scene.
  11.         Mob mob = MobScene.Instantiate<Mob>();
  13.         // Choose a random location on the SpawnPath.
  14.         // We store the reference to the SpawnLocation node.
  15.         var mobSpawnLocation = GetNode<PathFollow3D>("SpawnPath/SpawnLocation");
  16.         // And give it a random offset.
  17.         mobSpawnLocation.ProgressRatio = GD.Randf();
  19.         Vector3 playerPosition = GetNode<Player>("Player").Position;
  20.         mob.Initialize(mobSpawnLocation.Position, playerPosition);
  22.         // Spawn the mob by adding it to the Main scene.
  23.         AddChild(mob);
  24.     }
  26.     private void OnPlayerHit()
  27.     {
  28.         GetNode<Timer>("MobTimer").Stop();
  29.     }
  30. }

Next is Mob.gd.

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. func _on_visible_on_screen_notifier_3d_screen_exited():
  32.     queue_free()
  34. func squash():
  35.     squashed.emit()
  36.     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);
  38.     }
  40.     public void Squash()
  41.     {
  42.         EmitSignal(SignalName.Squashed);
  43.         QueueFree(); // Destroy this node
  44.     }
  46.     private void OnVisibilityNotifierScreenExited()
  47.     {
  48.         QueueFree();
  49.     }
  50. }

Finally, the longest script, Player.gd:

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 moving fast af
  35.     if direction != Vector3.ZERO:
  36.         direction = direction.normalized()
  37.         $Pivot.look_at(position + direction, Vector3.UP)
  39.     # Ground Velocity
  40.     target_velocity.x = direction.x * speed
  41.     target_velocity.z = direction.z * speed
  43.     # Vertical Velocity
  44.     if not is_on_floor(): # If in the air, fall towards the floor. Literally gravity
  45.         target_velocity.y = target_velocity.y - (fall_acceleration * delta)
  47.     # Jumping.
  48.     if is_on_floor() and Input.is_action_just_pressed("jump"):
  49.         target_velocity.y = jump_impulse
  51.     # Iterate through all collisions that occurred this frame
  52.     # in C this would be for(int i = 0; i < collisions.Count; i++)
  53.     for index in range(get_slide_collision_count()):
  54.         # We get one of the collisions with the player
  55.         var collision = get_slide_collision(index)
  57.         # If the collision is with ground
  58.         if collision.get_collider() == null:
  59.             continue
  61.         # If the collider is with a mob
  62.         if collision.get_collider().is_in_group("mob"):
  63.             var mob = collision.get_collider()
  64.             # we check that we are hitting it from above.
  65.             if Vector3.UP.dot(collision.get_normal()) > 0.1:
  66.                 # If so, we squash it and bounce.
  67.                 mob.squash()
  68.                 target_velocity.y = bounce_impulse
  69.                 # Prevent further duplicate calls.
  70.                 break
  72.     # Moving the Character
  73.     velocity = target_velocity
  74.     move_and_slide()
  76. # And this function at the bottom.
  77. func die():
  78.     hit.emit()
  79.     queue_free()
  81. func _on_mob_detector_body_entered(body):
  82.     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 moving fast af
  50.         if (direction != Vector3.Zero)
  51.         {
  52.             direction = direction.Normalized();
  53.             GetNode<Node3D>("Pivot").LookAt(Position + direction, Vector3.Up);
  54.         }
  56.         // Ground Velocity
  57.         _targetVelocity.X = direction.X * Speed;
  58.         _targetVelocity.Z = direction.Z * Speed;
  60.         // Vertical Velocity
  61.         if (!IsOnFloor()) // If in the air, fall towards the floor. Literally gravity
  62.         {
  63.             _targetVelocity.Y -= FallAcceleration * (float)delta;
  64.         }
  66.         // Jumping.
  67.         if (IsOnFloor() && Input.IsActionJustPressed("jump"))
  68.         {
  69.             _targetVelocity.Y = JumpImpulse;
  70.         }
  72.         // Iterate through all collisions that occurred this frame.
  73.         for (int index = 0; index < GetSlideCollisionCount(); index++)
  74.         {
  75.             // We get one of the collisions with the player.
  76.             KinematicCollision3D collision = GetSlideCollision(index);
  78.             // If the collision is with a mob.
  79.             if (collision.GetCollider() is Mob mob)
  80.             {
  81.                 // We check that we are hitting it from above.
  82.                 if (Vector3.Up.Dot(collision.GetNormal()) > 0.1f)
  83.                 {
  84.                     // If so, we squash it and bounce.
  85.                     mob.Squash();
  86.                     _targetVelocity.Y = BounceImpulse;
  87.                     // Prevent further duplicate calls.
  88.                     break;
  89.                 }
  90.             }
  91.         }
  93.         // Moving the Character
  94.         Velocity = _targetVelocity;
  95.         MoveAndSlide();
  96.     }
  98.     private void Die()
  99.     {
  100.         EmitSignal(SignalName.Hit);
  101.         QueueFree();
  102.     }
  104.     private void OnMobDetectorBodyEntered(Node3D body)
  105.     {
  106.         Die();
  107.     }
  108. }

See you in the next lesson to add the score and the retry option.

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.