Введение

Предупреждение

Поддержка C# была введена в Godot 3.0. Из-за новизны, вы можете столкнуться с какими-то проблемами, ила найти места где документация может быть улучшена. Пожалуйста сообщайте о проблемах с C# в Godot на странице движка на GitHub, а о проблемах с документацией на странице GitHub документации.

Эта страница предоставляет краткое введение в C#, о том что это и как использовать его в Godot. После, вас может заинтересовать чтение о том как использовать особые возможности, о различиях между C# и GDScript API и (пере)посещение Секции скриптинга для пошагового руководства.

C# это высоко-уровневый язык программирования разработанный Microsoft. В Godot, он применён с использованием фреймворка Mono 5.x .NET, включающий поддержка C# 7.0. Mono это реализация Microsoft .NET Framework с открытым исходным кодом, базирующаяся на стандартах ECMA для C# и Common Language Runtime(CLR). Для изучения его возможностей смотрите страницу Совместимость в документации Mono.

Примечание

Это не полномасштабное руководство по целому языку C#. Если вы не знакомы с его синтаксисом или возможностями, посмотрите Microsoft C# руководство или поищите подходящее введение где-нибудь ещё.

Настройка C# для Godot

Windows

Download and install the latest version of Visual Studio (not Visual Studio Code), which contains utilities required to use C# in Godot. If you don’t plan on using the Visual Studio IDE, you can download just the Visual Studio Build Tools instead. Make sure you at least have the .NET Framework 4.5 targeting pack installed, you can get it using any of the installers mentioned above inside the «Individual components» tab.

macOS и Linux

Загрузите и установите последнюю версию Mono SDK. Начиная с Godot 3.1 beta 3, номер версии не играет роли так как Godot поставляется с собственной сборкой Mono 5.18. Нам нужна Mono установка для NuGet и MSBuild которые нужны для использования C# в Godot.

Примечание

Для загрузки Mono на macOS, используйте ссылку на «Stable Channel» из Страницы Загрузок Mono. Канал Visual Studio это ранняя версия Mono которая не будет работать.

Дополнительные заметки

Ваша версия Godot должна иметь включенную поддержку Mono, так что убедитесь что скачали именно Mono версию Godot. Если вы собираете Godot из исходников, убедитесь что вы следовали инструкции по включению Mono в вашу сборку как описано на странице Compiling with Mono.

В итоге, вы должны иметь установленную Visual Studio или Mono (в зависимости от вашей операционной системы) и Mono-ориентированную версию Godot.

Настройка внешнего редактора

C# support in Godot’s script editor is minimal. Consider using an external IDE or editor, such as Visual Studio Code or MonoDevelop. These provide autocompletion, debugging, and other useful features for C#. To select an external editor in Godot, click on Editor → Editor Settings and scroll down to Mono. Under Mono, click on Editor, and select your external editor of choice.

Примечание

Если вы используете Visual Studio Code, убедитесь что загрузили и установили C# расширение для включения подсветки синтаксиса и IntelliSense.

Создание C# скрипта

После успешной установки C# в Godot, вы должны увидеть следующую опцию при выборе Прикрепить скрипт в контекстном меню ноды в вашей сцене:

../../../_images/attachcsharpscript.png

Заметьте что хотя некоторые особенности изменились, большинство остались теми же во время использования C# для скриптинга. Если вы новичок в Godot, вы возможно захотите поизучать руководства из Написание скриптов на этом месте. Тогда как в некоторых местах документации ещё отсутствуют примеры для C#, большинство концептов могут быть легко перенесены из GDScript.

Настройка проекта и рабочего процесса

Когда вы создали ваш первый скрипт C#, Godot инициализирует его проектными файлами C# для вашего проекта. Это включает генерацию решения(solution) C# (.sln) и проектного файла (.csproj), а также создаются ещё некоторые файлы и папки (.mono и Properties/AssemblyInfo.cs). Все они (кроме .mono) важны и должны быть включены в вашу систему контроля версий. .mono можно спокойно добавить в лист исключений вашего VCS. Когда вы ищите проблему, иногда может помочь удаление папки .mono которая затем самовосстановится.

Заметьте что в настоящее время, существуют некоторые проблемы где Godot и проект C# не синхронизируются; если вы удаляете, переименовываете или перемещаете скрипт C#, эти изменения могут не отразиться в проектном файле C#. В таких случаях, вы должны отредактировать этот файл вручную.

For example, if you created a script (e.g. Test.cs) and delete it in Godot, compilation will fail because the missing file is still expected to be there by the C# project file. For now, you can simply open up the .csproj file and look for the ItemGroup, there should be a line included like the following:

<ItemGroup>
    <Compile Include="Test.cs" />
    <Compile Include="AnotherTest.cs" />
</ItemGroup>

Simply remove that line and your project should build correctly again. Same for renaming and moving things, simply rename and move them in the project file if needed.

Example

Here’s a blank C# script with some comments to demonstrate how it works.

using Godot;
using System;

public class YourCustomClass : Node
{
    // Member variables here, example:
    private int a = 2;
    private string b = "textvar";

    public override void _Ready()
    {
        // Called every time the node is added to the scene.
        // Initialization here.
        GD.Print("Hello from C# to Godot :)");
    }

    public override void _Process(float delta)
    {
        // Called every frame. Delta is time since the last frame.
        // Update game logic here.
    }
}

As you can see, functions normally in global scope in GDScript like Godot’s print function are available in the GD class which is part of the Godot namespace. For a list of methods in the GD class, see the class reference pages for @GDScript and @GlobalScope.

Примечание

Keep in mind that the class you wish to attach to your node should be named as the .cs file. Otherwise, you will get the following error and won’t be able to run the scene: «Cannot find class XXX for script res://XXX.cs»

General differences between C# and GDScript

The C# API uses PascalCase instead of snake_case in GDScript/C++. Where possible, fields and getters/setters have been converted to properties. In general, the C# Godot API strives to be as idiomatic as is reasonably possible.

For more information, see the API differences to GDScript page.

Current gotchas and known issues

As C# support is quite new in Godot, there are some growing pains and things that need to be ironed out. Below is a list of the most important issues you should be aware of when diving into C# in Godot, but if in doubt, also take a look over the official issue tracker for Mono issues.

  • As explained above, the C# project isn’t always kept in sync automatically when things are deleted, renamed or moved in Godot (#12917).
  • Writing editor plugins is possible, but it is currently quite convoluted.
  • State is currently not saved and restored when hot-reloading, with the exception of exported variables.
  • Exporting Mono projects is only supported for desktop platforms (Linux, Windows and macOS). Android, iOS, HTML5 and UWP are not currently supported (#20267, #20268 #20270 #20271).
  • Attached C# scripts should refer to a class that has a class name that matches the file name.

Performance of C# in Godot

According to some preliminary benchmarks, the performance of C# in Godot — while generally in the same order of magnitude — is roughly ~4× that of GDScript in some naive cases. C++ is still a little faster; the specifics are going to vary according to your use case. GDScript is likely fast enough for most general scripting workloads. C# is faster, but requires some expensive marshalling when talking to Godot.

Using NuGet packages in Godot

NuGet packages can be installed and used with Godot, as with any C# project. Many IDEs are able to add packages directly. They can also be added manually by adding the package reference in the .csproj file located in the project root:

    <ItemGroup>
        <PackageReference Include="Newtonsoft.Json" Version="11.0.2"/>
    </ItemGroup>
    ...
</Project>

Whenever packages are added or modified, run nuget restore in the root of the project directory. To ensure that NuGet packages will be available for msbuild to use, run:

msbuild /t:restore