Killing the player

    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 Area node, which works well for hitboxes.

    Head back to the Player scene and add a new Area node. Name it MobDetector. Add a CollisionShape node as a child of it.

    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.

    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.

    When areas detect a collision, they emit signals. We’re going to connect one to the Player node. In the Node tab, double-click the signal and connect it to the Player.

    image4

    The MobDetector will emit body_entered when a KinematicBody or a RigidBody 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.

    GDScript   C#

    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 Hit();
    7. // ...
    9. private void Die()
    10. {
    11.     EmitSignal(nameof(Hit));
    12.     QueueFree();
    13. }
    15. // We also specified this function name in PascalCase in the editor's connection window
    16. public void OnMobDetectorBodyEntered(Node 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 it.

    However, note that this depends entirely 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.

    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.

    GDScript   C#

    1. func _on_Player_hit():
    2.     $MobTimer.stop()

    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.

    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.

    GDScript   C#

    1. extends Node
    3. export(PackedScene) var mob_scene
    6. func _ready():
    7.     randomize()
    10. func _on_MobTimer_timeout():
    11.     # Create a new instance of the Mob scene.
    12.     var mob = mob_scene.instance()
    14.     # Choose a random location on the SpawnPath.
    15.     var mob_spawn_location = get_node("SpawnPath/SpawnLocation")
    16.     # And give it a random offset.
    17.     mob_spawn_location.unit_offset = randf()
    19.     # Communicate the spawn location and the player's location to the mob.
    20.     var player_position = $Player.transform.origin
    21.     mob.initialize(mob_spawn_location.translation, player_position)
    23.     # Spawn the mob by adding it to the Main scene.
    24.     add_child(mob)
    27. func _on_Player_hit():
    28.     $MobTimer.stop()
    1. public class Main : Node
    2. {
    3. #pragma warning disable 649
    4.     [Export]
    5.     public PackedScene MobScene;
    6. #pragma warning restore 649
    8.     public override void _Ready()
    10.         GD.Randomize();
    12.     public void OnMobTimerTimeout()
    13.     {
    14.         // Create a new instance of the Mob scene.
    15.         var mob = (Mob)MobScene.Instance();
    17.         // Choose a random location on the SpawnPath.
    18.         // We store the reference to the SpawnLocation node.
    19.         var mobSpawnLocation = GetNode<PathFollow>("SpawnPath/SpawnLocation");
    20.         // And give it a random offset.
    21.         mobSpawnLocation.UnitOffset = GD.Randf();
    23.         // Communicate the spawn location and the player's location to the mob.
    24.         Vector3 playerPosition = GetNode<Player>("Player").Transform.origin;
    25.         mob.Initialize(mobSpawnLocation.Translation, playerPosition);
    27.         // Spawn the mob by adding it to the Main scene.
    28.         AddChild(mob);
    29.     }
    31.     public void OnPlayerHit()
    32.     {
    33.         GetNode<Timer>("MobTimer").Stop();
    34.     }
    35. }

    Next is Mob.gd.

    GDScript   C#

    1. public class Mob : KinematicBody
    2. {
    3.     // Emitted when the played jumped on the mob.
    4.     [Signal]
    5.     public delegate void Squashed();
    7.     // Minimum speed of the mob in meters per second
    8.     [Export]
    9.     public int MinSpeed = 10;
    10.     // Maximum speed of the mob in meters per second
    11.     [Export]
    12.     public int MaxSpeed = 18;
    14.     private Vector3 _velocity = Vector3.Zero;
    16.     public override void _PhysicsProcess(float delta)
    17.     {
    18.         MoveAndSlide(_velocity);
    19.     }
    21.     public void Initialize(Vector3 startPosition, Vector3 playerPosition)
    22.     {
    23.         LookAtFromPosition(startPosition, playerPosition, Vector3.Up);
    24.         RotateY((float)GD.RandRange(-Mathf.Pi / 4.0, Mathf.Pi / 4.0));
    26.         float randomSpeed = (float)GD.RandRange(MinSpeed, MaxSpeed);
    27.         _velocity = Vector3.Forward * randomSpeed;
    28.         _velocity = _velocity.Rotated(Vector3.Up, Rotation.y);
    29.     }
    31.     public void Squash()
    32.     {
    33.         EmitSignal(nameof(Squashed));
    34.         QueueFree();
    35.     }
    38.         QueueFree();
    39.     }
    40. }

    Finally, the longest script, Player.gd.

    1. extends KinematicBody
    3. # Emitted when a mob hit the player.
    4. signal hit
    6. # How fast the player moves in meters per second.
    7. export var speed = 14
    8. # The downward acceleration when in the air, in meters per second squared.
    9. export var fall_acceleration = 75
    10. # Vertical impulse applied to the character upon jumping in meters per second.
    11. export var jump_impulse = 20
    12. # Vertical impulse applied to the character upon bouncing over a mob in meters per second.
    13. export var bounce_impulse = 16
    15. var velocity = Vector3.ZERO
    18. func _physics_process(delta):
    19.     var direction = Vector3.ZERO
    21.     if Input.is_action_pressed("move_right"):
    22.         direction.x += 1
    23.     if Input.is_action_pressed("move_left"):
    24.         direction.x -= 1
    25.     if Input.is_action_pressed("move_back"):
    26.         direction.z += 1
    27.     if Input.is_action_pressed("move_forward"):
    28.         direction.z -= 1
    30.     if direction != Vector3.ZERO:
    31.         direction = direction.normalized()
    32.         $Pivot.look_at(translation + direction, Vector3.UP)
    34.     velocity.x = direction.x * speed
    35.     velocity.z = direction.z * speed
    37.     # Jumping.
    38.     if is_on_floor() and Input.is_action_just_pressed("jump"):
    39.         velocity.y += jump_impulse
    41.     velocity.y -= fall_acceleration * delta
    42.     velocity = move_and_slide(velocity, Vector3.UP)
    44.     for index in range(get_slide_count()):
    45.         var collision = get_slide_collision(index)
    46.         if collision.collider.is_in_group("mob"):
    47.             var mob = collision.collider
    48.             if Vector3.UP.dot(collision.normal) > 0.1:
    49.                 mob.squash()
    50.                 velocity.y = bounce_impulse
    53. func die():
    54.     emit_signal("hit")
    55.     queue_free()
    58. func _on_MobDetector_body_entered(_body):
    59.     die()

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