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...
Come leggere l'API di Godot
In questa pagina, imparerai come leggere il riferimento alle classi per l'API di Godot.
L'API, o Application Programming Interface, è un indice di ciò che Godot offre agli utenti. Fornisce un breve riepilogo delle classi esistenti, di come sono correlate tra loro, delle loro funzionalità e di come utilizzarle.
Ereditarietà
In alto a ogni file, vedrai il nome della classe.
La sezione "Eredita" elenca ogni classe ereditata da quella attuale. Qui CanvasItem eredita Node e Node eredita Object.
La sezione "Ereditato da" elenca ciascuna classe che eredita direttamente la classe attuale. Qui Control e Node2D ereditano entrambi CanvasItem.
Breve descrizione
Segue una breve descrizione della classe. Questo testo appare nei popup dell'editor Godot per la creazione di nodi, risorse e altri tipi.
Descrizione
Successivamente una descrizione più dettagliata della classe, delle sue caratteristiche e dei suoi casi d'uso.
Cose che potresti trovare qui:
Dettagli su come funziona la classe.
Esempi di codice di casi d'uso comuni.
Dettagli di utilizzo condivisi tra ciascuno dei metodi della classe.
Avvertimenti riguardo le dipendenze o la configurazione richiesta.
Collegamenti ad altre parti correlate dell'API di Godot.
Tutorial
La pagina fornisce poi collegamenti alle parti del manuale che menzionano o utilizzano la classe attuale.
Proprietà
Nella tabella Proprietà sono elencate le variabili che appartengono a ciascuna istanza della classe, note anche come "proprietà".
La colonna sinistra contiene il tipo di dato della proprietà. Il testo è anche un collegamento alla pagina dell'API di Godot riguardo quel tipo di dato.
La colonna centrale contiene il nome della proprietà. Il testo è anche un collegamento alla descrizione completa della proprietà nella pagina. Utilizza questo nome per ottenere i dati della proprietà o impostarne un nuovo valore.
La colonna destra contiene il valore predefinito della proprietà. Per inizializzarla con un valore diverso, è necessario impostarne uno diverso tramite script o tramite l'Ispettore.
Metodi
Nella tabella Metodi sono elencate le funzioni che appartengono a ciascuna istanza della classe, note anche come "metodi".
La colonna sinistra contiene il tipo di dato del valore restituito dal metodo.
La colonna destra contiene il nome, i parametri e i qualificatori del metodo. Il nome è il testo prima della parentesi aperta. È anche un collegamento alla descrizione completa del metodo nella pagina. Utilizza questo nome per richiamare il metodo.
Per ogni parametro, la pagina ne specifica il tipo di dato, il nome, e il valore predefinito se presente.
I possibili qualificatori includono...
const: il metodo non cambia alcun dato nell'istanza della classe.virtual: il metodo non fa altro che attendere che uno script lo sovrascriva.vararg: il metodo può accettare un numero arbitrario di argomenti.
Segnali
L'elenco dei Segnali riporta i nomi e i parametri degli eventi che "segnalano" un cambiamento nello stato del gioco ad altre istanze di classe.
Come la tabella Metodi, tutti i parametri includeranno il tipo di dato e il nome.
Inoltre, ogni segnale include una spiegazione dettagliata di quando viene emesso.
Enumerazioni
L'elenco delle Enumerazioni descrive in dettaglio i tipi di dati enumerabili associati alla classe attuale.
Per ogni enumerazione, la pagina ne indica il nome e poi elenca i possibili valori.
Per ogni valore di enumerazione, la pagina ne indica il nome, il valore intero e una spiegazione dei casi d'uso e/o degli effetti.
Costanti
L'elenco delle Costanti descrive in dettaglio le costanti intere denominate nella classe attuale.
Per ogni costante, la pagina ne indica il nome, il valore intero e una spiegazione dei casi d'uso e/o degli effetti.
Le descrizioni delle costanti NOTIFICATION_* indicheranno quale evento del motore attiva la notifica.
Descrizioni delle proprietà
L'elenco delle descrizioni delle proprietà fornisce informazioni dettagliate su ciascuna proprietà.
Ribadisce il tipo di dato e il nome della proprietà.
Ogni proprietà nell'API di Godot è associata a una coppia di funzioni setter e getter. L'utilizzo di una delle due è equivalente. Le funzioni sono elencate qui.
Di seguito è riportato un riepilogo dettagliato di ciò che rappresentano i dati della proprietà, dei suoi casi d'uso e/o degli effetti delle modifiche. Potrebbe includere esempi di codice e/o collegamenti a parti pertinenti all'API di Godot.
Nota
Conoscere i nomi dei setter e dei getter è utile quando si deve associare il nome di un metodo o Callable a qualcosa.
Descrizioni dei metodi
L'elenco delle descrizioni dei metodi fornisce informazioni dettagliate su ciascun metodo.
Ribadisce il tipo di dato restituito dal metodo, i nomi/tipi/valori predefiniti dei parametri e i qualificatori.
Di seguito è riportato un riepilogo dettagliato di cosa fa il metodo e dei suoi casi d'uso. Potrebbe includere esempi di codice e/o collegamenti a parti pertinenti all'API di Godot.