Files
godot-docs-l10n/sphinx/templates/engine_details/class_reference/index.pot
2025-12-19 15:00:42 +01:00

577 lines
19 KiB
Plaintext

# SOME DESCRIPTIVE TITLE.
# Copyright (C) 2014-present Juan Linietsky, Ariel Manzur and the Godot community (CC BY 3.0)
# This file is distributed under the same license as the Godot Engine package.
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: Godot Engine latest\n"
"Report-Msgid-Bugs-To: \n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#: ../../docs/engine_details/class_reference/index.rst:4
msgid "Class reference primer"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:6
msgid "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."
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:12
msgid "To learn to submit your changes to the Godot project using the Git version control system, see `Class reference contribution documentation <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__."
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:15
msgid "The reference for each class is contained in an XML file like the one below:"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:65
msgid "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."
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:70
msgid "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:"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:73
msgid "`<brief_description>`"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:74
msgid "`<description>`"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:75
#: ../../docs/engine_details/class_reference/index.rst:80
msgid "`<constant>`"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:76
msgid "`<method>` (in its `<description>` tag; return types and arguments don't take separate documentation strings)"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:78
msgid "`<member>`"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:79
msgid "`<signal>` (in its `<description>` tag; arguments don't take separate documentation strings)"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:82
msgid "Write in a clear and simple language. Always follow the `writing guidelines <https://contributing.godotengine.org/en/latest/documentation/guidelines/docs_writing_guidelines.html>`__ 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."
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:91
msgid "How to edit class XML"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:93
msgid "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."
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:98
msgid "For some modules in the engine's source code, you'll find the XML files in the ``modules/<module_name>/doc_classes/`` directory instead."
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:101
msgid "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."
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:105
msgid "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."
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:110
msgid "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 :ref:`compilation guide <toc-devel-compiling>`."
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:114
msgid "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."
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:120
msgid "If you use Visual Studio Code, you can install the `vscode-xml extension <https://marketplace.visualstudio.com/items?itemName=redhat.vscode-xml>`__ to get linting for class reference XML files."
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:127
msgid "Improve formatting with BBCode style tags"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:129
msgid "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."
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:133
msgid "Linking"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:135
msgid "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."
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:139
#: ../../docs/engine_details/class_reference/index.rst:183
msgid "Tag and Description"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:139
#: ../../docs/engine_details/class_reference/index.rst:183
msgid "Example"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:139
#: ../../docs/engine_details/class_reference/index.rst:183
msgid "Result"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "``[Class]``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "Link to class"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:141
msgid "``Move the [Sprite2D].``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:141
msgid "Move the :ref:`class_Sprite2D`."
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "``[annotation Class.name]``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "Link to annotation"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:144
msgid "``See [annotation @GDScript.@rpc].``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:144
msgid "See :ref:`@GDScript.@rpc <class_@GDScript_annotation_@rpc>`."
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "``[constant Class.name]``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "Link to constant"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:147
msgid "``See [constant Color.RED].``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:147
msgid "See :ref:`Color.RED <class_Color_constant_RED>`."
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "``[enum Class.name]``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "Link to enum"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:150
msgid "``See [enum Mesh.ArrayType].``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:150
msgid "See :ref:`Mesh.ArrayType <enum_Mesh_ArrayType>`."
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "``[member Class.name]``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "Link to member"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:153
msgid "``Get [member Node2D.scale].``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:153
msgid "Get :ref:`Node2D.scale <class_Node2D_property_scale>`."
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "``[method Class.name]``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "Link to method"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:156
msgid "``Call [method Node3D.hide].``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:156
msgid "Call :ref:`Node3D.hide() <class_Node3D_method_hide>`."
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "``[constructor Class.name]``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "Link to built-in constructor"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:159
msgid "``Use [constructor Color.Color].``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:159
msgid "Use :ref:`Color.Color <class_Color_constructor_Color>`."
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "``[operator Class.name]``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "Link to built-in operator"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:162
msgid "``Use [operator Color.operator *].``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:162
msgid "Use :ref:`Color.operator * <class_Color_operator_mul_int>`."
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "``[signal Class.name]``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "Link to signal"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:165
msgid "``Emit [signal Node.renamed].``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:165
msgid "Emit :ref:`Node.renamed <class_Node_signal_renamed>`."
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "``[theme_item Class.name]``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "Link to theme item"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:168
msgid "``See [theme_item Label.font].``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:168
msgid "See :ref:`Label.font <class_Label_theme_font_font>`."
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "``[param name]``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "Parameter name (as code)"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:171
msgid "``Takes [param size] for the size.``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:171
msgid "Takes ``size`` for the size."
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:177
msgid "Currently only :ref:`class_@GDScript` has annotations."
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:180
msgid "Formatting text"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "``[br]``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "Line break"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "``Line 1.[br]``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "``Line 2.``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "Line 1."
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "Line 2."
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "``[lb]`` ``[rb]``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "``[`` and ``]`` respectively"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:188
msgid "``[lb]b[rb]text[lb]/b[rb]``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:188
msgid "[b]text[/b]"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "``[b]`` ``[/b]``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "Bold"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:191
msgid "``Do [b]not[/b] call this method.``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:191
msgid "Do **not** call this method."
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "``[i]`` ``[/i]``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "Italic"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:194
msgid "``Returns the [i]global[/i] position.``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:194
msgid "Returns the *global* position."
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "``[u]`` ``[/u]``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "Underline"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:197
msgid "``[u]Always[/u] use this method.``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "``[s]`` ``[/s]``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "Strikethrough"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:201
msgid "``[s]Outdated information.[/s]``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "``[url]`` ``[/url]``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "Hyperlink"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "``[url]https://example.com[/url]``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "``[url=https://example.com]Website[/url]``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "https://example.com"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "`Website <https://example.com>`_"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "``[center]`` ``[/center]``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "Horizontal centering"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:208
msgid "``[center]2 + 2 = 4[/center]``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "``[kbd]`` ``[/kbd]``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "Keyboard/mouse shortcut"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:212
msgid "``Press [kbd]Ctrl + C[/kbd].``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:212
msgid "Press :kbd:`Ctrl + C`."
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "``[code]`` ``[/code]``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:0
msgid "Inline code fragment"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:215
msgid "``Returns [code]true[/code].``"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:215
msgid "Returns ``true``."
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:221
msgid "Some supported tags like ``[color]`` and ``[font]`` are not listed here because they are not recommended in the engine documentation."
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:222
msgid "``[kbd]`` disables BBCode until the parser encounters ``[/kbd]``."
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:223
msgid "``[code]`` disables BBCode until the parser encounters ``[/code]``."
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:226
msgid "Formatting code blocks"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:228
msgid "There are two options for formatting code blocks:"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:230
msgid "Use ``[codeblock]`` if you want to add an example for a specific language."
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:231
msgid "Use ``[codeblocks]``, ``[gdscript]``, and ``[csharp]`` if you want to add the same example for both languages, GDScript and C#."
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:233
msgid "By default, ``[codeblock]`` highlights GDScript syntax. You can change it using the ``lang`` attribute. Currently supported options are:"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:236
msgid "``[codeblock lang=text]`` disables syntax highlighting;"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:237
msgid "``[codeblock lang=gdscript]`` highlights GDScript syntax;"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:238
msgid "``[codeblock lang=csharp]`` highlights C# syntax (only in .NET version)."
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:242
msgid "``[codeblock]`` disables BBCode until the parser encounters ``[/codeblock]``."
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:246
msgid "Use ``[codeblock]`` for pre-formatted code blocks. Since Godot 4.5, **tabs** should be used for indentation."
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:249
msgid "For example:"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:259
msgid "Will display as:"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:267
msgid "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]``."
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:271
msgid "Always write GDScript code examples first! You can use this `experimental code translation tool <https://github.com/HaSa1002/codetranslator>`_ to speed up your workflow."
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:292
msgid "The above will display as:"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:310
msgid "Formatting notes and warnings"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:312
msgid "To denote important information, add a paragraph starting with \"[b]Note:[/b]\" at the end of the description:"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:319
msgid "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:"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:327
msgid "In all the paragraphs described above, make sure the punctuation is part of the BBCode tags for consistency."
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:331
msgid "Marking API as deprecated/experimental"
msgstr ""
#: ../../docs/engine_details/class_reference/index.rst:333
msgid "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."
msgstr ""