f86c6b6ac4
This commit replaces most usages of `ConvertManagedObjectToVariant` and `ConvertVariantToManagedObjectOfType`, by using the `Godot.Variant` struct instead of `System.Object`. The most notable change is to the `GetGodotPropertyDefaultValues` method that's generated for scripts. The dictionary it returns now stores `Godot.Variant` values. Remaining usages are: - The `DelegateUtils` class, for the serialization of closure display classes during assembly reloading by the editor. These display classes are compiler generated classes to store values captured by a closure. Since it's generated by the compiler, the only way we have to access the fields is through reflection. This leads to using `System.Object`. - Converting parameters when invoking constructors from the engine. This will be replaced with source generators in the future. - Legacy support for old `GetGodotPropertyDefaultValues` return values. We need to keep supporting the old version of this generated method for some time. Otherwise, if loading a project built with the previous version, it could lead to the loss of exported property values. Ideally, we should remove this legacy support before a stable release.
How to build and run
- Build Godot with the module enabled:
module_mono_enabled=yes. - After building Godot, use it to generate the C# glue code:
<godot_binary> --generate-mono-glue ./modules/mono/glue - Build the C# solutions:
./modules/mono/build_scripts/build_assemblies.py --godot-output-dir ./bin
The paths specified in these examples assume the command is being run from the Godot source root.
How to deal with NuGet packages
We distribute the API assemblies, our source generators, and our custom MSBuild project SDK as NuGet packages. This is all transparent to the user, but it can make things complicated during development.
In order to use Godot with a development of those packages, we must create a local NuGet source where MSBuild can find them. This can be done with the .NET CLI:
dotnet nuget add source ~/MyLocalNugetSource --name MyLocalNugetSource
The Godot NuGet packages must be added to that local source. Additionally, we must make sure there are no other versions of the package in the NuGet cache, as MSBuild may pick one of those instead.
In order to simplify this process, the build_assemblies.py script provides
the following --push-nupkgs-local option:
./modules/mono/build_scripts/build_assemblies.py --godot-output-dir ./bin \
--push-nupkgs-local ~/MyLocalNugetSource
This option ensures the packages will be added to the specified local NuGet source and that conflicting versions of the package are removed from the NuGet cache. It's recommended to always use this option when building the C# solutions during development to avoid mistakes.
Double Precision Support (REAL_T_IS_DOUBLE)
Follow the above instructions but build Godot with the float=64 argument to scons
When building the NuGet packages, specify --float=64 - for example:
./modules/mono/build_scripts/build_assemblies.py --godot-output-dir ./bin \
--push-nupkgs-local ~/MyLocalNugetSource --float=64