stan220/godot-docs
1
0
Fork 0
mirror of https://github.com/stan220/godot-docs.git synced 2026-09-08 18:29:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

Standardize RST header syntax

Browse Source
This commit is contained in:
tetrapod00
2024-12-29 13:44:09 -08:00
parent 56a3dc697f
commit c4d3aa134a
101 changed files with 695 additions and 694 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tutorials/migrating/upgrading_to_godot_4.1.rst
+10 -10
View File
@@ -28,7 +28,7 @@ the C# breaking change is *binary compatible* or *source compatible*:
upgrading Godot.
Core
^^^^
~~~~
======================================================================================================================== =================== ==================== ==================== ===========
Change GDScript Compatible C# Binary Compatible C# Source Compatible Introduced
@@ -46,7 +46,7 @@ Method ``wait_for_task_completion`` changes return type from ``void`` to ``Error
======================================================================================================================== =================== ==================== ==================== ===========
Animation
^^^^^^^^^
~~~~~~~~~
======================================================================================================================== =================== ==================== ==================== ===========
Change GDScript Compatible C# Binary Compatible C# Source Compatible Introduced
@@ -60,7 +60,7 @@ Method ``get_travel_path`` changes return type from ``PackedStringArray`` to ``A
======================================================================================================================== =================== ==================== ==================== ===========
2D nodes
^^^^^^^^
~~~~~~~~
======================================================================================================================== =================== ==================== ==================== ===========
Change GDScript Compatible C# Binary Compatible C# Source Compatible Introduced
@@ -70,7 +70,7 @@ Property ``lookahead`` removed
======================================================================================================================== =================== ==================== ==================== ===========
3D nodes
^^^^^^^^
~~~~~~~~
======================================================================================================================== =================== ==================== ==================== ===========
Change GDScript Compatible C# Binary Compatible C# Source Compatible Introduced
@@ -85,7 +85,7 @@ Method ``look_at_from_position`` adds a new ``use_model_front`` optional paramet
======================================================================================================================== =================== ==================== ==================== ===========
GUI nodes
^^^^^^^^^
~~~~~~~~~
======================================================================================================================== =================== ==================== ==================== ===========
Change GDScript Compatible C# Binary Compatible C# Source Compatible Introduced
@@ -101,7 +101,7 @@ Method ``edit_selected`` adds a new ``force_edit`` optional parameter
======================================================================================================================== =================== ==================== ==================== ===========
Physics
^^^^^^^
~~~~~~~
======================================================================================================================== =================== ==================== ==================== ===========
Change GDScript Compatible C# Binary Compatible C# Source Compatible Introduced
@@ -117,7 +117,7 @@ Method ``collide_shape`` changes return type from ``Array[PackedVector3Array]``
======================================================================================================================== =================== ==================== ==================== ===========
Rendering
^^^^^^^^^
~~~~~~~~~
======================================================================================================================== =================== ==================== ==================== ===========
Change GDScript Compatible C# Binary Compatible C# Source Compatible Introduced
@@ -133,7 +133,7 @@ Method ``add_triangle_fan`` changes ``tangents`` parameter type from untyped ``A
======================================================================================================================== =================== ==================== ==================== ===========
Navigation
^^^^^^^^^^
~~~~~~~~~~
======================================================================================================================== =================== ==================== ==================== ===========
Change GDScript Compatible C# Binary Compatible C# Source Compatible Introduced
@@ -163,7 +163,7 @@ Method ``agent_set_time_horizon`` split into ``agent_set_time_horizon_agents`` a
======================================================================================================================== =================== ==================== ==================== ===========
Networking
^^^^^^^^^^
~~~~~~~~~~
======================================================================================================================== =================== ==================== ==================== ===========
Change GDScript Compatible C# Binary Compatible C# Source Compatible Introduced
@@ -173,7 +173,7 @@ Method ``_create_data_channel`` changes return type from ``Object`` to ``WebRTCD
======================================================================================================================== =================== ==================== ==================== ===========
Editor plugins
^^^^^^^^^^^^^^
~~~~~~~~~~~~~~
======================================================================================================================== =================== ==================== ==================== ===========
Change GDScript Compatible C# Binary Compatible C# Source Compatible Introduced
tutorials/migrating/upgrading_to_godot_4.2.rst
+8 -8
View File
@@ -49,7 +49,7 @@ the C# breaking change is *binary compatible* or *source compatible*:
upgrading Godot.
Core
^^^^
~~~~
======================================================================================================================== =================== ==================== ==================== ===========
Change GDScript Compatible C# Binary Compatible C# Source Compatible Introduced
@@ -59,7 +59,7 @@ Constant ``NOTIFICATION_NODE_RECACHE_REQUESTED`` removed
======================================================================================================================== =================== ==================== ==================== ===========
Animation
^^^^^^^^^
~~~~~~~~~
======================================================================================================================== =================== ==================== ==================== ===========
Change GDScript Compatible C# Binary Compatible C# Source Compatible Introduced
@@ -111,7 +111,7 @@ Property ``tree_root`` changes type from ``AnimationNode`` to ``AnimationRootNod
======================================================================================================================== =================== ==================== ==================== ===========
GUI nodes
^^^^^^^^^
~~~~~~~~~
======================================================================================================================== =================== ==================== ==================== ===========
Change GDScript Compatible C# Binary Compatible C# Source Compatible Introduced
@@ -125,7 +125,7 @@ Method ``add_image`` adds new ``key``, ``pad``, ``tooltip``, and ``size_in_perce
======================================================================================================================== =================== ==================== ==================== ===========
Rendering
^^^^^^^^^
~~~~~~~~~
======================================================================================================================== =================== ==================== ==================== ===========
Change GDScript Compatible C# Binary Compatible C# Source Compatible Introduced
@@ -147,7 +147,7 @@ Method ``commit`` changes ``flags`` parameter type from ``uint32`` to ``uint64``
======================================================================================================================== =================== ==================== ==================== ===========
Text
^^^^
~~~~
==================================================================================================================================== =================== ==================== ==================== ===========
Change GDScript Compatible C# Binary Compatible C# Source Compatible Introduced
@@ -159,7 +159,7 @@ Method ``find_variation`` adds new ``spacing_top``, ``spacing_bottom``, ``spacin
==================================================================================================================================== =================== ==================== ==================== ===========
GraphEdit
^^^^^^^^^
~~~~~~~~~
======================================================================================================================== =================== ==================== ==================== ===========
Change GDScript Compatible C# Binary Compatible C# Source Compatible Introduced
@@ -203,7 +203,7 @@ Property ``text_direction`` removed
======================================================================================================================== =================== ==================== ==================== ===========
TileMap
^^^^^^^
~~~~~~~
======================================================================================================================== =================== ==================== ==================== ===========
Change GDScript Compatible C# Binary Compatible C# Source Compatible Introduced
@@ -213,7 +213,7 @@ Property ``cell_quadrant_size`` renamed to ``rendering_quadrant_size``
======================================================================================================================== =================== ==================== ==================== ===========
XR
^^
~~
======================================================================================================================== =================== ==================== ==================== ===========
Change GDScript Compatible C# Binary Compatible C# Source Compatible Introduced
tutorials/migrating/upgrading_to_godot_4.3.rst
+18 -18
View File
@@ -22,7 +22,7 @@ the C# breaking change is *binary compatible* or *source compatible*:
upgrading Godot.
GDExtension
^^^^^^^^^^^
~~~~~~~~~~~
======================================================================================================================== =================== ==================== ==================== ===========
Change GDScript Compatible C# Binary Compatible C# Source Compatible Introduced
@@ -36,7 +36,7 @@ Method ``open_library`` removed
Since it was basically impossible to use these methods in any useful way, these methods have been removed. Use ``GDExtensionManager::load_extension`` and ``GDExtensionManager::unload_extension`` instead to correctly load and unload a GDExtension.
Animation
^^^^^^^^^
~~~~~~~~~
======================================================================================================================== =================== ==================== ==================== ===========
Change GDScript Compatible C# Binary Compatible C# Source Compatible Introduced
@@ -59,7 +59,7 @@ Method ``on_bone_pose_update`` replaced by ``on_skeleton_update``
======================================================================================================================== =================== ==================== ==================== ===========
GUI nodes
^^^^^^^^^
~~~~~~~~~
======================================================================================================================== =================== ==================== ==================== ===========
Change GDScript Compatible C# Binary Compatible C# Source Compatible Introduced
@@ -70,7 +70,7 @@ Method ``remove_button`` changes parameter ``button`` type from ``Control`` to `
======================================================================================================================== =================== ==================== ==================== ===========
Physics
^^^^^^^
~~~~~~~
======================================================================================================================== =================== ==================== ==================== ===========
Change GDScript Compatible C# Binary Compatible C# Source Compatible Introduced
@@ -85,7 +85,7 @@ Property ``motion`` changes type from ``Vector2`` to ``Vector3``
detects the enum prefix. New members were added in `GH-89851`_ to the enum that caused the enum members to be renamed.
Rendering
^^^^^^^^^
~~~~~~~~~
======================================================================================================================== =================== ==================== ==================== ===========
Change GDScript Compatible C# Binary Compatible C# Source Compatible Introduced
@@ -131,7 +131,7 @@ Method ``get_velocity_texture`` adds a new ``msaa`` optional parameter
renamed.
Text
^^^^
~~~~
======================================================================================================================== =================== ==================== ==================== ===========
Change GDScript Compatible C# Binary Compatible C# Source Compatible Introduced
@@ -147,7 +147,7 @@ Method ``_shaped_text_get_word_breaks`` adds a new ``skip_grapheme_flags`` param
======================================================================================================================== =================== ==================== ==================== ===========
Audio
^^^^^
~~~~~
======================================================================================================================== =================== ==================== ==================== ===========
Change GDScript Compatible C# Binary Compatible C# Source Compatible Introduced
@@ -157,7 +157,7 @@ Method ``play_stream`` adds new ``playback_type``, and ``bus`` optional paramete
======================================================================================================================== =================== ==================== ==================== ===========
Navigation
^^^^^^^^^^
~~~~~~~~~~
======================================================================================================================== =================== ==================== ==================== ===========
Change GDScript Compatible C# Binary Compatible C# Source Compatible Introduced
@@ -184,7 +184,7 @@ Method ``set_avoidance_layer_value`` removed
replacement.
TileMap
^^^^^^^
~~~~~~~
======================================================================================================================== =================== ==================== ==================== ===========
Change GDScript Compatible C# Binary Compatible C# Source Compatible Introduced
@@ -195,7 +195,7 @@ Method ``get_occluder`` adds new ``flip_h``, ``flip_v``, and ``transpose`` optio
======================================================================================================================== =================== ==================== ==================== ===========
XR
^^
~~
======================================================================================================================== =================== ==================== ==================== ===========
Change GDScript Compatible C# Binary Compatible C# Source Compatible Introduced
@@ -207,7 +207,7 @@ Method ``get_tracker`` changes return type from ``XRPositionalTracker`` to ``XRT
======================================================================================================================== =================== ==================== ==================== ===========
Editor plugins
^^^^^^^^^^^^^^
~~~~~~~~~~~~~~
======================================================================================================================== =================== ==================== ==================== ===========
Change GDScript Compatible C# Binary Compatible C# Source Compatible Introduced
@@ -227,7 +227,7 @@ Behavior changes
In 4.3 some behavior changes have been introduced, which might require you to adjust your project.
Core
^^^^
~~~~
.. note::
@@ -259,7 +259,7 @@ Core
of the operating system that the program is running on.
Animation
^^^^^^^^^
~~~~~~~~~
.. note::
@@ -277,7 +277,7 @@ More information about the changes to Animation can be found in the
article.
GUI nodes
^^^^^^^^^
~~~~~~~~~
.. note::
@@ -291,7 +291,7 @@ GUI nodes
are children of a node with the ``auto_translate`` property set to ``false``.
Multiplayer
^^^^^^^^^^^
~~~~~~~~~~~
.. note::
@@ -303,7 +303,7 @@ Multiplayer
Note that high-level multiplayer facilities are only ever meant to be compatible with server and client using the same Godot version. It is recommended to implement some kind of version checking.
Rendering
^^^^^^^^^
~~~~~~~~~
.. note::
@@ -318,14 +318,14 @@ Rendering
article for more information and guidance on how to fix common scenarios.
TileMap
^^^^^^^
~~~~~~~
.. note::
``TileMap`` layers were moved to individual nodes (`GH-87379`_ and `GH-89179`_).
Android
^^^^^^^
~~~~~~~
.. note::
tutorials/migrating/upgrading_to_godot_4.rst
+12 -12
View File
@@ -10,7 +10,7 @@ Before beginning the upgrade process, it's worth thinking about the advantages
and disadvantages that upgrading would bring to your project.
Advantages of upgrading
^^^^^^^^^^^^^^^^^^^^^^^
~~~~~~~~~~~~~~~~~~~~~~~
Along with the
`new features present in 4.0 <https://godotengine.org/article/godot-4-0-sets-sail>`__,
@@ -26,7 +26,7 @@ See :ref:`doc_docs_changelog` for a list of pages documenting new features in
Godot 4.0, and :ref:`doc_list_of_features` for a list of all features in Godot.
Disadvantages of upgrading
^^^^^^^^^^^^^^^^^^^^^^^^^^
~~~~~~~~~~~~~~~~~~~~~~~~~~
If you don't *need* any features present in Godot 4.0, you may want to stay on
Godot 3.x for the following reasons:
@@ -61,7 +61,7 @@ Godot 3.x for the following reasons:
can be used to bypass this limitation, but they're too slow for gaming.
Caveats of upgrading
^^^^^^^^^^^^^^^^^^^^
~~~~~~~~~~~~~~~~~~~~
.. UPDATE: Planned feature. There are several planned or missing features that
.. may be added back in the future. Check this section for accuracy and update
@@ -119,7 +119,7 @@ Running the project upgrade tool
folder to another location.
Using the Project Manager
^^^^^^^^^^^^^^^^^^^^^^^^^
~~~~~~~~~~~~~~~~~~~~~~~~~
To use the project upgrade tool:
@@ -143,7 +143,7 @@ you can use the command line to upgrade the project (see below). This will allow
you to override the converter's size limits.
Using the command line
^^^^^^^^^^^^^^^^^^^^^^
~~~~~~~~~~~~~~~~~~~~~~
To use the project upgrade tool from the :ref:`command line <doc_command_line_tutorial>`,
it's recommended to validate the project conversion by running the Godot editor binary with the following arguments:
@@ -196,7 +196,7 @@ cater to all situations. Therefore, a large part of the upgrade process remains
manual.
Automatically renamed nodes and resources
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The list below refers to nodes which were simply renamed for consistency or
clarity in Godot 4.0. The project upgrade tool renames them automatically in
@@ -372,7 +372,7 @@ a ``3D`` suffix to the old name:
.. _doc_upgrading_to_godot_4_manual_rename:
Manually renaming methods, properties, signals and constants
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Due to how the project upgrade tool works, not all
:abbr:`API (Application Programming Interface)` renames can be performed automatically.
@@ -488,7 +488,7 @@ table to find its new name.
- MainLoop's ``NOTIFICATION_WM_QUIT_REQUEST`` is now ``NOTIFICATION_WM_CLOSE_REQUEST``.
Checking project settings
^^^^^^^^^^^^^^^^^^^^^^^^^
~~~~~~~~~~~~~~~~~~~~~~~~~
Several project settings were renamed, and some of them had their enums changed
in incompatible ways (such as shadow filter quality). This means you may need to
@@ -496,7 +496,7 @@ set some project settings' values again. Make sure the **Advanced** toggle is
enabled in the project settings dialog so you can see all project settings.
Checking Environment settings
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Graphics quality settings were moved from Environment properties to project
settings. This was done to make runtime quality adjustments easier, without
@@ -513,7 +513,7 @@ methods that affect environment effects' quality. Only the "base" toggle of each
environment effect and its visual knobs remain within the Environment resource.
Updating shaders
^^^^^^^^^^^^^^^^
~~~~~~~~~~~~~~~~
There have been some changes to shaders that aren't covered by the upgrade tool.
You will need to make some manual changes, especially if your shader uses coordinate
@@ -549,7 +549,7 @@ This list is not exhaustive. If you made all the changes mentioned here and your
shader still doesn't work, try asking for help in one of the `community channels <https://godotengine.org/community/>`__.
Updating scripts to take backwards-incompatible changes into account
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Some changes performed between Godot 3.x and 4 are not renames, but they still
break backwards compatibility due to different default behavior.
@@ -716,7 +716,7 @@ example, the following code snippet in Godot 3.x must be modified to work in 4.0
for a full list of changes between Godot 3.x and 4.
ArrayMesh resource compatibility breakage
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you've saved an ArrayMesh resource to a ``.res`` or ``.tres`` file, the
format used in 4.0 is not compatible with the one used in 3.x. You will need to