Script

Hereda: Resource < RefCounted < Object

Heredado por: CSharpScript, GDScript, ScriptExtension

Una clase almacenada como recurso.

Descripción

A class stored as a resource. A script extends the functionality of all objects that instantiate it.

This is the base class for all scripts and should not be used directly. Trying to create a new script with this class will result in an error.

The new method of a script subclass creates a new instance. Object.set_script() extends an existing object, if that object's class matches one of the script's base classes.

Tutoriales

Propiedades

String

source_code

Métodos

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_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)

Descripciones de Propiedades

String source_code 🔗

  • void set_source_code(value: String)

  • String get_source_code()

El código fuente del script o una string vacía si el código fuente no está disponible. Cuando está configurado, no recarga la implementación de la clase automáticamente.

Descripciones de Métodos

bool can_instantiate() const 🔗

Devuelve true si el script puede ser instanciado.

Script get_base_script() const 🔗

Devuelve el script directamente heredado por este script.

StringName get_global_name() const 🔗

Returns the class name associated with the script, if there is one. Returns an empty string otherwise.

To give the script a global name, you can use the class_name keyword in GDScript and the [GlobalClass] attribute in C#.

class_name MyNode
extends Node

StringName get_instance_base_type() const 🔗

Devuelve el tipo de base del script.

Variant get_property_default_value(property: StringName) 🔗

Devuelve el valor por defecto de la propiedad especificada.

Variant get_rpc_config() const 🔗

Devuelve un Dictionary que mapea los nombres de los métodos a su configuración RPC definida por este script.

Dictionary get_script_constant_map() 🔗

Devuelve un diccionario que contiene nombres de constantes y sus valores.

Array[Dictionary] get_script_method_list() 🔗

Devuelve la lista de métodos en este Script.

Nota: Los diccionarios devueltos por este método tienen un formato idéntico a los devueltos por Object.get_method_list().

Array[Dictionary] get_script_property_list() 🔗

Devuelve la lista de propiedades en este Script.

Nota: Los diccionarios devueltos por este método tienen un formato idéntico a los devueltos por Object.get_property_list().

Array[Dictionary] get_script_signal_list() 🔗

Devuelve la lista de señales de usuario definidas en este Script.

Nota: Los diccionarios devueltos por este método tienen un formato idéntico a los devueltos por Object.get_signal_list().

bool has_script_signal(signal_name: StringName) const 🔗

Devuelve true si el script, o una clase base, define una señal con el nombre dado.

bool has_source_code() const 🔗

Devuelve true si el script contiene código fuente no vacío.

Nota: Que un script no tenga código fuente no significa que no sea válido o inutilizable. Por ejemplo, un GDScript que fue exportado con tokenización binaria no tiene código fuente, pero aun así se comporta como se espera y puede ser instanciado. Esto puede ser verificado con can_instantiate().

bool instance_has(base_object: Object) const 🔗

Devuelve true si base_object es una instancia de este script.

bool is_abstract() const 🔗

Devuelve true si el script es un script abstracto. Un script abstracto no tiene un constructor y no puede ser instanciado.

bool is_tool() const 🔗

Devuelve true si el script es un script de herramientas. Un script de herramienta puede ejecutarse en el editor.

Error reload(keep_state: bool = false) 🔗

Recarga la implementación de la clase del script. Devuelve un código de error.