Skip to content

Commit

Permalink
Merge pull request #10270 from godotengine/classref/sync-6c05ec3
Browse files Browse the repository at this point in the history
classref: Sync with current master branch (6c05ec3)
  • Loading branch information
mhilbrunner authored Nov 16, 2024
2 parents 703d0cd + e0dc2b1 commit 99a88c6
Show file tree
Hide file tree
Showing 149 changed files with 2,125 additions and 515 deletions.
15 changes: 14 additions & 1 deletion classes/[email protected]
Original file line number Diff line number Diff line change
Expand Up @@ -705,7 +705,20 @@ See also :ref:`@GlobalScope.PROPERTY_USAGE_SUBGROUP<class_@GlobalScope_constant_
@export var car_label = "Speedy"
@export var car_number = 3

\ **Note:** Subgroups cannot be nested, they only provide one extra level of depth. Just like the next group ends the previous group, so do the subsequent subgroups.
\ **Note:** Subgroups cannot be nested, but you can use the slash separator (``/``) to achieve the desired effect:

::

@export_group("Car Properties")
@export_subgroup("Wheels", "wheel_")
@export_subgroup("Wheels/Front", "front_wheel_")
@export var front_wheel_strength = 10
@export var front_wheel_mobility = 5
@export_subgroup("Wheels/Rear", "rear_wheel_")
@export var rear_wheel_strength = 8
@export var rear_wheel_mobility = 3
@export_subgroup("Wheels", "wheel_")
@export var wheel_material: PhysicsMaterial

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

Expand Down
8 changes: 4 additions & 4 deletions classes/[email protected]
Original file line number Diff line number Diff line change
Expand Up @@ -3987,7 +3987,7 @@ Editing the property prompts the user for restarting the editor.

:ref:`PropertyUsageFlags<enum_@GlobalScope_PropertyUsageFlags>` **PROPERTY_USAGE_SCRIPT_VARIABLE** = ``4096``

The property is a script variable which should be serialized and saved in the scene file.
The property is a script variable. :ref:`PROPERTY_USAGE_SCRIPT_VARIABLE<class_@GlobalScope_constant_PROPERTY_USAGE_SCRIPT_VARIABLE>` can be used to distinguish between exported script variables from built-in variables (which don't have this usage flag). By default, :ref:`PROPERTY_USAGE_SCRIPT_VARIABLE<class_@GlobalScope_constant_PROPERTY_USAGE_SCRIPT_VARIABLE>` is **not** applied to variables that are created by overriding :ref:`Object._get_property_list<class_Object_private_method__get_property_list>` in a script.

.. _class_@GlobalScope_constant_PROPERTY_USAGE_STORE_IF_NULL:

Expand Down Expand Up @@ -4021,7 +4021,7 @@ If this property is modified, all inspector fields will be refreshed.

:ref:`PropertyUsageFlags<enum_@GlobalScope_PropertyUsageFlags>` **PROPERTY_USAGE_CLASS_IS_ENUM** = ``65536``

The property is an enum, i.e. it only takes named integer constants from its associated enumeration.
The property is a variable of enum type, i.e. it only takes named integer constants from its associated enumeration.

.. _class_@GlobalScope_constant_PROPERTY_USAGE_NIL_IS_VARIANT:

Expand Down Expand Up @@ -6698,8 +6698,8 @@ Given a ``seed``, returns a :ref:`PackedInt64Array<class_PackedInt64Array>` of s

var a = rand_from_seed(4)
print(a[0]) # Prints 2879024997
print(a[1]) # Prints 4
print(a[0]) # Prints 2879024997
print(a[1]) # Prints 4

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

Expand Down
4 changes: 2 additions & 2 deletions classes/class_aabb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -692,7 +692,7 @@ The segment begins at ``from`` and ends at ``to``.

:ref:`bool<class_bool>` **is_equal_approx**\ (\ aabb\: :ref:`AABB<class_AABB>`\ ) |const| :ref:`🔗<class_AABB_method_is_equal_approx>`

Returns ``true`` if this bounding box and ``aabb`` are approximately equal, by calling :ref:`Vector2.is_equal_approx<class_Vector2_method_is_equal_approx>` on the :ref:`position<class_AABB_property_position>` and the :ref:`size<class_AABB_property_size>`.
Returns ``true`` if this bounding box and ``aabb`` are approximately equal, by calling :ref:`Vector3.is_equal_approx<class_Vector3_method_is_equal_approx>` on the :ref:`position<class_AABB_property_position>` and the :ref:`size<class_AABB_property_size>`.

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

Expand All @@ -704,7 +704,7 @@ Returns ``true`` if this bounding box and ``aabb`` are approximately equal, by c

:ref:`bool<class_bool>` **is_finite**\ (\ ) |const| :ref:`🔗<class_AABB_method_is_finite>`

Returns ``true`` if this bounding box's values are finite, by calling :ref:`Vector2.is_finite<class_Vector2_method_is_finite>` on the :ref:`position<class_AABB_property_position>` and the :ref:`size<class_AABB_property_size>`.
Returns ``true`` if this bounding box's values are finite, by calling :ref:`Vector3.is_finite<class_Vector3_method_is_finite>` on the :ref:`position<class_AABB_property_position>` and the :ref:`size<class_AABB_property_size>`.

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

Expand Down
2 changes: 1 addition & 1 deletion classes/class_animatedsprite2d.rst
Original file line number Diff line number Diff line change
Expand Up @@ -415,7 +415,7 @@ This method is a shorthand for :ref:`play<class_AnimatedSprite2D_method_play>` w

Sets :ref:`frame<class_AnimatedSprite2D_property_frame>` the :ref:`frame_progress<class_AnimatedSprite2D_property_frame_progress>` to the given values. Unlike setting :ref:`frame<class_AnimatedSprite2D_property_frame>`, this method does not reset the :ref:`frame_progress<class_AnimatedSprite2D_property_frame_progress>` to ``0.0`` implicitly.

\ **Example:** Change the animation while keeping the same :ref:`frame<class_AnimatedSprite2D_property_frame>` and :ref:`frame_progress<class_AnimatedSprite2D_property_frame_progress>`.
\ **Example:** Change the animation while keeping the same :ref:`frame<class_AnimatedSprite2D_property_frame>` and :ref:`frame_progress<class_AnimatedSprite2D_property_frame_progress>`:


.. tabs::
Expand Down
2 changes: 1 addition & 1 deletion classes/class_animatedsprite3d.rst
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +335,7 @@ This method is a shorthand for :ref:`play<class_AnimatedSprite3D_method_play>` w

Sets :ref:`frame<class_AnimatedSprite3D_property_frame>` the :ref:`frame_progress<class_AnimatedSprite3D_property_frame_progress>` to the given values. Unlike setting :ref:`frame<class_AnimatedSprite3D_property_frame>`, this method does not reset the :ref:`frame_progress<class_AnimatedSprite3D_property_frame_progress>` to ``0.0`` implicitly.

\ **Example:** Change the animation while keeping the same :ref:`frame<class_AnimatedSprite3D_property_frame>` and :ref:`frame_progress<class_AnimatedSprite3D_property_frame_progress>`.
\ **Example:** Change the animation while keeping the same :ref:`frame<class_AnimatedSprite3D_property_frame>` and :ref:`frame_progress<class_AnimatedSprite3D_property_frame_progress>`:


.. tabs::
Expand Down
21 changes: 21 additions & 0 deletions classes/class_animationnodeanimation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ Properties
.. table::
:widths: auto

+-------------------------------------------------------+---------------------------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>` | :ref:`advance_on_start<class_AnimationNodeAnimation_property_advance_on_start>` | ``false`` |
+-------------------------------------------------------+---------------------------------------------------------------------------------------+-----------+
| :ref:`StringName<class_StringName>` | :ref:`animation<class_AnimationNodeAnimation_property_animation>` | ``&""`` |
+-------------------------------------------------------+---------------------------------------------------------------------------------------+-----------+
Expand Down Expand Up @@ -96,6 +98,25 @@ Plays animation in backward direction.
Property Descriptions
---------------------

.. _class_AnimationNodeAnimation_property_advance_on_start:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **advance_on_start** = ``false`` :ref:`🔗<class_AnimationNodeAnimation_property_advance_on_start>`

.. rst-class:: classref-property-setget

- |void| **set_advance_on_start**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_advance_on_start**\ (\ )

If ``true``, on receiving a request to play an animation from the start, the first frame is not drawn, but only processed, and playback starts from the next frame.

See also the notes of :ref:`AnimationPlayer.play<class_AnimationPlayer_method_play>`.

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

----

.. _class_AnimationNodeAnimation_property_animation:

.. rst-class:: classref-property
Expand Down
4 changes: 2 additions & 2 deletions classes/class_animationnodestatemachinetransition.rst
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ Only use this transition during :ref:`AnimationNodeStateMachinePlayback.travel<c

:ref:`AdvanceMode<enum_AnimationNodeStateMachineTransition_AdvanceMode>` **ADVANCE_MODE_AUTO** = ``2``

Automatically use this transition if the :ref:`advance_condition<class_AnimationNodeStateMachineTransition_property_advance_condition>` and :ref:`advance_expression<class_AnimationNodeStateMachineTransition_property_advance_expression>` checks are true (if assigned).
Automatically use this transition if the :ref:`advance_condition<class_AnimationNodeStateMachineTransition_property_advance_condition>` and :ref:`advance_expression<class_AnimationNodeStateMachineTransition_property_advance_expression>` checks are ``true`` (if assigned).

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

Expand Down Expand Up @@ -215,7 +215,7 @@ Use an expression as a condition for state machine transitions. It is possible t
- |void| **set_advance_mode**\ (\ value\: :ref:`AdvanceMode<enum_AnimationNodeStateMachineTransition_AdvanceMode>`\ )
- :ref:`AdvanceMode<enum_AnimationNodeStateMachineTransition_AdvanceMode>` **get_advance_mode**\ (\ )

Determines whether the transition should disabled, enabled when using :ref:`AnimationNodeStateMachinePlayback.travel<class_AnimationNodeStateMachinePlayback_method_travel>`, or traversed automatically if the :ref:`advance_condition<class_AnimationNodeStateMachineTransition_property_advance_condition>` and :ref:`advance_expression<class_AnimationNodeStateMachineTransition_property_advance_expression>` checks are true (if assigned).
Determines whether the transition should be disabled, enabled when using :ref:`AnimationNodeStateMachinePlayback.travel<class_AnimationNodeStateMachinePlayback_method_travel>`, or traversed automatically if the :ref:`advance_condition<class_AnimationNodeStateMachineTransition_property_advance_condition>` and :ref:`advance_expression<class_AnimationNodeStateMachineTransition_property_advance_expression>` checks are ``true`` (if assigned).

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

Expand Down
4 changes: 2 additions & 2 deletions classes/class_area2d.rst
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ Emitted when a :ref:`Shape2D<class_Shape2D>` of the received ``area`` enters a s

\ ``local_shape_index`` and ``area_shape_index`` contain indices of the interacting shapes from this area and the other area, respectively. ``area_rid`` contains the :ref:`RID<class_RID>` of the other area. These values can be used with the :ref:`PhysicsServer2D<class_PhysicsServer2D>`.

\ **Example of getting the** :ref:`CollisionShape2D<class_CollisionShape2D>` **node from the shape index:**\
\ **Example:** Get the :ref:`CollisionShape2D<class_CollisionShape2D>` node from the shape index:


.. tabs::
Expand Down Expand Up @@ -213,7 +213,7 @@ Emitted when a :ref:`Shape2D<class_Shape2D>` of the received ``body`` enters a s

\ ``local_shape_index`` and ``body_shape_index`` contain indices of the interacting shapes from this area and the interacting body, respectively. ``body_rid`` contains the :ref:`RID<class_RID>` of the body. These values can be used with the :ref:`PhysicsServer2D<class_PhysicsServer2D>`.

\ **Example of getting the** :ref:`CollisionShape2D<class_CollisionShape2D>` **node from the shape index:**\
\ **Example:** Get the :ref:`CollisionShape2D<class_CollisionShape2D>` node from the shape index:


.. tabs::
Expand Down
4 changes: 2 additions & 2 deletions classes/class_area3d.rst
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ Emitted when a :ref:`Shape3D<class_Shape3D>` of the received ``area`` enters a s

\ ``local_shape_index`` and ``area_shape_index`` contain indices of the interacting shapes from this area and the other area, respectively. ``area_rid`` contains the :ref:`RID<class_RID>` of the other area. These values can be used with the :ref:`PhysicsServer3D<class_PhysicsServer3D>`.

\ **Example of getting the** :ref:`CollisionShape3D<class_CollisionShape3D>` **node from the shape index:**\
\ **Example:** Get the :ref:`CollisionShape3D<class_CollisionShape3D>` node from the shape index:


.. tabs::
Expand Down Expand Up @@ -227,7 +227,7 @@ Emitted when a :ref:`Shape3D<class_Shape3D>` of the received ``body`` enters a s

\ ``local_shape_index`` and ``body_shape_index`` contain indices of the interacting shapes from this area and the interacting body, respectively. ``body_rid`` contains the :ref:`RID<class_RID>` of the body. These values can be used with the :ref:`PhysicsServer3D<class_PhysicsServer3D>`.

\ **Example of getting the** :ref:`CollisionShape3D<class_CollisionShape3D>` **node from the shape index:**\
\ **Example:** Get the :ref:`CollisionShape3D<class_CollisionShape3D>` node from the shape index:


.. tabs::
Expand Down
2 changes: 1 addition & 1 deletion classes/class_astar2d.rst
Original file line number Diff line number Diff line change
Expand Up @@ -494,7 +494,7 @@ Removes the point associated with the given ``id`` from the points pool.

|void| **reserve_space**\ (\ num_nodes\: :ref:`int<class_int>`\ ) :ref:`🔗<class_AStar2D_method_reserve_space>`

Reserves space internally for ``num_nodes`` points, useful if you're adding a known large number of points at once, such as points on a grid. New capacity must be greater or equals to old capacity.
Reserves space internally for ``num_nodes`` points. Useful if you're adding a known large number of points at once, such as points on a grid. The new capacity must be greater or equal to the old capacity.

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

Expand Down
2 changes: 1 addition & 1 deletion classes/class_audioeffectspectrumanalyzer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Description

This audio effect does not affect sound output, but can be used for real-time audio visualizations.

This resource configures an :ref:`AudioEffectSpectrumAnalyzerInstance<class_AudioEffectSpectrumAnalyzerInstance>`, which performs the actual analysis at runtime. An instance can be acquired with :ref:`AudioServer.get_bus_effect_instance<class_AudioServer_method_get_bus_effect_instance>`.
This resource configures an :ref:`AudioEffectSpectrumAnalyzerInstance<class_AudioEffectSpectrumAnalyzerInstance>`, which performs the actual analysis at runtime. An instance can be obtained with :ref:`AudioServer.get_bus_effect_instance<class_AudioServer_method_get_bus_effect_instance>`.

See also :ref:`AudioStreamGenerator<class_AudioStreamGenerator>` for procedurally generating sounds.

Expand Down
2 changes: 1 addition & 1 deletion classes/class_audioeffectspectrumanalyzerinstance.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Description

The runtime part of an :ref:`AudioEffectSpectrumAnalyzer<class_AudioEffectSpectrumAnalyzer>`, which can be used to query the magnitude of a frequency range on its host bus.

An instance of this class can be acquired with :ref:`AudioServer.get_bus_effect_instance<class_AudioServer_method_get_bus_effect_instance>`.
An instance of this class can be obtained with :ref:`AudioServer.get_bus_effect_instance<class_AudioServer_method_get_bus_effect_instance>`.

.. rst-class:: classref-introduction-group

Expand Down
2 changes: 1 addition & 1 deletion classes/class_audiostreaminteractive.rst
Original file line number Diff line number Diff line change
Expand Up @@ -471,7 +471,7 @@ Return the destination time position for a transition (see :ref:`add_transition<

:ref:`bool<class_bool>` **has_transition**\ (\ from_clip\: :ref:`int<class_int>`, to_clip\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_AudioStreamInteractive_method_has_transition>`

Return true if a given transition exists (was added via :ref:`add_transition<class_AudioStreamInteractive_method_add_transition>`).
Returns ``true`` if a given transition exists (was added via :ref:`add_transition<class_AudioStreamInteractive_method_add_transition>`).

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

Expand Down
2 changes: 1 addition & 1 deletion classes/class_audiostreamplaybackpolyphonic.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Method Descriptions

:ref:`bool<class_bool>` **is_stream_playing**\ (\ stream\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_AudioStreamPlaybackPolyphonic_method_is_stream_playing>`

Return true whether the stream associated with an integer ID is still playing. Check :ref:`play_stream<class_AudioStreamPlaybackPolyphonic_method_play_stream>` for information on when this ID becomes invalid.
Returns ``true`` if the stream associated with the given integer ID is still playing. Check :ref:`play_stream<class_AudioStreamPlaybackPolyphonic_method_play_stream>` for information on when this ID becomes invalid.

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

Expand Down
4 changes: 1 addition & 3 deletions classes/class_basematerial3d.rst
Original file line number Diff line number Diff line change
Expand Up @@ -645,7 +645,7 @@ The object will be shaded per pixel. Useful for realistic shading effects.

:ref:`ShadingMode<enum_BaseMaterial3D_ShadingMode>` **SHADING_MODE_PER_VERTEX** = ``2``

The object will be shaded per vertex. Useful when you want cheaper shaders and do not care about visual quality. Not implemented yet (this mode will act like :ref:`SHADING_MODE_PER_PIXEL<class_BaseMaterial3D_constant_SHADING_MODE_PER_PIXEL>`).
The object will be shaded per vertex. Useful when you want cheaper shaders and do not care about visual quality.

.. _class_BaseMaterial3D_constant_SHADING_MODE_MAX:

Expand Down Expand Up @@ -2929,8 +2929,6 @@ Specifies the channel of the :ref:`roughness_texture<class_BaseMaterial3D_proper

Sets whether the shading takes place, per-pixel, per-vertex or unshaded. Per-vertex lighting is faster, making it the best choice for mobile applications, however it looks considerably worse than per-pixel. Unshaded rendering is the fastest, but disables all interactions with lights.

\ **Note:** Setting the shading mode vertex shading currently has no effect, as vertex shading is not implemented yet.

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

----
Expand Down
4 changes: 3 additions & 1 deletion classes/class_basis.rst
Original file line number Diff line number Diff line change
Expand Up @@ -296,6 +296,8 @@ Constructor Descriptions

Constructs a **Basis** identical to the :ref:`IDENTITY<class_Basis_constant_IDENTITY>`.

\ **Note:** In C#, this constructs a **Basis** with all of its components set to :ref:`Vector3.ZERO<class_Vector3_constant_ZERO>`.

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

----
Expand Down Expand Up @@ -716,7 +718,7 @@ The basis matrix's rows are multiplied by ``scale``'s components. This operation

Performs a spherical-linear interpolation with the ``to`` basis, given a ``weight``. Both this basis and ``to`` should represent a rotation.

\ **Example:** Smoothly rotate a :ref:`Node3D<class_Node3D>` to the target basis over time, with a :ref:`Tween<class_Tween>`.
\ **Example:** Smoothly rotate a :ref:`Node3D<class_Node3D>` to the target basis over time, with a :ref:`Tween<class_Tween>`:

::

Expand Down
Loading

0 comments on commit 99a88c6

Please sign in to comment.