Up to date
This page is up to date for Godot 4.2.
If you still find outdated information, please open an issue.
Wie man die Godot-API liest¶
Auf dieser Seite erfahren Sie, wie Sie die Klassenreferenz für die Godot-API lesen können.
Die API (Application Programming Interface) ist ein Verzeichnis dessen, was Godot den Benutzern bietet. Sie enthält eine kurze Zusammenfassung darüber, welche Klassen es gibt, wie sie miteinander in Beziehung stehen, welche Funktionen sie haben und wie sie zu verwenden sind.
Vererbung¶
Am Anfang jeder Datei sehen Sie den Namen der Klasse.
Der Abschnitt "Inherits" listet jede Klasse auf, von der die aktuelle Klasse erbt. Hier erbt CanvasItem von Node und Node erbt von Object.
Der Abschnitt "Inherited By" listet alle Klassen auf, die direkt von der aktuellen Klasse erben. Hier erben Control und Node2D beide von CanvasItem.
Kurzbeschreibung¶
Danach folgt eine kurze Beschreibung der Klasse. Dieser Text erscheint in Godot-Editor-Popups zum Erstellen von Nodes, Ressourcen und anderen Typen.
Beschreibung¶
Es folgt eine detailliertere Beschreibung der Klasse, ihrer Features und ihrer Anwendungsfälle.
Dinge, die Sie hier finden können:
Einzelheiten zur Funktionsweise der Klasse.
Codebeispiele für häufige Anwendungsfälle.
Verwendungsdetails, die von allen Methoden der Klasse gemeinsam genutzt werden.
Warnungen über erforderliche Abhängigkeiten oder Konfigurationen.
Links zu anderen verwandten Teilen der Godot-API.
Tutorials¶
Die Seite enthält dann Links zu Teilen des Handbuchs, in denen die aktuelle Klasse erwähnt oder verwendet wird.
Propertys¶
In der Tabelle "Propertys" sind die Variablen aufgelistet, die zu jeder Instanz der Klasse gehören und auch als "Propertys" bezeichnet werden.
Die linke Spalte enthält den Datentyp der Property. Der Text ist auch ein Link zur Godot-API-Seite für diesen Datentyp.
Die mittlere Spalte enthält den Namen der Property. Der Text ist auch ein Link zur vollständigen Beschreibung dieser Property auf der Seite. Verwenden Sie diesen Namen, um die Daten der Property abzurufen oder ihr einen neuen Wert zuzuweisen.
Die rechte Spalte enthält den Defaultwert der Property. Um sie mit einem anderen Wert zu initialisieren, müssen Sie über ein Skript oder den Inspektor einen anderen Wert festlegen.
Methoden¶
In der Tabelle "Methoden" sind die Funktionen aufgelistet, die zu jeder Instanz der Klasse gehören, auch "Methoden" genannt.
Die linke Spalte enthält den Datentyp des Rückgabewerts der Methode.
Die rechte Spalte enthält den Namen, die Parameter und die Qualifier der Methode. Der Name ist der Text vor der öffnenden Klammer. Er ist auch ein Link zur vollständigen Beschreibung der Methode auf der Seite. Verwenden Sie diesen Namen, um die Methode aufzurufen.
Für jeden Parameter werden auf der Seite der Datentyp, der Name und ggf. der Defaultwert angegeben.
Mögliche Qualifier sind...
const: Die Methode ändert keine Daten in der Klasseninstanz.virtual: Die Methode tut nichts weiter, als darauf zu warten, dass ein Skript sie überschreibt.vararg: die Methode kann eine beliebige Anzahl von Argumenten annehmen.
Signale¶
Die Liste "Signale" enthält die Namen und Parameter von Ereignissen, die anderen Klasseninstanzen eine Änderung des Spielzustands "signalisieren".
Wie in der Methoden-Tabelle werden alle Parameter mit ihrem Datentyp und Namen angegeben.
Zu jedem Signal gibt es auch eine ausführliche Erklärung, wann das Signal ausgesendet wird.
Enumerationen¶
In der Liste "Enumerationen" werden die enumerierbaren Datentypen aufgeführt, die mit der aktuellen Klasse verbunden sind.
Für jede Enumeration gibt die Seite den Namen an und listet dann die möglichen Werte auf.
Für jeden Enumerationswert werden auf der Seite sein Name, sein Integer-Wert und eine Erläuterung seines/ihres Anwendungsfalls und/oder seiner/ihrer Auswirkungen angegeben.
Konstanten¶
Die Liste "Konstanten" enthält Details zu benannten Integer-Konstanten in der aktuellen Klasse.
Für jede Konstante werden auf der Seite ihr Name, ihr Integer-Wert und eine Erläuterung ihres Anwendungsfalls bzw. ihrer Auswirkungen angegeben.
Die Beschreibungen der Konstanten NOTIFICATION_* geben an, welches Engine-Event die Benachrichtigung auslöst.
Property-Beschreibungen¶
Die Liste "Property-Beschreibungen" enthält alle Details zu den einzelnen Propertys.
Sie gibt den Datentyp und den Namen der Property wieder.
Jede Property in der Godot-API ist an ein Paar von Setter- und Getter-Funktionen gebunden. Die Verwendung einer dieser Funktionen ist gleichwertig. Sie sind hier aufgeführt.
Darunter befindet sich eine ausführliche Zusammenfassung dessen, was die Daten der Property repräsentieren, ihr(e) Verwendungszweck(e) und/oder die Auswirkungen einer Änderung der Property. Sie kann Codebeispiele und/oder Links zu relevanten Teilen der Godot-API enthalten.
Bemerkung
Die Kenntnis der Setter- und Getter-Namen ist nützlich, wenn man einen Methodennamen oder Callable an etwas binden muss.
Methodenbeschreibungen¶
In der Liste der Methodenbeschreibungen finden Sie alle Informationen zu den einzelnen Methoden.
Sie gibt den Rückgabedatentyp der Methode, die Parameternamen/Typen/Defaultwerte und die Qualifier an.
Darunter befindet sich eine ausführliche Zusammenfassung der Funktion der Methode und ihres Anwendungsfalls/ihrer Anwendungsfälle. Sie kann Codebeispiele und/oder Links zu relevanten Teilen der Godot-API enthalten.