Skip to content

Commit 21a2761

Browse files
Ayush41Ayush41
authored
Merge branch 'godotengine:master' into export_file-breaking-change-doc
2 parents 7ba0a7c + b2dcf6a commit 21a2761

File tree

127 files changed

+2343
-1093
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

127 files changed

+2343
-1093
lines changed

‎.github/workflows/ci.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,10 @@ jobs:
1919
- name: Style checks via pre-commit
2020
uses: pre-commit/[email protected]
2121

22+
- name: Custom RST checks (check-rst.sh)
23+
run: |
24+
bash ./_tools/check-rst.sh
25+
2226
- name: Get Python version
2327
id: pythonv
2428
run: |

‎_static/css/custom.css

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,8 @@
150150
--kbd-shadow-color: #b0b7bf;
151151
--kbd-text-color: #444d56;
152152

153+
--role-button-background-color: #d3d7e1;
154+
153155
--code-example-good-color: #3fb950;
154156
--code-example-bad-color: #f85149;
155157

@@ -279,6 +281,8 @@
279281
--kbd-outline-color: #3d4144;
280282
--kbd-shadow-color: #1e2023;
281283
--kbd-text-color: #e2f2ff;
284+
285+
--role-button-background-color: #22252d;
282286

283287
--code-example-good-color: #3fb950;
284288
--code-example-bad-color: #f85149;
@@ -1844,3 +1848,18 @@ p + .classref-constant {
18441848
#godot-giscus {
18451849
margin-bottom: 1em;
18461850
}
1851+
1852+
/* Custom Sphinx roles for editor UI */
1853+
/* The :ui: and :inspector: roles just render as bold. */
1854+
.role-ui {
1855+
font-weight: 700;
1856+
}
1857+
1858+
.role-button, .role-menu {
1859+
font-size: 80%;
1860+
border-radius: 4px;
1861+
padding: 2.4px 6px;
1862+
margin: auto 2px;
1863+
border: 0px solid #7fbbe3;
1864+
background: var(--role-button-background-color);
1865+
}

‎_tools/check-rst.sh

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
#!/usr/bin/env bash
2+
3+
set -uo pipefail
4+
5+
output=$(grep -r -P '^(?!\s*\.\.).*\S::$' --include='*.rst' --exclude='docs_writing_guidelines.rst' .)
6+
if [[ -n $output ]]; then
7+
echo 'The shorthand codeblock syntax (trailing `::`) is not allowed.'
8+
echo "$output"
9+
exit 1
10+
fi

‎about/faq.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -579,7 +579,7 @@ general-purpose library, but we had special requirements for Godot.
579579
* We use our custom String type, as the one provided by STL is too basic and lacks proper
580580
internationalization support.
581581

582-
Check out :ref:`Godot's container types <doc_cpp_godot_types>` for alternatives.
582+
Check out :ref:`Godot's container types <doc_core_types>` for alternatives.
583583

584584
Why does Godot not use exceptions?
585585
----------------------------------

‎about/list_of_features.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,13 @@ Platforms
3636
- :ref:`Web browsers <doc_using_the_web_editor>`. Experimental in 4.0,
3737
using Godot 3.x is recommended instead when targeting HTML5.
3838

39+
.. note::
40+
41+
Linux supports rv64 (RISC-V), ppc64 & ppc32 (PowerPC), and loongarch64. However
42+
you must compile the editor for that platform (as well as export templates)
43+
yourself, no official downloads are currently provided. RISC-V compiling
44+
instructions can be found on the :ref:`doc_compiling_for_linuxbsd` page.
45+
3946
**Runs exported projects:**
4047

4148
- iOS.

‎about/system_requirements.rst

Lines changed: 24 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -23,17 +23,18 @@ Desktop or laptop PC - Minimum
2323
.. which can run up to macOS 10.13.
2424
2525
+----------------------+-----------------------------------------------------------------------------------------+
26-
| **CPU** | - **Windows:** x86_32 CPU with SSE2 instructions, x86_64 CPU, ARMv8 CPU |
26+
| **CPU** | - **Windows:** x86_32 CPU with SSE2 support, x86_64 CPU with SSE4.2 support, ARMv8 CPU |
2727
| | |
28-
| | - *Example: Intel Core 2 Duo E8200, AMD Athlon XE BE-2300, Snapdragon X Elite* |
28+
| | - *Example: Intel Core 2 Duo E8200, AMD FX-4100, Snapdragon X Elite* |
2929
| | |
3030
| | - **macOS:** x86_64 or ARM CPU (Apple Silicon) |
3131
| | |
3232
| | - *Example: Intel Core 2 Duo SU9400, Apple M1* |
3333
| | |
34-
| | - **Linux:** x86_32 CPU with SSE2 instructions, x86_64 CPU, ARMv7 or ARMv8 CPU |
34+
| | - **Linux:** x86_32 CPU with SSE2 support, x86_64 CPU with SSE4.2 support, ARMv7 or |
35+
| | ARMv8 CPU |
3536
| | |
36-
| | - *Example: Intel Core 2 Duo E8200, AMD Athlon XE BE-2300, Raspberry Pi 4* |
37+
| | - *Example: Intel Core 2 Duo E8200, AMD FX-4100, Raspberry Pi 4* |
3738
+----------------------+-----------------------------------------------------------------------------------------+
3839
| **GPU** | - **Forward+ renderer:** Integrated graphics with full Vulkan 1.0 support |
3940
| | |
@@ -62,9 +63,14 @@ Desktop or laptop PC - Minimum
6263

6364
.. note::
6465

65-
Vulkan drivers for these Windows versions are known to have issues with
66-
memory leaks. As a result, it's recommended to stick to the Compatibility
67-
renderer when running Godot on a Windows version older than 10.
66+
If your x86_64 CPU does not support SSE4.2, you can still run the 32-bit Godot
67+
executable which only has a SSE2 requirement (all x86_64 CPUs support SSE2).
68+
69+
While supported on Linux, we have no official minimum requirements for running on
70+
rv64 (RISC-V), ppc64 & ppc32 (PowerPC), and loongarch64. In addition you must
71+
compile the editor for that platform (as well as export templates) yourself,
72+
no official downloads are currently provided. RISC-V compiling instructions can
73+
be found on the :ref:`doc_compiling_for_linuxbsd` page.
6874

6975
Mobile device (smartphone/tablet) - Minimum
7076
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -107,15 +113,15 @@ Desktop or laptop PC - Recommended
107113
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
108114

109115
+----------------------+---------------------------------------------------------------------------------------------+
110-
| **CPU** | - **Windows:** x86_64 CPU with SSE4.2 instructions, with 4 physical cores or more, ARMv8 CPU|
116+
| **CPU** | - **Windows:** x86_64 CPU with SSE4.2 support, with 4 physical cores or more, ARMv8 CPU |
111117
| | |
112118
| | - *Example: Intel Core i5-6600K, AMD Ryzen 5 1600, Snapdragon X Elite* |
113119
| | |
114120
| | - **macOS:** x86_64 or ARM CPU (Apple Silicon) |
115121
| | |
116122
| | - *Example: Intel Core i5-8500, Apple M1* |
117123
| | |
118-
| | - **Linux:** x86_32 CPU with SSE2 instructions, x86_64 CPU, ARMv7 or ARMv8 CPU |
124+
| | - **Linux:** x86_64 CPU with SSE4.2 support, ARMv7 or ARMv8 CPU |
119125
| | |
120126
| | - *Example: Intel Core i5-6600K, AMD Ryzen 5 1600, Raspberry Pi 5 with overclocking* |
121127
+----------------------+---------------------------------------------------------------------------------------------+
@@ -202,17 +208,19 @@ Desktop or laptop PC - Minimum
202208
.. which can run up to macOS 10.13.
203209
204210
+----------------------+-----------------------------------------------------------------------------------------+
205-
| **CPU** | - **Windows:** x86_32 CPU with SSE2 instructions, any x86_64 CPU, ARMv8 CPU |
211+
| **CPU** | - **Windows:** x86_32 CPU with SSE2 support, x86_64 CPU with SSE4.2 support, |
212+
| | ARMv8 CPU |
206213
| | |
207-
| | - *Example: Intel Core 2 Duo E8200, AMD Athlon XE BE-2300, Snapdragon X Elite* |
214+
| | - *Example: Intel Core 2 Duo E8200, AMD FX-4100, Snapdragon X Elite* |
208215
| | |
209216
| | - **macOS:** x86_64 or ARM CPU (Apple Silicon) |
210217
| | |
211218
| | - *Example: Intel Core 2 Duo SU9400, Apple M1* |
212219
| | |
213-
| | - **Linux:** x86_32 CPU with SSE2 instructions, x86_64 CPU, ARMv7 or ARMv8 CPU |
220+
| | - **Linux:** x86_32 CPU with SSE2 support, x86_64 CPU with SSE4.2 support, |
221+
| | ARMv7 or ARMv8 CPU |
214222
| | |
215-
| | - *Example: Intel Core 2 Duo E8200, AMD Athlon XE BE-2300, Raspberry Pi 4* |
223+
| | - *Example: Intel Core 2 Duo E8200, AMD FX-4100, Raspberry Pi 4* |
216224
+----------------------+-----------------------------------------------------------------------------------------+
217225
| **GPU** | - **Forward+ renderer:** Integrated graphics with full Vulkan 1.0 support, |
218226
| | Metal 3 support (macOS) or Direct3D 12 (12_0 feature level) support (Windows) |
@@ -241,12 +249,6 @@ Desktop or laptop PC - Minimum
241249
| | (including ESR), Chrome and Chromium derivatives, Safari and WebKit derivatives. |
242250
+----------------------+-----------------------------------------------------------------------------------------+
243251

244-
.. note::
245-
246-
Vulkan drivers for these Windows versions are known to have issues with
247-
memory leaks. As a result, it's recommended to stick to the Compatibility
248-
renderer when running Godot on a Windows version older than 10.
249-
250252
Mobile device (smartphone/tablet) - Minimum
251253
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
252254

@@ -293,15 +295,16 @@ Desktop or laptop PC - Recommended
293295
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
294296

295297
+----------------------+----------------------------------------------------------------------------------------------+
296-
| **CPU** | - **Windows:** x86_64 CPU with SSE4.2 instructions, with 4 physical cores or more, ARMv8 CPU |
298+
| **CPU** | - **Windows:** x86_64 CPU with SSE4.2 support, with 4 physical cores or more, ARMv8 CPU |
297299
| | |
298300
| | - *Example: Intel Core i5-6600K, AMD Ryzen 5 1600, Snapdragon X Elite* |
299301
| | |
300302
| | - **macOS:** x86_64 or ARM CPU (Apple Silicon) |
301303
| | |
302304
| | - *Example: Intel Core i5-8500, Apple M1* |
303305
| | |
304-
| | - **Linux:** x86_32 CPU with SSE2 instructions, x86_64 CPU, ARMv7 or ARMv8 CPU |
306+
| | - **Linux:** x86_64 CPU with SSE4.2 support, with 4 physical cores or more, |
307+
| | ARMv7 or ARMv8 CPU |
305308
| | |
306309
| | - *Example: Intel Core i5-6600K, AMD Ryzen 5 1600, Raspberry Pi 5 with overclocking* |
307310
+----------------------+----------------------------------------------------------------------------------------------+

‎classes/class_animationmixer.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,8 @@ Notifies when an animation list is changed.
169169

170170
Notifies when an animation starts playing.
171171

172+
\ **Note:** This signal is not emitted if an animation is looping.
173+
172174
.. rst-class:: classref-item-separator
173175

174176
----

‎classes/class_displayserver.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2128,7 +2128,9 @@ The window background can be transparent.
21282128

21292129
\ **Note:** This flag has no effect if :ref:`is_window_transparency_available()<class_DisplayServer_method_is_window_transparency_available>` returns ``false``.
21302130

2131-
\ **Note:** Transparency support is implemented on Android, Linux (X11/Wayland), macOS, and Windows, but availability might vary depending on GPU driver, display manager, and compositor capabilities.
2131+
\ **Note:** Transparency support is implemented on Linux (X11/Wayland), macOS, and Windows, but availability might vary depending on GPU driver, display manager, and compositor capabilities.
2132+
2133+
\ **Note:** Transparency support is implemented on Android, but can only be enabled via :ref:`ProjectSettings.display/window/per_pixel_transparency/allowed<class_ProjectSettings_property_display/window/per_pixel_transparency/allowed>`. This flag has no effect on Android.
21322134

21332135
.. _class_DisplayServer_constant_WINDOW_FLAG_NO_FOCUS:
21342136

@@ -5987,6 +5989,8 @@ Unregisters an :ref:`Object<class_Object>` representing an additional output, th
59875989

59885990
Returns the on-screen keyboard's height in pixels. Returns 0 if there is no keyboard or if it is currently hidden.
59895991

5992+
\ **Note:** On Android 7 and 8, the keyboard height may return 0 the first time the keyboard is opened in non-immersive mode. This behavior does not occur in immersive mode.
5993+
59905994
.. rst-class:: classref-item-separator
59915995

59925996
----

‎classes/class_editorexportplatformextension.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Methods
6262
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
6363
| :ref:`String<class_String>` | :ref:`_get_name<class_EditorExportPlatformExtension_private_method__get_name>`\ (\ ) |virtual| |required| |const| |
6464
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
65-
| :ref:`ImageTexture<class_ImageTexture>` | :ref:`_get_option_icon<class_EditorExportPlatformExtension_private_method__get_option_icon>`\ (\ device\: :ref:`int<class_int>`\ ) |virtual| |const| |
65+
| :ref:`Texture2D<class_Texture2D>` | :ref:`_get_option_icon<class_EditorExportPlatformExtension_private_method__get_option_icon>`\ (\ device\: :ref:`int<class_int>`\ ) |virtual| |const| |
6666
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
6767
| :ref:`String<class_String>` | :ref:`_get_option_label<class_EditorExportPlatformExtension_private_method__get_option_label>`\ (\ device\: :ref:`int<class_int>`\ ) |virtual| |const| |
6868
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -330,7 +330,7 @@ Returns export platform name.
330330

331331
.. rst-class:: classref-method
332332

333-
:ref:`ImageTexture<class_ImageTexture>` **_get_option_icon**\ (\ device\: :ref:`int<class_int>`\ ) |virtual| |const| :ref:`🔗<class_EditorExportPlatformExtension_private_method__get_option_icon>`
333+
:ref:`Texture2D<class_Texture2D>` **_get_option_icon**\ (\ device\: :ref:`int<class_int>`\ ) |virtual| |const| :ref:`🔗<class_EditorExportPlatformExtension_private_method__get_option_icon>`
334334

335335
Returns the item icon for the specified ``device`` in the one-click deploy menu. The icon should be 16×16 pixels, adjusted for the current editor scale (see :ref:`EditorInterface.get_editor_scale()<class_EditorInterface_method_get_editor_scale>`).
336336

0 commit comments

Comments
 (0)