Skip to content

Commit 1ec3e45

Browse files
authored
Merge pull request #10405 from godotengine/classref/sync-dc5f1b7
classref: Sync with current master branch (dc5f1b7)
2 parents 36af1ba + cb88777 commit 1ec3e45

File tree

72 files changed

+2958
-411
lines changed

Some content is hidden

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

72 files changed

+2958
-411
lines changed

classes/[email protected]

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -787,7 +787,7 @@ Add a custom icon to the current script. The icon specified at ``icon_path`` is
787787

788788
\ **Note:** As annotations describe their subject, the :ref:`@icon<class_@GDScript_annotation_@icon>` annotation must be placed before the class definition and inheritance.
789789

790-
\ **Note:** Unlike other annotations, the argument of the :ref:`@icon<class_@GDScript_annotation_@icon>` annotation must be a string literal (constant expressions are not supported).
790+
\ **Note:** Unlike most other annotations, the argument of the :ref:`@icon<class_@GDScript_annotation_@icon>` annotation must be a string literal (constant expressions are not supported).
791791

792792
.. rst-class:: classref-item-separator
793793

@@ -893,6 +893,48 @@ Mark the following statement to ignore the specified ``warning``. See :doc:`GDSc
893893
@warning_ignore("unreachable_code")
894894
print("unreachable")
895895

896+
See also :ref:`@warning_ignore_start<class_@GDScript_annotation_@warning_ignore_start>` and :ref:`@warning_ignore_restore<class_@GDScript_annotation_@warning_ignore_restore>`.
897+
898+
.. rst-class:: classref-item-separator
899+
900+
----
901+
902+
.. _class_@GDScript_annotation_@warning_ignore_restore:
903+
904+
.. rst-class:: classref-annotation
905+
906+
**@warning_ignore_restore**\ (\ warning\: :ref:`String<class_String>`, ...\ ) |vararg| :ref:`🔗<class_@GDScript_annotation_@warning_ignore_restore>`
907+
908+
Stops ignoring the listed warning types after :ref:`@warning_ignore_start<class_@GDScript_annotation_@warning_ignore_start>`. Ignoring the specified warning types will be reset to Project Settings. This annotation can be omitted to ignore the warning types until the end of the file.
909+
910+
\ **Note:** Unlike most other annotations, arguments of the :ref:`@warning_ignore_restore<class_@GDScript_annotation_@warning_ignore_restore>` annotation must be string literals (constant expressions are not supported).
911+
912+
.. rst-class:: classref-item-separator
913+
914+
----
915+
916+
.. _class_@GDScript_annotation_@warning_ignore_start:
917+
918+
.. rst-class:: classref-annotation
919+
920+
**@warning_ignore_start**\ (\ warning\: :ref:`String<class_String>`, ...\ ) |vararg| :ref:`🔗<class_@GDScript_annotation_@warning_ignore_start>`
921+
922+
Starts ignoring the listed warning types until the end of the file or the :ref:`@warning_ignore_restore<class_@GDScript_annotation_@warning_ignore_restore>` annotation with the given warning type.
923+
924+
::
925+
926+
func test():
927+
var a = 1 # Warning (if enabled in the Project Settings).
928+
@warning_ignore_start("unused_variable")
929+
var b = 2 # No warning.
930+
var c = 3 # No warning.
931+
@warning_ignore_restore("unused_variable")
932+
var d = 4 # Warning (if enabled in the Project Settings).
933+
934+
\ **Note:** To suppress a single warning, use :ref:`@warning_ignore<class_@GDScript_annotation_@warning_ignore>` instead.
935+
936+
\ **Note:** Unlike most other annotations, arguments of the :ref:`@warning_ignore_start<class_@GDScript_annotation_@warning_ignore_start>` annotation must be string literals (constant expressions are not supported).
937+
896938
.. rst-class:: classref-section-separator
897939

898940
----

classes/[email protected]

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6473,8 +6473,6 @@ Converts one or more arguments of any type to string in the best way possible an
64736473

64746474
The following BBCode tags are supported: ``b``, ``i``, ``u``, ``s``, ``indent``, ``code``, ``url``, ``center``, ``right``, ``color``, ``bgcolor``, ``fgcolor``.
64756475

6476-
Color tags only support the following named colors: ``black``, ``red``, ``green``, ``yellow``, ``blue``, ``magenta``, ``pink``, ``purple``, ``cyan``, ``white``, ``orange``, ``gray``. Hexadecimal color codes are not supported.
6477-
64786476
URL tags only support URLs wrapped by a URL tag, not URLs with a different title.
64796477

64806478
When printing to standard output, the supported subset of BBCode is converted to ANSI escape codes for the terminal emulator to display. Support for ANSI escape codes varies across terminal emulators, especially for italic and strikethrough. In standard output, ``code`` is represented with faint text but without any font change. Unsupported tags are left as-is in standard output.

classes/class_aabb.rst

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -252,8 +252,8 @@ Returns an **AABB** equivalent to this bounding box, with its width, height, and
252252

253253
var box = AABB(Vector3(5, 0, 5), Vector3(-20, -10, -5))
254254
var absolute = box.abs()
255-
print(absolute.position) # Prints (-15, -10, 0)
256-
print(absolute.size) # Prints (20, 10, 5)
255+
print(absolute.position) # Prints (-15.0, -10.0, 0.0)
256+
print(absolute.size) # Prints (20.0, 10.0, 5.0)
257257

258258
.. code-tab:: csharp
259259

@@ -323,12 +323,12 @@ Returns a copy of this bounding box expanded to align the edges with the given `
323323
var box = AABB(Vector3(0, 0, 0), Vector3(5, 2, 5))
324324

325325
box = box.expand(Vector3(10, 0, 0))
326-
print(box.position) # Prints (0, 0, 0)
327-
print(box.size) # Prints (10, 2, 5)
326+
print(box.position) # Prints (0.0, 0.0, 0.0)
327+
print(box.size) # Prints (10.0, 2.0, 5.0)
328328

329329
box = box.expand(Vector3(-5, 0, 5))
330-
print(box.position) # Prints (-5, 0, 0)
331-
print(box.size) # Prints (15, 2, 5)
330+
print(box.position) # Prints (-5.0, 0.0, 0.0)
331+
print(box.size) # Prints (15.0, 2.0, 5.0)
332332

333333
.. code-tab:: csharp
334334

@@ -387,16 +387,16 @@ Returns the longest normalized axis of this bounding box's :ref:`size<class_AABB
387387

388388
var box = AABB(Vector3(0, 0, 0), Vector3(2, 4, 8))
389389

390-
print(box.get_longest_axis()) # Prints (0, 0, 1)
390+
print(box.get_longest_axis()) # Prints (0.0, 0.0, 1.0)
391391
print(box.get_longest_axis_index()) # Prints 2
392-
print(box.get_longest_axis_size()) # Prints 8
392+
print(box.get_longest_axis_size()) # Prints 8.0
393393

394394
.. code-tab:: csharp
395395

396396
var box = new Aabb(new Vector3(0, 0, 0), new Vector3(2, 4, 8));
397397

398398
GD.Print(box.GetLongestAxis()); // Prints (0, 0, 1)
399-
GD.Print(box.GetLongestAxisIndex()); // Prints 2
399+
GD.Print(box.GetLongestAxisIndex()); // Prints Z
400400
GD.Print(box.GetLongestAxisSize()); // Prints 8
401401

402402

@@ -450,16 +450,16 @@ Returns the shortest normalized axis of this bounding box's :ref:`size<class_AAB
450450

451451
var box = AABB(Vector3(0, 0, 0), Vector3(2, 4, 8))
452452

453-
print(box.get_shortest_axis()) # Prints (1, 0, 0)
453+
print(box.get_shortest_axis()) # Prints (1.0, 0.0, 0.0)
454454
print(box.get_shortest_axis_index()) # Prints 0
455-
print(box.get_shortest_axis_size()) # Prints 2
455+
print(box.get_shortest_axis_size()) # Prints 2.0
456456

457457
.. code-tab:: csharp
458458

459459
var box = new Aabb(new Vector3(0, 0, 0), new Vector3(2, 4, 8));
460460

461461
GD.Print(box.GetShortestAxis()); // Prints (1, 0, 0)
462-
GD.Print(box.GetShortestAxisIndex()); // Prints 0
462+
GD.Print(box.GetShortestAxisIndex()); // Prints X
463463
GD.Print(box.GetShortestAxisSize()); // Prints 2
464464

465465

@@ -536,12 +536,12 @@ Returns a copy of this bounding box extended on all sides by the given amount ``
536536
.. code-tab:: gdscript
537537

538538
var a = AABB(Vector3(4, 4, 4), Vector3(8, 8, 8)).grow(4)
539-
print(a.position) # Prints (0, 0, 0)
540-
print(a.size) # Prints (16, 16, 16)
539+
print(a.position) # Prints (0.0, 0.0, 0.0)
540+
print(a.size) # Prints (16.0, 16.0, 16.0)
541541

542542
var b = AABB(Vector3(0, 0, 0), Vector3(8, 4, 2)).grow(2)
543-
print(b.position) # Prints (-2, -2, -2)
544-
print(b.size) # Prints (12, 8, 6)
543+
print(b.position) # Prints (-2.0, -2.0, -2.0)
544+
print(b.size) # Prints (12.0, 8.0, 6.0)
545545

546546
.. code-tab:: csharp
547547

@@ -614,8 +614,8 @@ Returns the intersection between this bounding box and ``with``. If the boxes do
614614
var box2 = AABB(Vector3(2, 0, 2), Vector3(8, 4, 4))
615615

616616
var intersection = box1.intersection(box2)
617-
print(intersection.position) # Prints (2, 0, 2)
618-
print(intersection.size) # Prints (3, 2, 4)
617+
print(intersection.position) # Prints (2.0, 0.0, 2.0)
618+
print(intersection.size) # Prints (3.0, 2.0, 4.0)
619619

620620
.. code-tab:: csharp
621621

classes/class_animationnode.rst

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,8 +95,12 @@ Methods
9595
+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
9696
| :ref:`Variant<class_Variant>` | :ref:`get_parameter<class_AnimationNode_method_get_parameter>`\ (\ name\: :ref:`StringName<class_StringName>`\ ) |const| |
9797
+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
98+
| :ref:`int<class_int>` | :ref:`get_processing_animation_tree_instance_id<class_AnimationNode_method_get_processing_animation_tree_instance_id>`\ (\ ) |const| |
99+
+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
98100
| :ref:`bool<class_bool>` | :ref:`is_path_filtered<class_AnimationNode_method_is_path_filtered>`\ (\ path\: :ref:`NodePath<class_NodePath>`\ ) |const| |
99101
+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
102+
| :ref:`bool<class_bool>` | :ref:`is_process_testing<class_AnimationNode_method_is_process_testing>`\ (\ ) |const| |
103+
+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
100104
| |void| | :ref:`remove_input<class_AnimationNode_method_remove_input>`\ (\ index\: :ref:`int<class_int>`\ ) |
101105
+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
102106
| |void| | :ref:`set_filter_path<class_AnimationNode_method_set_filter_path>`\ (\ path\: :ref:`NodePath<class_NodePath>`, enable\: :ref:`bool<class_bool>`\ ) |
@@ -425,13 +429,39 @@ Gets the value of a parameter. Parameters are custom local memory used for your
425429

426430
----
427431

432+
.. _class_AnimationNode_method_get_processing_animation_tree_instance_id:
433+
434+
.. rst-class:: classref-method
435+
436+
:ref:`int<class_int>` **get_processing_animation_tree_instance_id**\ (\ ) |const| :ref:`🔗<class_AnimationNode_method_get_processing_animation_tree_instance_id>`
437+
438+
Returns the object id of the :ref:`AnimationTree<class_AnimationTree>` that owns this node.
439+
440+
\ **Note:** This method should only be called from within the :ref:`AnimationNodeExtension._process<class_AnimationNodeExtension_private_method__process>` method, and will return an invalid id otherwise.
441+
442+
.. rst-class:: classref-item-separator
443+
444+
----
445+
428446
.. _class_AnimationNode_method_is_path_filtered:
429447

430448
.. rst-class:: classref-method
431449

432450
:ref:`bool<class_bool>` **is_path_filtered**\ (\ path\: :ref:`NodePath<class_NodePath>`\ ) |const| :ref:`🔗<class_AnimationNode_method_is_path_filtered>`
433451

434-
Returns whether the given path is filtered.
452+
Returns ``true`` if the given path is filtered.
453+
454+
.. rst-class:: classref-item-separator
455+
456+
----
457+
458+
.. _class_AnimationNode_method_is_process_testing:
459+
460+
.. rst-class:: classref-method
461+
462+
:ref:`bool<class_bool>` **is_process_testing**\ (\ ) |const| :ref:`🔗<class_AnimationNode_method_is_process_testing>`
463+
464+
Returns ``true`` if this animation node is being processed in test-only mode.
435465

436466
.. rst-class:: classref-item-separator
437467

0 commit comments

Comments
 (0)