Cross-language scripting

    The following two scripts will be used as references throughout this page.

    GDScript   C#

    2. {
    3.     public String str1 = "bar";
    4.     public String str2 { get { return "barbar"; } }
    6.     public void PrintNodeName(Node node)
    7.     {
    8.         GD.Print(node.GetName());
    10.     public void PrintArray(String[] arr)
    11.     {
    12.         foreach (String element in arr)
    13.         {
    14.             GD.Print(element);
    15.         }
    16.     }
    18.     public void PrintNTimes(String msg, int n)
    19.     {
    20.         for (int i = 0; i < n; ++i)
    21.         {
    22.             GD.Print(msg);
    23.         }
    24.     }
    25. }

    If you’re not using nodes from the scene tree, you’ll probably want to instantiate nodes directly from the code.

    Using C# from GDScript doesn’t need much work. Once loaded (see Classes as resources), the script can be instantiated with .

    Warning

    For example, MyCoolNode.cs should contain a class named MyCoolNode.

    You also need to check your .cs file is referenced in the project’s .csproj file. Otherwise, the same error will occur.

    Instantiating GDScript nodes from C

    From the C# side, everything work the same way. Once loaded, the GDScript can be instantiated with .

    1. GDScript MyGDScript = (GDScript) GD.Load("res://path_to_gd_file.gd");

    Here we are using an Object, but you can use type conversion like explained in .

    Accessing C# fields from GDScript is straightforward, you shouldn’t have anything to worry about.

    Accessing GDScript fields from C

    As C# is statically typed, accessing GDScript from C# is a bit more convoluted, you will have to use and Object.Set(). The first argument is the name of the field you want to access.

    1. GD.Print(myGDScriptNode.Get("str1")); // foo
    3. GD.Print(myGDScriptNode.Get("str1")); // FOO
    5. GD.Print(myGDScriptNode.Get("str2")); // foofoo
    6. // myGDScriptNode.Set("str2", "FOOFOO"); // This line won't do anything

    Keep in mind that when setting a field value you should only use types the GDScript side knows about. Essentially, you want to work with built-in types as described in or classes extending Object.

    Again, calling C# methods from GDScript should be straightforward. The marshalling process will do its best to cast the arguments to match function signatures. If that’s impossible, you’ll see the following error: Invalid call. Nonexistent function `FunctionName` .

    Calling GDScript methods from C

    To call GDScript methods from C# you’ll need to use Object.Call(). The first argument is the name of the method you want to call. The following arguments will be passed to said method.

    1. myGDScriptNode.Call("print_node_name", this); // my_csharp_node
    2. // myGDScriptNode.Call("print_node_name"); // This line will fail silently and won't error out.
    4. myGDScriptNode.Call("print_n_times", "Hello there!", 2); // Hello there! Hello there!
    6. // When dealing with functions taking a single array as arguments, we need to be careful.
    7. // If we don't cast it into an object, the engine will treat each element of the array as a separate argument and the call will fail.
    8. String[] arr = new String[] { "a", "b", "c" };
    9. // myGDScriptNode.Call("print_array", arr); // This line will fail silently and won't error out.
    10. myGDScriptNode.Call("print_array", (object)arr); // a, b, c
    11. myGDScriptNode.Call("print_array", (object)new int[] { 1, 2, 3 }); // 1, 2, 3

    Warning

    A GDScript file may not inherit from a C# script. Likewise, a C# script may not inherit from a GDScript file. Due to how complex this would be to implement, this limitation is unlikely to be lifted in the future. See this GitHub issue for more information.