godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (6da4ad1)

Browse Source
This commit is contained in:
Godot Organization
2023-08-26 03:18:38 +00:00
parent 0ea575930c
commit 55d4bd8010
70 changed files with 372 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
classes/class_array.rst
View File

@@ -567,7 +567,7 @@ void **erase** **(** :ref:`Variant<class_Variant>` value **)**
Removes the first occurrence of a value from the array. If the value does not exist in the array, nothing happens. To remove an element by index, use :ref:`remove_at<class_Array_method_remove_at>` instead.
\ **Note:** This method acts in-place and doesn't return a value.
\ **Note:** This method acts in-place and doesn't return a modified array.
\ **Note:** On large arrays, this method will be slower if the removed element is close to the beginning of the array (index 0). This is because all elements placed after the removed element have to be reindexed.
@@ -770,9 +770,9 @@ Returns a hashed 32-bit integer value representing the array and its contents.
:ref:`int<class_int>` **insert** **(** :ref:`int<class_int>` position, :ref:`Variant<class_Variant>` value **)**
Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (``pos == size()``).
Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (``pos == size()``). Returns :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>` on success, or one of the other :ref:`Error<enum_@GlobalScope_Error>` values if the operation failed.
\ **Note:** This method acts in-place and doesn't return a value.
\ **Note:** This method acts in-place and doesn't return a modified array.
\ **Note:** On large arrays, this method will be slower if the inserted element is close to the beginning of the array (index 0). This is because all elements placed after the newly inserted element have to be reindexed.
@@ -909,7 +909,7 @@ See also :ref:`max<class_Array_method_max>` for an example of using a custom com
:ref:`Variant<class_Variant>` **pick_random** **(** **)** |const|
Returns a random value from the target array.
Returns a random value from the target array. Prints an error and returns ``null`` if the array is empty.
.. tabs::
@@ -1029,7 +1029,7 @@ void **remove_at** **(** :ref:`int<class_int>` position **)**
Removes an element from the array by index. If the index does not exist in the array, nothing happens. To remove an element by searching for its value, use :ref:`erase<class_Array_method_erase>` instead.
\ **Note:** This method acts in-place and doesn't return a value.
\ **Note:** This method acts in-place and doesn't return a modified array.
\ **Note:** On large arrays, this method will be slower if the removed element is close to the beginning of the array (index 0). This is because all elements placed after the removed element have to be reindexed.
@@ -1045,7 +1045,9 @@ Removes an element from the array by index. If the index does not exist in the a
:ref:`int<class_int>` **resize** **(** :ref:`int<class_int>` size **)**
Resizes the array to contain a different number of elements. If the array size is smaller, elements are cleared, if bigger, new elements are ``null``.
Resizes the array to contain a different number of elements. If the array size is smaller, elements are cleared, if bigger, new elements are ``null``. Returns :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>` on success, or one of the other :ref:`Error<enum_@GlobalScope_Error>` values if the operation failed.
\ **Note:** This method acts in-place and doesn't return a modified array.
.. rst-class:: classref-item-separator

7
classes/class_arrayoccluder3d.rst
View File

@@ -23,6 +23,13 @@ Description
See :ref:`OccluderInstance3D<class_OccluderInstance3D>`'s documentation for instructions on setting up occlusion culling.
.. rst-class:: classref-introduction-group
Tutorials
---------
- :doc:`Occlusion culling <../tutorials/3d/occlusion_culling>`
.. rst-class:: classref-reftable-group
Properties

2
classes/class_audiostreammicrophone.rst
View File

@@ -28,6 +28,8 @@ When used directly in an :ref:`AudioStreamPlayer<class_AudioStreamPlayer>` node,
Tutorials
---------
- :doc:`Recording with microphone <../tutorials/audio/recording_with_microphone>`
- `Audio Mic Record Demo <https://github.com/godotengine/godot-demo-projects/tree/master/audio/mic_record>`__
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`

7
classes/class_boxoccluder3d.rst
View File

@@ -23,6 +23,13 @@ Description
See :ref:`OccluderInstance3D<class_OccluderInstance3D>`'s documentation for instructions on setting up occlusion culling.
.. rst-class:: classref-introduction-group
Tutorials
---------
- :doc:`Occlusion culling <../tutorials/3d/occlusion_culling>`
.. rst-class:: classref-reftable-group
Properties

7
classes/class_cameraattributesphysical.rst
View File

@@ -27,6 +27,13 @@ The default settings are intended for use in an outdoor environment, tips for se
\ **Note:** Depth of field blur is only supported in the Forward+ and Mobile rendering methods, not Compatibility.
.. rst-class:: classref-introduction-group
Tutorials
---------
- :doc:`Physical light and camera units <../tutorials/3d/physical_light_and_camera_units>`
.. rst-class:: classref-reftable-group
Properties

2
classes/class_color.rst
View File

@@ -1883,7 +1883,7 @@ Returns ``true`` if ``color`` is a valid HTML hexadecimal color string. The stri
Color.html_is_valid("55AAFF") # Returns true
Color.html_is_valid("#F2C") # Returns true
Color.html_is_valid("#AABBC) # Returns false
Color.html_is_valid("#AABBC") # Returns false
Color.html_is_valid("#55aaFF5") # Returns false
.. code-tab:: csharp

2
classes/class_control.rst
View File

@@ -52,6 +52,8 @@ Tutorials
- :doc:`Control node gallery <../tutorials/ui/control_node_gallery>`
- :doc:`Multiple resolutions <../tutorials/rendering/multiple_resolutions>`
- `All GUI Demos <https://github.com/godotengine/godot-demo-projects/tree/master/gui>`__
.. rst-class:: classref-reftable-group

7
classes/class_cpuparticles3d.rst
View File

@@ -23,6 +23,13 @@ CPU-based 3D particle node used to create a variety of particle systems and effe
See also :ref:`GPUParticles3D<class_GPUParticles3D>`, which provides the same functionality with hardware acceleration, but may not run on older devices.
.. rst-class:: classref-introduction-group
Tutorials
---------
- :doc:`Particle systems (3D) <../tutorials/3d/particles/index>`
.. rst-class:: classref-reftable-group
Properties

7
classes/class_cryptokey.rst
View File

@@ -23,6 +23,13 @@ The CryptoKey class represents a cryptographic key. Keys can be loaded and saved
They can be used to generate a self-signed :ref:`X509Certificate<class_X509Certificate>` via :ref:`Crypto.generate_self_signed_certificate<class_Crypto_method_generate_self_signed_certificate>` and as private key in :ref:`StreamPeerTLS.accept_stream<class_StreamPeerTLS_method_accept_stream>` along with the appropriate certificate.
.. rst-class:: classref-introduction-group
Tutorials
---------
- :doc:`SSL certificates <../tutorials/networking/ssl_certificates>`
.. rst-class:: classref-reftable-group
Methods

4
classes/class_directionallight3d.rst
View File

@@ -26,7 +26,9 @@ A directional light is a type of :ref:`Light3D<class_Light3D>` node that models
Tutorials
---------
- :doc:`Lights and shadows <../tutorials/3d/lights_and_shadows>`
- :doc:`3D lights and shadows <../tutorials/3d/lights_and_shadows>`
- :doc:`Faking global illumination <../tutorials/3d/global_illumination/faking_global_illumination>`
.. rst-class:: classref-reftable-group

7
classes/class_editorexportplatform.rst
View File

@@ -25,6 +25,13 @@ Base resource that provides the functionality of exporting a release build of a
Used in scripting by :ref:`EditorExportPlugin<class_EditorExportPlugin>` to configure platform-specific customization of scenes and resources. See :ref:`EditorExportPlugin._begin_customize_scenes<class_EditorExportPlugin_method__begin_customize_scenes>` and :ref:`EditorExportPlugin._begin_customize_resources<class_EditorExportPlugin_method__begin_customize_resources>` for more details.
.. rst-class:: classref-introduction-group
Tutorials
---------
- `$DOCS_URL/tutorials/platform/consoles.html <Console support in Godot>`__
.. |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.)`

2
classes/class_editorexportplatformandroid.rst
View File

@@ -23,6 +23,8 @@ Tutorials
- :doc:`Custom builds for Android <../tutorials/export/android_custom_build>`
- :doc:`Android plugins documentation index <../tutorials/platform/index>`
.. rst-class:: classref-reftable-group
Properties

2
classes/class_editorexportplatformios.rst
View File

@@ -21,6 +21,8 @@ Tutorials
- :doc:`Exporting for iOS <../tutorials/export/exporting_for_ios>`
- :doc:`iOS plugins documentation index <../tutorials/platform/ios/index>`
.. rst-class:: classref-reftable-group
Properties

2
classes/class_editorexportplatformmacos.rst
View File

@@ -790,7 +790,7 @@ If enabled, a wrapper that can be used to run the application with console outpu
:ref:`bool<class_bool>` **display/high_res**
If ``true``, the application is rendered at native display resolution, otherwise it is always rendered at loHPI resolution and upscaled by OS when required.
If ``true``, the application is rendered at native display resolution, otherwise it is always rendered at loDPI resolution and upscaled by OS when required.
.. rst-class:: classref-item-separator

2
classes/class_editorexportplatformweb.rst
View File

@@ -21,6 +21,8 @@ Tutorials
- :doc:`Exporting for the Web <../tutorials/export/exporting_for_web>`
- :doc:`Web documentation index <../tutorials/platform/web/index>`
.. rst-class:: classref-reftable-group
Properties

2
classes/class_editorplugin.rst
View File

@@ -203,6 +203,8 @@ Emitted when user changes the workspace (**2D**, **3D**, **Script**, **AssetLib*
Emitted when any project setting has changed.
\ *Deprecated.* Use :ref:`ProjectSettings.settings_changed<class_ProjectSettings_signal_settings_changed>` instead.
.. rst-class:: classref-item-separator
----

2
classes/class_editorresourcepreview.rst
View File

@@ -19,7 +19,7 @@ A node used to generate previews of resources or files.
Description
-----------
This node is used to generate previews for resources of files.
This node is used to generate previews for resources or files.
\ **Note:** This class shouldn't be instantiated directly. Instead, access the singleton using :ref:`EditorInterface.get_resource_previewer<class_EditorInterface_method_get_resource_previewer>`.

4
classes/class_editorresourcepreviewgenerator.rst
View File

@@ -76,7 +76,7 @@ Returning an empty texture is an OK way to fail and let another generator take c
Care must be taken because this function is always called from a thread (not the main thread).
\ ``metadata`` dictionary can modified to store file-specific metadata that can be used in :ref:`EditorResourceTooltipPlugin._make_tooltip_for_path<class_EditorResourceTooltipPlugin_method__make_tooltip_for_path>` (like image size, sample length etc.).
\ ``metadata`` dictionary can be modified to store file-specific metadata that can be used in :ref:`EditorResourceTooltipPlugin._make_tooltip_for_path<class_EditorResourceTooltipPlugin_method__make_tooltip_for_path>` (like image size, sample length etc.).
.. rst-class:: classref-item-separator
@@ -94,7 +94,7 @@ Returning an empty texture is an OK way to fail and let another generator take c
Care must be taken because this function is always called from a thread (not the main thread).
\ ``metadata`` dictionary can modified to store file-specific metadata that can be used in :ref:`EditorResourceTooltipPlugin._make_tooltip_for_path<class_EditorResourceTooltipPlugin_method__make_tooltip_for_path>` (like image size, sample length etc.).
\ ``metadata`` dictionary can be modified to store file-specific metadata that can be used in :ref:`EditorResourceTooltipPlugin._make_tooltip_for_path<class_EditorResourceTooltipPlugin_method__make_tooltip_for_path>` (like image size, sample length etc.).
.. rst-class:: classref-item-separator

2
classes/class_editorsettings.rst
View File

@@ -1083,7 +1083,7 @@ The grid division bias to use in the 3D editor. Negative values will cause small
:ref:`int<class_int>` **editors/3d/grid_division_level_max**
The largest grid division to use in the 3D editor. Together with :ref:`editors/3d/primary_grid_steps<class_EditorSettings_property_editors/3d/primary_grid_steps>`, this determines how large the grid divisions can be. The grid divisions will not be able to get larger than ``primary_grid_steps ^ grid_division_level_max`` units. By default, when :ref:`editors/3d/primary_grid_steps<class_EditorSettings_property_editors/3d/primary_grid_steps>` is ``8``, this means grid divisions cannot get larger than ``64`` uints each (so primary grid lines are ``512`` uints apart), no matter how far away the camera is from the grid.
The largest grid division to use in the 3D editor. Together with :ref:`editors/3d/primary_grid_steps<class_EditorSettings_property_editors/3d/primary_grid_steps>`, this determines how large the grid divisions can be. The grid divisions will not be able to get larger than ``primary_grid_steps ^ grid_division_level_max`` units. By default, when :ref:`editors/3d/primary_grid_steps<class_EditorSettings_property_editors/3d/primary_grid_steps>` is ``8``, this means grid divisions cannot get larger than ``64`` units each (so primary grid lines are ``512`` units apart), no matter how far away the camera is from the grid.
.. rst-class:: classref-item-separator

2
classes/class_editorsyntaxhighlighter.rst
View File

@@ -21,7 +21,7 @@ Description
Base class that all :ref:`SyntaxHighlighter<class_SyntaxHighlighter>`\ s used by the :ref:`ScriptEditor<class_ScriptEditor>` extend from.
Add a syntax highlighter to an individual script by calling :ref:`ScriptEditorBase.add_syntax_highlighter<class_ScriptEditorBase_method_add_syntax_highlighter>`. To apply to all scripts on open, call :ref:`ScriptEditor.register_syntax_highlighter<class_ScriptEditor_method_register_syntax_highlighter>`
Add a syntax highlighter to an individual script by calling :ref:`ScriptEditorBase.add_syntax_highlighter<class_ScriptEditorBase_method_add_syntax_highlighter>`. To apply to all scripts on open, call :ref:`ScriptEditor.register_syntax_highlighter<class_ScriptEditor_method_register_syntax_highlighter>`.
.. rst-class:: classref-reftable-group

7
classes/class_editorvcsinterface.rst
View File

@@ -21,6 +21,13 @@ Description
Defines the API that the editor uses to extract information from the underlying VCS. The implementation of this API is included in VCS plugins, which are GDExtension plugins that inherit **EditorVCSInterface** and are attached (on demand) to the singleton instance of **EditorVCSInterface**. Instead of performing the task themselves, all the virtual functions listed below are calling the internally overridden functions in the VCS plugins to provide a plug-n-play experience. A custom VCS plugin is supposed to inherit from **EditorVCSInterface** and override each of these virtual functions.
.. rst-class:: classref-introduction-group
Tutorials
---------
- :doc:`Version control systems <../tutorials/best_practices/version_control_systems>`
.. rst-class:: classref-reftable-group
Methods

2
classes/class_environment.rst
View File

@@ -36,7 +36,7 @@ Tutorials
- :doc:`Environment and post-processing <../tutorials/3d/environment_and_post_processing>`
- :doc:`Light transport in game engines <../tutorials/3d/high_dynamic_range>`
- :doc:`High dynamic range lighting <../tutorials/3d/high_dynamic_range>`
- `3D Material Testers Demo <https://godotengine.org/asset-library/asset/123>`__

2
classes/class_fileaccess.rst
View File

@@ -730,7 +730,7 @@ Returns an MD5 String representing the file at the given path or an empty :ref:`
:ref:`int<class_int>` **get_modified_time** **(** :ref:`String<class_String>` file **)** |static|
Returns the last time the ``file`` was modified in Unix timestamp format or returns a :ref:`String<class_String>` "ERROR IN ``file``". This Unix timestamp can be converted to another format using the :ref:`Time<class_Time>` singleton.
Returns the last time the ``file`` was modified in Unix timestamp format, or ``0`` on error. This Unix timestamp can be converted to another format using the :ref:`Time<class_Time>` singleton.
.. rst-class:: classref-item-separator

7
classes/class_fogvolume.rst
View File

@@ -25,6 +25,13 @@ Performance of **FogVolume**\ s is directly related to their relative size on th
\ **Note:** **FogVolume**\ s only have a visible effect if :ref:`Environment.volumetric_fog_enabled<class_Environment_property_volumetric_fog_enabled>` is ``true``. If you don't want fog to be globally visible (but only within **FogVolume** nodes), set :ref:`Environment.volumetric_fog_density<class_Environment_property_volumetric_fog_density>` to ``0.0``.
.. rst-class:: classref-introduction-group
Tutorials
---------
- :doc:`Volumetric fog and fog volumes <../tutorials/3d/volumetric_fog>`
.. rst-class:: classref-reftable-group
Properties

7
classes/class_geometryinstance3d.rst
View File

@@ -23,6 +23,13 @@ Description
Base node for geometry-based visual instances. Shares some common functionality like visibility and custom materials.
.. rst-class:: classref-introduction-group
Tutorials
---------
- :doc:`Visibility ranges (HLOD) <../tutorials/3d/visibility_ranges>`
.. rst-class:: classref-reftable-group
Properties

14
classes/class_gpuparticles2d.rst
View File

@@ -101,6 +101,8 @@ Methods
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_Rect2>` | :ref:`capture_rect<class_GPUParticles2D_method_capture_rect>` **(** **)** |const| |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`convert_from_particles<class_GPUParticles2D_method_convert_from_particles>` **(** :ref:`Node<class_Node>` particles **)** |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`emit_particle<class_GPUParticles2D_method_emit_particle>` **(** :ref:`Transform2D<class_Transform2D>` xform, :ref:`Vector2<class_Vector2>` velocity, :ref:`Color<class_Color>` color, :ref:`Color<class_Color>` custom, :ref:`int<class_int>` flags **)** |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`restart<class_GPUParticles2D_method_restart>` **(** **)** |
@@ -620,6 +622,18 @@ Returns a rectangle containing the positions of all existing particles.
----
.. _class_GPUParticles2D_method_convert_from_particles:
.. rst-class:: classref-method
void **convert_from_particles** **(** :ref:`Node<class_Node>` particles **)**
Sets this node's properties to match a given :ref:`CPUParticles2D<class_CPUParticles2D>` node.
.. rst-class:: classref-item-separator
----
.. _class_GPUParticles2D_method_emit_particle:
.. rst-class:: classref-method

16
classes/class_gpuparticles3d.rst
View File

@@ -28,6 +28,8 @@ Use the ``process_material`` property to add a :ref:`ParticleProcessMaterial<cla
Tutorials
---------
- :doc:`Particle systems (3D) <../tutorials/3d/particles/index>`
- :doc:`Controlling thousands of fish with Particles <../tutorials/performance/vertex_animation/controlling_thousands_of_fish>`
- `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`__
@@ -105,6 +107,8 @@ Methods
+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`AABB<class_AABB>` | :ref:`capture_aabb<class_GPUParticles3D_method_capture_aabb>` **(** **)** |const| |
+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`convert_from_particles<class_GPUParticles3D_method_convert_from_particles>` **(** :ref:`Node<class_Node>` particles **)** |
+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`emit_particle<class_GPUParticles3D_method_emit_particle>` **(** :ref:`Transform3D<class_Transform3D>` xform, :ref:`Vector3<class_Vector3>` velocity, :ref:`Color<class_Color>` color, :ref:`Color<class_Color>` custom, :ref:`int<class_int>` flags **)** |
+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Mesh<class_Mesh>` | :ref:`get_draw_pass_mesh<class_GPUParticles3D_method_get_draw_pass_mesh>` **(** :ref:`int<class_int>` pass **)** |const| |
@@ -771,6 +775,18 @@ Returns the axis-aligned bounding box that contains all the particles that are a
----
.. _class_GPUParticles3D_method_convert_from_particles:
.. rst-class:: classref-method
void **convert_from_particles** **(** :ref:`Node<class_Node>` particles **)**
Sets this node's properties to match a given :ref:`CPUParticles3D<class_CPUParticles3D>` node.
.. rst-class:: classref-item-separator
----
.. _class_GPUParticles3D_method_emit_particle:
.. rst-class:: classref-method

12
classes/class_gridmap.rst
View File

@@ -147,6 +147,18 @@ Signals
Emitted when :ref:`cell_size<class_GridMap_property_cell_size>` changes.
.. rst-class:: classref-item-separator
----
.. _class_GridMap_signal_changed:
.. rst-class:: classref-signal
**changed** **(** **)**
Emitted when the :ref:`MeshLibrary<class_MeshLibrary>` of this GridMap changes.
.. rst-class:: classref-section-separator
----

14
classes/class_image.rst
View File

@@ -139,6 +139,8 @@ Methods
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`load_jpg_from_buffer<class_Image_method_load_jpg_from_buffer>` **(** :ref:`PackedByteArray<class_PackedByteArray>` buffer **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`load_ktx_from_buffer<class_Image_method_load_ktx_from_buffer>` **(** :ref:`PackedByteArray<class_PackedByteArray>` buffer **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`load_png_from_buffer<class_Image_method_load_png_from_buffer>` **(** :ref:`PackedByteArray<class_PackedByteArray>` buffer **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`load_svg_from_buffer<class_Image_method_load_svg_from_buffer>` **(** :ref:`PackedByteArray<class_PackedByteArray>` buffer, :ref:`float<class_float>` scale=1.0 **)** |
@@ -1404,6 +1406,18 @@ Loads an image from the binary contents of a JPEG file.
----
.. _class_Image_method_load_ktx_from_buffer:
.. rst-class:: classref-method
:ref:`Error<enum_@GlobalScope_Error>` **load_ktx_from_buffer** **(** :ref:`PackedByteArray<class_PackedByteArray>` buffer **)**
Loads an image from the binary contents of a KTX file.
.. rst-class:: classref-item-separator
----
.. _class_Image_method_load_png_from_buffer:
.. rst-class:: classref-method

7
classes/class_label3d.rst
View File

@@ -21,6 +21,13 @@ Description
A node for displaying plain text in 3D space. By adjusting various properties of this node, you can configure things such as the text's appearance and whether it always faces the camera.
.. rst-class:: classref-introduction-group
Tutorials
---------
- :doc:`3D text <../tutorials/3d/3d_text>`
.. rst-class:: classref-reftable-group
Properties

2
classes/class_light3d.rst
View File

@@ -30,6 +30,8 @@ Tutorials
- :doc:`3D lights and shadows <../tutorials/3d/lights_and_shadows>`
- :doc:`Faking global illumination <../tutorials/3d/global_illumination/faking_global_illumination>`
- `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`__
.. rst-class:: classref-reftable-group

7
classes/class_lightmapgi.rst
View File

@@ -31,6 +31,13 @@ The **LightmapGI** node is used to compute and store baked lightmaps. Lightmaps
\ **Note:** If no custom lightmappers are installed, **LightmapGI** can only be baked when using the Vulkan backend (Forward+ or Mobile), not OpenGL.
.. rst-class:: classref-introduction-group
Tutorials
---------
- :doc:`Using Lightmap global illumination <../tutorials/3d/global_illumination/using_lightmap_gi>`
.. rst-class:: classref-reftable-group
Properties

7
classes/class_meshdatatool.rst
View File

@@ -72,6 +72,13 @@ See also :ref:`ArrayMesh<class_ArrayMesh>`, :ref:`ImmediateMesh<class_ImmediateM
\ **Note:** Godot uses clockwise `winding order <https://learnopengl.com/Advanced-OpenGL/Face-culling>`__ for front faces of triangle primitive modes.
.. rst-class:: classref-introduction-group
Tutorials
---------
- :doc:`Using the MeshDataTool <../tutorials/3d/procedural_geometry/meshdatatool>`
.. rst-class:: classref-reftable-group
Methods

4
classes/class_multimesh.rst
View File

@@ -36,10 +36,12 @@ Since instances may have any behavior, the AABB used for visibility must be prov
Tutorials
---------
- :doc:`Animating thousands of fish with MultiMeshInstance <../tutorials/performance/vertex_animation/animating_thousands_of_fish>`
- :doc:`Using MultiMeshInstance <../tutorials/3d/using_multi_mesh_instance>`
- :doc:`Optimization using MultiMeshes <../tutorials/performance/using_multimesh>`
- :doc:`Animating thousands of fish with MultiMeshInstance <../tutorials/performance/vertex_animation/animating_thousands_of_fish>`
.. rst-class:: classref-reftable-group
Properties

4
classes/class_multimeshinstance3d.rst
View File

@@ -28,12 +28,12 @@ This is useful to optimize the rendering of a high number of instances of a give
Tutorials
---------
- :doc:`Animating thousands of fish with MultiMeshInstance <../tutorials/performance/vertex_animation/animating_thousands_of_fish>`
- :doc:`Using MultiMeshInstance <../tutorials/3d/using_multi_mesh_instance>`
- :doc:`Optimization using MultiMeshes <../tutorials/performance/using_multimesh>`
- :doc:`Animating thousands of fish with MultiMeshInstance <../tutorials/performance/vertex_animation/animating_thousands_of_fish>`
.. rst-class:: classref-reftable-group
Properties

4
classes/class_navigationmesh.rst
View File

@@ -26,10 +26,10 @@ A navigation mesh is a collection of polygons that define which areas of an envi
Tutorials
---------
- `3D Navmesh Demo <https://godotengine.org/asset-library/asset/124>`__
- :doc:`Using NavigationMeshes <../tutorials/navigation/navigation_using_navigationmeshes>`
- `3D Navmesh Demo <https://godotengine.org/asset-library/asset/124>`__
.. rst-class:: classref-reftable-group
Properties

2
classes/class_navigationobstacle2d.rst
View File

@@ -111,7 +111,7 @@ If ``true`` the obstacle affects avoidance using agents.
- void **set_avoidance_layers** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_avoidance_layers** **(** **)**
A bitfield determining the avoidance layers for this obstacle. Agent's with a matching bit on the their avoidance mask will avoid this obstacle.
A bitfield determining the avoidance layers for this obstacle. Agents with a matching bit on the their avoidance mask will avoid this obstacle.
.. rst-class:: classref-item-separator

2
classes/class_navigationobstacle3d.rst
View File

@@ -115,7 +115,7 @@ If ``true`` the obstacle affects avoidance using agents.
- void **set_avoidance_layers** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_avoidance_layers** **(** **)**
A bitfield determining the avoidance layers for this obstacle. Agent's with a matching bit on the their avoidance mask will avoid this obstacle.
A bitfield determining the avoidance layers for this obstacle. Agents with a matching bit on the their avoidance mask will avoid this obstacle.
.. rst-class:: classref-item-separator

31
classes/class_object.rst
View File

@@ -304,7 +304,7 @@ Combined with :ref:`_set<class_Object_method__set>` and :ref:`_get_property_list
.. code-tab:: gdscript
func _get(property):
if (property == "fake_property"):
if property == "fake_property":
print("Getting my property!")
return 4
@@ -533,9 +533,13 @@ Combined with :ref:`_get<class_Object_method__get>` and :ref:`_get_property_list
.. code-tab:: gdscript
var internal_data = {}
func _set(property, value):
if (property == "fake_property"):
print("Setting my property to ", value)
if property == "fake_property":
# Storing the value in the fake property.
internal_data["fake_property"] = value
return true
func _get_property_list():
return [
@@ -544,11 +548,14 @@ Combined with :ref:`_get<class_Object_method__get>` and :ref:`_get_property_list
.. code-tab:: csharp
private Godot.Collections.Dictionary _internalData = new Godot.Collections.Dictionary();
public override void _Set(StringName property, Variant value)
{
if (property == "FakeProperty")
{
GD.Print($"Setting my property to {value}");
// Storing the value in the fake property.
_internalData["FakeProperty"] = value;
return true;
}
@@ -1099,9 +1106,9 @@ Returns the object's unique instance ID. This ID can be saved in :ref:`EncodedOb
Returns the object's metadata value for the given entry ``name``. If the entry does not exist, returns ``default``. If ``default`` is ``null``, an error is also generated.
\ **Note:** A metadata's ``name`` must be a valid identifier as per :ref:`StringName.is_valid_identifier<class_StringName_method_is_valid_identifier>` method.
\ **Note:** A metadata's name must be a valid identifier as per :ref:`StringName.is_valid_identifier<class_StringName_method_is_valid_identifier>` method.
\ **Note:** Metadata that has a ``name`` starting with an underscore (``_``) is considered editor-only. Editor-only metadata is not displayed in the Inspector and should not be edited, although it can still be found by this method.
\ **Note:** Metadata that has a name starting with an underscore (``_``) is considered editor-only. Editor-only metadata is not displayed in the Inspector and should not be edited, although it can still be found by this method.
.. rst-class:: classref-item-separator
@@ -1221,9 +1228,9 @@ Returns the list of existing signals as an :ref:`Array<class_Array>` of dictiona
Returns ``true`` if a metadata entry is found with the given ``name``. See also :ref:`get_meta<class_Object_method_get_meta>`, :ref:`set_meta<class_Object_method_set_meta>` and :ref:`remove_meta<class_Object_method_remove_meta>`.
\ **Note:** A metadata's ``name`` must be a valid identifier as per :ref:`StringName.is_valid_identifier<class_StringName_method_is_valid_identifier>` method.
\ **Note:** A metadata's name must be a valid identifier as per :ref:`StringName.is_valid_identifier<class_StringName_method_is_valid_identifier>` method.
\ **Note:** Metadata that has a ``name`` starting with an underscore (``_``) is considered editor-only. Editor-only metadata is not displayed in the Inspector and should not be edited, although it can still be found by this method.
\ **Note:** Metadata that has a name starting with an underscore (``_``) is considered editor-only. Editor-only metadata is not displayed in the Inspector and should not be edited, although it can still be found by this method.
.. rst-class:: classref-item-separator
@@ -1429,9 +1436,9 @@ void **remove_meta** **(** :ref:`StringName<class_StringName>` name **)**
Removes the given entry ``name`` from the object's metadata. See also :ref:`has_meta<class_Object_method_has_meta>`, :ref:`get_meta<class_Object_method_get_meta>` and :ref:`set_meta<class_Object_method_set_meta>`.
\ **Note:** A metadata's ``name`` must be a valid identifier as per :ref:`StringName.is_valid_identifier<class_StringName_method_is_valid_identifier>` method.
\ **Note:** A metadata's name must be a valid identifier as per :ref:`StringName.is_valid_identifier<class_StringName_method_is_valid_identifier>` method.
\ **Note:** Metadata that has a ``name`` starting with an underscore (``_``) is considered editor-only. Editor-only metadata is not displayed in the Inspector and should not be edited, although it can still be found by this method.
\ **Note:** Metadata that has a name starting with an underscore (``_``) is considered editor-only. Editor-only metadata is not displayed in the Inspector and should not be edited, although it can still be found by this method.
.. rst-class:: classref-item-separator
@@ -1576,9 +1583,9 @@ Adds or changes the entry ``name`` inside the object's metadata. The metadata ``
If ``value`` is ``null``, the entry is removed. This is the equivalent of using :ref:`remove_meta<class_Object_method_remove_meta>`. See also :ref:`has_meta<class_Object_method_has_meta>` and :ref:`get_meta<class_Object_method_get_meta>`.
\ **Note:** A metadata's ``name`` must be a valid identifier as per :ref:`StringName.is_valid_identifier<class_StringName_method_is_valid_identifier>` method.
\ **Note:** A metadata's name must be a valid identifier as per :ref:`StringName.is_valid_identifier<class_StringName_method_is_valid_identifier>` method.
\ **Note:** Metadata that has a ``name`` starting with an underscore (``_``) is considered editor-only. Editor-only metadata is not displayed in the Inspector and should not be edited, although it can still be found by this method.
\ **Note:** Metadata that has a name starting with an underscore (``_``) is considered editor-only. Editor-only metadata is not displayed in the Inspector and should not be edited, although it can still be found by this method.
.. rst-class:: classref-item-separator

7
classes/class_occluder3d.rst
View File

@@ -25,6 +25,13 @@ Description
See :ref:`OccluderInstance3D<class_OccluderInstance3D>`'s documentation for instructions on setting up occlusion culling.
.. rst-class:: classref-introduction-group
Tutorials
---------
- :doc:`Occlusion culling <../tutorials/3d/occlusion_culling>`
.. rst-class:: classref-reftable-group
Methods

7
classes/class_occluderinstance3d.rst
View File

@@ -29,6 +29,13 @@ The occlusion culling system works by rendering the occluders on the CPU in para
\ **Note:** Occlusion culling is only effective if :ref:`ProjectSettings.rendering/occlusion_culling/use_occlusion_culling<class_ProjectSettings_property_rendering/occlusion_culling/use_occlusion_culling>` is ``true``. Enabling occlusion culling has a cost on the CPU. Only enable occlusion culling if you actually plan to use it. Large open scenes with few or no objects blocking the view will generally not benefit much from occlusion culling. Large open scenes generally benefit more from mesh LOD and visibility ranges (:ref:`GeometryInstance3D.visibility_range_begin<class_GeometryInstance3D_property_visibility_range_begin>` and :ref:`GeometryInstance3D.visibility_range_end<class_GeometryInstance3D_property_visibility_range_end>`) compared to occlusion culling.
.. rst-class:: classref-introduction-group
Tutorials
---------
- :doc:`Occlusion culling <../tutorials/3d/occlusion_culling>`
.. rst-class:: classref-reftable-group
Properties

2
classes/class_omnilight3d.rst
View File

@@ -32,6 +32,8 @@ Tutorials
- :doc:`3D lights and shadows <../tutorials/3d/lights_and_shadows>`
- :doc:`Faking global illumination <../tutorials/3d/global_illumination/faking_global_illumination>`
.. rst-class:: classref-reftable-group
Properties

4
classes/class_optionbutton.rst
View File

@@ -23,12 +23,8 @@ Description
See also :ref:`BaseButton<class_BaseButton>` which contains common properties and methods associated with this node.
\ **Note:** Properties :ref:`Button.text<class_Button_property_text>` and :ref:`Button.icon<class_Button_property_icon>` are automatically set based on the selected item. They shouldn't be changed manually.
\ **Note:** The ID values used for items are limited to 32 bits, not full 64 bits of :ref:`int<class_int>`. This has a range of ``-2^32`` to ``2^32 - 1``, i.e. ``-2147483648`` to ``2147483647``.
\ **Note:** The ID values used for items are 32-bit, unlike :ref:`int<class_int>` which is always 64-bit. They go from ``-2147483648`` to ``2147483647``.
\ **Note:** The :ref:`Button.text<class_Button_property_text>` and :ref:`Button.icon<class_Button_property_icon>` properties are set automatically based on the selected item. They shouldn't be changed manually.
.. rst-class:: classref-reftable-group

7
classes/class_polygonoccluder3d.rst
View File

@@ -23,6 +23,13 @@ Description
See :ref:`OccluderInstance3D<class_OccluderInstance3D>`'s documentation for instructions on setting up occlusion culling.
.. rst-class:: classref-introduction-group
Tutorials
---------
- :doc:`Occlusion culling <../tutorials/3d/occlusion_culling>`
.. rst-class:: classref-reftable-group
Properties

18
classes/class_projectsettings.rst
View File

@@ -195,6 +195,8 @@ Properties
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`debug/gdscript/warnings/redundant_await<class_ProjectSettings_property_debug/gdscript/warnings/redundant_await>` | ``1`` |
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`debug/gdscript/warnings/redundant_for_variable_type<class_ProjectSettings_property_debug/gdscript/warnings/redundant_for_variable_type>` | ``1`` |
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`debug/gdscript/warnings/redundant_static_unload<class_ProjectSettings_property_debug/gdscript/warnings/redundant_static_unload>` | ``1`` |
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`debug/gdscript/warnings/renamed_in_godot_4_hint<class_ProjectSettings_property_debug/gdscript/warnings/renamed_in_godot_4_hint>` | ``1`` |
@@ -2550,6 +2552,18 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w
----
.. _class_ProjectSettings_property_debug/gdscript/warnings/redundant_for_variable_type:
.. rst-class:: classref-property
:ref:`int<class_int>` **debug/gdscript/warnings/redundant_for_variable_type** = ``1``
When set to ``warn`` or ``error``, produces a warning or an error respectively when a ``for`` variable type specifier is a supertype of the inferred type.
.. rst-class:: classref-item-separator
----
.. _class_ProjectSettings_property_debug/gdscript/warnings/redundant_static_unload:
.. rst-class:: classref-property
@@ -11089,8 +11103,8 @@ Adds a custom property info to a property. The dictionary must contain:
var propertyInfo = new Godot.Collections.Dictionary
{
{"name", "category/propertyName"},
{"type", Variant.Type.Int},
{"hint", PropertyHint.Enum},
{"type", (int)Variant.Type.Int},
{"hint", (int)PropertyHint.Enum},
{"hint_string", "one,two,three"},
};

7
classes/class_quadoccluder3d.rst
View File

@@ -23,6 +23,13 @@ Description
See :ref:`OccluderInstance3D<class_OccluderInstance3D>`'s documentation for instructions on setting up occlusion culling.
.. rst-class:: classref-introduction-group
Tutorials
---------
- :doc:`Occlusion culling <../tutorials/3d/occlusion_culling>`
.. rst-class:: classref-reftable-group
Properties

2
classes/class_renderingdevice.rst
View File

@@ -34,7 +34,7 @@ On startup, Godot creates a global **RenderingDevice** which can be retrieved us
Tutorials
---------
- `Using compute shaders <https://docs.godotengine.org/en/latest/tutorials/shaders/compute_shaders.html>`__
- :doc:`Using compute shaders <../tutorials/shaders/compute_shaders>`
.. rst-class:: classref-reftable-group

2
classes/class_renderingserver.rst
View File

@@ -1588,7 +1588,7 @@ Flag used to mark that the array contains 2D vertices.
:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_USE_8_BONE_WEIGHTS** = ``134217728``
Flag used to mark that the array uses 8 bone weighs instead of 4.
Flag used to mark that the array uses 8 bone weights instead of 4.
.. _class_RenderingServer_constant_ARRAY_FLAG_USES_EMPTY_VERTEX_ARRAY:

2
classes/class_resourceimportercsvtranslation.rst
View File

@@ -36,7 +36,7 @@ Comma-separated values are a plain text table storage format. The format's simpl
Tutorials
---------
- `Importing translations <https://docs.godotengine.org/en/latest/tutorials/assets_pipeline/importing_translations.html>`__
- :doc:`Importing translations <../tutorials/assets_pipeline/importing_translations>`
.. rst-class:: classref-reftable-group

2
classes/class_resourceimporterlayeredtexture.rst
View File

@@ -147,7 +147,7 @@ The compression mode to use. Each compression mode provides a different tradeoff
\ **Basis Universal:** Reduced quality, low memory usage, lowest size on disk, slow import. Only use for textures in 3D scenes, not for 2D elements.
See `Compress mode <https://docs.godotengine.org/en/latest/tutorials/assets_pipeline/importing_images.html#compress-mode>`__ in the manual for more details.
See `Compress mode <../tutorials/assets_pipeline/importing_images.html#compress-mode>`__ in the manual for more details.
.. rst-class:: classref-item-separator

2
classes/class_resourceimporteroggvorbis.rst
View File

@@ -30,7 +30,7 @@ Ogg Vorbis requires more CPU to decode than :ref:`ResourceImporterWAV<class_Reso
Tutorials
---------
- `Importing audio samples <https://docs.godotengine.org/en/latest/tutorials/assets_pipeline/importing_audio_samples.html>`__
- :doc:`Importing audio samples <../tutorials/assets_pipeline/importing_audio_samples>`
.. rst-class:: classref-reftable-group

2
classes/class_resourceimportertexture.rst
View File

@@ -169,7 +169,7 @@ The compression mode to use. Each compression mode provides a different tradeoff
\ **Basis Universal:** Reduced quality, low memory usage, lowest size on disk, slow import. Only use for textures in 3D scenes, not for 2D elements.
See `Compress mode <https://docs.godotengine.org/en/latest/tutorials/assets_pipeline/importing_images.html#compress-mode>`__ in the manual for more details.
See `Compress mode <../tutorials/assets_pipeline/importing_images.html#compress-mode>`__ in the manual for more details.
.. rst-class:: classref-item-separator

14
classes/class_richtextlabel.rst
View File

@@ -201,6 +201,8 @@ Methods
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`push_italics<class_RichTextLabel_method_push_italics>` **(** **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`push_language<class_RichTextLabel_method_push_language>` **(** :ref:`String<class_String>` language **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`push_list<class_RichTextLabel_method_push_list>` **(** :ref:`int<class_int>` level, :ref:`ListType<enum_RichTextLabel_ListType>` type, :ref:`bool<class_bool>` capitalize, :ref:`String<class_String>` bullet="•" **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`push_meta<class_RichTextLabel_method_push_meta>` **(** :ref:`Variant<class_Variant>` data **)** |
@@ -1505,6 +1507,18 @@ Adds a ``[font]`` tag with an italics font to the tag stack. This is the same as
----
.. _class_RichTextLabel_method_push_language:
.. rst-class:: classref-method
void **push_language** **(** :ref:`String<class_String>` language **)**
Adds language code used for text shaping algorithm and Open-Type font features.
.. rst-class:: classref-item-separator
----
.. _class_RichTextLabel_method_push_list:
.. rst-class:: classref-method

7
classes/class_sphereoccluder3d.rst
View File

@@ -23,6 +23,13 @@ Description
See :ref:`OccluderInstance3D<class_OccluderInstance3D>`'s documentation for instructions on setting up occlusion culling.
.. rst-class:: classref-introduction-group
Tutorials
---------
- :doc:`Occlusion culling <../tutorials/3d/occlusion_culling>`
.. rst-class:: classref-reftable-group
Properties

2
classes/class_spotlight3d.rst
View File

@@ -32,6 +32,8 @@ Tutorials
- :doc:`3D lights and shadows <../tutorials/3d/lights_and_shadows>`
- :doc:`Faking global illumination <../tutorials/3d/global_illumination/faking_global_illumination>`
- `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`__
.. rst-class:: classref-reftable-group

2
classes/class_surfacetool.rst
View File

@@ -57,6 +57,8 @@ See also :ref:`ArrayMesh<class_ArrayMesh>`, :ref:`ImmediateMesh<class_ImmediateM
Tutorials
---------
- :doc:`Using the SurfaceTool <../tutorials/3d/procedural_geometry/surfacetool>`
- `3D Voxel Demo <https://godotengine.org/asset-library/asset/676>`__
.. rst-class:: classref-reftable-group

7
classes/class_textmesh.rst
View File

@@ -25,6 +25,13 @@ TextMesh can be generated only when using dynamic fonts with vector glyph contou
The UV layout is arranged in 4 horizontal strips, top to bottom: 40% of the height for the front face, 40% for the back face, 10% for the outer edges and 10% for the inner edges.
.. rst-class:: classref-introduction-group
Tutorials
---------
- :doc:`3D text <../tutorials/3d/3d_text>`
.. rst-class:: classref-reftable-group
Properties

4
classes/class_textserver.rst
View File

@@ -1761,7 +1761,7 @@ Returns outline contours of the glyph as a ``Dictionary`` with the following con
:ref:`int<class_int>` **font_get_glyph_index** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`int<class_int>` char, :ref:`int<class_int>` variation_selector **)** |const|
Returns the glyph index of a ``char``, optionally modified by the ``variation_selector``. See :ref:`font_get_char_from_glyph_index<class_TextServer_method_font_get_char_from_glyph_index>`.
Returns the glyph index of a ``char``, optionally modified by the ``variation_selector``. See :ref:`font_get_char_from_glyph_index<class_TextServer_method_font_get_char_from_glyph_index>`.
.. rst-class:: classref-item-separator
@@ -3603,7 +3603,7 @@ Breaks text into words and returns array of character ranges. Use ``grapheme_fla
:ref:`bool<class_bool>` **shaped_text_has_visible_chars** **(** :ref:`RID<class_RID>` shaped **)** |const|
Returns ``true``, if text buffer contents any visible characters.
Returns ``true`` if text buffer contains any visible characters.
.. rst-class:: classref-item-separator

2
classes/class_tree.rst
View File

@@ -1676,7 +1676,7 @@ The right margin of the scrollbars. When negative, uses :ref:`panel<class_Tree_t
:ref:`int<class_int>` **scrollbar_margin_top** = ``-1``
The right margin of the vertical scrollbar. When negative, uses :ref:`panel<class_Tree_theme_style_panel>` top margin.
The top margin of the vertical scrollbar. When negative, uses :ref:`panel<class_Tree_theme_style_panel>` top margin.
.. rst-class:: classref-item-separator

28
classes/class_treeitem.rst
View File

@@ -144,6 +144,8 @@ Methods
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`TextDirection<enum_Control_TextDirection>` | :ref:`get_text_direction<class_TreeItem_method_get_text_direction>` **(** :ref:`int<class_int>` column **)** |const| |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` | :ref:`get_text_overrun_behavior<class_TreeItem_method_get_text_overrun_behavior>` **(** :ref:`int<class_int>` column **)** |const| |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_tooltip_text<class_TreeItem_method_get_tooltip_text>` **(** :ref:`int<class_int>` column **)** |const| |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Tree<class_Tree>` | :ref:`get_tree<class_TreeItem_method_get_tree>` **(** **)** |const| |
@@ -242,6 +244,8 @@ Methods
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_text_direction<class_TreeItem_method_set_text_direction>` **(** :ref:`int<class_int>` column, :ref:`TextDirection<enum_Control_TextDirection>` direction **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_text_overrun_behavior<class_TreeItem_method_set_text_overrun_behavior>` **(** :ref:`int<class_int>` column, :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` overrun_behavior **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tooltip_text<class_TreeItem_method_set_tooltip_text>` **(** :ref:`int<class_int>` column, :ref:`String<class_String>` tooltip **)** |
+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`uncollapse_tree<class_TreeItem_method_uncollapse_tree>` **(** **)** |
@@ -954,6 +958,18 @@ Returns item's text base writing direction.
----
.. _class_TreeItem_method_get_text_overrun_behavior:
.. rst-class:: classref-method
:ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **get_text_overrun_behavior** **(** :ref:`int<class_int>` column **)** |const|
Returns the clipping behavior when the text exceeds the item's bounding rectangle in the given ``column``. By default it is :ref:`TextServer.OVERRUN_TRIM_ELLIPSIS<class_TextServer_constant_OVERRUN_TRIM_ELLIPSIS>`.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_get_tooltip_text:
.. rst-class:: classref-method
@@ -1566,6 +1582,18 @@ Sets item's text base writing direction.
----
.. _class_TreeItem_method_set_text_overrun_behavior:
.. rst-class:: classref-method
void **set_text_overrun_behavior** **(** :ref:`int<class_int>` column, :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` overrun_behavior **)**
Sets the clipping behavior when the text exceeds the item's bounding rectangle in the given ``column``.
.. rst-class:: classref-item-separator
----
.. _class_TreeItem_method_set_tooltip_text:
.. rst-class:: classref-method

2
classes/class_tween.rst
View File

@@ -143,7 +143,7 @@ Some :ref:`Tweener<class_Tweener>`\ s use transitions and eases. The first accep
\ **Note:** Tweens are not designed to be re-used and trying to do so results in an undefined behavior. Create a new Tween for each animation and every time you replay an animation from start. Keep in mind that Tweens start immediately, so only create a Tween when you want to start animating.
\ **Note:** The tween is processed after all of the nodes in the current frame, i.e. node's :ref:`Node._process<class_Node_method__process>` method would be called before the timer (or :ref:`Node._physics_process<class_Node_method__physics_process>` depending on the value passed to :ref:`set_process_mode<class_Tween_method_set_process_mode>`).
\ **Note:** The tween is processed after all of the nodes in the current frame, i.e. node's :ref:`Node._process<class_Node_method__process>` method would be called before the tween (or :ref:`Node._physics_process<class_Node_method__physics_process>` depending on the value passed to :ref:`set_process_mode<class_Tween_method_set_process_mode>`).
.. rst-class:: classref-reftable-group

7
classes/class_videostream.rst
View File

@@ -23,6 +23,13 @@ Description
Base resource type for all video streams. Classes that derive from **VideoStream** can all be used as resource types to play back videos in :ref:`VideoStreamPlayer<class_VideoStreamPlayer>`.
.. rst-class:: classref-introduction-group
Tutorials
---------
- :doc:`Playing videos <../tutorials/animation/playing_videos>`
.. rst-class:: classref-reftable-group
Properties

7
classes/class_videostreamplayer.rst
View File

@@ -27,6 +27,13 @@ Supported video formats are `Ogg Theora <https://www.theora.org/>`__ (``.ogv``,
\ **Warning:** On Web, video playback *will* perform poorly due to missing architecture-specific assembly optimizations.
.. rst-class:: classref-introduction-group
Tutorials
---------
- :doc:`Playing videos <../tutorials/animation/playing_videos>`
.. rst-class:: classref-reftable-group
Properties

4
classes/class_viewport.rst
View File

@@ -1300,6 +1300,8 @@ If ``true``, the viewport will use a unique copy of the :ref:`World3D<class_Worl
If ``true``, the objects rendered by viewport become subjects of mouse picking process.
\ **Note:** The number of simultaneously pickable objects is limited to 64 and they are selected in a non-deterministic order, which can be different in each picking process.
.. rst-class:: classref-item-separator
----
@@ -1319,6 +1321,8 @@ If ``true``, objects receive mouse picking events sorted primarily by their :ref
\ **Note:** This setting is disabled by default because of its potential expensive computational cost.
\ **Note:** Sorting happens after selecting the pickable objects. Because of the limitation of 64 simultaneously pickable objects, it is not guaranteed that the object with the highest :ref:`CanvasItem.z_index<class_CanvasItem_property_z_index>` receives the picking event.
.. rst-class:: classref-item-separator
----

2
classes/class_voxelgi.rst
View File

@@ -34,7 +34,7 @@ Description
Tutorials
---------
- :doc:`VoxelGI <../tutorials/3d/global_illumination/using_voxel_gi>`
- :doc:`Using Voxel global illumination <../tutorials/3d/global_illumination/using_voxel_gi>`
- `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`__

7
classes/class_x509certificate.rst
View File

@@ -23,6 +23,13 @@ The X509Certificate class represents an X509 certificate. Certificates can be lo
They can be used as the server certificate in :ref:`StreamPeerTLS.accept_stream<class_StreamPeerTLS_method_accept_stream>` (along with the proper :ref:`CryptoKey<class_CryptoKey>`), and to specify the only certificate that should be accepted when connecting to a TLS server via :ref:`StreamPeerTLS.connect_to_stream<class_StreamPeerTLS_method_connect_to_stream>`.
.. rst-class:: classref-introduction-group
Tutorials
---------
- :doc:`SSL certificates <../tutorials/networking/ssl_certificates>`
.. rst-class:: classref-reftable-group
Methods

7
classes/class_xranchor3d.rst
View File

@@ -25,6 +25,13 @@ This node is mapped to one of the anchors through its unique ID. When you receiv
Keep in mind that, as long as plane detection is enabled, the size, placing and orientation of an anchor will be updated as the detection logic learns more about the real world out there especially if only part of the surface is in view.
.. rst-class:: classref-introduction-group
Tutorials
---------
- :doc:`XR documentation index <../tutorials/xr/index>`
.. rst-class:: classref-reftable-group
Methods

7
classes/class_xrinterfaceextension.rst
View File

@@ -21,6 +21,13 @@ Description
External XR interface plugins should inherit from this class.
.. rst-class:: classref-introduction-group
Tutorials
---------
- :doc:`XR documentation index <../tutorials/xr/index>`
.. rst-class:: classref-reftable-group
Methods

7
classes/class_xrnode3d.rst
View File

@@ -23,6 +23,13 @@ Description
This node can be bound to a specific pose of a :ref:`XRPositionalTracker<class_XRPositionalTracker>` and will automatically have its :ref:`Node3D.transform<class_Node3D_property_transform>` updated by the :ref:`XRServer<class_XRServer>`. Nodes of this type must be added as children of the :ref:`XROrigin3D<class_XROrigin3D>` node.
.. rst-class:: classref-introduction-group
Tutorials
---------
- :doc:`XR documentation index <../tutorials/xr/index>`
.. rst-class:: classref-reftable-group
Properties

7
classes/class_xrpose.rst
View File

@@ -23,6 +23,13 @@ XR runtimes often identify multiple locations on devices such as controllers tha
Orientation, location, linear velocity and angular velocity are all provided for each pose by the XR runtime. This object contains this state of a pose.
.. rst-class:: classref-introduction-group
Tutorials
---------
- :doc:`XR documentation index <../tutorials/xr/index>`
.. rst-class:: classref-reftable-group
Properties