diff --git a/classes/class_arraymesh.rst b/classes/class_arraymesh.rst index c5abca14e..655f39dbf 100644 --- a/classes/class_arraymesh.rst +++ b/classes/class_arraymesh.rst @@ -70,7 +70,7 @@ See also :ref:`ImmediateMesh`, :ref:`MeshDataTool`__ diff --git a/classes/class_container.rst b/classes/class_container.rst index 06f2912ca..be595f65e 100644 --- a/classes/class_container.rst +++ b/classes/class_container.rst @@ -41,6 +41,14 @@ Methods Signals ------- +.. _class_Container_signal_pre_sort_children: + +- **pre_sort_children** **(** **)** + +Emitted when children are going to be sorted. + +---- + .. _class_Container_signal_sort_children: - **sort_children** **(** **)** @@ -50,9 +58,13 @@ Emitted when sorting the children is needed. Constants --------- +.. _class_Container_constant_NOTIFICATION_PRE_SORT_CHILDREN: + .. _class_Container_constant_NOTIFICATION_SORT_CHILDREN: -- **NOTIFICATION_SORT_CHILDREN** = **50** --- Notification for when sorting the children, it must be obeyed immediately. +- **NOTIFICATION_PRE_SORT_CHILDREN** = **50** --- Notification just before children are going to be sorted, in case there's something to process beforehand. + +- **NOTIFICATION_SORT_CHILDREN** = **51** --- Notification for when sorting the children, it must be obeyed immediately. Method Descriptions ------------------- diff --git a/classes/class_csharpscript.rst b/classes/class_csharpscript.rst index 3ec39febe..f5f0241be 100644 --- a/classes/class_csharpscript.rst +++ b/classes/class_csharpscript.rst @@ -23,7 +23,7 @@ See also :ref:`GodotSharp`. Tutorials --------- -- :doc:`../getting_started/scripting/c_sharp/index` +- :doc:`../tutorials/scripting/c_sharp/index` Methods ------- diff --git a/classes/class_dictionary.rst b/classes/class_dictionary.rst index fabb9125d..84610b6c5 100644 --- a/classes/class_dictionary.rst +++ b/classes/class_dictionary.rst @@ -236,7 +236,7 @@ You need to first calculate the dictionary's hash with :ref:`hash`_ in :doc:`../getting_started/scripting/gdscript/gdscript_basics` +- `#dictionary <../tutorials/scripting/gdscript/gdscript_basics.html#dictionary>`_ in :doc:`../tutorials/scripting/gdscript/gdscript_basics` - `3D Voxel Demo `__ diff --git a/classes/class_directory.rst b/classes/class_directory.rst index eec60e5e2..b892ffa0f 100644 --- a/classes/class_directory.rst +++ b/classes/class_directory.rst @@ -76,7 +76,7 @@ Here is an example on how to iterate through the files of a directory: Tutorials --------- -- :doc:`../getting_started/step_by_step/filesystem` +- :doc:`../tutorials/scripting/filesystem` Methods ------- diff --git a/classes/class_displayserver.rst b/classes/class_displayserver.rst index d3281ac73..815611bf8 100644 --- a/classes/class_displayserver.rst +++ b/classes/class_displayserver.rst @@ -1142,6 +1142,8 @@ Shows the virtual keyboard if the platform has one. - :ref:`WindowMode` **window_get_mode** **(** :ref:`int` window_id=0 **)** |const| +Returns the current window's mode. + ---- .. _class_DisplayServer_method_window_get_position: @@ -1244,6 +1246,10 @@ Sets the minimum size for the given window to ``min_size`` (in pixels). - void **window_set_mode** **(** :ref:`WindowMode` mode, :ref:`int` window_id=0 **)** +Sets window mode for the given window to ``mode``. See :ref:`WindowMode` for possible values and how each mode behaves. + +**Note:** Setting the window to fullscreen forcibly sets the borderless flag to ``true``, so make sure to set it back to ``false`` when not wanted. + ---- .. _class_DisplayServer_method_window_set_mouse_passthrough: diff --git a/classes/class_editorscenepostimport.rst b/classes/class_editorscenepostimport.rst index 9d4b7eb44..9a19f4dee 100644 --- a/classes/class_editorscenepostimport.rst +++ b/classes/class_editorscenepostimport.rst @@ -72,7 +72,7 @@ The :ref:`_post_import` callbac Tutorials --------- -- `#custom-script <../getting_started/workflow/assets/importing_scenes.html#custom-script>`_ in :doc:`../getting_started/workflow/assets/importing_scenes` +- `#custom-script <../tutorials/assets_pipeline/importing_scenes.html#custom-script>`_ in :doc:`../tutorials/assets_pipeline/importing_scenes` Methods ------- diff --git a/classes/class_file.rst b/classes/class_file.rst index 95acf1e38..d9df484e2 100644 --- a/classes/class_file.rst +++ b/classes/class_file.rst @@ -68,7 +68,7 @@ In the example above, the file will be saved in the user data folder as specifie Tutorials --------- -- :doc:`../getting_started/step_by_step/filesystem` +- :doc:`../tutorials/scripting/filesystem` - `3D Voxel Demo `__ diff --git a/classes/class_gdnativelibrary.rst b/classes/class_gdnativelibrary.rst index 908588a1c..ca6498433 100644 --- a/classes/class_gdnativelibrary.rst +++ b/classes/class_gdnativelibrary.rst @@ -21,9 +21,9 @@ A GDNative library can implement :ref:`NativeScript`\ s, glo Tutorials --------- -- :doc:`../tutorials/plugins/gdnative/gdnative-c-example` +- :doc:`../tutorials/scripting/gdnative/gdnative_c_example` -- :doc:`../tutorials/plugins/gdnative/gdnative-cpp-example` +- :doc:`../tutorials/scripting/gdnative/gdnative_cpp_example` Properties ---------- diff --git a/classes/class_gdscript.rst b/classes/class_gdscript.rst index 46065e482..5f9010c6e 100644 --- a/classes/class_gdscript.rst +++ b/classes/class_gdscript.rst @@ -23,7 +23,7 @@ A script implemented in the GDScript programming language. The script extends th Tutorials --------- -- :doc:`../getting_started/scripting/gdscript/index` +- :doc:`../tutorials/scripting/gdscript/index` Methods ------- diff --git a/classes/class_gpuparticles3d.rst b/classes/class_gpuparticles3d.rst index 9625c3500..e2552eb9b 100644 --- a/classes/class_gpuparticles3d.rst +++ b/classes/class_gpuparticles3d.rst @@ -23,7 +23,7 @@ Use the ``process_material`` property to add a :ref:`ParticlesMaterial`__ diff --git a/classes/class_image.rst b/classes/class_image.rst index 869725bf8..8b705efd5 100644 --- a/classes/class_image.rst +++ b/classes/class_image.rst @@ -25,7 +25,7 @@ An ``Image`` cannot be assigned to a ``texture`` property of an object directly Tutorials --------- -- :doc:`../getting_started/workflow/assets/importing_images` +- :doc:`../tutorials/assets_pipeline/importing_images` Properties ---------- diff --git a/classes/class_javascript.rst b/classes/class_javascript.rst index 4d46c8f71..86642e87c 100644 --- a/classes/class_javascript.rst +++ b/classes/class_javascript.rst @@ -23,7 +23,7 @@ The JavaScript singleton is implemented only in the HTML5 export. It's used to a Tutorials --------- -- `#calling-javascript-from-script <../getting_started/workflow/export/exporting_for_web.html#calling-javascript-from-script>`_ in :doc:`../getting_started/workflow/export/exporting_for_web` +- `#calling-javascript-from-script <../tutorials/export/exporting_for_web.html#calling-javascript-from-script>`_ in :doc:`../tutorials/export/exporting_for_web` Methods ------- diff --git a/classes/class_multimesh.rst b/classes/class_multimesh.rst index a5a7e25d0..558ca7305 100644 --- a/classes/class_multimesh.rst +++ b/classes/class_multimesh.rst @@ -27,9 +27,9 @@ Since instances may have any behavior, the AABB used for visibility must be prov Tutorials --------- -- :doc:`../tutorials/3d/vertex_animation/animating_thousands_of_fish` +- :doc:`../tutorials/performance/vertex_animation/animating_thousands_of_fish` -- :doc:`../tutorials/optimization/using_multimesh` +- :doc:`../tutorials/performance/using_multimesh` Properties ---------- diff --git a/classes/class_multimeshinstance3d.rst b/classes/class_multimeshinstance3d.rst index 07201d794..2d5386ece 100644 --- a/classes/class_multimeshinstance3d.rst +++ b/classes/class_multimeshinstance3d.rst @@ -23,11 +23,11 @@ This is useful to optimize the rendering of a high amount of instances of a give Tutorials --------- -- :doc:`../tutorials/3d/vertex_animation/animating_thousands_of_fish` +- :doc:`../tutorials/performance/vertex_animation/animating_thousands_of_fish` - :doc:`../tutorials/3d/using_multi_mesh_instance` -- :doc:`../tutorials/optimization/using_multimesh` +- :doc:`../tutorials/performance/using_multimesh` Properties ---------- diff --git a/classes/class_mutex.rst b/classes/class_mutex.rst index 0bd3ad446..f96be553b 100644 --- a/classes/class_mutex.rst +++ b/classes/class_mutex.rst @@ -21,7 +21,7 @@ A synchronization mutex (mutual exclusion). This is used to synchronize multiple Tutorials --------- -- :doc:`../tutorials/threads/using_multiple_threads` +- :doc:`../tutorials/performance/using_multiple_threads` Methods ------- diff --git a/classes/class_node.rst b/classes/class_node.rst index d1c63b522..776f7eb22 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -43,7 +43,7 @@ Finally, when a node is freed with :ref:`Object.free` Tutorials --------- -- :doc:`../getting_started/step_by_step/scenes_and_nodes` +- `Nodes and scenes `__ - `All Demos `__ diff --git a/classes/class_object.rst b/classes/class_object.rst index 482eaab87..0de7a3aab 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -56,7 +56,7 @@ Objects also receive notifications. Notifications are a simple way to notify the Tutorials --------- -- :doc:`../getting_started/workflow/best_practices/node_alternatives` +- :doc:`../tutorials/best_practices/node_alternatives` Methods ------- diff --git a/classes/class_refcounted.rst b/classes/class_refcounted.rst index f5b577fd3..0b1c61cc7 100644 --- a/classes/class_refcounted.rst +++ b/classes/class_refcounted.rst @@ -29,7 +29,7 @@ In the vast majority of use cases, instantiating and using ``RefCounted``-derive Tutorials --------- -- :doc:`../getting_started/workflow/best_practices/node_alternatives` +- :doc:`../tutorials/best_practices/node_alternatives` Methods ------- diff --git a/classes/class_renderingserver.rst b/classes/class_renderingserver.rst index aec941bfb..d459a9db5 100644 --- a/classes/class_renderingserver.rst +++ b/classes/class_renderingserver.rst @@ -37,7 +37,7 @@ In 2D, all visible objects are some form of canvas item. In order to be visible, Tutorials --------- -- :doc:`../tutorials/optimization/using_servers` +- :doc:`../tutorials/performance/using_servers` Properties ---------- diff --git a/classes/class_resource.rst b/classes/class_resource.rst index e5475c190..695e7f091 100644 --- a/classes/class_resource.rst +++ b/classes/class_resource.rst @@ -25,9 +25,9 @@ Resource is the base class for all Godot-specific resource types, serving primar Tutorials --------- -- :doc:`../getting_started/step_by_step/resources` +- :doc:`../tutorials/scripting/resources` -- :doc:`../getting_started/workflow/best_practices/node_alternatives` +- :doc:`../tutorials/best_practices/node_alternatives` Properties ---------- diff --git a/classes/class_richtexteffect.rst b/classes/class_richtexteffect.rst index d4e51ccc9..980474a59 100644 --- a/classes/class_richtexteffect.rst +++ b/classes/class_richtexteffect.rst @@ -40,7 +40,7 @@ A custom effect for use with :ref:`RichTextLabel`. Tutorials --------- -- :doc:`../tutorials/gui/bbcode_in_richtextlabel` +- :doc:`../tutorials/ui/bbcode_in_richtextlabel` - `RichTextEffect test project (third-party) `__ diff --git a/classes/class_richtextlabel.rst b/classes/class_richtextlabel.rst index 6278a2858..44d1335bb 100644 --- a/classes/class_richtextlabel.rst +++ b/classes/class_richtextlabel.rst @@ -29,7 +29,7 @@ Rich text can contain custom text, fonts, images and some basic formatting. The Tutorials --------- -- :doc:`../tutorials/gui/bbcode_in_richtextlabel` +- :doc:`../tutorials/ui/bbcode_in_richtextlabel` - `GUI Rich Text/BBcode Demo `__ diff --git a/classes/class_scenetree.rst b/classes/class_scenetree.rst index cd192c518..48d46992f 100644 --- a/classes/class_scenetree.rst +++ b/classes/class_scenetree.rst @@ -25,9 +25,9 @@ You can also use the ``SceneTree`` to organize your nodes into groups: every nod Tutorials --------- -- :doc:`../getting_started/step_by_step/scene_tree` +- :doc:`../tutorials/scripting/scene_tree` -- :doc:`../tutorials/viewports/multiple_resolutions` +- :doc:`../tutorials/rendering/multiple_resolutions` Properties ---------- diff --git a/classes/class_script.rst b/classes/class_script.rst index 62cd265bd..524c84483 100644 --- a/classes/class_script.rst +++ b/classes/class_script.rst @@ -25,7 +25,7 @@ The ``new`` method of a script subclass creates a new instance. :ref:`Object.set Tutorials --------- -- :doc:`../getting_started/step_by_step/scripting` +- :doc:`../tutorials/scripting/index` Properties ---------- diff --git a/classes/class_semaphore.rst b/classes/class_semaphore.rst index 3d2c7603e..06ed4a4bd 100644 --- a/classes/class_semaphore.rst +++ b/classes/class_semaphore.rst @@ -21,7 +21,7 @@ A synchronization semaphore which can be used to synchronize multiple :ref:`Thre Tutorials --------- -- :doc:`../tutorials/threads/using_multiple_threads` +- :doc:`../tutorials/performance/using_multiple_threads` Methods ------- diff --git a/classes/class_shader.rst b/classes/class_shader.rst index 8e664b0e6..1fb46e9d4 100644 --- a/classes/class_shader.rst +++ b/classes/class_shader.rst @@ -23,9 +23,7 @@ This class allows you to define a custom shader program that can be used by a :r Tutorials --------- -- :doc:`../tutorials/shading/index` - -- :doc:`../tutorials/shading/your_first_shader/what_are_shaders` +- :doc:`../tutorials/shaders/index` Properties ---------- diff --git a/classes/class_shadermaterial.rst b/classes/class_shadermaterial.rst index 529c2fd10..93db774a1 100644 --- a/classes/class_shadermaterial.rst +++ b/classes/class_shadermaterial.rst @@ -21,7 +21,7 @@ A material that uses a custom :ref:`Shader` program to render eith Tutorials --------- -- :doc:`../tutorials/shading/index` +- :doc:`../tutorials/shaders/index` Properties ---------- diff --git a/classes/class_standardmaterial3d.rst b/classes/class_standardmaterial3d.rst index 00ae4c2ba..9ffe6f3d4 100644 --- a/classes/class_standardmaterial3d.rst +++ b/classes/class_standardmaterial3d.rst @@ -13,6 +13,11 @@ StandardMaterial3D +Tutorials +--------- + +- :doc:`../tutorials/3d/standard_material_3d` + .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_string.rst b/classes/class_string.rst index 0e091d2af..6c1ce9ad6 100644 --- a/classes/class_string.rst +++ b/classes/class_string.rst @@ -19,7 +19,7 @@ This is the built-in string class (and the one used by GDScript). It supports Un Tutorials --------- -- :doc:`../getting_started/scripting/gdscript/gdscript_format_string` +- :doc:`../tutorials/scripting/gdscript/gdscript_format_string` Methods ------- diff --git a/classes/class_subviewport.rst b/classes/class_subviewport.rst index 033aff8ad..3d9663d15 100644 --- a/classes/class_subviewport.rst +++ b/classes/class_subviewport.rst @@ -16,9 +16,9 @@ Creates a sub-view into the screen. Tutorials --------- -- :doc:`../tutorials/2d/2d_transforms` +- :doc:`../tutorials/rendering/viewports` -- :doc:`../tutorials/viewports/index` +- :doc:`../tutorials/2d/2d_transforms` - `GUI in 3D Demo `__ diff --git a/classes/class_theme.rst b/classes/class_theme.rst index 42c8934ec..f71dca76d 100644 --- a/classes/class_theme.rst +++ b/classes/class_theme.rst @@ -23,7 +23,7 @@ Theme resources can alternatively be loaded by writing them in a ``.theme`` file Tutorials --------- -- :doc:`../tutorials/gui/gui_skinning` +- :doc:`../tutorials/ui/gui_skinning` Properties ---------- diff --git a/classes/class_thread.rst b/classes/class_thread.rst index 900755deb..58a2bc65a 100644 --- a/classes/class_thread.rst +++ b/classes/class_thread.rst @@ -23,9 +23,9 @@ A unit of execution in a process. Can run methods on :ref:`Object` Tutorials --------- -- :doc:`../tutorials/threads/using_multiple_threads` +- :doc:`../tutorials/performance/using_multiple_threads` -- :doc:`../tutorials/threads/thread_safe_apis` +- :doc:`../tutorials/performance/thread_safe_apis` - `3D Voxel Demo `__ diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index 430d8f9dd..f116722fc 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -33,9 +33,9 @@ Finally, viewports can also behave as render targets, in which case they will no Tutorials --------- -- :doc:`../tutorials/2d/2d_transforms` +- :doc:`../tutorials/rendering/viewports` -- :doc:`../tutorials/viewports/index` +- :doc:`../tutorials/2d/2d_transforms` - `GUI in 3D Demo `__ diff --git a/classes/class_visualscript.rst b/classes/class_visualscript.rst index 9752325d2..ad54fb68c 100644 --- a/classes/class_visualscript.rst +++ b/classes/class_visualscript.rst @@ -25,7 +25,7 @@ You are most likely to use this class via the Visual Script editor or when writi Tutorials --------- -- :doc:`../getting_started/scripting/visual_script/index` +- :doc:`../tutorials/scripting/visual_script/index` Methods ------- diff --git a/classes/class_visualshadernode.rst b/classes/class_visualshadernode.rst index cbbf4d5e6..3d9f7ef5c 100644 --- a/classes/class_visualshadernode.rst +++ b/classes/class_visualshadernode.rst @@ -23,7 +23,7 @@ Visual shader graphs consist of various nodes. Each node in the graph is a separ Tutorials --------- -- :doc:`../tutorials/shading/visual_shaders` +- :doc:`../tutorials/shaders/visual_shaders` Properties ---------- diff --git a/classes/class_visualshadernodeinput.rst b/classes/class_visualshadernodeinput.rst index 04bb0a090..3ba6f95b3 100644 --- a/classes/class_visualshadernodeinput.rst +++ b/classes/class_visualshadernodeinput.rst @@ -21,7 +21,7 @@ Gives access to input variables (built-ins) available for the shader. See the sh Tutorials --------- -- :doc:`../tutorials/shading/shading_reference/index` +- :doc:`../tutorials/shaders/shader_reference/index` Properties ---------- diff --git a/classes/class_voxelgi.rst b/classes/class_voxelgi.rst index 1a844eeb6..3b7e27367 100644 --- a/classes/class_voxelgi.rst +++ b/classes/class_voxelgi.rst @@ -25,7 +25,7 @@ Having ``VoxelGI``\ s in a scene can be expensive, the quality of the probe can Tutorials --------- -- :doc:`../tutorials/3d/voxel_gi` +- :doc:`../tutorials/3d/gi_probes` - `Third Person Shooter Demo `__