Up to date
This page is up to date for Godot 4.2
.
If you still find outdated information, please open an issue.
Einführung in die Klassenreferenz¶
Auf dieser Seite wird erklärt, wie man die Klassenreferenz schreibt. Sie erfahren, wo Sie neue Beschreibungen für die Klassen, Methoden und Propertys für Godots Built-in-Node-Typen schreiben können.
Siehe auch
Wie Sie Ihre Änderungen mit dem Git-Versionskontrollsystem an das Godot-Projekt übermitteln können, erfahren Sie unter Beitragen zur Klassenreferenz.
Die Referenz für jede Klasse ist in einer XML-Datei wie der folgenden enthalten:
<class name="Node2D" inherits="CanvasItem" version="4.0">
<brief_description>
A 2D game object, inherited by all 2D-related nodes. Has a position, rotation, scale, and Z index.
</brief_description>
<description>
A 2D game object, with a transform (position, rotation, and scale). All 2D nodes, including physics objects and sprites, inherit from Node2D. Use Node2D as a parent node to move, scale and rotate children in a 2D project. Also gives control of the node's render order.
</description>
<tutorials>
<link title="Custom drawing in 2D">https://docs.godotengine.org/en/latest/tutorials/2d/custom_drawing_in_2d.html</link>
<link title="All 2D Demos">https://github.com/godotengine/godot-demo-projects/tree/master/2d</link>
</tutorials>
<methods>
<method name="apply_scale">
<return type="void">
</return>
<argument index="0" name="ratio" type="Vector2">
</argument>
<description>
Multiplies the current scale by the [code]ratio[/code] vector.
</description>
</method>
[...]
<method name="translate">
<return type="void">
</return>
<argument index="0" name="offset" type="Vector2">
</argument>
<description>
Translates the node by the given [code]offset[/code] in local coordinates.
</description>
</method>
</methods>
<members>
<member name="global_position" type="Vector2" setter="set_global_position" getter="get_global_position">
Global position.
</member>
[...]
<member name="z_index" type="int" setter="set_z_index" getter="get_z_index" default="0">
Z index. Controls the order in which the nodes render. A node with a higher Z index will display in front of others.
</member>
</members>
<constants>
</constants>
</class>
Es beginnt mit kurzen und langen Beschreibungen. In den generierten Dokumenten steht die Kurzbeschreibung immer oben auf der Seite, während die Langbeschreibung unterhalb der Liste der Methoden, Variablen und Konstanten steht. Methoden, Membervariablen, Konstanten und Signale finden Sie in separaten XML-Nodes.
Für jedes dieser Elemente müssen Sie herausfinden, wie es im Quellcode von Godot funktioniert. Füllen Sie dann ihre Dokumentation aus, indem Sie den Text in diesen Tags vervollständigen oder verbessern:
<brief_description>
<description>
<constant>
<method> (in ihrem <description>-Tag; Rückgabetypen und Argumente benötigen keine separaten Dokumentationsstrings)
<member>
<signal> (in seinem <description>-Tag); Argumente benötigen keine separaten Dokumentationsstrings)
<constant>
Schreiben Sie in einer klaren und einfachen Sprache. Befolgen Sie immer die Schreibrichtlinien, um Ihre Beschreibungen kurz und leicht lesbar zu halten. Lassen Sie keine Leerzeilen in den Beschreibungen: Jede Zeile in der XML-Datei ergibt einen neuen Absatz, auch wenn sie leer ist.
Wie man Klassen-XMLs bearbeitet¶
Bearbeiten Sie die Datei für die von Ihnen gewählte Klasse in doc/classes/
, um die Klassenreferenz zu aktualisieren. Der Ordner enthält eine XML-Datei für jede Klasse. In der XML-Datei sind die Konstanten und Methoden aufgeführt, die Sie in der Klassenreferenz finden. Godot generiert und aktualisiert die XML-Datei automatisch.
Bemerkung
Für einige Module im Quellcode der Engine finden Sie die XML-Dateien stattdessen im Verzeichnis modules/<module_name>/doc_classes/
.
Bearbeiten Sie sie mit Ihrem bevorzugten Texteditor. Wenn Sie einen Code-Editor verwenden, stellen Sie sicher, dass dieser den Einrückungsstil nicht ändert: Sie sollten Tabulatoren für die XML und vier Leerzeichen innerhalb von Blöcken im BBCode-Stil verwenden. Mehr dazu weiter unten.
Um zu überprüfen, ob die von Ihnen vorgenommenen Änderungen in der generierten Dokumentation korrekt sind, navigieren Sie zum Ordner doc/
und führen Sie den Befehl make rst
aus. Dies wird die XML-Dateien in das Format der Online-Dokumentation konvertieren und Fehler ausgeben, falls etwas nicht stimmt.
Alternativ dazu können Sie Godot kompilieren und die geänderte Seite in der eingebauten Code-Referenz öffnen. Um zu erfahren, wie man die Engine kompiliert, lesen Sie den Kompilier-Anleitung.
Wir empfehlen die Verwendung eines Code-Editors, der XML-Dateien unterstützt, wie Vim, Atom, Visual Studio Code, Notepad++ oder andere, um die Datei bequem zu bearbeiten. Sie können auch deren Suchfunktion verwenden, um Klassen und Propertys schnell zu finden.
Tipp
Wenn Sie Visual Studio Code verwenden, können Sie die vscode-xml-Erweiterung installieren, um Linting für Klassenreferenz-XML-Dateien zu erhalten.