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.

Script

Eredita: Resource < RefCounted < Object

Ereditato da: CSharpScript, GDScript, ScriptExtension

Una classe memorizzata come risorsa.

Descrizione

Una classe memorizzata come risorsa. Uno script estende la funzionalità di tutti gli oggetti che lo istanziano.

Questa è la classe di base per tutti gli script e non dovrebbe essere utilizzata direttamente. Tentare di creare un nuovo script con questa classe causerà un errore.

Il metodo new di una sottoclasse di script crea una nuova istanza. Object.set_script() estende un oggetto esistente, se la classe di quell'oggetto corrisponde a una delle classi di base dello script.

Tutorial

Proprietà

String

source_code

Metodi

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)


Descrizioni delle proprietà

String source_code 🔗

  • void set_source_code(value: String)

  • String get_source_code()

Il codice sorgente dello script o una stringa vuota se il codice sorgente non è disponibile. Quando impostato, non ricarica automaticamente l'implementazione della classe.


Descrizioni dei metodi

bool can_instantiate() const 🔗

Restituisce true se lo script può essere istanziato.


Script get_base_script() const 🔗

Restituisce lo script direttamente ereditato da questo script.


StringName get_global_name() const 🔗

Restituisce il nome della classe associata allo script, se presente. Altrimenti, restituisce una stringa vuota.

Per assegnare un nome globale allo script, puoi usare la parola chiave class_name in GDScript e l'attributo [GlobalClass] in C#.

class_name MyNode
extends Node

StringName get_instance_base_type() const 🔗

Restituisce il tipo base dello script.


Variant get_property_default_value(property: StringName) 🔗

Restituisce il valore predefinito della proprietà specificata.


Variant get_rpc_config() const 🔗

Restituisce un Dictionary che mappa i nomi dei metodi alla loro configurazione RPC definita da questo script.


Dictionary get_script_constant_map() 🔗

Restituisce un dizionario contenente i nomi delle costanti e i relativi valori.


Array[Dictionary] get_script_method_list() 🔗

Restituisce la lista dei metodi in questo Script.

Nota: I dizionari restituiti da questo metodo sono formattati in modo identico a quelli restituiti da Object.get_method_list().


Array[Dictionary] get_script_property_list() 🔗

Restituisce la lista delle proprietà in questo Script.

Nota: I dizionari restituiti da questo metodo sono formattati in modo identico a quelli restituiti da 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 🔗

Restituisce true se lo script, o una classe base, definisce un segnale con il nome specificato.


bool has_source_code() const 🔗

Restituisce true se lo script contiene codice sorgente non vuoto.

Nota: Se uno script non ha codice sorgente, ciò non significa che non sia valido o inutilizzabile. Ad esempio, un GDScript esportato con tokenizzazione binaria non ha codice sorgente, ma si comporta comunque come previsto e può essere istanziato. Questo può essere verificato con can_instantiate().


bool instance_has(base_object: Object) const 🔗

Deprecato: Compare this script with Object.get_script() instead.

Restituisce true se base_object è un'istanza di questo script.


bool is_abstract() const 🔗

Restituisce true se lo script è uno script astratto. Uno script astratto non ha un costruttore e non può essere istanziato.


bool is_tool() const 🔗

Restituisce true se lo script è uno script di strumento. Uno script di strumento può eseguirsi nell'editor.


Error reload(keep_state: bool = false) 🔗

Ricarica l'implementazione della classe dello script. Restituisce un codice di errore.