Skip to content

Commit 0be715a

Browse files
authored
Merge pull request godotengine#7840 from godotengine/classref/sync-6da4ad1
2 parents 0ea5759 + 55d4bd8 commit 0be715a

File tree

70 files changed

+372
-52
lines changed

Some content is hidden

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

70 files changed

+372
-52
lines changed

classes/class_array.rst

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -567,7 +567,7 @@ void **erase** **(** :ref:`Variant<class_Variant>` value **)**
567567

568568
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.
569569

570-
\ **Note:** This method acts in-place and doesn't return a value.
570+
\ **Note:** This method acts in-place and doesn't return a modified array.
571571

572572
\ **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.
573573

@@ -770,9 +770,9 @@ Returns a hashed 32-bit integer value representing the array and its contents.
770770

771771
:ref:`int<class_int>` **insert** **(** :ref:`int<class_int>` position, :ref:`Variant<class_Variant>` value **)**
772772

773-
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()``).
773+
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.
774774

775-
\ **Note:** This method acts in-place and doesn't return a value.
775+
\ **Note:** This method acts in-place and doesn't return a modified array.
776776

777777
\ **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.
778778

@@ -909,7 +909,7 @@ See also :ref:`max<class_Array_method_max>` for an example of using a custom com
909909

910910
:ref:`Variant<class_Variant>` **pick_random** **(** **)** |const|
911911

912-
Returns a random value from the target array.
912+
Returns a random value from the target array. Prints an error and returns ``null`` if the array is empty.
913913

914914

915915
.. tabs::
@@ -1029,7 +1029,7 @@ void **remove_at** **(** :ref:`int<class_int>` position **)**
10291029

10301030
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.
10311031

1032-
\ **Note:** This method acts in-place and doesn't return a value.
1032+
\ **Note:** This method acts in-place and doesn't return a modified array.
10331033

10341034
\ **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.
10351035

@@ -1045,7 +1045,9 @@ Removes an element from the array by index. If the index does not exist in the a
10451045

10461046
:ref:`int<class_int>` **resize** **(** :ref:`int<class_int>` size **)**
10471047

1048-
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``.
1048+
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.
1049+
1050+
\ **Note:** This method acts in-place and doesn't return a modified array.
10491051

10501052
.. rst-class:: classref-item-separator
10511053

classes/class_arrayoccluder3d.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,13 @@ Description
2323

2424
See :ref:`OccluderInstance3D<class_OccluderInstance3D>`'s documentation for instructions on setting up occlusion culling.
2525

26+
.. rst-class:: classref-introduction-group
27+
28+
Tutorials
29+
---------
30+
31+
- :doc:`Occlusion culling <../tutorials/3d/occlusion_culling>`
32+
2633
.. rst-class:: classref-reftable-group
2734

2835
Properties

classes/class_audiostreammicrophone.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ When used directly in an :ref:`AudioStreamPlayer<class_AudioStreamPlayer>` node,
2828
Tutorials
2929
---------
3030

31+
- :doc:`Recording with microphone <../tutorials/audio/recording_with_microphone>`
32+
3133
- `Audio Mic Record Demo <https://github.com/godotengine/godot-demo-projects/tree/master/audio/mic_record>`__
3234

3335
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`

classes/class_boxoccluder3d.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,13 @@ Description
2323

2424
See :ref:`OccluderInstance3D<class_OccluderInstance3D>`'s documentation for instructions on setting up occlusion culling.
2525

26+
.. rst-class:: classref-introduction-group
27+
28+
Tutorials
29+
---------
30+
31+
- :doc:`Occlusion culling <../tutorials/3d/occlusion_culling>`
32+
2633
.. rst-class:: classref-reftable-group
2734

2835
Properties

classes/class_cameraattributesphysical.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,13 @@ The default settings are intended for use in an outdoor environment, tips for se
2727

2828
\ **Note:** Depth of field blur is only supported in the Forward+ and Mobile rendering methods, not Compatibility.
2929

30+
.. rst-class:: classref-introduction-group
31+
32+
Tutorials
33+
---------
34+
35+
- :doc:`Physical light and camera units <../tutorials/3d/physical_light_and_camera_units>`
36+
3037
.. rst-class:: classref-reftable-group
3138

3239
Properties

classes/class_color.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1883,7 +1883,7 @@ Returns ``true`` if ``color`` is a valid HTML hexadecimal color string. The stri
18831883
Color.html_is_valid("55AAFF") # Returns true
18841884
Color.html_is_valid("#F2C") # Returns true
18851885

1886-
Color.html_is_valid("#AABBC) # Returns false
1886+
Color.html_is_valid("#AABBC") # Returns false
18871887
Color.html_is_valid("#55aaFF5") # Returns false
18881888

18891889
.. code-tab:: csharp

classes/class_control.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,8 @@ Tutorials
5252

5353
- :doc:`Control node gallery <../tutorials/ui/control_node_gallery>`
5454

55+
- :doc:`Multiple resolutions <../tutorials/rendering/multiple_resolutions>`
56+
5557
- `All GUI Demos <https://github.com/godotengine/godot-demo-projects/tree/master/gui>`__
5658

5759
.. rst-class:: classref-reftable-group

classes/class_cpuparticles3d.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,13 @@ CPU-based 3D particle node used to create a variety of particle systems and effe
2323

2424
See also :ref:`GPUParticles3D<class_GPUParticles3D>`, which provides the same functionality with hardware acceleration, but may not run on older devices.
2525

26+
.. rst-class:: classref-introduction-group
27+
28+
Tutorials
29+
---------
30+
31+
- :doc:`Particle systems (3D) <../tutorials/3d/particles/index>`
32+
2633
.. rst-class:: classref-reftable-group
2734

2835
Properties

classes/class_cryptokey.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,13 @@ The CryptoKey class represents a cryptographic key. Keys can be loaded and saved
2323

2424
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.
2525

26+
.. rst-class:: classref-introduction-group
27+
28+
Tutorials
29+
---------
30+
31+
- :doc:`SSL certificates <../tutorials/networking/ssl_certificates>`
32+
2633
.. rst-class:: classref-reftable-group
2734

2835
Methods

classes/class_directionallight3d.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,9 @@ A directional light is a type of :ref:`Light3D<class_Light3D>` node that models
2626
Tutorials
2727
---------
2828

29-
- :doc:`Lights and shadows <../tutorials/3d/lights_and_shadows>`
29+
- :doc:`3D lights and shadows <../tutorials/3d/lights_and_shadows>`
30+
31+
- :doc:`Faking global illumination <../tutorials/3d/global_illumination/faking_global_illumination>`
3032

3133
.. rst-class:: classref-reftable-group
3234

0 commit comments

Comments
 (0)