Skip to content

Commit df22cbd

Browse files
author
Godot Organization
committed
classref: Sync with current master branch (ab6c6ee)
1 parent e11d59a commit df22cbd

33 files changed

+781
-163
lines changed

‎classes/class_acceptdialog.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ Sets autowrapping for the text in the dialog.
177177
- |void| **set_close_on_escape**\ (\ value\: :ref:`bool<class_bool>`\ )
178178
- :ref:`bool<class_bool>` **get_close_on_escape**\ (\ )
179179

180-
If ``true``, the dialog will be hidden when the ``ui_cancel`` action is pressed (by default, this action is bound to :ref:`@GlobalScope.KEY_ESCAPE<class_@GlobalScope_constant_KEY_ESCAPE>`).
180+
If ``true``, the dialog will be hidden when the ``ui_close_dialog`` action is pressed (by default, this action is bound to :kbd:`Escape`, or :kbd:`Cmd + W` on macOS).
181181

182182
.. rst-class:: classref-item-separator
183183

‎classes/class_array.rst‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1237,8 +1237,6 @@ If you need to return the removed element, use :ref:`pop_at()<class_Array_method
12371237

12381238
\ **Note:** This method shifts every element's index after ``position`` back, which may have a noticeable performance cost, especially on larger arrays.
12391239

1240-
\ **Note:** The ``position`` cannot be negative. To remove an element relative to the end of the array, use ``arr.remove_at(arr.size() - (i + 1))``. To remove the last element from the array, use ``arr.resize(arr.size() - 1)``.
1241-
12421240
.. rst-class:: classref-item-separator
12431241

12441242
----

‎classes/class_camerafeed.rst‎

Lines changed: 41 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -49,33 +49,35 @@ Methods
4949
.. table::
5050
:widths: auto
5151

52-
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
53-
| :ref:`bool<class_bool>` | :ref:`_activate_feed<class_CameraFeed_private_method__activate_feed>`\ (\ ) |virtual| |
54-
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
55-
| |void| | :ref:`_deactivate_feed<class_CameraFeed_private_method__deactivate_feed>`\ (\ ) |virtual| |
56-
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
57-
| :ref:`FeedDataType<enum_CameraFeed_FeedDataType>` | :ref:`get_datatype<class_CameraFeed_method_get_datatype>`\ (\ ) |const| |
58-
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
59-
| :ref:`int<class_int>` | :ref:`get_id<class_CameraFeed_method_get_id>`\ (\ ) |const| |
60-
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
61-
| :ref:`String<class_String>` | :ref:`get_name<class_CameraFeed_method_get_name>`\ (\ ) |const| |
62-
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
63-
| :ref:`FeedPosition<enum_CameraFeed_FeedPosition>` | :ref:`get_position<class_CameraFeed_method_get_position>`\ (\ ) |const| |
64-
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
65-
| :ref:`int<class_int>` | :ref:`get_texture_tex_id<class_CameraFeed_method_get_texture_tex_id>`\ (\ feed_image_type\: :ref:`FeedImage<enum_CameraServer_FeedImage>`\ ) |
66-
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
67-
| |void| | :ref:`set_external<class_CameraFeed_method_set_external>`\ (\ width\: :ref:`int<class_int>`, height\: :ref:`int<class_int>`\ ) |
68-
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
69-
| :ref:`bool<class_bool>` | :ref:`set_format<class_CameraFeed_method_set_format>`\ (\ index\: :ref:`int<class_int>`, parameters\: :ref:`Dictionary<class_Dictionary>`\ ) |
70-
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
71-
| |void| | :ref:`set_name<class_CameraFeed_method_set_name>`\ (\ name\: :ref:`String<class_String>`\ ) |
72-
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
73-
| |void| | :ref:`set_position<class_CameraFeed_method_set_position>`\ (\ position\: :ref:`FeedPosition<enum_CameraFeed_FeedPosition>`\ ) |
74-
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
75-
| |void| | :ref:`set_rgb_image<class_CameraFeed_method_set_rgb_image>`\ (\ rgb_image\: :ref:`Image<class_Image>`\ ) |
76-
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
77-
| |void| | :ref:`set_ycbcr_image<class_CameraFeed_method_set_ycbcr_image>`\ (\ ycbcr_image\: :ref:`Image<class_Image>`\ ) |
78-
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
52+
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
53+
| :ref:`bool<class_bool>` | :ref:`_activate_feed<class_CameraFeed_private_method__activate_feed>`\ (\ ) |virtual| |
54+
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
55+
| |void| | :ref:`_deactivate_feed<class_CameraFeed_private_method__deactivate_feed>`\ (\ ) |virtual| |
56+
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
57+
| :ref:`FeedDataType<enum_CameraFeed_FeedDataType>` | :ref:`get_datatype<class_CameraFeed_method_get_datatype>`\ (\ ) |const| |
58+
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
59+
| :ref:`int<class_int>` | :ref:`get_id<class_CameraFeed_method_get_id>`\ (\ ) |const| |
60+
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
61+
| :ref:`String<class_String>` | :ref:`get_name<class_CameraFeed_method_get_name>`\ (\ ) |const| |
62+
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
63+
| :ref:`FeedPosition<enum_CameraFeed_FeedPosition>` | :ref:`get_position<class_CameraFeed_method_get_position>`\ (\ ) |const| |
64+
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
65+
| :ref:`int<class_int>` | :ref:`get_texture_tex_id<class_CameraFeed_method_get_texture_tex_id>`\ (\ feed_image_type\: :ref:`FeedImage<enum_CameraServer_FeedImage>`\ ) |
66+
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
67+
| |void| | :ref:`set_external<class_CameraFeed_method_set_external>`\ (\ width\: :ref:`int<class_int>`, height\: :ref:`int<class_int>`\ ) |
68+
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
69+
| :ref:`bool<class_bool>` | :ref:`set_format<class_CameraFeed_method_set_format>`\ (\ index\: :ref:`int<class_int>`, parameters\: :ref:`Dictionary<class_Dictionary>`\ ) |
70+
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
71+
| |void| | :ref:`set_name<class_CameraFeed_method_set_name>`\ (\ name\: :ref:`String<class_String>`\ ) |
72+
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
73+
| |void| | :ref:`set_position<class_CameraFeed_method_set_position>`\ (\ position\: :ref:`FeedPosition<enum_CameraFeed_FeedPosition>`\ ) |
74+
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
75+
| |void| | :ref:`set_rgb_image<class_CameraFeed_method_set_rgb_image>`\ (\ rgb_image\: :ref:`Image<class_Image>`\ ) |
76+
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
77+
| |void| | :ref:`set_ycbcr_image<class_CameraFeed_method_set_ycbcr_image>`\ (\ ycbcr_image\: :ref:`Image<class_Image>`\ ) |
78+
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
79+
| |void| | :ref:`set_ycbcr_images<class_CameraFeed_method_set_ycbcr_images>`\ (\ y_image\: :ref:`Image<class_Image>`, cbcr_image\: :ref:`Image<class_Image>`\ ) |
80+
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
7981

8082
.. rst-class:: classref-section-separator
8183

@@ -417,6 +419,18 @@ Sets RGB image for this feed.
417419

418420
Sets YCbCr image for this feed.
419421

422+
.. rst-class:: classref-item-separator
423+
424+
----
425+
426+
.. _class_CameraFeed_method_set_ycbcr_images:
427+
428+
.. rst-class:: classref-method
429+
430+
|void| **set_ycbcr_images**\ (\ y_image\: :ref:`Image<class_Image>`, cbcr_image\: :ref:`Image<class_Image>`\ ) :ref:`🔗<class_CameraFeed_method_set_ycbcr_images>`
431+
432+
Sets Y and CbCr images for this feed.
433+
420434
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
421435
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
422436
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`

‎classes/class_control.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3255,7 +3255,7 @@ Creates an :ref:`InputEventMouseButton<class_InputEventMouseButton>` that attemp
32553255

32563256
Steal the focus from another control and become the focused control (see :ref:`focus_mode<class_Control_property_focus_mode>`).
32573257

3258-
If ``hide_focus`` is ``true``, the control will not visually show its focused state. Has no effect if :ref:`ProjectSettings.gui/common/always_show_focus_state<class_ProjectSettings_property_gui/common/always_show_focus_state>` is set to ``true``.
3258+
If ``hide_focus`` is ``true``, the control will not visually show its focused state. Has no effect for :ref:`LineEdit<class_LineEdit>` and :ref:`TextEdit<class_TextEdit>` when :ref:`ProjectSettings.gui/common/show_focus_state_on_pointer_event<class_ProjectSettings_property_gui/common/show_focus_state_on_pointer_event>` is set to ``Control Supports Keyboard Input``, or for any control when it is set to ``Always``.
32593259

32603260
\ **Note:** Using this method together with :ref:`Callable.call_deferred()<class_Callable_method_call_deferred>` makes it more reliable, especially when called inside :ref:`Node._ready()<class_Node_private_method__ready>`.
32613261

‎classes/class_displayserver.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3942,7 +3942,7 @@ Callbacks have the following arguments: ``status: bool, selected_paths: PackedSt
39423942

39433943
\ **Note:** ``current_directory`` might be ignored.
39443944

3945-
\ **Note:** Embedded file dialog and Windows file dialog support only file extensions, while Android, Linux, and macOS file dialogs also support MIME types.
3945+
\ **Note:** Embedded file dialogs and Windows file dialogs support only file extensions, while Android, Linux, and macOS file dialogs also support MIME types.
39463946

39473947
\ **Note:** On Android and Linux, ``show_hidden`` is ignored.
39483948

@@ -3978,7 +3978,7 @@ Callbacks have the following arguments: ``status: bool, selected_paths: PackedSt
39783978

39793979
\ **Note:** ``current_directory`` might be ignored.
39803980

3981-
\ **Note:** Embedded file dialog and Windows file dialog support only file extensions, while Android, Linux, and macOS file dialogs also support MIME types.
3981+
\ **Note:** Embedded file dialogs and Windows file dialogs support only file extensions, while Android, Linux, and macOS file dialogs also support MIME types.
39823982

39833983
\ **Note:** On Linux (X11), ``show_hidden`` is ignored.
39843984

‎classes/class_editorfiledialog.rst‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -493,7 +493,9 @@ Adds an additional :ref:`OptionButton<class_OptionButton>` to the file dialog. I
493493

494494
|void| **add_side_menu**\ (\ menu\: :ref:`Control<class_Control>`, title\: :ref:`String<class_String>` = ""\ ) :ref:`🔗<class_EditorFileDialog_method_add_side_menu>`
495495

496-
Adds the given ``menu`` to the side of the file dialog with the given ``title`` text on top. Only one side menu is allowed.
496+
**Deprecated:** This feature is no longer supported.
497+
498+
This method is kept for compatibility and does nothing. As an alternative, you can display another dialog after showing the file dialog.
497499

498500
.. rst-class:: classref-item-separator
499501

‎classes/class_editorplugin.rst‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,8 @@ Methods
8383
+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
8484
| |void| | :ref:`_make_visible<class_EditorPlugin_private_method__make_visible>`\ (\ visible\: :ref:`bool<class_bool>`\ ) |virtual| |
8585
+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
86+
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`_run_scene<class_EditorPlugin_private_method__run_scene>`\ (\ scene\: :ref:`String<class_String>`, args\: :ref:`PackedStringArray<class_PackedStringArray>`\ ) |virtual| |const| |
87+
+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
8688
| |void| | :ref:`_save_external_data<class_EditorPlugin_private_method__save_external_data>`\ (\ ) |virtual| |
8789
+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
8890
| |void| | :ref:`_set_state<class_EditorPlugin_private_method__set_state>`\ (\ state\: :ref:`Dictionary<class_Dictionary>`\ ) |virtual| |
@@ -1041,6 +1043,26 @@ Remember that you have to manage the visibility of all your editor controls manu
10411043

10421044
----
10431045

1046+
.. _class_EditorPlugin_private_method__run_scene:
1047+
1048+
.. rst-class:: classref-method
1049+
1050+
:ref:`PackedStringArray<class_PackedStringArray>` **_run_scene**\ (\ scene\: :ref:`String<class_String>`, args\: :ref:`PackedStringArray<class_PackedStringArray>`\ ) |virtual| |const| :ref:`🔗<class_EditorPlugin_private_method__run_scene>`
1051+
1052+
This function is called when an individual scene is about to be played in the editor. ``args`` is a list of command line arguments that will be passed to the new Godot instance, which will be replaced by the list returned by this function.
1053+
1054+
::
1055+
1056+
func _run_scene(scene, args):
1057+
args.append("--an-extra-argument")
1058+
return args
1059+
1060+
\ **Note:** Text that is printed in this method will not be visible in the editor's Output panel unless :ref:`EditorSettings.run/output/always_clear_output_on_play<class_EditorSettings_property_run/output/always_clear_output_on_play>` is ``false``.
1061+
1062+
.. rst-class:: classref-item-separator
1063+
1064+
----
1065+
10441066
.. _class_EditorPlugin_private_method__save_external_data:
10451067

10461068
.. rst-class:: classref-method

0 commit comments

Comments
 (0)