Up to date

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

C# exports

Introduction to exports

In Godot, class members can be exported. This means their value gets saved along with the resource (such as the scene) they’re attached to. They will also be available for editing in the property editor. Exporting is done by using the [Export] attribute.

  1. using Godot;
  3. public partial class ExportExample : Node3D
  4. {
  5.     [Export]
  6.     private int Number = 5;
  7. }

In that example the value 5 will be saved, and after building the current project it will be visible in the property editor.

One of the fundamental benefits of exporting member variables is to have them visible and editable in the editor. This way, artists and game designers can modify values that later influence how the program runs. For this, a special export syntax is provided.

Exporting can only be done with Variant-compatible types.

Note

Exporting properties can also be done in GDScript, for information on that see GDScript exports.

Basic use

Exporting can work with fields and properties.

  1. [Export]
  2. private int _number;
  4. [Export]
  5. public int Number { get; set; }

Exported members can specify a default value; otherwise, the default value of the type is used instead.

  1. [Export]
  2. private int _number; // Defaults to '0'
  4. [Export]
  5. private string _text; // Defaults to 'null' because it's a reference type
  7. [Export]
  8. private string _greeting = "Hello World"; // Exported field specifies a default value
  10. [Export]
  11. public string Greeting { get; set; } = "Hello World"; // Exported property specifies a default value
  13. // This property uses `_greeting` as its backing field, so the default value
  14. // will be the default value of the `_greeting` field.
  15. [Export]
  16. public string GreetingWithBackingField
  17. {
  18.     get => _greeting;
  19.     set => _greeting = value;
  20. }

Resources and nodes can be exported.

  1. [Export]
  2. public Resource Resource { get; set; }
  4. [Export]
  5. public Node Node { get; set; }

Grouping exports

It is possible to group your exported properties inside the Inspector with the [ExportGroup] attribute. Every exported property after this attribute will be added to the group. Start a new group or use [ExportGroup("")] to break out.

  1. [ExportGroup("My Properties")]
  2. [Export]
  3. public int Number { get; set; } = 3;

The second argument of the attribute can be used to only group properties with the specified prefix.

Groups cannot be nested, use [ExportSubgroup] to create subgroups within a group.

  1. [ExportSubgroup("Extra Properties")]
  2. [Export]
  3. public string Text { get; set; } = "";
  4. [Export]
  5. public bool Flag { get; set; } = false;

You can also change the name of your main category, or create additional categories in the property list with the [ExportCategory] attribute.

  1. [ExportCategory("Main Category")]
  2. [Export]
  3. public int Number { get; set; } = 3;
  4. [Export]
  5. public string Text { get; set; } = "";
  7. [ExportCategory("Extra Category")]
  8. [Export]
  9. private bool Flag { get; set; } = false;

Note

The list of properties is organized based on the class inheritance, and new categories break that expectation. Use them carefully, especially when creating projects for public use.

Strings as paths

Property hints can be used to export strings as paths

String as a path to a file.

  1. [Export(PropertyHint.File)]
  2. public string GameFile { get; set; }

String as a path to a directory.

  1. [Export(PropertyHint.Dir)]
  2. public string GameDirectory { get; set; }

String as a path to a file, custom filter provided as hint.

  1. [Export(PropertyHint.File, "*.txt,")]
  2. public string GameFile { get; set; }

Using paths in the global filesystem is also possible, but only in scripts in tool mode.

String as a path to a PNG file in the global filesystem.

  1. [Export(PropertyHint.GlobalFile, "*.png")]
  2. public string ToolImage { get; set; }

String as a path to a directory in the global filesystem.

  1. [Export(PropertyHint.GlobalDir)]
  2. public string ToolDir { get; set; }

The multiline annotation tells the editor to show a large input field for editing over multiple lines.

  1. [Export(PropertyHint.MultilineText)]
  2. public string Text { get; set; }

Limiting editor input ranges

Using the range property hint allows you to limit what can be input as a value using the editor.

Allow integer values from 0 to 20.

  1. [Export(PropertyHint.Range, "0,20,")]
  2. public int Number { get; set; }

Allow integer values from -10 to 20.

  1. [Export(PropertyHint.Range, "-10,20,")]
  2. public int Number { get; set; }

Allow floats from -10 to 20 and snap the value to multiples of 0.2.

  1. [Export(PropertyHint.Range, "-10,20,0.2")]
  2. public float Number { get; set; }

If you add the hints “or_greater” and/or “or_less” you can go above or below the limits when adjusting the value by typing it instead of using the slider.

  1. [Export(PropertyHint.Range, "0,100,1,or_greater,or_less")]
  2. public int Number { get; set; }

Floats with easing hint

Display a visual representation of the ‘ease()’ function when editing.

  1. [Export(PropertyHint.ExpEasing)]
  2. public float TransitionSpeed { get; set; }

Colors

Regular color given as red-green-blue-alpha value.

  1. [Export]
  2. private Color Color { get; set; }

Color given as red-green-blue value (alpha will always be 1).

  1. [Export(PropertyHint.ColorNoAlpha)]
  2. private Color Color { get; set; }

Nodes

Since Godot 4.0, nodes can be directly exported without having to use NodePaths.

  1. [Export]
  2. public Node Node { get; set; }

Custom node classes can also be used, see C# global classes.

Exporting NodePaths like in Godot 3.x is still possible, in case you need it:

  1. [Export]
  2. private NodePath _nodePath;
  4. public override void _Ready()
  5. {
  6.     var node = GetNode(_nodePath);
  7. }

Resources

  1. [Export]
  2. private Resource Resource;

In the Inspector, you can then drag and drop a resource file from the FileSystem dock into the variable slot.

Opening the inspector dropdown may result in an extremely long list of possible classes to create, however. Therefore, if you specify a type derived from Resource such as:

  1. [Export]
  2. private AnimationNode Resource;

The drop-down menu will be limited to AnimationNode and all its inherited classes. Custom resource classes can also be used, see C# global classes.

It must be noted that even if the script is not being run while in the editor, the exported properties are still editable. This can be used in conjunction with a script in “tool” mode.

Exporting bit flags

Members whose type is an enum with the [Flags] attribute can be exported and their values are limited to the members of the enum type. The editor will create a widget in the Inspector, allowing to select none, one, or multiple of the enum members. The value will be stored as an integer.

  1. // Use power of 2 values for the values of the enum members.
  2. [Flags]
  3. public enum MyEnum
  4. {
  5.     Fire = 1 << 1,
  6.     Water = 1 << 2,
  7.     Earth = 1 << 3,
  8.     Wind = 1 << 4,
  10.     // A combination of flags is also possible.
  11.     FireAndWater = Fire | Water,
  12. }
  14. [Export]
  15. public SpellElements MySpellElements { get; set; }

Integers used as bit flags can store multiple true/false (boolean) values in one property. By using the Flags property hint, they can be set from the editor.

  1. // Set any of the given flags from the editor.
  2. [Export(PropertyHint.Flags, "Fire,Water,Earth,Wind")]
  3. public int SpellElements { get; set; } = 0;

You must provide a string description for each flag. In this example, Fire has value 1, Water has value 2, Earth has value 4 and Wind corresponds to value 8. Usually, constants should be defined accordingly (e.g. private const int ElementWind = 8 and so on).

You can add explicit values using a colon:

  1. [Export(PropertyHint.Flags, "Self:4,Allies:8,Foes:16")]
  2. public int SpellTargets { get; set; } = 0;

Only power of 2 values are valid as bit flags options. The lowest allowed value is 1, as 0 means that nothing is selected. You can also add options that are a combination of other flags:

  1. [Export(PropertyHint.Flags, "Self:4,Allies:8,Self and Allies:12,Foes:16")]
  2. public int SpellTargets { get; set; } = 0;

Export annotations are also provided for the physics and render layers defined in the project settings.

  1. [Export(PropertyHint.Layers2DPhysics)]
  2. public int Layers2DPhysics { get; set; }
  3. [Export(PropertyHint.Layers2DRender)]
  4. public int Layers2DRender { get; set; }
  5. [Export(PropertyHint.Layers3DPhysics)]
  6. public int layers3DPhysics { get; set; }
  7. [Export(PropertyHint.Layers3DRender)]
  8. public int layers3DRender { get; set; }

Using bit flags requires some understanding of bitwise operations. If in doubt, use boolean variables instead.

Exporting enums

Members whose type is an enum can be exported and their values are limited to the members of the enum type. The editor will create a widget in the Inspector, enumerating the following as “Thing 1”, “Thing 2”, “Another Thing”. The value will be stored as an integer.

  1. public enum MyEnum
  2. {
  3.     Thing1,
  4.     Thing2,
  5.     AnotherThing = -1,
  6. }
  8. [Export]
  9. public MyEnum MyEnum { get; set; }

Integer and string members can also be limited to a specific list of values using the [Export] annotation with the PropertyHint.Enum hint. The editor will create a widget in the Inspector, enumerating the following as Warrior, Magician, Thief. The value will be stored as an integer, corresponding to the index of the selected option (i.e. 0, 1, or 2).

  1. [Export(PropertyHint.Enum, "Warrior,Magician,Thief")]
  2. public int CharacterClass { get; set; };

You can add explicit values using a colon:

  1. [Export(PropertyHint.Enum, "Slow:30,Average:60,Very Fast:200")]
  2. public int CharacterSpeed { get; set; }

If the type is string, the value will be stored as a string.

  1. [Export(PropertyHint.Enum, "Rebecca,Mary,Leah")]
  2. public string CharacterName { get; set; }

If you want to set an initial value, you must specify it explicitly:

  1. [Export(PropertyHint.Enum, "Rebecca,Mary,Leah")]
  2. public string CharacterName { get; set; } = "Rebecca";

Exporting collections

As explained in the C# Variant documentation, only certain C# arrays and the collection types defined in the Godot.Collections namespace are Variant-compatible, therefore, only those types can be exported.

Exporting Godot arrays

  1. [Export]
  2. public Godot.Collections.Array Array { get; set; }

Using the generic Godot.Collections.Array<T> allows to specify the type of the array elements which will be used as a hint for the editor. The Inspector will restrict the elements to the specified type.

  1. [Export]
  2. public Godot.Collections.Array<string> Array { get; set; }

The default value of Godot arrays is null, a different default can be specified:

  1. [Export]
  2. public Godot.Collections.Array<string> CharacterNames { get; set; } = new Godot.Collections.Array<string>
  3. {
  4.     "Rebecca",
  5.     "Mary",
  6.     "Leah",
  7. };

Arrays with specified types which inherit from resource can be set by drag-and-dropping multiple files from the FileSystem dock.

  1. [Export]
  2. public Godot.Collections.Array<Texture> Textures { get; set; }
  4. [Export]
  5. public Godot.Collections.Array<PackedScene> Scenes { get; set; }

Exporting Godot dictionaries

  1. [Export]
  2. public Godot.Collections.Dictionary Dictionary { get; set; }

Using the generic Godot.Collections.Dictionary<TKey, TValue> allows to specify the type of the key and value elements of the dictionary.

Note

Typed dictionaries are currently unsupported in the Godot editor, so the Inspector will not restrict the types that can be assigned, potentially resulting in runtime exceptions.

  1. [Export]
  2. public Godot.Collections.Dictionary<string, int> Dictionary { get; set; }

The default value of Godot dictionaries is null, a different default can be specified:

  1. [Export]
  2. public Godot.Collections.Dictionary<string, int> CharacterLives { get; set; } = new Godot.Collections.Dictionary<string, int>
  3. {
  4.     ["Rebecca"] = 10,
  5.     ["Mary"] = 42,
  6.     ["Leah"] = 0,
  7. };

Exporting C# arrays

C# arrays can exported as long as the element type is a Variant-compatible type.

  1. [Export]
  2. public Vector3[] Vectors { get; set; }
  4. [Export]
  5. public NodePath[] NodePaths { get; set; }

The default value of C# arrays is null, a different default can be specified:

  1. [Export]
  2. public Vector3[] Vectors { get; set; } = new Vector3[]
  3. {
  4.     new Vector3(1, 2, 3),
  5.     new Vector3(3, 2, 1),
  6. }

Setting exported variables from a tool script

When changing an exported variable’s value from a script in Tool mode, the value in the inspector won’t be updated automatically. To update it, call NotifyPropertyListChanged() after setting the exported variable’s value.

Advanced exports

Not every type of export can be provided on the level of the language itself to avoid unnecessary design complexity. The following describes some more or less common exporting features which can be implemented with a low-level API.

Before reading further, you should get familiar with the way properties are handled and how they can be customized with _Set(), _Get(), and _GetPropertyList() methods as described in Accessing data or logic from an object.

See also

For binding properties using the above methods in C++, see Binding properties using _set/_get/_get_property_list.

Warning

The script must operate in the tool mode so the above methods can work from within the editor.