Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

C# language features

Cette page donne un aperçu des fonctionnalités couramment utilisées de C# et de Godot, et de la façon dont elles sont utilisées ensemble.

Conversion de type et Casting

C# est un langage à typage statique. Par conséquent, vous ne pouvez pas faire ce qui suit :

var mySprite = GetNode("MySprite");
mySprite.SetFrame(0);

The method GetNode() returns a Node instance. You must explicitly convert it to the desired derived type, Sprite2D in this case.

Pour cela, en C#, vous disposez de plusieurs options.

Casting et vérification de type

Throws InvalidCastException if the returned node cannot be cast to Sprite2D. You would use it instead of the as operator if you are pretty sure it won't fail.

Sprite2D mySprite = (Sprite2D)GetNode("MySprite");
mySprite.SetFrame(0);

Utilisation de l'opérateur AS

The as operator returns null if the node cannot be cast to Sprite2D, and for that reason, it cannot be used with value types.

Sprite2D mySprite = GetNode("MySprite") as Sprite2D;
// Only call SetFrame() if mySprite is not null
mySprite?.SetFrame(0);

Utilisation des méthodes génériques

Des méthodes génériques sont également fournies pour rendre ce type de conversion transparent.

GetNode <T> () convertit le nœud avant de le retourner. Il enverra une InvalidCastException si le nœud ne peut pas être converti au type désiré.

Sprite2D mySprite = GetNode<Sprite2D>("MySprite");
mySprite.SetFrame(0);

GetNodeOrNull<T>() utilise l'opérateur as et retourne null si le nœud ne peut pas être converti au type désiré.

Sprite2D mySprite = GetNodeOrNull<Sprite2D>("MySprite");
// Only call SetFrame() if mySprite is not null
mySprite?.SetFrame(0);

Vérification du type à l'aide de l'opérateur IS

To check if the node can be cast to Sprite2D, you can use the is operator. The is operator returns false if the node cannot be cast to Sprite2D, otherwise it returns true. Note that when the is operator is used against null the result is always going to be false.

if (GetNode("MySprite") is Sprite2D)
{
    // Yup, it's a Sprite2D!
}

if (null is Sprite2D)
{
    // This block can never happen.
}

You can also declare a new variable to conditionally store the result of the cast if the is operator returns true.

if (GetNode("MySprite") is Sprite2D mySprite)
{
    // The mySprite variable only exists inside this block, and it's never null.
    mySprite.SetFrame(0);
}

Pour un contrôle de type plus avancé, vous pouvez regarder dans Pattern Matching.

Définition Préprocesseur

Godot a un jeu de "defines" permettant de changer de code C# selon l’environnement pour lequel vous compilez.

Note

Si vous avez créé votre projet avant Godot 3.2, vous devez modifier ou re-générer votre fichier csproj pour utiliser cette fonctionnalité (comparez <DefineConstants> avec un nouveau projet 3.2+).

Exemples

Par exemple, vous pouvez changer de code, selon la plateforme :

    public override void _Ready()
    {
#if GODOT_SERVER
        // Don't try to load meshes or anything, this is a server!
        LaunchServer();
#elif GODOT_32 || GODOT_MOBILE || GODOT_WEB
        // Use simple objects when running on less powerful systems.
        SpawnSimpleObjects();
#else
        SpawnComplexObjects();
#endif
    }

Ou vous pouvez détecter quel moteur votre code utilise, utile pour créer des librairies cross-engine :

    public void MyPlatformPrinter()
    {
#if GODOT
        GD.Print("This is Godot.");
#elif UNITY_5_3_OR_NEWER
        print("This is Unity.");
#else
        throw new NotSupportedException("Only Godot and Unity are supported.");
#endif
    }

Or you can write scripts that target multiple Godot versions and take advantage of features that are only available on some of those versions:

    public void UseCoolFeature()
    {
#if GODOT4_3_OR_GREATER || GODOT4_2_2_OR_GREATER
        // Use CoolFeature, that was added to Godot in 4.3 and cherry-picked into 4.2.2, here.
#else
        // Use a workaround for the absence of CoolFeature here.
#endif
    }

Liste complète des définitions

  • GODOT est toujours défini dans un project Godot.

  • TOOLS is defined when building with the Debug configuration (editor and editor player).

  • GODOT_REAL_T_IS_DOUBLE is defined when the GodotFloat64 property is set to true.

  • GODOT_64 ou GODOT_32 est défini selon que l'architecture est 64-bit ou 32-bit.

  • One of GODOT_LINUXBSD, GODOT_WINDOWS, GODOT_OSX, GODOT_ANDROID, GODOT_IOS, GODOT_HTML5, or GODOT_SERVER depending on the OS. These names may change in the future. These are created from the get_name() method of the OS singleton, but not every possible OS the method returns is an OS that Godot with .NET runs on.

  • GODOTX, GODOTX_Y, GODOTX_Y_Z, GODOTx_OR_GREATER, GODOTX_y_OR_GREATER, and GODOTX_Y_z_OR_GREATER, where X, Y, and Z are replaced by the current major, minor and patch version of Godot. x, y, and z are replaced by all values from 0 to the current version number for that component.

    Note

    These defines were first added in Godot 4.0.4 and 4.1. Version defines for prior versions do not exist, regardless of the current Godot version.

    For example: Godot 4.0.5 defines GODOT4, GODOT4_OR_GREATER, GODOT4_0, GODOT4_0_OR_GREATER, GODOT4_0_5, GODOT4_0_4_OR_GREATER, and GODOT4_0_5_OR_GREATER. Godot 4.3.2 defines GODOT4, GODOT4_OR_GREATER, GODOT4_3, GODOT4_0_OR_GREATER, GODOT4_1_OR_GREATER, GODOT4_2_OR_GREATER, GODOT4_3_OR_GREATER, GODOT4_3_2, GODOT4_3_0_OR_GREATER, GODOT4_3_1_OR_GREATER, and GODOT4_3_2_OR_GREATER.

Quand vous exportez, les choses suivantes peuvent également être définies selon les caractéristiques d'exportation :

  • Un des GODOT_PC, GODOT_MOBILE, ou GODOT_WEB selon le type de plateforme.

  • One of GODOT_WINDOWS, GODOT_LINUXBSD, GODOT_MACOS, GODOT_ANDROID, GODOT_IOS, or GODOT_WEB depending on the platform.

Pour voir un projet d’exemple, voyez la démo de système d’exploitation de test : https://github.com/godotengine/godot-demo-projects/tree/master/misc/os_test