Exports GDScript

Introduction aux exports GDScript

Dans Godot, les membres de classe peuvent être exportés. Cela signifie que leur valeur est sauvegardée avec la ressource (par exemple la scene) à laquelle ils sont attachés. Ils seront également disponibles pour l'édition dans l'éditeur de propriétés. L'exportation se fait en utilisant le mot clé export :

extends Button

export var number = 5 # Value will be saved and visible in the property editor.

Une variable exportée doit être initialisée à une expression constante ou avoir une indication d'exportation sous la forme d'un argument au mot-clé export (voir la section Exemples ci-dessous).

L'un des avantages fondamentaux de l'exportation des variables membres est de les rendre visibles et modifiables dans l'éditeur. De cette façon, les artistes et les game designers peuvent modifier les valeurs qui influenceront plus tard le fonctionnement du programme. Pour cela, une syntaxe spéciale d'exportation est fournie.

Note

L'exportation de propriétés peut également se faire dans d'autres langages comme le C#. La syntaxe varie en fonction du langage.

Exemples

# If the exported value assigns a constant or constant expression,
# the type will be inferred and used in the editor.

export var number = 5

# Export can take a basic data type as an argument, which will be
# used in the editor.

export(int) var number

# Export can also take a resource type to use as a hint.

export(Texture) var character_face
export(PackedScene) var scene_file
# There are many resource types that can be used this way, try e.g.
# the following to list them:
export(Resource) var resource

# Integers and strings hint enumerated values.

# Editor will enumerate as 0, 1 and 2.
export(int, "Warrior", "Magician", "Thief") var character_class
# Editor will enumerate with string names.
export(String, "Rebecca", "Mary", "Leah") var character_name

# Named enum values

# Editor will enumerate as THING_1, THING_2, ANOTHER_THING.
enum NamedEnum {THING_1, THING_2, ANOTHER_THING = -1}
export(NamedEnum) var x

# Strings as paths

# String is a path to a file.
export(String, FILE) var f
# String is a path to a directory.
export(String, DIR) var f
# String is a path to a file, custom filter provided as hint.
export(String, FILE, "*.txt") var f

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

# String is a path to a PNG file in the global filesystem.
export(String, FILE, GLOBAL, "*.png") var tool_image
# String is a path to a directory in the global filesystem.
export(String, DIR, GLOBAL) var tool_dir

# The MULTILINE setting tells the editor to show a large input
# field for editing over multiple lines.
export(String, MULTILINE) var text

# Limiting editor input ranges

# Allow integer values from 0 to 20.
export(int, 20) var i
# Allow integer values from -10 to 20.
export(int, -10, 20) var j
# Allow floats from -10 to 20 and snap the value to multiples of 0.2.
export(float, -10, 20, 0.2) var k
# Allow values 'y = exp(x)' where 'y' varies between 100 and 1000
# while snapping to steps of 20. The editor will present a
# slider for easily editing the value.
export(float, EXP, 100, 1000, 20) var l

# Floats with easing hint

# Display a visual representation of the 'ease()' function
# when editing.
export(float, EASE) var transition_speed

# Colors

# Color given as red-green-blue value (alpha will always be 1).
export(Color, RGB) var col
# Color given as red-green-blue-alpha value.
export(Color, RGBA) var col

# Nodes

# Another node in the scene can be exported as a NodePath.
export(NodePath) var node_path
# Do take note that the node itself isn't being exported -
# there is one more step to call the true node:
onready var node = get_node(node_path)

# Resources

export(Resource) var 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 an extension of Resource such as:
export(AnimationNode) var resource
# The drop-down menu will be limited to AnimationNode and all
# its inherited classes.

Il faut noter que même si le script n'est pas exécuté pendant qu'il est dans l'éditeur, les propriétés exportées sont toujours modifiables. Ceci peut être utilisé en conjonction avec un script en mode "tool".

Exportation bit flags

Les nombres entiers utilisés comme bit flags peuvent stocker plusieurs valeurs true/false (booléen) dans une propriété. En utilisant l'indication d'exportation int, FLAGS, ..., ils peuvent être réglés depuis l'éditeur :

# Set any of the given flags from the editor.
export(int, FLAGS, "Fire", "Water", "Earth", "Wind") var spell_elements = 0

Vous devez fournir une description sous forme de chaîne de caractère pour chaque flag. Dans cet exemple, Feu a la valeur 1, Eau a la valeur 2, Terre a la valeur 4 et Vent correspond à la valeur 8. Généralement, les constantes doivent être définies en conséquence (p. ex. const ELEMENT_VENT = 8 et ainsi de suite).

Des indices d'exportation sont également fournis pour les couches physiques et de rendu définies dans les paramètres du projet :

export(int, LAYERS_2D_PHYSICS) var layers_2d_physics
export(int, LAYERS_2D_RENDER) var layers_2d_render
export(int, LAYERS_3D_PHYSICS) var layers_3d_physics
export(int, LAYERS_3D_RENDER) var layers_3d_render

L'utilisation de bit flags nécessite une certaine compréhension des opérations sur les bits. En cas de doute, utilisez des variables booléennes à la place.

Exportation de tableaux

Les arrays exportés peuvent avoir des initialisateurs, mais ils doivent être des expressions constantes.

Si le tableau exporté spécifie un type qui hérite de Resource, les valeurs du tableau peuvent être définies dans l'inspecteur en glissant et déposant plusieurs fichiers du dock système de fichiers en même temps.

# Default value must be a constant expression.

export var a = [1, 2, 3]

# Exported arrays can specify type (using the same hints as before).

export(Array, int) var ints = [1, 2, 3]
export(Array, int, "Red", "Green", "Blue") var enums = [2, 1, 0]
export(Array, Array, float) var two_dimensional = [[1.0, 2.0], [3.0, 4.0]]

# You can omit the default value, but then it would be null if not assigned.

export(Array) var b
export(Array, PackedScene) var scenes

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

export(Array, Texture) var textures
export(Array, PackedScene) var scenes

# Typed arrays also work, only initialized empty:

export var vector3s = PoolVector3Array()
export var strings = PoolStringArray()

# Default value can include run-time values, but can't
# be exported.

var c = [a, 2, 3]

Définition des variables exportées à partir d'un script tool(outil)

Quand la valeur d'une variable exportée depuis un script Mode tool(outil) est modifiée, la valeur dans l'inspecteur ne sera pas mise-à-jour automatiquement. Pour la mettre-à-jour, appelez property_list_changed_notify() après avoir défini la valeur de la variable exportée.

Exportations avancées

Tous les types d'exportation ne peuvent pas être fournis au niveau du langage lui-même pour éviter une complexité de conception inutile. Ce qui suit décrit quelques fonctions d'exportation plus ou moins courantes qui peuvent être mises en œuvre avec une API de bas niveau.

Avant de poursuivre la lecture, vous devriez vous familiariser avec la manière dont les propriétés sont gérées et comment elles peuvent être personnalisées avec les méthodes _set() , _get() et :ref:` _get_property_list() <class_Object_method__get_property_list> comme décrit dans :ref:`doc_accessing_data_or_logic_from_object.

Voir aussi

Pour les propriétés de liaison utilisant les méthodes ci-dessus en C++, voir Liaison (Binding) des propriétés à l'aide de _set/_get/_get_property_list.

Avertissement

Le script doit fonctionner en mode tool pour que les méthodes ci-dessus puissent fonctionner dans l'éditeur.

Propriétés

Pour utiliser au mieux les sections ci-dessous, vous devrez savoir créer des propriétés avec des exports avancés.

func _get_property_list():
    var properties = []
    # Same as "export(int) var my_property"
    properties.append({
        name = "my_property",
        type = TYPE_INT
    })
    return properties

  • La fonction _get_property_list() est appelée par l'inspecteur. Vous pouvez la supplanter pour des exports avancés. Vous devez retourner un Array avec le contenu des propriétés pour que la fonction puisse marcher.

  • name est le nom de la propriété

  • type est le type de la propriété de Variant.Type.

Note

Le type flottant float est appelé réel (TYPE_REAL) dans l'énumération Variant.Type.

Attacher des variables aux propriétés

Pour attacher des variables à des propriétés (ce qui permet d'utiliser la valeur de la propriété dans des scripts), vous devez créer une variable portant exactement le même nom que la propriété, sinon vous devrez peut-être remplacer les méthodes _set() et _get(). Attacher une variable à une propriété vous donne également la possibilité de lui donner un état par défaut.

# This variable is determined by the function below.
# This variable acts just like a regular gdscript export.
var my_property = 5

func _get_property_list():
    var properties = []
    # Same as "export(int) var my_property"
    properties.append({
        name = "my_property",
        type = TYPE_INT
    })
    return properties

Adding default values for properties

To define default values for advanced exports, you need to override the property_can_revert() and property_get_revert() methods.

  • The property_can_revert() method takes the name of a property and must return true if the property can be reverted. This will enable the Revert button next to the property in the inspector.

  • The property_get_revert() method takes the name of a property and must return the default value for that property.

func _get_property_list():
    var properties = []
    properties.append({
        name = "my_property",
        type = TYPE_INT
    })
    return properties

func property_can_revert(property):
    if property == "my_property":
        return true
    return false

func property_get_revert(property):
    if property == "my_property":
        return 5

Ajout de catégories de script

Pour une meilleure distinction visuelle des propriétés, une catégorie d'écriture spéciale peut être intégrée à l'inspecteur pour servir de séparateur. Script Variables est un exemple de catégorie intégrée.

func _get_property_list():
    var properties = []
    properties.append({
        name = "Debug",
        type = TYPE_NIL,
        usage = PROPERTY_USAGE_CATEGORY | PROPERTY_USAGE_SCRIPT_VARIABLE
    })

    # Example of adding a property to the script category
    properties.append({
        name = "Logging_Enabled",
        type = TYPE_BOOL
    })
    return properties

  • name est le nom d'une catégorie à ajouter à l'inspecteur ;

  • Chaque propriété ajoutée après la définition de catégorie fera partie de la catégorie.

  • La propriété PROPERTY_USAGE_CATEGORY indique que la propriété doit être traitée comme une catégorie de script spécifique, donc le type TYPE_NIL peut être ignoré car il ne sera pas réellement utilisé pour la logique de script, mais il doit quand même être défini.

Groupement des propriétés

Une liste de propriétés ayant des noms similaires peut être groupée.

func _get_property_list():
    var properties = []
    properties.append({
        name = "Rotate",
        type = TYPE_NIL,
        hint_string = "rotate_",
        usage = PROPERTY_USAGE_GROUP | PROPERTY_USAGE_SCRIPT_VARIABLE
    })

    # Example of adding to the group
    properties.append({
        name = "rotate_speed",
        type = TYPE_REAL
    })

    # This property won't get added to the group
    # due to not having the "rotate_" prefix.
    properties.append({
        name = "trail_color",
        type = TYPE_COLOR
    })
    return properties

  • name est le nom d'un groupe qui va s'afficher sous forme de liste pliable de propriétés ;

  • Chaque propriété ajoutée après la propriété groupe avec le préfixe (déterminé par hint_string) sera raccourcie. Par exemple, rotate_speed deviendra speed dans ce cas. Mais movement_speed ne fera pas partie du groupe et ne sera pas raccourci.

  • PROPERTY_USAGE_GROUP indique que la propriété doit être traitée comme un groupe de script spécifique, donc le type TYPE_NIL peut être ignoré car il ne sera pas réellement utilisé pour la logique de script, mais il doit quand même être défini.