Class reference primer (original) (raw)

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...

This page explains how to write the class reference. You will learn where to write new descriptions for the classes, methods, and properties for Godot's built-in node types.

The reference for each class is contained in an XML file like the one below:

It starts with brief and long descriptions. In the generated docs, the brief description is always at the top of the page, while the long description lies below the list of methods, variables, and constants. You can find methods, member variables, constants, and signals in separate XML nodes.

For each, you want to learn how they work in Godot's source code. Then, fill their documentation by completing or improving the text in these tags:

• <brief_description>
• (in its tag; return types and arguments don't take separate documentation strings)
• (in its tag; arguments don't take separate documentation strings)

Write in a clear and simple language. Always follow the writing guidelines to keep your descriptions short and easy to read.Do not leave empty lines in the descriptions: each line in the XML file will result in a new paragraph, even if it is empty.

How to edit class XML

Edit the file for your chosen class in doc/classes/ to update the class reference. The folder contains an XML file for each class. The XML lists the constants and methods you will find in the class reference. Godot generates and updates the XML automatically.

Note

For some modules in the engine's source code, you'll find the XML files in the modules/<module_name>/doc_classes/ directory instead.

Edit it using your favorite text editor. If you use a code editor, make sure that it doesn't change the indent style: you should use tabs for the XML and four spaces inside BBCode-style blocks. More on that below.

To check that the modifications you've made are correct in the generated documentation, navigate to the doc/ folder and run the command make rst. This will convert the XML files to the online documentation's format and output errors if anything's wrong.

Alternatively, you can build Godot and open the modified page in the built-in code reference. To learn how to compile the engine, read the compilation guide.

We recommend using a code editor that supports XML files like Vim, Atom, Visual Studio Code, Notepad++, or another to comfortably edit the file. You can also use their search feature to find classes and properties quickly.

Tip

If you use Visual Studio Code, you can install thevscode-xml extensionto get linting for class reference XML files.

Improve formatting with BBCode style tags

Godot's XML class reference supports BBCode-like tags for linking as well as formatting text and code. In the tables below you can find the available tags, usage examples and the results after conversion to reStructuredText.

Linking

Whenever you link to a member of another class, you need to specify the class name. For links to the same class, the class name is optional and can be omitted.

Note

Currently only @GDScript has annotations.

Formatting text

Note

1. Some supported tags like [color] and [font] are not listed here because they are not recommended in the engine documentation.
2. [kbd] disables BBCode until the parser encounters [/kbd].
3. [code] disables BBCode until the parser encounters [/code].

Formatting code blocks

There are two options for formatting code blocks:

1. Use [codeblock] if you want to add an example for a specific language.
2. Use [codeblocks], [gdscript], and [csharp] if you want to add the same example for both languages, GDScript and C#.

By default, [codeblock] highlights GDScript syntax. You can change it using the lang attribute. Currently supported options are:

• [codeblock lang=text] disables syntax highlighting;
• [codeblock lang=gdscript] highlights GDScript syntax;
• [codeblock lang=csharp] highlights C# syntax (only in .NET version).

Note

[codeblock] disables BBCode until the parser encounters [/codeblock].

Warning

Use [codeblock] for pre-formatted code blocks. Inside [codeblock], always use four spaces for indentation. The parser will delete tabs.

For example:

[codeblock] func _ready(): var sprite = get_node("Sprite2D") print(sprite.get_pos()) [/codeblock]

Will display as:

func _ready(): var sprite = get_node("Sprite2D") print(sprite.get_pos())

If you need to have different code version in GDScript and C#, use[codeblocks] instead. If you use [codeblocks], you also need to have at least one of the language-specific tags, [gdscript] and [csharp].

Always write GDScript code examples first! You can use this experimental code translation tool to speed up your workflow.

[codeblocks] [gdscript] func _ready(): var sprite = get_node("Sprite2D") print(sprite.get_pos()) [/gdscript] [csharp] public override void _Ready() { var sprite = GetNode("Sprite2D"); GD.Print(sprite.GetPos()); } [/csharp] [/codeblocks]

The above will display as:

func _ready(): var sprite = get_node("Sprite2D") print(sprite.get_pos())

Formatting notes and warnings

To denote important information, add a paragraph starting with "[b]Note:[/b]" at the end of the description:

[b]Note:[/b] Only available when using the Vulkan renderer.

To denote crucial information that could cause security issues or loss of data if not followed carefully, add a paragraph starting with "[b]Warning:[/b]" at the end of the description:

[b]Warning:[/b] If this property is set to [code]true[/code], it allows clients to execute arbitrary code on the server.

In all the paragraphs described above, make sure the punctuation is part of the BBCode tags for consistency.

Marking API as deprecated/experimental

To mark an API as deprecated or experimental, you need to add the corresponding XML attribute. The attribute value must be a message explaining why the API is not recommended (BBCode markup is supported) or an empty string (the default message will be used). If an API element is marked as deprecated/experimental, then it is considered documented even if the description is empty.