Attention: Here be dragons
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
Checking the stable version of the documentation...
ClassDB
Hérite de : Object
Un dépôt d'informations de classes.
Description
Fournit un accès aux métadonnées enregistrées pour chaque classe disponible du moteur.
Remarque : Les classes définies dans des scripts avec class_name ne font pas partie de ClassDB, elles ne renverront donc pas de données de réflexion telles qu'une méthode ou une liste de propriétés. Cependant, les classes définies par GDExtension font partie de ClassDB, elle renverront donc des données de réflexion.
Méthodes
Énumérations
enum APIType: 🔗
APIType API_CORE = 0
Type de classe Native Core (code principal natif).
APIType API_EDITOR = 1
Type de classe Native Editor (code de l'éditeur natif).
APIType API_EXTENSION = 2
Type de classe GDExtension.
APIType API_EDITOR_EXTENSION = 3
Type de classe GDExtension Editor (GDExtension pour l'éditeur).
APIType API_NONE = 4
Type de classe inconnu.
Descriptions des méthodes
bool can_instantiate(class: StringName) const 🔗
Renvoie true si des objets peuvent être instanciés à partir de la classe class spécifiée, sinon renvoie false.
Variant class_call_static(class: StringName, method: StringName, ...) vararg 🔗
Appelle une méthode statique sur une classe.
bool class_exists(class: StringName) const 🔗
Renvoie si la classe class spécifiée est disponible ou non.
APIType class_get_api_type(class: StringName) const 🔗
Renvoie le type d'API de la classe class spécifiée.
PackedStringArray class_get_enum_constants(class: StringName, enum: StringName, no_inheritance: bool = false) const 🔗
Renvoie un tableau avec toutes les clés dans l’énumération enum de la classe class ou de ses parents.
PackedStringArray class_get_enum_list(class: StringName, no_inheritance: bool = false) const 🔗
Renvoie un tableau avec toutes les énumérations de la classe class ou de ses parents.
int class_get_integer_constant(class: StringName, name: StringName) const 🔗
Renvoie la valeur de la constante entière name de la classe class ou ses parents. Renvoie toujours 0 si la constante n'a pas été trouvée.
StringName class_get_integer_constant_enum(class: StringName, name: StringName, no_inheritance: bool = false) const 🔗
Renvoie à quelle énumération la constante entière nommée name dans class ou un de ses parents appartient.
PackedStringArray class_get_integer_constant_list(class: StringName, no_inheritance: bool = false) const 🔗
Renvoie un tableau avec le nom de toutes les constantes entières de la classe class ou de ses parents.
int class_get_method_argument_count(class: StringName, method: StringName, no_inheritance: bool = false) const 🔗
Renvoie un tableau avec tous les arguments de la méthode method de la classe class ou ses parents si no_inheritance vaut false.
Array[Dictionary] class_get_method_list(class: StringName, no_inheritance: bool = false) const 🔗
Renvoie un tableau avec toutes les méthodes de la classe class ou ses parents si no_inheritance vaut false. Chaque élément du tableau est un Dictionary avec les clés suivantes : args, default_args, flags, id, name et return: (class_name, hint, hint_string, name, type, usage).
Note : Dans les version exportés de release, les informations de débogage ne sont pas disponibles, les dictionnaires renvoyés ne contiendront donc que le nom des méthodes.
Variant class_get_property(object: Object, property: StringName) const 🔗
Renvoie la valeur de la propriété property de l'objet object ou de ses parents.
Variant class_get_property_default_value(class: StringName, property: StringName) const 🔗
Renvoie la valeur par défaut de la propriété property de la classe class ou de ses parents.
StringName class_get_property_getter(class: StringName, property: StringName) 🔗
Renvoie le nom de méthode getter de la propriété property de la classe class.
Array[Dictionary] class_get_property_list(class: StringName, no_inheritance: bool = false) const 🔗
Renvoie un tableau avec toutes les propriétés de la classe class ou son ascendance si no_inheritance vaut false.
StringName class_get_property_setter(class: StringName, property: StringName) 🔗
Renvoie le nom de méthode setter de la propriété property de la classe class.
Dictionary class_get_signal(class: StringName, signal: StringName) const 🔗
Renvoie les données du signal signal de la classe class ou de ses parents. La valeur renvoyée est un Dictionary avec les clés suivantes : args, default_args, flags, id, name et return: (class_name, hint, hint_string, name, type, usage).
Array[Dictionary] class_get_signal_list(class: StringName, no_inheritance: bool = false) const 🔗
Renvoie un tableau avec tous les signaux de la classe class ou ses parents si no_inheritance vaut false. Chaque élément du tableau est un Dictionary comme décrit dans class_get_signal().
bool class_has_enum(class: StringName, name: StringName, no_inheritance: bool = false) const 🔗
Renvoie si la classe class ou ses parents ont une énumération nommée name ou non.
bool class_has_integer_constant(class: StringName, name: StringName) const 🔗
Renvoie si la classe class ou ses parents a une constante entière appelée name ou non.
bool class_has_method(class: StringName, method: StringName, no_inheritance: bool = false) const 🔗
Renvoie si la classe class (ou un de ses parents si no_inheritance vaut false) a une méthode nommée method ou non.
bool class_has_signal(class: StringName, signal: StringName) const 🔗
Renvoie si class ou ses parents ont un signal nommé signal ou non.
Error class_set_property(object: Object, property: StringName, value: Variant) const 🔗
Définit la valeur de la propriété property de l'objet object à value.
PackedStringArray get_class_list() const 🔗
Renvoie les noms de toutes les classes du moteur disponibles.
Note : Les classes définies dans des scripts avec class_name ne sont pas incluses dans cette liste. Utilisez à la place ProjectSettings.get_global_class_list() pour obtenir une liste de classes définies dans des scripts.
PackedStringArray get_inheriters_from_class(class: StringName) const 🔗
Renvoie le nom de toutes les classes du moteur qui héritent directement ou indirectement de class.
StringName get_parent_class(class: StringName) const 🔗
Renvoie la classe parente de class.
Variant instantiate(class: StringName) const 🔗
Crée une instance de class.
bool is_class_enabled(class: StringName) const 🔗
Renvoie si cette class est active ou non.
bool is_class_enum_bitfield(class: StringName, enum: StringName, no_inheritance: bool = false) const 🔗
Renvoie si class (ou un de ses parents si no_inheritance vaut false) a une énumération nommée enum qui est un champ de bits.
bool is_parent_class(class: StringName, inherits: StringName) const 🔗
Renvoie si class hérite de la classe inherits ou non.