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...

Script

Hérite de : Resource < RefCounted < Object

Hérité par : CSharpScript, GDScript, ScriptExtension

Une classe stockée en tant que ressource.

Description

Une classe stockée en tant que ressource. Un script prolonge la fonctionnalité de tous les objets qui l'instancient.

Il s'agit de la classe de base pour tous les scripts et ne devrait pas être utilisée directement. Essayer de créer un nouveau script avec cette classe entraînera une erreur.

La méthode new d'une sous-classe de script crée une nouvelle instance. Object.set_script() étend un objet existant, si la classe de cet objet correspond à l'une des classes de base du script.

Tutoriels

Propriétés

String

source_code

Méthodes

bool

can_instantiate() const

Script

get_base_script() const

StringName

get_global_name() const

StringName

get_instance_base_type() const

Variant

get_property_default_value(property: StringName)

Variant

get_rpc_config() const

Dictionary

get_script_constant_map()

Array[Dictionary]

get_script_method_list()

Array[Dictionary]

get_script_property_list()

Array[Dictionary]

get_script_signal_list()

bool

has_script_method(method_name: StringName) const

bool

has_script_signal(signal_name: StringName) const

bool

has_source_code() const

bool

instance_has(base_object: Object) const

bool

is_abstract() const

bool

is_tool() const

Error

reload(keep_state: bool = false)

Descriptions des propriétés

String source_code 🔗

  • void set_source_code(value: String)

  • String get_source_code()

Le code source du script ou une chaîne vide si le code source n'est pas disponible. Lorsque défini, ne recharge pas automatiquement l'implémentation de classe.

Descriptions des méthodes

bool can_instantiate() const 🔗

Renvoie true si le script peut être instancié.

Script get_base_script() const 🔗

Renvoie le script directement hérité par ce script.

StringName get_global_name() const 🔗

Renvoie le nom de classe associé au script, s'il y en a un. Renvoie une chaîne vide sinon.

Pour donner au script un nom global, vous pouvez utiliser le mot-clé class_name en GDScript et l'attribut [GlobalClass] en C#.

class_name MonNoeud
extends Node

StringName get_instance_base_type() const 🔗

Renvoie le type de base du script.

Variant get_property_default_value(property: StringName) 🔗

Renvoie la valeur par défaut de la propriété spécifiée.

Variant get_rpc_config() const 🔗

Renvoie un Dictionary associant les noms de méthodes à leur configuration RPC définies par ce script.

Dictionary get_script_constant_map() 🔗

Renvoie un dictionnaire contenant le nom et valeur des constantes.

Array[Dictionary] get_script_method_list() 🔗

Renvoie la liste des méthodes dans ce Script.

Note : Les dictionnaires renvoyés par cette méthode sont formatés de façon identique à ceux renvoyés par Object.get_method_list().

Array[Dictionary] get_script_property_list() 🔗

Renvoie la liste des propriétés dans ce Script.

Note : Les dictionnaires renvoyés par cette méthode sont formatés de façon identique à ceux renvoyés par Object.get_property_list().

Array[Dictionary] get_script_signal_list() 🔗

Returns the list of signals defined in this Script.

Note: The dictionaries returned by this method are formatted identically to those returned by Object.get_signal_list().

bool has_script_method(method_name: StringName) const 🔗

Returns true if the script, or a base class, defines a method with the given name.

bool has_script_signal(signal_name: StringName) const 🔗

Renvoie true si le script, ou sa classe parente, définit un signal avec le nom donné.

bool has_source_code() const 🔗

Renvoie true si le script contient du code source non vide.

Note : Si un script n'a pas de code source, cela ne signifie pas qu'il est invalide ou inutilisable. Par exemple, un GDScript qui a été exporté avec la tokenisation binaire n'a pas de code source, mais se comporte toujours comme prévu et pourrait être instancié. Cela peut être vérifié avec can_instantiate().

bool instance_has(base_object: Object) const 🔗

Obsolète : Compare this script with Object.get_script() instead.

Renvoie true si base_object est une instance de ce script.

bool is_abstract() const 🔗

Renvoie true si le script est un script abstrait. Un script abstrait n'a pas de constructeur et ne peut pas être instancié.

bool is_tool() const 🔗

Renvoie true si le script est un script outil. Un script d'outil peut être exécuté dans l'éditeur.

Error reload(keep_state: bool = false) 🔗

Recharge l'implémentation de classe du script. Renvoie un code d'erreur.