Skip to content

Commit 7939a16

Browse files
author
Godot Organization
committed
classref: Sync with current master branch (4e990cd)
1 parent 5062d09 commit 7939a16

32 files changed

+978
-399
lines changed

classes/class_callable.rst

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -242,11 +242,23 @@ void **call_deferred** **(** ... **)** |vararg| |const|
242242

243243
Calls the method represented by this **Callable** in deferred mode, i.e. at the end of the current frame. Arguments can be passed and should match the method's signature.
244244

245-
::
245+
246+
.. tabs::
247+
248+
.. code-tab:: gdscript
246249

247250
func _ready():
248251
grab_focus.call_deferred()
249252

253+
.. code-tab:: csharp
254+
255+
public override void _Ready()
256+
{
257+
Callable.From(GrabFocus).CallDeferred();
258+
}
259+
260+
261+
250262
See also :ref:`Object.call_deferred<class_Object_method_call_deferred>`.
251263

252264
.. rst-class:: classref-item-separator

classes/class_color.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ A color represented in RGBA format.
1717
Description
1818
-----------
1919

20-
A color represented in RGBA format by a red (:ref:`r<class_Color_property_r>`), green (:ref:`g<class_Color_property_g>`), blue (:ref:`b<class_Color_property_b>`), and alpha (:ref:`a<class_Color_property_a>`) component. Each component is a 16-bit floating-point value, usually ranging from ``0.0`` to ``1.0``. Some properties (such as :ref:`CanvasItem.modulate<class_CanvasItem_property_modulate>`) may support values greater than ``1.0``, for overbright or HDR (High Dynamic Range) colors.
20+
A color represented in RGBA format by a red (:ref:`r<class_Color_property_r>`), green (:ref:`g<class_Color_property_g>`), blue (:ref:`b<class_Color_property_b>`), and alpha (:ref:`a<class_Color_property_a>`) component. Each component is a 32-bit floating-point value, usually ranging from ``0.0`` to ``1.0``. Some properties (such as :ref:`CanvasItem.modulate<class_CanvasItem_property_modulate>`) may support values greater than ``1.0``, for overbright or HDR (High Dynamic Range) colors.
2121

2222
Colors can be created in various ways: By the various **Color** constructors, by static methods such as :ref:`from_hsv<class_Color_method_from_hsv>`, and by using a name from the set of standardized colors based on `X11 color names <https://en.wikipedia.org/wiki/X11_color_names>`__ with the addition of :ref:`TRANSPARENT<class_Color_constant_TRANSPARENT>`. GDScript also provides :ref:`@GDScript.Color8<class_@GDScript_method_Color8>`, which uses integers from ``0`` to ``255`` and doesn't support overbright colors.
2323

classes/class_displayserver.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -466,7 +466,7 @@ Display server supports setting the mouse cursor shape to a custom image. **Wind
466466

467467
:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_DIALOG** = ``9``
468468

469-
Display server supports spawning dialogs using the operating system's native look-and-feel. **macOS**
469+
Display server supports spawning dialogs using the operating system's native look-and-feel. **Windows, macOS, Linux (X11/Wayland)**
470470

471471
.. _class_DisplayServer_constant_FEATURE_IME:
472472

classes/class_editorexportplatform.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Used in scripting by :ref:`EditorExportPlugin<class_EditorExportPlugin>` to conf
3030
Tutorials
3131
---------
3232

33-
- `$DOCS_URL/tutorials/platform/consoles.html <Console support in Godot>`__
33+
- :doc:`Console support in Godot <../tutorials/platform/consoles>`
3434

3535
.. rst-class:: classref-reftable-group
3636

classes/class_editorexportplatformandroid.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -834,7 +834,13 @@ If ``true``, package signing is enabled.
834834

835835
:ref:`String<class_String>` **package/unique_name**
836836

837-
Unique application identifier in a reverse-DNS format, can only contain alphanumeric characters (``A-Z``, ``a-z``, and ``0-9``), hyphens (``-``), and periods (``.``).
837+
Unique application identifier in a reverse-DNS format. The reverse DNS format should preferably match a domain name you control, but this is not strictly required. For instance, if you own ``example.com``, your package unique name should preferably be of the form ``com.example.mygame``. This identifier can only contain lowercase alphanumeric characters (``a-z``, and ``0-9``), underscores (``_``), and periods (``.``). Each component of the reverse DNS format must start with a letter: for instance, ``com.example.8game`` is not valid.
838+
839+
If ``$genname`` is present in the value, it will be replaced by the project name converted to lowercase. If there are invalid characters in the project name, they will be stripped. If all characters in the project name are stripped, ``$genname`` is replaced by ``noname``.
840+
841+
\ **Note:** Changing the package name will cause the package to be considered as a new package, with its own installation and data paths. The new package won't be usable to update existing installations.
842+
843+
\ **Note:** When publishing to Google Play, the package name must be *globally* unique. This means no other apps published on Google Play must be using the same package name as yours. Otherwise, you'll be prevented from publishing your app on Google Play.
838844

839845
.. rst-class:: classref-item-separator
840846

classes/class_editorinterface.rst

Lines changed: 155 additions & 99 deletions
Large diffs are not rendered by default.

classes/class_editorproperty.rst

Lines changed: 34 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -29,21 +29,23 @@ Properties
2929
.. table::
3030
:widths: auto
3131

32-
+-----------------------------+-----------------------------------------------------------------+-----------+
33-
| :ref:`bool<class_bool>` | :ref:`checkable<class_EditorProperty_property_checkable>` | ``false`` |
34-
+-----------------------------+-----------------------------------------------------------------+-----------+
35-
| :ref:`bool<class_bool>` | :ref:`checked<class_EditorProperty_property_checked>` | ``false`` |
36-
+-----------------------------+-----------------------------------------------------------------+-----------+
37-
| :ref:`bool<class_bool>` | :ref:`deletable<class_EditorProperty_property_deletable>` | ``false`` |
38-
+-----------------------------+-----------------------------------------------------------------+-----------+
39-
| :ref:`bool<class_bool>` | :ref:`draw_warning<class_EditorProperty_property_draw_warning>` | ``false`` |
40-
+-----------------------------+-----------------------------------------------------------------+-----------+
41-
| :ref:`bool<class_bool>` | :ref:`keying<class_EditorProperty_property_keying>` | ``false`` |
42-
+-----------------------------+-----------------------------------------------------------------+-----------+
43-
| :ref:`String<class_String>` | :ref:`label<class_EditorProperty_property_label>` | ``""`` |
44-
+-----------------------------+-----------------------------------------------------------------+-----------+
45-
| :ref:`bool<class_bool>` | :ref:`read_only<class_EditorProperty_property_read_only>` | ``false`` |
46-
+-----------------------------+-----------------------------------------------------------------+-----------+
32+
+-----------------------------+-----------------------------------------------------------------------------------+-----------+
33+
| :ref:`bool<class_bool>` | :ref:`checkable<class_EditorProperty_property_checkable>` | ``false`` |
34+
+-----------------------------+-----------------------------------------------------------------------------------+-----------+
35+
| :ref:`bool<class_bool>` | :ref:`checked<class_EditorProperty_property_checked>` | ``false`` |
36+
+-----------------------------+-----------------------------------------------------------------------------------+-----------+
37+
| :ref:`String<class_String>` | :ref:`configuration_warning<class_EditorProperty_property_configuration_warning>` | ``""`` |
38+
+-----------------------------+-----------------------------------------------------------------------------------+-----------+
39+
| :ref:`bool<class_bool>` | :ref:`deletable<class_EditorProperty_property_deletable>` | ``false`` |
40+
+-----------------------------+-----------------------------------------------------------------------------------+-----------+
41+
| :ref:`bool<class_bool>` | :ref:`draw_warning<class_EditorProperty_property_draw_warning>` | ``false`` |
42+
+-----------------------------+-----------------------------------------------------------------------------------+-----------+
43+
| :ref:`bool<class_bool>` | :ref:`keying<class_EditorProperty_property_keying>` | ``false`` |
44+
+-----------------------------+-----------------------------------------------------------------------------------+-----------+
45+
| :ref:`String<class_String>` | :ref:`label<class_EditorProperty_property_label>` | ``""`` |
46+
+-----------------------------+-----------------------------------------------------------------------------------+-----------+
47+
| :ref:`bool<class_bool>` | :ref:`read_only<class_EditorProperty_property_read_only>` | ``false`` |
48+
+-----------------------------+-----------------------------------------------------------------------------------+-----------+
4749

4850
.. rst-class:: classref-reftable-group
4951

@@ -253,6 +255,23 @@ Used by the inspector, set to ``true`` when the property is checked.
253255

254256
----
255257

258+
.. _class_EditorProperty_property_configuration_warning:
259+
260+
.. rst-class:: classref-property
261+
262+
:ref:`String<class_String>` **configuration_warning** = ``""``
263+
264+
.. rst-class:: classref-property-setget
265+
266+
- void **set_configuration_warning** **(** :ref:`String<class_String>` value **)**
267+
- :ref:`String<class_String>` **get_configuration_warning** **(** **)**
268+
269+
Used by the inspector, set to show a configuration warning on the property.
270+
271+
.. rst-class:: classref-item-separator
272+
273+
----
274+
256275
.. _class_EditorProperty_property_deletable:
257276

258277
.. rst-class:: classref-property

classes/class_editorsettings.rst

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -317,6 +317,8 @@ Properties
317317
+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
318318
| :ref:`bool<class_bool>` | :ref:`interface/editor/use_embedded_menu<class_EditorSettings_property_interface/editor/use_embedded_menu>` |
319319
+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
320+
| :ref:`int<class_int>` | :ref:`interface/editor/vsync_mode<class_EditorSettings_property_interface/editor/vsync_mode>` |
321+
+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
320322
| :ref:`float<class_float>` | :ref:`interface/inspector/float_drag_speed<class_EditorSettings_property_interface/inspector/float_drag_speed>` |
321323
+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
322324
| :ref:`int<class_int>` | :ref:`interface/inspector/max_array_dictionary_items_per_page<class_EditorSettings_property_interface/inspector/max_array_dictionary_items_per_page>` |
@@ -2341,6 +2343,22 @@ Specific to the macOS platform.
23412343

23422344
----
23432345

2346+
.. _class_EditorSettings_property_interface/editor/vsync_mode:
2347+
2348+
.. rst-class:: classref-property
2349+
2350+
:ref:`int<class_int>` **interface/editor/vsync_mode**
2351+
2352+
Sets the V-Sync mode for the editor. Does not affect the project when run from the editor (this is controlled by :ref:`ProjectSettings.display/window/vsync/vsync_mode<class_ProjectSettings_property_display/window/vsync/vsync_mode>`).
2353+
2354+
Depending on the platform and used renderer, the engine will fall back to **Enabled** if the desired mode is not supported.
2355+
2356+
\ **Note:** V-Sync modes other than **Enabled** are only supported in the Forward+ and Mobile rendering methods, not Compatibility.
2357+
2358+
.. rst-class:: classref-item-separator
2359+
2360+
----
2361+
23442362
.. _class_EditorSettings_property_interface/inspector/float_drag_speed:
23452363

23462364
.. rst-class:: classref-property
@@ -3343,7 +3361,7 @@ The number of pixels to scroll with every mouse wheel increment. Higher values m
33433361

33443362
:ref:`bool<class_bool>` **text_editor/completion/add_type_hints**
33453363

3346-
If ``true``, adds static typing hints such as ``-> void`` and ``: int`` when using code autocompletion or when creating onready variables by drag and dropping nodes into the script editor while pressing the :kbd:`Ctrl` key.
3364+
If ``true``, adds :doc:`GDScript static typing <../tutorials/scripting/gdscript/static_typing>` hints such as ``-> void`` and ``: int`` when using code autocompletion or when creating onready variables by drag and dropping nodes into the script editor while pressing the :kbd:`Ctrl` key. If ``true``, newly created scripts will also automatically have type hints added to their method parameters and return types.
33473365

33483366
.. rst-class:: classref-item-separator
33493367

classes/class_heightmapshape3d.rst

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,20 @@ Properties
3939
| :ref:`int<class_int>` | :ref:`map_width<class_HeightMapShape3D_property_map_width>` | ``2`` |
4040
+-----------------------------------------------------+-------------------------------------------------------------+------------------------------------+
4141

42+
.. rst-class:: classref-reftable-group
43+
44+
Methods
45+
-------
46+
47+
.. table::
48+
:widths: auto
49+
50+
+---------------------------+-----------------------------------------------------------------------------------------+
51+
| :ref:`float<class_float>` | :ref:`get_max_height<class_HeightMapShape3D_method_get_max_height>` **(** **)** |const| |
52+
+---------------------------+-----------------------------------------------------------------------------------------+
53+
| :ref:`float<class_float>` | :ref:`get_min_height<class_HeightMapShape3D_method_get_min_height>` **(** **)** |const| |
54+
+---------------------------+-----------------------------------------------------------------------------------------+
55+
4256
.. rst-class:: classref-section-separator
4357

4458
----
@@ -59,7 +73,7 @@ Property Descriptions
5973
- void **set_map_data** **(** :ref:`PackedFloat32Array<class_PackedFloat32Array>` value **)**
6074
- :ref:`PackedFloat32Array<class_PackedFloat32Array>` **get_map_data** **(** **)**
6175

62-
Height map data, pool array must be of :ref:`map_width<class_HeightMapShape3D_property_map_width>` \* :ref:`map_depth<class_HeightMapShape3D_property_map_depth>` size.
76+
Height map data. The array's size must be equal to :ref:`map_width<class_HeightMapShape3D_property_map_width>` multiplied by :ref:`map_depth<class_HeightMapShape3D_property_map_depth>`.
6377

6478
.. rst-class:: classref-item-separator
6579

@@ -95,6 +109,35 @@ Number of vertices in the depth of the height map. Changing this will resize the
95109

96110
Number of vertices in the width of the height map. Changing this will resize the :ref:`map_data<class_HeightMapShape3D_property_map_data>`.
97111

112+
.. rst-class:: classref-section-separator
113+
114+
----
115+
116+
.. rst-class:: classref-descriptions-group
117+
118+
Method Descriptions
119+
-------------------
120+
121+
.. _class_HeightMapShape3D_method_get_max_height:
122+
123+
.. rst-class:: classref-method
124+
125+
:ref:`float<class_float>` **get_max_height** **(** **)** |const|
126+
127+
Returns the largest height value found in :ref:`map_data<class_HeightMapShape3D_property_map_data>`. Recalculates only when :ref:`map_data<class_HeightMapShape3D_property_map_data>` changes.
128+
129+
.. rst-class:: classref-item-separator
130+
131+
----
132+
133+
.. _class_HeightMapShape3D_method_get_min_height:
134+
135+
.. rst-class:: classref-method
136+
137+
:ref:`float<class_float>` **get_min_height** **(** **)** |const|
138+
139+
Returns the smallest height value found in :ref:`map_data<class_HeightMapShape3D_property_map_data>`. Recalculates only when :ref:`map_data<class_HeightMapShape3D_property_map_data>` changes.
140+
98141
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
99142
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
100143
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

classes/class_input.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,8 @@ Methods
9797
+-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
9898
| :ref:`Vector2<class_Vector2>` | :ref:`get_joy_vibration_strength<class_Input_method_get_joy_vibration_strength>` **(** :ref:`int<class_int>` device **)** |
9999
+-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
100+
| :ref:`Vector2<class_Vector2>` | :ref:`get_last_mouse_screen_velocity<class_Input_method_get_last_mouse_screen_velocity>` **(** **)** |
101+
+-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
100102
| :ref:`Vector2<class_Vector2>` | :ref:`get_last_mouse_velocity<class_Input_method_get_last_mouse_velocity>` **(** **)** |
101103
+-------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
102104
| :ref:`Vector3<class_Vector3>` | :ref:`get_magnetometer<class_Input_method_get_magnetometer>` **(** **)** |const| |
@@ -710,6 +712,18 @@ Returns the strength of the joypad vibration: x is the strength of the weak moto
710712

711713
----
712714

715+
.. _class_Input_method_get_last_mouse_screen_velocity:
716+
717+
.. rst-class:: classref-method
718+
719+
:ref:`Vector2<class_Vector2>` **get_last_mouse_screen_velocity** **(** **)**
720+
721+
Returns the last mouse velocity in screen coordinates. To provide a precise and jitter-free velocity, mouse velocity is only calculated every 0.1s. Therefore, mouse velocity will lag mouse movements.
722+
723+
.. rst-class:: classref-item-separator
724+
725+
----
726+
713727
.. _class_Input_method_get_last_mouse_velocity:
714728

715729
.. rst-class:: classref-method

0 commit comments

Comments
 (0)