3. Weapon Setup met Signals

Maak een weapon scene en leer signals gebruiken voor communicatie

Overzicht

In dit hoofdstuk maak je een Railgun weapon met zijn eigen script. Je leert hoe je weapon logic scheidt van player logic en signals gebruikt voor communicatie tussen nodes.

Input actions

Voor dit hoofdstuk heb je een extra Input Action nodig: shoot, dat zal worden gebruikt om het weapon af te vuren.

1. Project > Project Settings

2. Tab Input Map

3. In het veld "Add New Action", type: shoot

4. Click Add

5. Click het + icon naast "shoot"

6. Mouse Button > Left Button

7. Click OK

8. Close Project Settings

Railgun scene maken

Om te beginnen heb je een weapon scene nodig. Daarvoor gebruiken we het blaster model uit de assets.

1. Ga in de menu naar Scene > New Scene

2. Selecteer Node3D als root node

3. Klik Create

4. Hernoem de root node naar Railgun

5. Sleep het models/blaster.glb model vanuit het FileSystem panel naar de Railgun node in de Scene hierarchy

6. Het model wordt als child toegevoegd

7. Sla de scene op als res://objects/Railgun.tscn

Railgun script

Om te kunnen schieten, heb je 2 dingen nodig:

• de player die een signaal uitstuurt dat ze willen schieten

• het weapon dat reageert op dat signaal, door een functie uit te voeren

Dat wilt dus zeggen dat je Railgun een script nodig heeft, met een functie die kan schieten.

1. Selecteer de Railgun root node

2. Klik op Attach Script (het 📜 icoontje met een +, bovenaan het Scene Hierarchy venster)

   • Language: C#

   • Class Name: Railgun

   • Path: res://scripts/Railgun.cs

3. Klik Create

Railgun onshoot method

1. Open het Railgun script

2. Voeg een nieuwe functie OnShoot toe aan het script. De Railgun class erft van Node3D omdat het een 3D object in de scene is. We gebruiken GD.Print om een boodschap te tonen in de console.

using Godot;

public partial class Railgun : Node3D
{
    public void OnShoot()
    {
        GD.Print("Railgun fired!");
    }
}

Player shoot signal

1. Open het PlayerController script

2. Voeg een nieuw Signal toe aan het script met het [Signal] attribute. De naam van een Godot Signal moet eindigen met EventHandler en gebruikt een C# delegate.

using Godot;
using System;

public partial class PlayerController : CharacterBody3D
{
    [Signal]
    public delegate void ShootEventHandler();

    // ... rest van de code
}

1. Voer het signaal uit in de _Process method wanneer de speler klikt met de muis. Gebruik Input.IsActionJustPressed om te checken of de shoot actie net werd ingedrukt, en EmitSignal om het signaal uit te sturen. Merk daarbij op dat de naam van het signaal gewoon Shoot is, dus zonder het EventHandler deel.

public partial class PlayerController : CharacterBody3D
{
    [Signal]
    public delegate void ShootEventHandler();

    // ... rest van de code

    public override void _Process(double delta)
    {
        if (Input.IsActionJustPressed("shoot"))
        {
            EmitSignal(SignalName.Shoot);
        }
    }
}

Shoot signal verbinden met onshoot method

Je hebt een Player die een Shoot signal uitstuurt wanneer de speler klikt, en een Railgun met een OnShoot() method. Verbind deze twee met elkaar!

In Godot doe je dit via het Node panel in de editor. Hier ga je de twee "elektrisch bedraden" - de Player zendt een signaal uit, en de Railgun luistert ernaar. Wanneer het signaal wordt uitgezonden, wordt automatisch de OnShoot() method aangeroepen.

1. Open de main scene

2. Voeg de Railgun scene toe aan de root van de main scene (sleep Railgun.tscn naar de scene hierarchy)

3. Selecteer de Player node in de hierarchy

4. Aan de rechterkant van de Editor, naast de Inspector tab, vind je het Node venster (klik erop als het niet zichtbaar is) Met de Player geselecteerd, zie je in het Node venster alle signals die de Player kan uitzenden

5. Dubbelklik op het Shoot signal

6. In het venster "Connect a Signal to a Method" selecteer je de Railgun node (dit is de ontvanger)

7. Bij Receiver Method klik op Pick

8. Selecteer de OnShoot method uit de lijst

9. Klik op Connect. In de Scene Hierarchy zie je nu een signaal-icoontje 󰘊 naast de Player node. Dit geeft aan dat deze node een signal heeft geconnect. Als je erop klikt, zie je naar welke method het signaal verbonden is.

10. Test het spel met F6. Wanneer je klikt met de muis, verschijnt in de Output tab onderaan de boodschap "Railgun fired!"

Fire rate limiting

Momenteel kan de speler oneindig snel schieten door snel te klikken. Dit maakt het wapen overpowered en het voelt niet geloofwaardig aan. Implementeer een fire rate - een cooldown tijd tussen shots. Gebruik hiervoor een Timer node om de cooldown bij te houden.

1. Open de Railgun.tscn scene

2. Selecteer de Railgun root node

3. Voeg een Timer child node toe (rechtermuisknop > Add Child Node > Timer)

4. Hernoem de Timer naar FireRateTimer

5. Selecteer FireRateTimer in de hierarchy

6. In de Inspector, configureer:

   • Wait Time: 0.5 (cooldown van 0.5 seconden = 2 shots/sec)

   • One Shot: Aan (timer stopt na elke timeout, we starten hem handmatig)

   • Autostart: Uit (we starten de timer alleen wanneer we schieten)

7. Sla de scene op

Scene hierarchy:

Railgun (Node3D)
├── blaster (imported model)
└── FireRateTimer (Timer)

Muzzle marker

Voordat we verder gaan, voeg een Muzzle Marker3D toe aan het wapen. Dit markeert de positie waar de projectielen vandaan komen - de tip van het wapen. Later gebruiken we dit voor visuele effecten zoals muzzle flashes en beam lines.

1. Open de Railgun.tscn scene

2. Selecteer de Railgun root node

3. Voeg een Marker3D child node toe (rechtermuisknop > Add Child Node > Marker3D)

4. Hernoem de Marker3D naar Muzzle

5. Selecteer Muzzle in de hierarchy

6. Gebruik de Move tool om de Muzzle vooraan de loop van het wapen te plaatsen

7. Sla de scene op

1. Open het Railgun script

2. Voeg een nieuwe [Export] variabele toe om de muzzle bij te houden

3. Sleep vervolgens in Godot de muzzle node naar de Muzzle in de inspector

using Godot;

public partial class Railgun : Node3D
{
    [Export] Marker3D _muzzle;
    
    public void OnShoot()
    {
        GD.Print("Railgun fired!");
    }
}

Scene hierarchy:

Railgun (Node3D)
├── blaster (imported model)
├── FireRateTimer (Timer)
└── Muzzle (Marker3D)

Timer gebruiken in script

Nu passen we het Railgun script aan om de Timer te gebruiken.

1. Open het Railgun script

2. Voeg een variabele toe voor de timer referentie:

using Godot;

public partial class Railgun : Node3D
{
    [Export] Marker3D _muzzle;
    [Export] private Timer _fireRateTimer;

    public void OnShoot()
    {
        GD.Print("Railgun fired!");
    }
}

1. Nu checken we in OnShoot() of de timer nog loopt. Als de timer loopt (dus IsStopped() geeft false), betekent dit dat we nog in cooldown zitten. We gebruiken return om de functie vroeg te stoppen.

using Godot;

public partial class Railgun : Node3D
{
    [Export] Marker3D _muzzle;
    [Export] private Timer _fireRateTimer;

    public void OnShoot()
    {
        // Stop met de functie als de timer nog loopt
        if (_fireRateTimer.IsStopped() == false)
            return;

        // Start de cooldown timer
        _fireRateTimer.Start();

        GD.Print("Railgun fired!");
    }
}

1. Selecteer de Railgun node in de Godot Editor, en sleep de FireRateTimer node naar de fireRateTimer in de inspector

Weapon mount point

Maak een mount point in de Player scene waar je weapons aan kunt hangen. Dit is een lege Node3D die als referentiepunt dient - het weapon zal deze positie en rotatie volgen.

1. Open objects/Player.tscn

2. Selecteer de Camera3D node

3. Voeg een child node toe: rechtsklik Camera3D > Add Child Node

4. Zoek naar Node3D en klik Create

5. Hernoem de node naar WeaponMount

6. Pas de Transform > Position van WeaponMount aan in de Inspector:

   • X: 0.8 (rechts van het midden, voor rechtshandige weapon grip)

   • Y: -1 (iets naar beneden)

   • Z: -1.2 (voor de camera uit)

7. OPGELET! Bekijk de weaponMount in local transform en draai de Z-as, zodat die naar voor wijst!

8. Sla de scene op (Ctrl+S)

Scene hierarchy:

Player (CharacterBody3D)
├── Camera3D
│   └── WeaponMount (Node3D)  ← Hier komt het weapon
└── CollisionShape3D

Weapon transform

Nu hebben we een WeaponMount punt, maar het weapon beweegt nog niet mee! De Railgun staat nog los ergens in de scene. Laat de Railgun elke frame de positie en rotatie van het WeaponMount volgen.

Dit doe je door de GlobalTransform van de Railgun gelijk te stellen aan de GlobalTransform van de WeaponMount. Een Transform bevat zowel positie, rotatie als scale - door deze te kopiëren volgt het weapon perfect de mount point.

1. Open het Railgun script

2. Voeg een nieuwe variabele toe voor de weapon mount referentie:

public partial class Railgun : Node3D
{
    [Export] private Timer _fireRateTimer;

    [Export] private Node3D _weaponMount;  // Referentie naar de mount point

    // ... rest van de code
}

1. Nu gaan we in de method _Process() elke frame de transform van het weapon updaten zodat het de WeaponMount volgt.

public partial class Railgun : Node3D
{
    [Export] private Timer _fireRateTimer;

    [Export] private Node3D _weaponMount;

    public override void _Process(double delta)
    {
        // Volg de weapon mount position en rotation
        GlobalTransform = _weaponMount.GlobalTransform;
    }

    public void OnShoot()
    {
        // Check of we nog in cooldown zitten
        if (!_fireRateTimer.IsStopped())
            return;

        // Start de cooldown timer
        _fireRateTimer.Start();

        GD.Print("Railgun fired!");
    }
}

WeaponMount Toewijzen in de Scene

Nu moet je de verbinding maken tussen de Railgun en de WeaponMount.

Het probleem is dat de children van een child-scene (zoals de weaponmount een child is in de player scene) standaard niet zichtbaar zijn. Gelukkig kan je dit gemakkelijk oplossen.

1. Open de main scene (waar je Player en Railgun in hebt staan)

2. Rechts-klik op de Player node

3. Vink Editable Children aan

4. Selecteer de Railgun node

5. In de Inspector zie je nu een nieuwe property: Weapon Mount

6. Klik op Assign en navigeer naar: Player > Camera3D > WeaponMount

7. Selecteer WeaponMount en klik OK

8. Sla de scene op

9. Test met F6 - het weapon volgt nu je camera beweging!

Test het weapon system

1. Run de scene met F6

2. Beweeg met WASD en kijk rond met de muis

3. Het weapon volgt nu perfect je camera

4. Klik met de linker muisknop om te schieten

5. Probeer snel te klikken - door de fire rate zal dit niet lukken

Beam visualisation

Voeg nu een visueel effect toe aan de railgun. Wanneer je schiet, verschijnt er kort een beam die aangeeft waar je heen schiet.

1. Open scripts/Railgun.cs

2. Voeg een lege ShowBeam() method toe onderaan de klasse:

public partial class Railgun : Node3D
{
    // ... rest van de code

    private void ShowBeam(Vector3 start, Vector3 end)
    {
    }
}

1. Maak een dunne cilinder mesh die we als beam gebruiken:

    private void ShowBeam(Vector3 start, Vector3 end)
    {
        // Maak een cilinder mesh voor de beam
        var beamMesh = new CylinderMesh();
        beamMesh.TopRadius = 0.02f;
        beamMesh.BottomRadius = 0.02f;
        beamMesh.Height = 1.0f;
    }

1. Voeg een material toe om de beam cyan te kleuren:

    private void ShowBeam(Vector3 start, Vector3 end)
    {
        // Maak een cilinder mesh voor de beam
        var beamMesh = new CylinderMesh();
        beamMesh.TopRadius = 0.02f;
        beamMesh.BottomRadius = 0.02f;
        beamMesh.Height = 1.0f;

        // Maak een unshaded material in cyan kleur
        var material = new StandardMaterial3D();
        material.ShadingMode = BaseMaterial3D.ShadingModeEnum.Unshaded;
        material.AlbedoColor = Colors.Cyan;
    }

1. Maak een MeshInstance3D en voeg deze toe aan de scene:

    private void ShowBeam(Vector3 start, Vector3 end)
    {
        // Maak een cilinder mesh voor de beam
        var beamMesh = new CylinderMesh();
        beamMesh.TopRadius = 0.02f;
        beamMesh.BottomRadius = 0.02f;
        beamMesh.Height = 1.0f;

        // Maak een unshaded material in cyan kleur
        var material = new StandardMaterial3D();
        material.ShadingMode = BaseMaterial3D.ShadingModeEnum.Unshaded;
        material.AlbedoColor = Colors.Cyan;

        // Maak een MeshInstance3D met de mesh en material
        var beamInstance = new MeshInstance3D
        {
            Mesh = beamMesh,
            MaterialOverride = material,
            CastShadow = GeometryInstance3D.ShadowCastingSetting.Off
        };

        // Voeg toe aan de scene root
        GetTree().Root.AddChild(beamInstance);
    }

1. Bereken de richting en afstand tussen start en einde:

    private void ShowBeam(Vector3 start, Vector3 end)
    {
        // Maak een cilinder mesh voor de beam
        var beamMesh = new CylinderMesh();
        beamMesh.TopRadius = 0.02f;
        beamMesh.BottomRadius = 0.02f;
        beamMesh.Height = 1.0f;

        // Maak een unshaded material in cyan kleur
        var material = new StandardMaterial3D();
        material.ShadingMode = BaseMaterial3D.ShadingModeEnum.Unshaded;
        material.AlbedoColor = Colors.Cyan;

        // Maak een MeshInstance3D met de mesh en material
        var beamInstance = new MeshInstance3D
        {
            Mesh = beamMesh,
            MaterialOverride = material,
            CastShadow = GeometryInstance3D.ShadowCastingSetting.Off
        };

        // Voeg toe aan de scene root
        GetTree().Root.AddChild(beamInstance);

        // Bereken richting en afstand
        Vector3 direction = end - start;
        float distance = direction.Length();
    }

1. Positioneer, roteer en schaal de beam correct:

    private void ShowBeam(Vector3 start, Vector3 end)
    {
        // Maak een cilinder mesh voor de beam
        var beamMesh = new CylinderMesh();
        beamMesh.TopRadius = 0.02f;
        beamMesh.BottomRadius = 0.02f;
        beamMesh.Height = 1.0f;

        // Maak een unshaded material in cyan kleur
        var material = new StandardMaterial3D();
        material.ShadingMode = BaseMaterial3D.ShadingModeEnum.Unshaded;
        material.AlbedoColor = Colors.Cyan;

        // Maak een MeshInstance3D met de mesh en material
        var beamInstance = new MeshInstance3D
        {
            Mesh = beamMesh,
            MaterialOverride = material,
            CastShadow = GeometryInstance3D.ShadowCastingSetting.Off
        };

        // Voeg toe aan de scene root
        GetTree().Root.AddChild(beamInstance);

        // Bereken richting en afstand
        Vector3 direction = end - start;
        float distance = direction.Length();

        // Positioneer in het midden tussen start en einde
        beamInstance.GlobalPosition = start + direction / 2;
        // Roteer zodat de beam naar het eindpunt wijst
        beamInstance.LookAt(end, Vector3.Up);
        // Draai 90 graden zodat de cilinder horizontaal ligt
        beamInstance.RotateObjectLocal(Vector3.Right, Mathf.Pi / 2);
        // Schaal de beam op basis van de afstand
        beamInstance.Scale = new Vector3(1, distance, 1);
    }

1. Verwijder de beam automatisch na 0.05 seconden:

    private void ShowBeam(Vector3 start, Vector3 end)
    {
        // Maak een cilinder mesh voor de beam
        var beamMesh = new CylinderMesh();
        beamMesh.TopRadius = 0.02f;
        beamMesh.BottomRadius = 0.02f;
        beamMesh.Height = 1.0f;

        // Maak een unshaded material in cyan kleur
        var material = new StandardMaterial3D();
        material.ShadingMode = BaseMaterial3D.ShadingModeEnum.Unshaded;
        material.AlbedoColor = Colors.Cyan;

        // Maak een MeshInstance3D met de mesh en material
        var beamInstance = new MeshInstance3D
        {
            Mesh = beamMesh,
            MaterialOverride = material,
            CastShadow = GeometryInstance3D.ShadowCastingSetting.Off
        };

        // Voeg toe aan de scene root
        GetTree().Root.AddChild(beamInstance);

        // Bereken richting en afstand
        Vector3 direction = end - start;
        float distance = direction.Length();

        // Positioneer in het midden tussen start en einde
        beamInstance.GlobalPosition = start + direction / 2;
        // Roteer zodat de beam naar het eindpunt wijst
        beamInstance.LookAt(end, Vector3.Up);
        // Draai 90 graden zodat de cilinder horizontaal ligt
        beamInstance.RotateObjectLocal(Vector3.Right, Mathf.Pi / 2);
        // Schaal de beam op basis van de afstand
        beamInstance.Scale = new Vector3(1, distance, 1);

        // Verwijder de beam na 0.05 seconden
        GetTree().CreateTimer(0.05).Timeout += () => beamInstance.QueueFree();
    }

1. Roep ShowBeam() aan vanuit OnShoot():

public void OnShoot()
{
    // Check of we nog in cooldown zitten
    if (!_fireRateTimer.IsStopped())
        return;

    // Start de cooldown timer
    _fireRateTimer.Start();

    // Toon een beam vanaf de muzzle 100 units vooruit
    Vector3 beamEnd = _muzzle.GlobalPosition - _muzzle.GlobalBasis.Z * 100;
    ShowBeam(_muzzle.GlobalPosition, beamEnd);

    GD.Print("Railgun fired!");
}

1. Test met F6 - je zou nu een korte cyan beam moeten zien wanneer je schiet!

Complete railgun script

Hier is het volledige Railgun script tot nu toe:

using Godot;

public partial class Railgun : Node3D
{
    [Export] private Timer _fireRateTimer;
    [Export] private Node3D _weaponMount;
    [Export] private Marker3D _muzzle;

    public override void _Process(double delta)
    {
        // Volg de weapon mount position en rotation
        GlobalTransform = _weaponMount.GlobalTransform;
    }

    public void OnShoot()
    {
        // Check of we nog in cooldown zitten
        if (!_fireRateTimer.IsStopped())
            return;

        // Start de cooldown timer
        _fireRateTimer.Start();

        // Toon een beam vanaf de muzzle 100 units vooruit
        Vector3 beamEnd = _muzzle.GlobalPosition - _muzzle.GlobalBasis.Z * 100;
        ShowBeam(_muzzle.GlobalPosition, beamEnd);

        GD.Print("Railgun fired!");
    }

    private void ShowBeam(Vector3 start, Vector3 end)
    {
        // Maak een cilinder mesh voor de beam
        var beamMesh = new CylinderMesh();
        beamMesh.TopRadius = 0.02f;
        beamMesh.BottomRadius = 0.02f;
        beamMesh.Height = 1.0f;

        var material = new StandardMaterial3D();
        material.ShadingMode = BaseMaterial3D.ShadingModeEnum.Unshaded;
        material.AlbedoColor = Colors.Cyan;
        material.NoDepthTest = true;  // Teken altijd op de voorgrond

        var beamInstance = new MeshInstance3D
        {
            Mesh = beamMesh,
            MaterialOverride = material,
            CastShadow = GeometryInstance3D.ShadowCastingSetting.Off
        };

        GetTree().Root.AddChild(beamInstance);

        // Positioneer en roteer de beam
        Vector3 direction = end - start;
        float distance = direction.Length();

        beamInstance.GlobalPosition = start + direction / 2;
        beamInstance.LookAt(end, Vector3.Up);
        beamInstance.RotateObjectLocal(Vector3.Right, Mathf.Pi / 2);
        beamInstance.Scale = new Vector3(1, distance, 1);

        // Verwijder na 0.05 seconden
        GetTree().CreateTimer(0.05).Timeout += () => beamInstance.QueueFree();
    }
}