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

Merge pull request #10961 from godotengine/classref/sync-45fc515

Browse Source 
classref: Sync with current master branch (45fc515)
This commit is contained in:
Matthew
2025-05-25 09:50:07 -04:00
committed by GitHub
parent 67743e991b d4a8f7f2aa
commit 5c0ea92f93
34 changed files with 3382 additions and 337 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
classes/class_animation.rst
View File

@@ -67,15 +67,15 @@ Properties
.. table::
:widths: auto
+------------------------------------------+--------------------------------------------------------------------+---------------+
| :ref:`bool<class_bool>` | :ref:`capture_included<class_Animation_property_capture_included>` | ``false`` |
+------------------------------------------+--------------------------------------------------------------------+---------------+
| :ref:`float<class_float>` | :ref:`length<class_Animation_property_length>` | ``1.0`` |
+------------------------------------------+--------------------------------------------------------------------+---------------+
| :ref:`LoopMode<enum_Animation_LoopMode>` | :ref:`loop_mode<class_Animation_property_loop_mode>` | ``0`` |
+------------------------------------------+--------------------------------------------------------------------+---------------+
| :ref:`float<class_float>` | :ref:`step<class_Animation_property_step>` | ``0.0333333`` |
+------------------------------------------+--------------------------------------------------------------------+---------------+
+------------------------------------------+--------------------------------------------------------------------+-----------------+
| :ref:`bool<class_bool>` | :ref:`capture_included<class_Animation_property_capture_included>` | ``false`` |
+------------------------------------------+--------------------------------------------------------------------+-----------------+
| :ref:`float<class_float>` | :ref:`length<class_Animation_property_length>` | ``1.0`` |
+------------------------------------------+--------------------------------------------------------------------+-----------------+
| :ref:`LoopMode<enum_Animation_LoopMode>` | :ref:`loop_mode<class_Animation_property_loop_mode>` | ``0`` |
+------------------------------------------+--------------------------------------------------------------------+-----------------+
| :ref:`float<class_float>` | :ref:`step<class_Animation_property_step>` | ``0.033333335`` |
+------------------------------------------+--------------------------------------------------------------------+-----------------+
.. rst-class:: classref-reftable-group
@@ -585,7 +585,7 @@ Determines the behavior of both ends of the animation timeline during animation
.. rst-class:: classref-property
:ref:`float<class_float>` **step** = ``0.0333333`` :ref:`🔗<class_Animation_property_step>`
:ref:`float<class_float>` **step** = ``0.033333335`` :ref:`🔗<class_Animation_property_step>`
.. rst-class:: classref-property-setget

4
classes/class_animationnodeoneshot.rst
View File

@@ -291,7 +291,7 @@ Determines how cross-fading between animations is eased. If empty, the transitio
The fade-in duration. For example, setting this to ``1.0`` for a 5 second length animation will produce a cross-fade that starts at 0 second and ends at 1 second during the animation.
\ **Note:** **AnimationNodeOneShot** transitions the current state after the end of the fading. When :ref:`AnimationNodeOutput<class_AnimationNodeOutput>` is considered as the most upstream, so the :ref:`fadein_time<class_AnimationNodeOneShot_property_fadein_time>` is scaled depending on the downstream delta. For example, if this value is set to ``1.0`` and a :ref:`AnimationNodeTimeScale<class_AnimationNodeTimeScale>` with a value of ``2.0`` is chained downstream, the actual processing time will be 0.5 second.
\ **Note:** **AnimationNodeOneShot** transitions the current state after the fading has finished.
.. rst-class:: classref-item-separator
@@ -327,7 +327,7 @@ Determines how cross-fading between animations is eased. If empty, the transitio
The fade-out duration. For example, setting this to ``1.0`` for a 5 second length animation will produce a cross-fade that starts at 4 second and ends at 5 second during the animation.
\ **Note:** **AnimationNodeOneShot** transitions the current state after the end of the fading. When :ref:`AnimationNodeOutput<class_AnimationNodeOutput>` is considered as the most upstream, so the :ref:`fadeout_time<class_AnimationNodeOneShot_property_fadeout_time>` is scaled depending on the downstream delta. For example, if this value is set to ``1.0`` and an :ref:`AnimationNodeTimeScale<class_AnimationNodeTimeScale>` with a value of ``2.0`` is chained downstream, the actual processing time will be 0.5 second.
\ **Note:** **AnimationNodeOneShot** transitions the current state after the fading has finished.
.. rst-class:: classref-item-separator

96
classes/class_basematerial3d.rst
View File

@@ -143,6 +143,8 @@ Properties
+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
| :ref:`bool<class_bool>` | :ref:`fixed_size<class_BaseMaterial3D_property_fixed_size>` | ``false`` |
+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`fov_override<class_BaseMaterial3D_property_fov_override>` | ``75.0`` |
+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
| :ref:`bool<class_bool>` | :ref:`grow<class_BaseMaterial3D_property_grow>` | ``false`` |
+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`grow_amount<class_BaseMaterial3D_property_grow_amount>` | ``0.0`` |
@@ -251,10 +253,14 @@ Properties
+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
| :ref:`Transparency<enum_BaseMaterial3D_Transparency>` | :ref:`transparency<class_BaseMaterial3D_property_transparency>` | ``0`` |
+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
| :ref:`bool<class_bool>` | :ref:`use_fov_override<class_BaseMaterial3D_property_use_fov_override>` | ``false`` |
+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
| :ref:`bool<class_bool>` | :ref:`use_particle_trails<class_BaseMaterial3D_property_use_particle_trails>` | ``false`` |
+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
| :ref:`bool<class_bool>` | :ref:`use_point_size<class_BaseMaterial3D_property_use_point_size>` | ``false`` |
+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
| :ref:`bool<class_bool>` | :ref:`use_z_clip_scale<class_BaseMaterial3D_property_use_z_clip_scale>` | ``false`` |
+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`uv1_offset<class_BaseMaterial3D_property_uv1_offset>` | ``Vector3(0, 0, 0)`` |
+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`uv1_scale<class_BaseMaterial3D_property_uv1_scale>` | ``Vector3(1, 1, 1)`` |
@@ -279,6 +285,8 @@ Properties
+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
| :ref:`bool<class_bool>` | :ref:`vertex_color_use_as_albedo<class_BaseMaterial3D_property_vertex_color_use_as_albedo>` | ``false`` |
+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`z_clip_scale<class_BaseMaterial3D_property_z_clip_scale>` | ``1.0`` |
+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
.. rst-class:: classref-reftable-group
@@ -1141,11 +1149,27 @@ Disables receiving depth-based or volumetric fog.
Disables specular occlusion.
.. _class_BaseMaterial3D_constant_FLAG_USE_Z_CLIP_SCALE:
.. rst-class:: classref-enumeration-constant
:ref:`Flags<enum_BaseMaterial3D_Flags>` **FLAG_USE_Z_CLIP_SCALE** = ``23``
Enables using :ref:`z_clip_scale<class_BaseMaterial3D_property_z_clip_scale>`.
.. _class_BaseMaterial3D_constant_FLAG_USE_FOV_OVERRIDE:
.. rst-class:: classref-enumeration-constant
:ref:`Flags<enum_BaseMaterial3D_Flags>` **FLAG_USE_FOV_OVERRIDE** = ``24``
Enables using :ref:`fov_override<class_BaseMaterial3D_property_fov_override>`.
.. _class_BaseMaterial3D_constant_FLAG_MAX:
.. rst-class:: classref-enumeration-constant
:ref:`Flags<enum_BaseMaterial3D_Flags>` **FLAG_MAX** = ``23``
:ref:`Flags<enum_BaseMaterial3D_Flags>` **FLAG_MAX** = ``25``
Represents the size of the :ref:`Flags<enum_BaseMaterial3D_Flags>` enum.
@@ -2316,6 +2340,25 @@ If ``true``, the object is rendered at the same size regardless of distance. The
----
.. _class_BaseMaterial3D_property_fov_override:
.. rst-class:: classref-property
:ref:`float<class_float>` **fov_override** = ``75.0`` :ref:`🔗<class_BaseMaterial3D_property_fov_override>`
.. rst-class:: classref-property-setget
- |void| **set_fov_override**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_fov_override**\ (\ )
Overrides the :ref:`Camera3D<class_Camera3D>`'s field of view angle (in degrees).
\ **Note:** This behaves as if the field of view is set on a :ref:`Camera3D<class_Camera3D>` with :ref:`Camera3D.keep_aspect<class_Camera3D_property_keep_aspect>` set to :ref:`Camera3D.KEEP_HEIGHT<class_Camera3D_constant_KEEP_HEIGHT>`. Additionally, it may not look correct on a non-perspective camera where the field of view setting is ignored.
.. rst-class:: classref-item-separator
----
.. _class_BaseMaterial3D_property_grow:
.. rst-class:: classref-property
@@ -3266,6 +3309,23 @@ The material's transparency mode. Some transparency modes will disable shadow ca
----
.. _class_BaseMaterial3D_property_use_fov_override:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **use_fov_override** = ``false`` :ref:`🔗<class_BaseMaterial3D_property_use_fov_override>`
.. rst-class:: classref-property-setget
- |void| **set_flag**\ (\ flag\: :ref:`Flags<enum_BaseMaterial3D_Flags>`, enable\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **get_flag**\ (\ flag\: :ref:`Flags<enum_BaseMaterial3D_Flags>`\ ) |const|
If ``true`` use :ref:`fov_override<class_BaseMaterial3D_property_fov_override>` to override the :ref:`Camera3D<class_Camera3D>`'s field of view angle.
.. rst-class:: classref-item-separator
----
.. _class_BaseMaterial3D_property_use_particle_trails:
.. rst-class:: classref-property
@@ -3302,6 +3362,23 @@ If ``true``, render point size can be changed.
----
.. _class_BaseMaterial3D_property_use_z_clip_scale:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **use_z_clip_scale** = ``false`` :ref:`🔗<class_BaseMaterial3D_property_use_z_clip_scale>`
.. rst-class:: classref-property-setget
- |void| **set_flag**\ (\ flag\: :ref:`Flags<enum_BaseMaterial3D_Flags>`, enable\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **get_flag**\ (\ flag\: :ref:`Flags<enum_BaseMaterial3D_Flags>`\ ) |const|
If ``true`` use :ref:`z_clip_scale<class_BaseMaterial3D_property_z_clip_scale>` to scale the object being rendered towards the camera to avoid clipping into things like walls.
.. rst-class:: classref-item-separator
----
.. _class_BaseMaterial3D_property_uv1_offset:
.. rst-class:: classref-property
@@ -3508,6 +3585,23 @@ If ``true``, vertex colors are considered to be stored in sRGB color space and a
If ``true``, the vertex color is used as albedo color.
.. rst-class:: classref-item-separator
----
.. _class_BaseMaterial3D_property_z_clip_scale:
.. rst-class:: classref-property
:ref:`float<class_float>` **z_clip_scale** = ``1.0`` :ref:`🔗<class_BaseMaterial3D_property_z_clip_scale>`
.. rst-class:: classref-property-setget
- |void| **set_z_clip_scale**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_z_clip_scale**\ (\ )
Scales the object being rendered towards the camera to avoid clipping into things like walls. This is intended to be used for objects that are fixed with respect to the camera like player arms, tools, etc. Lighting and shadows will continue to work correctly when this setting is adjusted, but screen-space effects like SSAO and SSR may break with lower scales. Therefore, try to keep this setting as close to ``1.0`` as possible.
.. rst-class:: classref-section-separator
----

31
classes/class_capsuleshape2d.rst
View File

@@ -31,11 +31,13 @@ Properties
.. table::
:widths: auto
+---------------------------+-----------------------------------------------------+----------+
| :ref:`float<class_float>` | :ref:`height<class_CapsuleShape2D_property_height>` | ``30.0`` |
+---------------------------+-----------------------------------------------------+----------+
| :ref:`float<class_float>` | :ref:`radius<class_CapsuleShape2D_property_radius>` | ``10.0`` |
+---------------------------+-----------------------------------------------------+----------+
+---------------------------+-------------------------------------------------------------+----------+
| :ref:`float<class_float>` | :ref:`height<class_CapsuleShape2D_property_height>` | ``30.0`` |
+---------------------------+-------------------------------------------------------------+----------+
| :ref:`float<class_float>` | :ref:`mid_height<class_CapsuleShape2D_property_mid_height>` | |
+---------------------------+-------------------------------------------------------------+----------+
| :ref:`float<class_float>` | :ref:`radius<class_CapsuleShape2D_property_radius>` | ``10.0`` |
+---------------------------+-------------------------------------------------------------+----------+
.. rst-class:: classref-section-separator
@@ -57,7 +59,24 @@ Property Descriptions
- |void| **set_height**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_height**\ (\ )
The capsule's height.
The capsule's full height, including the semicircles.
.. rst-class:: classref-item-separator
----
.. _class_CapsuleShape2D_property_mid_height:
.. rst-class:: classref-property
:ref:`float<class_float>` **mid_height** :ref:`🔗<class_CapsuleShape2D_property_mid_height>`
.. rst-class:: classref-property-setget
- |void| **set_mid_height**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_mid_height**\ (\ )
The capsule's height, excluding the semicircles. This is the height of the central rectangular part in the middle of the capsule, and is the distance between the centers of the two semicircles. This is a wrapper for :ref:`height<class_CapsuleShape2D_property_height>`.
.. rst-class:: classref-item-separator

31
classes/class_capsuleshape3d.rst
View File

@@ -38,11 +38,13 @@ Properties
.. table::
:widths: auto
+---------------------------+-----------------------------------------------------+---------+
| :ref:`float<class_float>` | :ref:`height<class_CapsuleShape3D_property_height>` | ``2.0`` |
+---------------------------+-----------------------------------------------------+---------+
| :ref:`float<class_float>` | :ref:`radius<class_CapsuleShape3D_property_radius>` | ``0.5`` |
+---------------------------+-----------------------------------------------------+---------+
+---------------------------+-------------------------------------------------------------+---------+
| :ref:`float<class_float>` | :ref:`height<class_CapsuleShape3D_property_height>` | ``2.0`` |
+---------------------------+-------------------------------------------------------------+---------+
| :ref:`float<class_float>` | :ref:`mid_height<class_CapsuleShape3D_property_mid_height>` | |
+---------------------------+-------------------------------------------------------------+---------+
| :ref:`float<class_float>` | :ref:`radius<class_CapsuleShape3D_property_radius>` | ``0.5`` |
+---------------------------+-------------------------------------------------------------+---------+
.. rst-class:: classref-section-separator
@@ -64,7 +66,24 @@ Property Descriptions
- |void| **set_height**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_height**\ (\ )
The capsule's height.
The capsule's full height, including the hemispheres.
.. rst-class:: classref-item-separator
----
.. _class_CapsuleShape3D_property_mid_height:
.. rst-class:: classref-property
:ref:`float<class_float>` **mid_height** :ref:`🔗<class_CapsuleShape3D_property_mid_height>`
.. rst-class:: classref-property-setget
- |void| **set_mid_height**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_mid_height**\ (\ )
The capsule's height, excluding the hemispheres. This is the height of the central cylindrical part in the middle of the capsule, and is the distance between the centers of the two hemispheres. This is a wrapper for :ref:`height<class_CapsuleShape3D_property_height>`.
.. rst-class:: classref-item-separator

8
classes/class_characterbody2d.rst
View File

@@ -49,7 +49,7 @@ Properties
+--------------------------------------------------------------+------------------------------------------------------------------------------------+--------------------+
| :ref:`bool<class_bool>` | :ref:`floor_constant_speed<class_CharacterBody2D_property_floor_constant_speed>` | ``false`` |
+--------------------------------------------------------------+------------------------------------------------------------------------------------+--------------------+
| :ref:`float<class_float>` | :ref:`floor_max_angle<class_CharacterBody2D_property_floor_max_angle>` | ``0.785398`` |
| :ref:`float<class_float>` | :ref:`floor_max_angle<class_CharacterBody2D_property_floor_max_angle>` | ``0.7853982`` |
+--------------------------------------------------------------+------------------------------------------------------------------------------------+--------------------+
| :ref:`float<class_float>` | :ref:`floor_snap_length<class_CharacterBody2D_property_floor_snap_length>` | ``1.0`` |
+--------------------------------------------------------------+------------------------------------------------------------------------------------+--------------------+
@@ -73,7 +73,7 @@ Properties
+--------------------------------------------------------------+------------------------------------------------------------------------------------+--------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`velocity<class_CharacterBody2D_property_velocity>` | ``Vector2(0, 0)`` |
+--------------------------------------------------------------+------------------------------------------------------------------------------------+--------------------+
| :ref:`float<class_float>` | :ref:`wall_min_slide_angle<class_CharacterBody2D_property_wall_min_slide_angle>` | ``0.261799`` |
| :ref:`float<class_float>` | :ref:`wall_min_slide_angle<class_CharacterBody2D_property_wall_min_slide_angle>` | ``0.2617994`` |
+--------------------------------------------------------------+------------------------------------------------------------------------------------+--------------------+
.. rst-class:: classref-reftable-group
@@ -236,7 +236,7 @@ If ``true``, the body will always move at the same speed on the ground no matter
.. rst-class:: classref-property
:ref:`float<class_float>` **floor_max_angle** = ``0.785398`` :ref:`🔗<class_CharacterBody2D_property_floor_max_angle>`
:ref:`float<class_float>` **floor_max_angle** = ``0.7853982`` :ref:`🔗<class_CharacterBody2D_property_floor_max_angle>`
.. rst-class:: classref-property-setget
@@ -450,7 +450,7 @@ Current velocity vector in pixels per second, used and modified during calls to
.. rst-class:: classref-property
:ref:`float<class_float>` **wall_min_slide_angle** = ``0.261799`` :ref:`🔗<class_CharacterBody2D_property_wall_min_slide_angle>`
:ref:`float<class_float>` **wall_min_slide_angle** = ``0.2617994`` :ref:`🔗<class_CharacterBody2D_property_wall_min_slide_angle>`
.. rst-class:: classref-property-setget

8
classes/class_characterbody3d.rst
View File

@@ -51,7 +51,7 @@ Properties
+--------------------------------------------------------------+------------------------------------------------------------------------------------+----------------------+
| :ref:`bool<class_bool>` | :ref:`floor_constant_speed<class_CharacterBody3D_property_floor_constant_speed>` | ``false`` |
+--------------------------------------------------------------+------------------------------------------------------------------------------------+----------------------+
| :ref:`float<class_float>` | :ref:`floor_max_angle<class_CharacterBody3D_property_floor_max_angle>` | ``0.785398`` |
| :ref:`float<class_float>` | :ref:`floor_max_angle<class_CharacterBody3D_property_floor_max_angle>` | ``0.7853982`` |
+--------------------------------------------------------------+------------------------------------------------------------------------------------+----------------------+
| :ref:`float<class_float>` | :ref:`floor_snap_length<class_CharacterBody3D_property_floor_snap_length>` | ``0.1`` |
+--------------------------------------------------------------+------------------------------------------------------------------------------------+----------------------+
@@ -75,7 +75,7 @@ Properties
+--------------------------------------------------------------+------------------------------------------------------------------------------------+----------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`velocity<class_CharacterBody3D_property_velocity>` | ``Vector3(0, 0, 0)`` |
+--------------------------------------------------------------+------------------------------------------------------------------------------------+----------------------+
| :ref:`float<class_float>` | :ref:`wall_min_slide_angle<class_CharacterBody3D_property_wall_min_slide_angle>` | ``0.261799`` |
| :ref:`float<class_float>` | :ref:`wall_min_slide_angle<class_CharacterBody3D_property_wall_min_slide_angle>` | ``0.2617994`` |
+--------------------------------------------------------------+------------------------------------------------------------------------------------+----------------------+
.. rst-class:: classref-reftable-group
@@ -240,7 +240,7 @@ If ``true``, the body will always move at the same speed on the ground no matter
.. rst-class:: classref-property
:ref:`float<class_float>` **floor_max_angle** = ``0.785398`` :ref:`🔗<class_CharacterBody3D_property_floor_max_angle>`
:ref:`float<class_float>` **floor_max_angle** = ``0.7853982`` :ref:`🔗<class_CharacterBody3D_property_floor_max_angle>`
.. rst-class:: classref-property-setget
@@ -454,7 +454,7 @@ Current velocity vector (typically meters per second), used and modified during
.. rst-class:: classref-property
:ref:`float<class_float>` **wall_min_slide_angle** = ``0.261799`` :ref:`🔗<class_CharacterBody3D_property_wall_min_slide_angle>`
:ref:`float<class_float>` **wall_min_slide_angle** = ``0.2617994`` :ref:`🔗<class_CharacterBody3D_property_wall_min_slide_angle>`
.. rst-class:: classref-property-setget

262
classes/class_color.rst
View File

File diff suppressed because it is too large Load Diff

26
classes/class_conetwistjoint3d.rst
View File

@@ -29,17 +29,17 @@ Properties
.. table::
:widths: auto
+---------------------------+---------------------------------------------------------------+--------------+
| :ref:`float<class_float>` | :ref:`bias<class_ConeTwistJoint3D_property_bias>` | ``0.3`` |
+---------------------------+---------------------------------------------------------------+--------------+
| :ref:`float<class_float>` | :ref:`relaxation<class_ConeTwistJoint3D_property_relaxation>` | ``1.0`` |
+---------------------------+---------------------------------------------------------------+--------------+
| :ref:`float<class_float>` | :ref:`softness<class_ConeTwistJoint3D_property_softness>` | ``0.8`` |
+---------------------------+---------------------------------------------------------------+--------------+
| :ref:`float<class_float>` | :ref:`swing_span<class_ConeTwistJoint3D_property_swing_span>` | ``0.785398`` |
+---------------------------+---------------------------------------------------------------+--------------+
| :ref:`float<class_float>` | :ref:`twist_span<class_ConeTwistJoint3D_property_twist_span>` | ``3.14159`` |
+---------------------------+---------------------------------------------------------------+--------------+
+---------------------------+---------------------------------------------------------------+---------------+
| :ref:`float<class_float>` | :ref:`bias<class_ConeTwistJoint3D_property_bias>` | ``0.3`` |
+---------------------------+---------------------------------------------------------------+---------------+
| :ref:`float<class_float>` | :ref:`relaxation<class_ConeTwistJoint3D_property_relaxation>` | ``1.0`` |
+---------------------------+---------------------------------------------------------------+---------------+
| :ref:`float<class_float>` | :ref:`softness<class_ConeTwistJoint3D_property_softness>` | ``0.8`` |
+---------------------------+---------------------------------------------------------------+---------------+
| :ref:`float<class_float>` | :ref:`swing_span<class_ConeTwistJoint3D_property_swing_span>` | ``0.7853982`` |
+---------------------------+---------------------------------------------------------------+---------------+
| :ref:`float<class_float>` | :ref:`twist_span<class_ConeTwistJoint3D_property_twist_span>` | ``3.1415927`` |
+---------------------------+---------------------------------------------------------------+---------------+
.. rst-class:: classref-reftable-group
@@ -194,7 +194,7 @@ The ease with which the joint starts to twist. If it's too low, it takes more fo
.. rst-class:: classref-property
:ref:`float<class_float>` **swing_span** = ``0.785398`` :ref:`🔗<class_ConeTwistJoint3D_property_swing_span>`
:ref:`float<class_float>` **swing_span** = ``0.7853982`` :ref:`🔗<class_ConeTwistJoint3D_property_swing_span>`
.. rst-class:: classref-property-setget
@@ -217,7 +217,7 @@ If below 0.05, this behavior is locked.
.. rst-class:: classref-property
:ref:`float<class_float>` **twist_span** = ``3.14159`` :ref:`🔗<class_ConeTwistJoint3D_property_twist_span>`
:ref:`float<class_float>` **twist_span** = ``3.1415927`` :ref:`🔗<class_ConeTwistJoint3D_property_twist_span>`
.. rst-class:: classref-property-setget

2
classes/class_control.rst
View File

@@ -1903,7 +1903,7 @@ Helper property to access :ref:`rotation<class_Control_property_rotation>` in de
- |void| **set_scale**\ (\ value\: :ref:`Vector2<class_Vector2>`\ )
- :ref:`Vector2<class_Vector2>` **get_scale**\ (\ )
The node's scale, relative to its :ref:`size<class_Control_property_size>`. Change this property to scale the node around its :ref:`pivot_offset<class_Control_property_pivot_offset>`. The Control's :ref:`tooltip_text<class_Control_property_tooltip_text>` will also scale according to this value.
The node's scale, relative to its :ref:`size<class_Control_property_size>`. Change this property to scale the node around its :ref:`pivot_offset<class_Control_property_pivot_offset>`. The Control's tooltip will also scale according to this value.
\ **Note:** This property is mainly intended to be used for animation purposes. To support multiple resolutions in your project, use an appropriate viewport stretch mode as described in the :doc:`documentation <../tutorials/rendering/multiple_resolutions>` instead of scaling Controls individually.

2
classes/class_editorexportplatform.rst
View File

@@ -12,7 +12,7 @@ EditorExportPlatform
**Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
**Inherited By:** :ref:`EditorExportPlatformAndroid<class_EditorExportPlatformAndroid>`, :ref:`EditorExportPlatformExtension<class_EditorExportPlatformExtension>`, :ref:`EditorExportPlatformIOS<class_EditorExportPlatformIOS>`, :ref:`EditorExportPlatformMacOS<class_EditorExportPlatformMacOS>`, :ref:`EditorExportPlatformPC<class_EditorExportPlatformPC>`, :ref:`EditorExportPlatformWeb<class_EditorExportPlatformWeb>`
**Inherited By:** :ref:`EditorExportPlatformAndroid<class_EditorExportPlatformAndroid>`, :ref:`EditorExportPlatformAppleEmbedded<class_EditorExportPlatformAppleEmbedded>`, :ref:`EditorExportPlatformExtension<class_EditorExportPlatformExtension>`, :ref:`EditorExportPlatformMacOS<class_EditorExportPlatformMacOS>`, :ref:`EditorExportPlatformPC<class_EditorExportPlatformPC>`, :ref:`EditorExportPlatformWeb<class_EditorExportPlatformWeb>`
Identifies a supported export platform, and internally provides the functionality of exporting to that platform.

16
classes/class_editorexportplatformandroid.rst
View File

@@ -58,8 +58,6 @@ Properties
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`gradle_build/android_source_template<class_EditorExportPlatformAndroid_property_gradle_build/android_source_template>` |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`gradle_build/compress_native_libraries<class_EditorExportPlatformAndroid_property_gradle_build/compress_native_libraries>` |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`gradle_build/export_format<class_EditorExportPlatformAndroid_property_gradle_build/export_format>` |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`gradle_build/gradle_build_directory<class_EditorExportPlatformAndroid_property_gradle_build/gradle_build_directory>` |
@@ -598,20 +596,6 @@ Path to a ZIP file holding the source for the export template used in a Gradle b
----
.. _class_EditorExportPlatformAndroid_property_gradle_build/compress_native_libraries:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **gradle_build/compress_native_libraries** :ref:`🔗<class_EditorExportPlatformAndroid_property_gradle_build/compress_native_libraries>`
If ``true``, native libraries are compressed when performing a Gradle build.
\ **Note:** Although your binary may be smaller, your application may load slower because the native libraries are not loaded directly from the binary at runtime.
.. rst-class:: classref-item-separator
----
.. _class_EditorExportPlatformAndroid_property_gradle_build/export_format:
.. rst-class:: classref-property

42
classes/class_editorexportplatformappleembedded.rst Normal file
View File

@@ -0,0 +1,42 @@
:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorExportPlatformAppleEmbedded.xml.
.. _class_EditorExportPlatformAppleEmbedded:
EditorExportPlatformAppleEmbedded
=================================
**Inherits:** :ref:`EditorExportPlatform<class_EditorExportPlatform>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
**Inherited By:** :ref:`EditorExportPlatformIOS<class_EditorExportPlatformIOS>`, :ref:`EditorExportPlatformVisionOS<class_EditorExportPlatformVisionOS>`
Base class for the Apple embedded platform exporters (iOS and visionOS).
.. rst-class:: classref-introduction-group
Description
-----------
The base class for Apple embedded platform exporters. These include iOS and visionOS, but not macOS. See the classes inheriting from this one for more details.
.. rst-class:: classref-introduction-group
Tutorials
---------
- :doc:`Exporting for iOS <../tutorials/export/exporting_for_ios>`
- :doc:`iOS plugins documentation index <../tutorials/platform/ios/index>`
.. |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.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
.. |void| replace:: :abbr:`void (No return value.)`

20
classes/class_editorexportplatformios.rst
View File

@@ -10,7 +10,7 @@
EditorExportPlatformIOS
=======================
**Inherits:** :ref:`EditorExportPlatform<class_EditorExportPlatform>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
**Inherits:** :ref:`EditorExportPlatformAppleEmbedded<class_EditorExportPlatformAppleEmbedded>` **<** :ref:`EditorExportPlatform<class_EditorExportPlatform>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
Exporter for iOS.
@@ -571,7 +571,7 @@ Unique application identifier in a reverse-DNS format, can only contain alphanum
:ref:`String<class_String>` **application/code_sign_identity_debug** :ref:`🔗<class_EditorExportPlatformIOS_property_application/code_sign_identity_debug>`
The "Full Name", "Common Name" or SHA-1 hash of the signing identity used for debug export.
The "Full Name", "Common Name", or SHA-1 hash of the signing identity used for debug export.
.. rst-class:: classref-item-separator
@@ -583,7 +583,7 @@ The "Full Name", "Common Name" or SHA-1 hash of the signing identity used for de
:ref:`String<class_String>` **application/code_sign_identity_release** :ref:`🔗<class_EditorExportPlatformIOS_property_application/code_sign_identity_release>`
The "Full Name", "Common Name" or SHA-1 hash of the signing identity used for release export.
The "Full Name", "Common Name", or SHA-1 hash of the signing identity used for release export.
.. rst-class:: classref-item-separator
@@ -667,9 +667,9 @@ Minimum version of iOS required for this application to run in the ``major.minor
:ref:`String<class_String>` **application/provisioning_profile_specifier_debug** :ref:`🔗<class_EditorExportPlatformIOS_property_application/provisioning_profile_specifier_debug>`
Name of the provisioning profile. Sets XCode PROVISIONING_PROFILE_SPECIFIER for debug. `Used for manual provisioning <https://developer.apple.com/documentation/xcode/build-settings-reference#Provisioning-Profile>`__.
Name of the provisioning profile. Sets Xcode PROVISIONING_PROFILE_SPECIFIER for debug. `Used for manual provisioning <https://developer.apple.com/documentation/xcode/build-settings-reference#Provisioning-Profile>`__.
Can be overridden with the environment variable ``GODOT_IOS_PROFILE_SPECIFIER_DEBUG``.
Can be overridden with the environment variable ``GODOT_APPLE_PLATFORM_PROFILE_SPECIFIER_DEBUG``.
.. rst-class:: classref-item-separator
@@ -681,9 +681,9 @@ Can be overridden with the environment variable ``GODOT_IOS_PROFILE_SPECIFIER_DE
:ref:`String<class_String>` **application/provisioning_profile_specifier_release** :ref:`🔗<class_EditorExportPlatformIOS_property_application/provisioning_profile_specifier_release>`
Name of the provisioning profile. Sets XCode PROVISIONING_PROFILE_SPECIFIER for release. `Used for manual provisioning <https://developer.apple.com/documentation/xcode/build-settings-reference#Provisioning-Profile>`__.
Name of the provisioning profile. Sets Xcode PROVISIONING_PROFILE_SPECIFIER for release. `Used for manual provisioning <https://developer.apple.com/documentation/xcode/build-settings-reference#Provisioning-Profile>`__.
Can be overridden with the environment variable ``GODOT_IOS_PROFILE_SPECIFIER_RELEASE``.
Can be overridden with the environment variable ``GODOT_APPLE_PLATFORM_PROFILE_SPECIFIER_RELEASE``.
.. rst-class:: classref-item-separator
@@ -697,7 +697,7 @@ Can be overridden with the environment variable ``GODOT_IOS_PROFILE_SPECIFIER_RE
UUID of the provisioning profile. If left empty, Xcode will download or create a provisioning profile automatically. See `Edit, download, or delete provisioning profiles <https://developer.apple.com/help/account/manage-profiles/edit-download-or-delete-profiles>`__.
Can be overridden with the environment variable ``GODOT_IOS_PROVISIONING_PROFILE_UUID_DEBUG``.
Can be overridden with the environment variable ``GODOT_APPLE_PLATFORM_PROVISIONING_PROFILE_UUID_DEBUG``.
.. rst-class:: classref-item-separator
@@ -711,7 +711,7 @@ Can be overridden with the environment variable ``GODOT_IOS_PROVISIONING_PROFILE
UUID of the provisioning profile. If left empty, Xcode will download or create a provisioning profile automatically. See `Edit, download, or delete provisioning profiles <https://developer.apple.com/help/account/manage-profiles/edit-download-or-delete-profiles>`__.
Can be overridden with the environment variable ``GODOT_IOS_PROVISIONING_PROFILE_UUID_RELEASE``.
Can be overridden with the environment variable ``GODOT_APPLE_PLATFORM_PROVISIONING_PROFILE_UUID_RELEASE``.
.. rst-class:: classref-item-separator
@@ -811,7 +811,7 @@ Additional data added to the ``UIRequiredDeviceCapabilities`` array of the ``Inf
Requires the graphics performance and features of the A12 Bionic and later chips (devices supporting all Vulkan renderer features).
Enabling this option limits supported devices to: iPhone XS, iPhone XR, iPad Mini (5th gen.), iPad Air (3rd gen.), iPad (8th gen) and newer.
Enabling this option limits supported devices to: iPhone XS, iPhone XR, iPad Mini (5th gen.), iPad Air (3rd gen.), iPad (8th gen), and newer.
.. rst-class:: classref-item-separator

2
classes/class_editorexportplatformpc.rst
View File

@@ -21,7 +21,7 @@ Base class for the desktop platform exporter (Windows and Linux/BSD).
Description
-----------
The base class for the desktop platform exporters. These include Windows and Linux/BSD, but not macOS. See the classes inheriting this one for more details.
The base class for the desktop platform exporters. These include Windows and Linux/BSD, but not macOS. See the classes inheriting from this one for more details.
.. rst-class:: classref-introduction-group

2694
classes/class_editorexportplatformvisionos.rst Normal file
View File

File diff suppressed because it is too large Load Diff

126
classes/class_editorexportplugin.rst
View File

@@ -89,6 +89,20 @@ Methods
+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`_update_android_prebuilt_manifest<class_EditorExportPlugin_private_method__update_android_prebuilt_manifest>`\ (\ platform\: :ref:`EditorExportPlatform<class_EditorExportPlatform>`, manifest_data\: :ref:`PackedByteArray<class_PackedByteArray>`\ ) |virtual| |const| |
+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`add_apple_embedded_platform_bundle_file<class_EditorExportPlugin_method_add_apple_embedded_platform_bundle_file>`\ (\ path\: :ref:`String<class_String>`\ ) |
+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`add_apple_embedded_platform_cpp_code<class_EditorExportPlugin_method_add_apple_embedded_platform_cpp_code>`\ (\ code\: :ref:`String<class_String>`\ ) |
+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`add_apple_embedded_platform_embedded_framework<class_EditorExportPlugin_method_add_apple_embedded_platform_embedded_framework>`\ (\ path\: :ref:`String<class_String>`\ ) |
+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`add_apple_embedded_platform_framework<class_EditorExportPlugin_method_add_apple_embedded_platform_framework>`\ (\ path\: :ref:`String<class_String>`\ ) |
+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`add_apple_embedded_platform_linker_flags<class_EditorExportPlugin_method_add_apple_embedded_platform_linker_flags>`\ (\ flags\: :ref:`String<class_String>`\ ) |
+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`add_apple_embedded_platform_plist_content<class_EditorExportPlugin_method_add_apple_embedded_platform_plist_content>`\ (\ plist_content\: :ref:`String<class_String>`\ ) |
+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`add_apple_embedded_platform_project_static_lib<class_EditorExportPlugin_method_add_apple_embedded_platform_project_static_lib>`\ (\ path\: :ref:`String<class_String>`\ ) |
+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`add_file<class_EditorExportPlugin_method_add_file>`\ (\ path\: :ref:`String<class_String>`, file\: :ref:`PackedByteArray<class_PackedByteArray>`, remap\: :ref:`bool<class_bool>`\ ) |
+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`add_ios_bundle_file<class_EditorExportPlugin_method_add_ios_bundle_file>`\ (\ path\: :ref:`String<class_String>`\ ) |
@@ -513,6 +527,94 @@ If no modifications are needed, then an empty :ref:`PackedByteArray<class_Packed
----
.. _class_EditorExportPlugin_method_add_apple_embedded_platform_bundle_file:
.. rst-class:: classref-method
|void| **add_apple_embedded_platform_bundle_file**\ (\ path\: :ref:`String<class_String>`\ ) :ref:`🔗<class_EditorExportPlugin_method_add_apple_embedded_platform_bundle_file>`
Adds an Apple embedded platform bundle file from the given ``path`` to the exported project.
.. rst-class:: classref-item-separator
----
.. _class_EditorExportPlugin_method_add_apple_embedded_platform_cpp_code:
.. rst-class:: classref-method
|void| **add_apple_embedded_platform_cpp_code**\ (\ code\: :ref:`String<class_String>`\ ) :ref:`🔗<class_EditorExportPlugin_method_add_apple_embedded_platform_cpp_code>`
Adds C++ code to the Apple embedded platform export. The final code is created from the code appended by each active export plugin.
.. rst-class:: classref-item-separator
----
.. _class_EditorExportPlugin_method_add_apple_embedded_platform_embedded_framework:
.. rst-class:: classref-method
|void| **add_apple_embedded_platform_embedded_framework**\ (\ path\: :ref:`String<class_String>`\ ) :ref:`🔗<class_EditorExportPlugin_method_add_apple_embedded_platform_embedded_framework>`
Adds a dynamic library (\*.dylib, \*.framework) to the Linking Phase in the Apple embedded platform's Xcode project and embeds it into the resulting binary.
\ **Note:** For static libraries (\*.a), this works in the same way as :ref:`add_apple_embedded_platform_framework()<class_EditorExportPlugin_method_add_apple_embedded_platform_framework>`.
\ **Note:** This method should not be used for System libraries as they are already present on the device.
.. rst-class:: classref-item-separator
----
.. _class_EditorExportPlugin_method_add_apple_embedded_platform_framework:
.. rst-class:: classref-method
|void| **add_apple_embedded_platform_framework**\ (\ path\: :ref:`String<class_String>`\ ) :ref:`🔗<class_EditorExportPlugin_method_add_apple_embedded_platform_framework>`
Adds a static library (\*.a) or a dynamic library (\*.dylib, \*.framework) to the Linking Phase to the Apple embedded platform's Xcode project.
.. rst-class:: classref-item-separator
----
.. _class_EditorExportPlugin_method_add_apple_embedded_platform_linker_flags:
.. rst-class:: classref-method
|void| **add_apple_embedded_platform_linker_flags**\ (\ flags\: :ref:`String<class_String>`\ ) :ref:`🔗<class_EditorExportPlugin_method_add_apple_embedded_platform_linker_flags>`
Adds linker flags for the Apple embedded platform export.
.. rst-class:: classref-item-separator
----
.. _class_EditorExportPlugin_method_add_apple_embedded_platform_plist_content:
.. rst-class:: classref-method
|void| **add_apple_embedded_platform_plist_content**\ (\ plist_content\: :ref:`String<class_String>`\ ) :ref:`🔗<class_EditorExportPlugin_method_add_apple_embedded_platform_plist_content>`
Adds additional fields to the Apple embedded platform's project Info.plist file.
.. rst-class:: classref-item-separator
----
.. _class_EditorExportPlugin_method_add_apple_embedded_platform_project_static_lib:
.. rst-class:: classref-method
|void| **add_apple_embedded_platform_project_static_lib**\ (\ path\: :ref:`String<class_String>`\ ) :ref:`🔗<class_EditorExportPlugin_method_add_apple_embedded_platform_project_static_lib>`
Adds a static library from the given ``path`` to the Apple embedded platform project.
.. rst-class:: classref-item-separator
----
.. _class_EditorExportPlugin_method_add_file:
.. rst-class:: classref-method
@@ -535,6 +637,8 @@ When called inside :ref:`_export_file()<class_EditorExportPlugin_private_method_
|void| **add_ios_bundle_file**\ (\ path\: :ref:`String<class_String>`\ ) :ref:`🔗<class_EditorExportPlugin_method_add_ios_bundle_file>`
**Deprecated:** Use :ref:`add_apple_embedded_platform_bundle_file()<class_EditorExportPlugin_method_add_apple_embedded_platform_bundle_file>` instead.
Adds an iOS bundle file from the given ``path`` to the exported project.
.. rst-class:: classref-item-separator
@@ -547,7 +651,9 @@ Adds an iOS bundle file from the given ``path`` to the exported project.
|void| **add_ios_cpp_code**\ (\ code\: :ref:`String<class_String>`\ ) :ref:`🔗<class_EditorExportPlugin_method_add_ios_cpp_code>`
Adds a C++ code to the iOS export. The final code is created from the code appended by each active export plugin.
**Deprecated:** Use :ref:`add_apple_embedded_platform_cpp_code()<class_EditorExportPlugin_method_add_apple_embedded_platform_cpp_code>` instead.
Adds C++ code to the iOS export. The final code is created from the code appended by each active export plugin.
.. rst-class:: classref-item-separator
@@ -559,9 +665,11 @@ Adds a C++ code to the iOS export. The final code is created from the code appen
|void| **add_ios_embedded_framework**\ (\ path\: :ref:`String<class_String>`\ ) :ref:`🔗<class_EditorExportPlugin_method_add_ios_embedded_framework>`
**Deprecated:** Use :ref:`add_apple_embedded_platform_embedded_framework()<class_EditorExportPlugin_method_add_apple_embedded_platform_embedded_framework>` instead.
Adds a dynamic library (\*.dylib, \*.framework) to Linking Phase in iOS's Xcode project and embeds it into resulting binary.
\ **Note:** For static libraries (\*.a) works in same way as :ref:`add_ios_framework()<class_EditorExportPlugin_method_add_ios_framework>`.
\ **Note:** For static libraries (\*.a), this works the in same way as :ref:`add_apple_embedded_platform_framework()<class_EditorExportPlugin_method_add_apple_embedded_platform_framework>`.
\ **Note:** This method should not be used for System libraries as they are already present on the device.
@@ -575,7 +683,9 @@ Adds a dynamic library (\*.dylib, \*.framework) to Linking Phase in iOS's Xcode
|void| **add_ios_framework**\ (\ path\: :ref:`String<class_String>`\ ) :ref:`🔗<class_EditorExportPlugin_method_add_ios_framework>`
Adds a static library (\*.a) or dynamic library (\*.dylib, \*.framework) to Linking Phase in iOS's Xcode project.
**Deprecated:** Use :ref:`add_apple_embedded_platform_framework()<class_EditorExportPlugin_method_add_apple_embedded_platform_framework>` instead.
Adds a static library (\*.a) or a dynamic library (\*.dylib, \*.framework) to the Linking Phase to the iOS Xcode project.
.. rst-class:: classref-item-separator
@@ -587,6 +697,8 @@ Adds a static library (\*.a) or dynamic library (\*.dylib, \*.framework) to Link
|void| **add_ios_linker_flags**\ (\ flags\: :ref:`String<class_String>`\ ) :ref:`🔗<class_EditorExportPlugin_method_add_ios_linker_flags>`
**Deprecated:** Use :ref:`add_apple_embedded_platform_linker_flags()<class_EditorExportPlugin_method_add_apple_embedded_platform_linker_flags>` instead.
Adds linker flags for the iOS export.
.. rst-class:: classref-item-separator
@@ -599,7 +711,9 @@ Adds linker flags for the iOS export.
|void| **add_ios_plist_content**\ (\ plist_content\: :ref:`String<class_String>`\ ) :ref:`🔗<class_EditorExportPlugin_method_add_ios_plist_content>`
Adds content for iOS Property List files.
**Deprecated:** Use :ref:`add_apple_embedded_platform_plist_content()<class_EditorExportPlugin_method_add_apple_embedded_platform_plist_content>` instead.
Adds additional fields to the iOS project Info.plist file.
.. rst-class:: classref-item-separator
@@ -611,7 +725,9 @@ Adds content for iOS Property List files.
|void| **add_ios_project_static_lib**\ (\ path\: :ref:`String<class_String>`\ ) :ref:`🔗<class_EditorExportPlugin_method_add_ios_project_static_lib>`
Adds a static lib from the given ``path`` to the iOS project.
**Deprecated:** Use :ref:`add_apple_embedded_platform_project_static_lib()<class_EditorExportPlugin_method_add_apple_embedded_platform_project_static_lib>` instead.
Adds a static library from the given ``path`` to the iOS project.
.. rst-class:: classref-item-separator

4
classes/class_editorimportplugin.rst
View File

@@ -265,7 +265,7 @@ Gets the unique name of the importer.
:ref:`bool<class_bool>` **_get_option_visibility**\ (\ path\: :ref:`String<class_String>`, option_name\: :ref:`StringName<class_StringName>`, options\: :ref:`Dictionary<class_Dictionary>`\ ) |virtual| |const| :ref:`🔗<class_EditorImportPlugin_private_method__get_option_visibility>`
This method can be overridden to hide specific import options if conditions are met. This is mainly useful for hiding options that depend on others if one of them is disabled.
Gets whether the import option specified by ``option_name`` should be visible in the Import dock. The default implementation always returns ``true``, making all options visible. This is mainly useful for hiding options that depend on others if one of them is disabled.
.. tabs::
@@ -294,8 +294,6 @@ This method can be overridden to hide specific import options if conditions are
Returns ``true`` to make all options always visible.
.. rst-class:: classref-item-separator
----

24
classes/class_gltfcamera.rst
View File

@@ -40,17 +40,17 @@ Properties
.. table::
:widths: auto
+---------------------------+-----------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`depth_far<class_GLTFCamera_property_depth_far>` | ``4000.0`` |
+---------------------------+-----------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`depth_near<class_GLTFCamera_property_depth_near>` | ``0.05`` |
+---------------------------+-----------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`fov<class_GLTFCamera_property_fov>` | ``1.309`` |
+---------------------------+-----------------------------------------------------------+------------+
| :ref:`bool<class_bool>` | :ref:`perspective<class_GLTFCamera_property_perspective>` | ``true`` |
+---------------------------+-----------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`size_mag<class_GLTFCamera_property_size_mag>` | ``0.5`` |
+---------------------------+-----------------------------------------------------------+------------+
+---------------------------+-----------------------------------------------------------+---------------+
| :ref:`float<class_float>` | :ref:`depth_far<class_GLTFCamera_property_depth_far>` | ``4000.0`` |
+---------------------------+-----------------------------------------------------------+---------------+
| :ref:`float<class_float>` | :ref:`depth_near<class_GLTFCamera_property_depth_near>` | ``0.05`` |
+---------------------------+-----------------------------------------------------------+---------------+
| :ref:`float<class_float>` | :ref:`fov<class_GLTFCamera_property_fov>` | ``1.3089969`` |
+---------------------------+-----------------------------------------------------------+---------------+
| :ref:`bool<class_bool>` | :ref:`perspective<class_GLTFCamera_property_perspective>` | ``true`` |
+---------------------------+-----------------------------------------------------------+---------------+
| :ref:`float<class_float>` | :ref:`size_mag<class_GLTFCamera_property_size_mag>` | ``0.5`` |
+---------------------------+-----------------------------------------------------------+---------------+
.. rst-class:: classref-reftable-group
@@ -117,7 +117,7 @@ The distance to the near culling boundary for this camera relative to its local
.. rst-class:: classref-property
:ref:`float<class_float>` **fov** = ``1.309`` :ref:`🔗<class_GLTFCamera_property_fov>`
:ref:`float<class_float>` **fov** = ``1.3089969`` :ref:`🔗<class_GLTFCamera_property_fov>`
.. rst-class:: classref-property-setget

4
classes/class_gltflight.rst
View File

@@ -47,7 +47,7 @@ Properties
+-----------------------------+--------------------------------------------------------------------+-----------------------+
| :ref:`String<class_String>` | :ref:`light_type<class_GLTFLight_property_light_type>` | ``""`` |
+-----------------------------+--------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`outer_cone_angle<class_GLTFLight_property_outer_cone_angle>` | ``0.785398`` |
| :ref:`float<class_float>` | :ref:`outer_cone_angle<class_GLTFLight_property_outer_cone_angle>` | ``0.7853982`` |
+-----------------------------+--------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`range<class_GLTFLight_property_range>` | ``inf`` |
+-----------------------------+--------------------------------------------------------------------+-----------------------+
@@ -159,7 +159,7 @@ The type of the light. The values accepted by Godot are "point", "spot", and "di
.. rst-class:: classref-property
:ref:`float<class_float>` **outer_cone_angle** = ``0.785398`` :ref:`🔗<class_GLTFLight_property_outer_cone_angle>`
:ref:`float<class_float>` **outer_cone_angle** = ``0.7853982`` :ref:`🔗<class_GLTFLight_property_outer_cone_angle>`
.. rst-class:: classref-property-setget

8
classes/class_graphedit.rst
View File

@@ -86,9 +86,9 @@ Properties
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`zoom<class_GraphEdit_property_zoom>` | ``1.0`` |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`zoom_max<class_GraphEdit_property_zoom_max>` | ``2.0736`` |
| :ref:`float<class_float>` | :ref:`zoom_max<class_GraphEdit_property_zoom_max>` | ``2.0736003`` |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`zoom_min<class_GraphEdit_property_zoom_min>` | ``0.232568`` |
| :ref:`float<class_float>` | :ref:`zoom_min<class_GraphEdit_property_zoom_min>` | ``0.23256795`` |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`zoom_step<class_GraphEdit_property_zoom_step>` | ``1.2`` |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
@@ -908,7 +908,7 @@ The current zoom value.
.. rst-class:: classref-property
:ref:`float<class_float>` **zoom_max** = ``2.0736`` :ref:`🔗<class_GraphEdit_property_zoom_max>`
:ref:`float<class_float>` **zoom_max** = ``2.0736003`` :ref:`🔗<class_GraphEdit_property_zoom_max>`
.. rst-class:: classref-property-setget
@@ -925,7 +925,7 @@ The upper zoom limit.
.. rst-class:: classref-property
:ref:`float<class_float>` **zoom_min** = ``0.232568`` :ref:`🔗<class_GraphEdit_property_zoom_min>`
:ref:`float<class_float>` **zoom_min** = ``0.23256795`` :ref:`🔗<class_GraphEdit_property_zoom_min>`
.. rst-class:: classref-property-setget

46
classes/class_hingejoint3d.rst
View File

@@ -29,27 +29,27 @@ Properties
.. table::
:widths: auto
+---------------------------+---------------------------------------------------------------------------------------+-------------+
| :ref:`float<class_float>` | :ref:`angular_limit/bias<class_HingeJoint3D_property_angular_limit/bias>` | ``0.3`` |
+---------------------------+---------------------------------------------------------------------------------------+-------------+
| :ref:`bool<class_bool>` | :ref:`angular_limit/enable<class_HingeJoint3D_property_angular_limit/enable>` | ``false`` |
+---------------------------+---------------------------------------------------------------------------------------+-------------+
| :ref:`float<class_float>` | :ref:`angular_limit/lower<class_HingeJoint3D_property_angular_limit/lower>` | ``-1.5708`` |
+---------------------------+---------------------------------------------------------------------------------------+-------------+
| :ref:`float<class_float>` | :ref:`angular_limit/relaxation<class_HingeJoint3D_property_angular_limit/relaxation>` | ``1.0`` |
+---------------------------+---------------------------------------------------------------------------------------+-------------+
| :ref:`float<class_float>` | :ref:`angular_limit/softness<class_HingeJoint3D_property_angular_limit/softness>` | ``0.9`` |
+---------------------------+---------------------------------------------------------------------------------------+-------------+
| :ref:`float<class_float>` | :ref:`angular_limit/upper<class_HingeJoint3D_property_angular_limit/upper>` | ``1.5708`` |
+---------------------------+---------------------------------------------------------------------------------------+-------------+
| :ref:`bool<class_bool>` | :ref:`motor/enable<class_HingeJoint3D_property_motor/enable>` | ``false`` |
+---------------------------+---------------------------------------------------------------------------------------+-------------+
| :ref:`float<class_float>` | :ref:`motor/max_impulse<class_HingeJoint3D_property_motor/max_impulse>` | ``1.0`` |
+---------------------------+---------------------------------------------------------------------------------------+-------------+
| :ref:`float<class_float>` | :ref:`motor/target_velocity<class_HingeJoint3D_property_motor/target_velocity>` | ``1.0`` |
+---------------------------+---------------------------------------------------------------------------------------+-------------+
| :ref:`float<class_float>` | :ref:`params/bias<class_HingeJoint3D_property_params/bias>` | ``0.3`` |
+---------------------------+---------------------------------------------------------------------------------------+-------------+
+---------------------------+---------------------------------------------------------------------------------------+----------------+
| :ref:`float<class_float>` | :ref:`angular_limit/bias<class_HingeJoint3D_property_angular_limit/bias>` | ``0.3`` |
+---------------------------+---------------------------------------------------------------------------------------+----------------+
| :ref:`bool<class_bool>` | :ref:`angular_limit/enable<class_HingeJoint3D_property_angular_limit/enable>` | ``false`` |
+---------------------------+---------------------------------------------------------------------------------------+----------------+
| :ref:`float<class_float>` | :ref:`angular_limit/lower<class_HingeJoint3D_property_angular_limit/lower>` | ``-1.5707964`` |
+---------------------------+---------------------------------------------------------------------------------------+----------------+
| :ref:`float<class_float>` | :ref:`angular_limit/relaxation<class_HingeJoint3D_property_angular_limit/relaxation>` | ``1.0`` |
+---------------------------+---------------------------------------------------------------------------------------+----------------+
| :ref:`float<class_float>` | :ref:`angular_limit/softness<class_HingeJoint3D_property_angular_limit/softness>` | ``0.9`` |
+---------------------------+---------------------------------------------------------------------------------------+----------------+
| :ref:`float<class_float>` | :ref:`angular_limit/upper<class_HingeJoint3D_property_angular_limit/upper>` | ``1.5707964`` |
+---------------------------+---------------------------------------------------------------------------------------+----------------+
| :ref:`bool<class_bool>` | :ref:`motor/enable<class_HingeJoint3D_property_motor/enable>` | ``false`` |
+---------------------------+---------------------------------------------------------------------------------------+----------------+
| :ref:`float<class_float>` | :ref:`motor/max_impulse<class_HingeJoint3D_property_motor/max_impulse>` | ``1.0`` |
+---------------------------+---------------------------------------------------------------------------------------+----------------+
| :ref:`float<class_float>` | :ref:`motor/target_velocity<class_HingeJoint3D_property_motor/target_velocity>` | ``1.0`` |
+---------------------------+---------------------------------------------------------------------------------------+----------------+
| :ref:`float<class_float>` | :ref:`params/bias<class_HingeJoint3D_property_params/bias>` | ``0.3`` |
+---------------------------+---------------------------------------------------------------------------------------+----------------+
.. rst-class:: classref-reftable-group
@@ -239,7 +239,7 @@ If ``true``, the hinges maximum and minimum rotation, defined by :ref:`angular_l
.. rst-class:: classref-property
:ref:`float<class_float>` **angular_limit/lower** = ``-1.5708`` :ref:`🔗<class_HingeJoint3D_property_angular_limit/lower>`
:ref:`float<class_float>` **angular_limit/lower** = ``-1.5707964`` :ref:`🔗<class_HingeJoint3D_property_angular_limit/lower>`
.. rst-class:: classref-property-setget
@@ -290,7 +290,7 @@ The lower this value, the more the rotation gets slowed down.
.. rst-class:: classref-property
:ref:`float<class_float>` **angular_limit/upper** = ``1.5708`` :ref:`🔗<class_HingeJoint3D_property_angular_limit/upper>`
:ref:`float<class_float>` **angular_limit/upper** = ``1.5707964`` :ref:`🔗<class_HingeJoint3D_property_angular_limit/upper>`
.. rst-class:: classref-property-setget

20
classes/class_openxrcompositionlayercylinder.rst
View File

@@ -31,15 +31,15 @@ Properties
.. table::
:widths: auto
+---------------------------+-------------------------------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`aspect_ratio<class_OpenXRCompositionLayerCylinder_property_aspect_ratio>` | ``1.0`` |
+---------------------------+-------------------------------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`central_angle<class_OpenXRCompositionLayerCylinder_property_central_angle>` | ``1.5708`` |
+---------------------------+-------------------------------------------------------------------------------------------+------------+
| :ref:`int<class_int>` | :ref:`fallback_segments<class_OpenXRCompositionLayerCylinder_property_fallback_segments>` | ``10`` |
+---------------------------+-------------------------------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`radius<class_OpenXRCompositionLayerCylinder_property_radius>` | ``1.0`` |
+---------------------------+-------------------------------------------------------------------------------------------+------------+
+---------------------------+-------------------------------------------------------------------------------------------+---------------+
| :ref:`float<class_float>` | :ref:`aspect_ratio<class_OpenXRCompositionLayerCylinder_property_aspect_ratio>` | ``1.0`` |
+---------------------------+-------------------------------------------------------------------------------------------+---------------+
| :ref:`float<class_float>` | :ref:`central_angle<class_OpenXRCompositionLayerCylinder_property_central_angle>` | ``1.5707964`` |
+---------------------------+-------------------------------------------------------------------------------------------+---------------+
| :ref:`int<class_int>` | :ref:`fallback_segments<class_OpenXRCompositionLayerCylinder_property_fallback_segments>` | ``10`` |
+---------------------------+-------------------------------------------------------------------------------------------+---------------+
| :ref:`float<class_float>` | :ref:`radius<class_OpenXRCompositionLayerCylinder_property_radius>` | ``1.0`` |
+---------------------------+-------------------------------------------------------------------------------------------+---------------+
.. rst-class:: classref-section-separator
@@ -71,7 +71,7 @@ The aspect ratio of the slice. Used to set the height relative to the width.
.. rst-class:: classref-property
:ref:`float<class_float>` **central_angle** = ``1.5708`` :ref:`🔗<class_OpenXRCompositionLayerCylinder_property_central_angle>`
:ref:`float<class_float>` **central_angle** = ``1.5707964`` :ref:`🔗<class_OpenXRCompositionLayerCylinder_property_central_angle>`
.. rst-class:: classref-property-setget

28
classes/class_openxrcompositionlayerequirect.rst
View File

@@ -31,17 +31,17 @@ Properties
.. table::
:widths: auto
+---------------------------+---------------------------------------------------------------------------------------------------------+--------------+
| :ref:`float<class_float>` | :ref:`central_horizontal_angle<class_OpenXRCompositionLayerEquirect_property_central_horizontal_angle>` | ``1.5708`` |
+---------------------------+---------------------------------------------------------------------------------------------------------+--------------+
| :ref:`int<class_int>` | :ref:`fallback_segments<class_OpenXRCompositionLayerEquirect_property_fallback_segments>` | ``10`` |
+---------------------------+---------------------------------------------------------------------------------------------------------+--------------+
| :ref:`float<class_float>` | :ref:`lower_vertical_angle<class_OpenXRCompositionLayerEquirect_property_lower_vertical_angle>` | ``0.785398`` |
+---------------------------+---------------------------------------------------------------------------------------------------------+--------------+
| :ref:`float<class_float>` | :ref:`radius<class_OpenXRCompositionLayerEquirect_property_radius>` | ``1.0`` |
+---------------------------+---------------------------------------------------------------------------------------------------------+--------------+
| :ref:`float<class_float>` | :ref:`upper_vertical_angle<class_OpenXRCompositionLayerEquirect_property_upper_vertical_angle>` | ``0.785398`` |
+---------------------------+---------------------------------------------------------------------------------------------------------+--------------+
+---------------------------+---------------------------------------------------------------------------------------------------------+---------------+
| :ref:`float<class_float>` | :ref:`central_horizontal_angle<class_OpenXRCompositionLayerEquirect_property_central_horizontal_angle>` | ``1.5707964`` |
+---------------------------+---------------------------------------------------------------------------------------------------------+---------------+
| :ref:`int<class_int>` | :ref:`fallback_segments<class_OpenXRCompositionLayerEquirect_property_fallback_segments>` | ``10`` |
+---------------------------+---------------------------------------------------------------------------------------------------------+---------------+
| :ref:`float<class_float>` | :ref:`lower_vertical_angle<class_OpenXRCompositionLayerEquirect_property_lower_vertical_angle>` | ``0.7853982`` |
+---------------------------+---------------------------------------------------------------------------------------------------------+---------------+
| :ref:`float<class_float>` | :ref:`radius<class_OpenXRCompositionLayerEquirect_property_radius>` | ``1.0`` |
+---------------------------+---------------------------------------------------------------------------------------------------------+---------------+
| :ref:`float<class_float>` | :ref:`upper_vertical_angle<class_OpenXRCompositionLayerEquirect_property_upper_vertical_angle>` | ``0.7853982`` |
+---------------------------+---------------------------------------------------------------------------------------------------------+---------------+
.. rst-class:: classref-section-separator
@@ -56,7 +56,7 @@ Property Descriptions
.. rst-class:: classref-property
:ref:`float<class_float>` **central_horizontal_angle** = ``1.5708`` :ref:`🔗<class_OpenXRCompositionLayerEquirect_property_central_horizontal_angle>`
:ref:`float<class_float>` **central_horizontal_angle** = ``1.5707964`` :ref:`🔗<class_OpenXRCompositionLayerEquirect_property_central_horizontal_angle>`
.. rst-class:: classref-property-setget
@@ -90,7 +90,7 @@ The number of segments to use in the fallback mesh.
.. rst-class:: classref-property
:ref:`float<class_float>` **lower_vertical_angle** = ``0.785398`` :ref:`🔗<class_OpenXRCompositionLayerEquirect_property_lower_vertical_angle>`
:ref:`float<class_float>` **lower_vertical_angle** = ``0.7853982`` :ref:`🔗<class_OpenXRCompositionLayerEquirect_property_lower_vertical_angle>`
.. rst-class:: classref-property-setget
@@ -124,7 +124,7 @@ The radius of the sphere.
.. rst-class:: classref-property
:ref:`float<class_float>` **upper_vertical_angle** = ``0.785398`` :ref:`🔗<class_OpenXRCompositionLayerEquirect_property_upper_vertical_angle>`
:ref:`float<class_float>` **upper_vertical_angle** = ``0.7853982`` :ref:`🔗<class_OpenXRCompositionLayerEquirect_property_upper_vertical_angle>`
.. rst-class:: classref-property-setget

40
classes/class_openxrdpadbindingmodifier.rst
View File

@@ -33,25 +33,25 @@ Properties
.. table::
:widths: auto
+-------------------------------------------------+----------------------------------------------------------------------------------------+------------+
| :ref:`OpenXRActionSet<class_OpenXRActionSet>` | :ref:`action_set<class_OpenXRDpadBindingModifier_property_action_set>` | |
+-------------------------------------------------+----------------------------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`center_region<class_OpenXRDpadBindingModifier_property_center_region>` | ``0.1`` |
+-------------------------------------------------+----------------------------------------------------------------------------------------+------------+
| :ref:`String<class_String>` | :ref:`input_path<class_OpenXRDpadBindingModifier_property_input_path>` | ``""`` |
+-------------------------------------------------+----------------------------------------------------------------------------------------+------------+
| :ref:`bool<class_bool>` | :ref:`is_sticky<class_OpenXRDpadBindingModifier_property_is_sticky>` | ``false`` |
+-------------------------------------------------+----------------------------------------------------------------------------------------+------------+
| :ref:`OpenXRHapticBase<class_OpenXRHapticBase>` | :ref:`off_haptic<class_OpenXRDpadBindingModifier_property_off_haptic>` | |
+-------------------------------------------------+----------------------------------------------------------------------------------------+------------+
| :ref:`OpenXRHapticBase<class_OpenXRHapticBase>` | :ref:`on_haptic<class_OpenXRDpadBindingModifier_property_on_haptic>` | |
+-------------------------------------------------+----------------------------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`threshold<class_OpenXRDpadBindingModifier_property_threshold>` | ``0.6`` |
+-------------------------------------------------+----------------------------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`threshold_released<class_OpenXRDpadBindingModifier_property_threshold_released>` | ``0.4`` |
+-------------------------------------------------+----------------------------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`wedge_angle<class_OpenXRDpadBindingModifier_property_wedge_angle>` | ``1.5708`` |
+-------------------------------------------------+----------------------------------------------------------------------------------------+------------+
+-------------------------------------------------+----------------------------------------------------------------------------------------+---------------+
| :ref:`OpenXRActionSet<class_OpenXRActionSet>` | :ref:`action_set<class_OpenXRDpadBindingModifier_property_action_set>` | |
+-------------------------------------------------+----------------------------------------------------------------------------------------+---------------+
| :ref:`float<class_float>` | :ref:`center_region<class_OpenXRDpadBindingModifier_property_center_region>` | ``0.1`` |
+-------------------------------------------------+----------------------------------------------------------------------------------------+---------------+
| :ref:`String<class_String>` | :ref:`input_path<class_OpenXRDpadBindingModifier_property_input_path>` | ``""`` |
+-------------------------------------------------+----------------------------------------------------------------------------------------+---------------+
| :ref:`bool<class_bool>` | :ref:`is_sticky<class_OpenXRDpadBindingModifier_property_is_sticky>` | ``false`` |
+-------------------------------------------------+----------------------------------------------------------------------------------------+---------------+
| :ref:`OpenXRHapticBase<class_OpenXRHapticBase>` | :ref:`off_haptic<class_OpenXRDpadBindingModifier_property_off_haptic>` | |
+-------------------------------------------------+----------------------------------------------------------------------------------------+---------------+
| :ref:`OpenXRHapticBase<class_OpenXRHapticBase>` | :ref:`on_haptic<class_OpenXRDpadBindingModifier_property_on_haptic>` | |
+-------------------------------------------------+----------------------------------------------------------------------------------------+---------------+
| :ref:`float<class_float>` | :ref:`threshold<class_OpenXRDpadBindingModifier_property_threshold>` | ``0.6`` |
+-------------------------------------------------+----------------------------------------------------------------------------------------+---------------+
| :ref:`float<class_float>` | :ref:`threshold_released<class_OpenXRDpadBindingModifier_property_threshold_released>` | ``0.4`` |
+-------------------------------------------------+----------------------------------------------------------------------------------------+---------------+
| :ref:`float<class_float>` | :ref:`wedge_angle<class_OpenXRDpadBindingModifier_property_wedge_angle>` | ``1.5707964`` |
+-------------------------------------------------+----------------------------------------------------------------------------------------+---------------+
.. rst-class:: classref-section-separator
@@ -204,7 +204,7 @@ When our input value falls below this, our output becomes ``false``.
.. rst-class:: classref-property
:ref:`float<class_float>` **wedge_angle** = ``1.5708`` :ref:`🔗<class_OpenXRDpadBindingModifier_property_wedge_angle>`
:ref:`float<class_float>` **wedge_angle** = ``1.5707964`` :ref:`🔗<class_OpenXRDpadBindingModifier_property_wedge_angle>`
.. rst-class:: classref-property-setget

2
classes/class_os.rst
View File

@@ -1165,7 +1165,7 @@ Returns ``-1`` if the ``pid`` is not a PID of a spawned child process, the proce
Returns the number used by the host machine to uniquely identify this application.
\ **Note:** This method is implemented on Android, iOS, Linux, macOS, and Windows.
\ **Note:** On Web, this method always returns ``0``.
.. rst-class:: classref-item-separator

8
classes/class_parallax2d.rst
View File

@@ -45,9 +45,9 @@ Properties
+---------------------------------------------------------------------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`ignore_camera_scroll<class_Parallax2D_property_ignore_camera_scroll>` | ``false`` |
+---------------------------------------------------------------------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`limit_begin<class_Parallax2D_property_limit_begin>` | ``Vector2(-1e+07, -1e+07)`` |
| :ref:`Vector2<class_Vector2>` | :ref:`limit_begin<class_Parallax2D_property_limit_begin>` | ``Vector2(-10000000, -10000000)`` |
+---------------------------------------------------------------------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`limit_end<class_Parallax2D_property_limit_end>` | ``Vector2(1e+07, 1e+07)`` |
| :ref:`Vector2<class_Vector2>` | :ref:`limit_end<class_Parallax2D_property_limit_end>` | ``Vector2(10000000, 10000000)`` |
+---------------------------------------------------------------------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------+
| :ref:`PhysicsInterpolationMode<enum_Node_PhysicsInterpolationMode>` | physics_interpolation_mode | ``2`` (overrides :ref:`Node<class_Node_property_physics_interpolation_mode>`) |
+---------------------------------------------------------------------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------+
@@ -126,7 +126,7 @@ If ``true``, **Parallax2D**'s position is not affected by the position of the ca
.. rst-class:: classref-property
:ref:`Vector2<class_Vector2>` **limit_begin** = ``Vector2(-1e+07, -1e+07)`` :ref:`🔗<class_Parallax2D_property_limit_begin>`
:ref:`Vector2<class_Vector2>` **limit_begin** = ``Vector2(-10000000, -10000000)`` :ref:`🔗<class_Parallax2D_property_limit_begin>`
.. rst-class:: classref-property-setget
@@ -143,7 +143,7 @@ Top-left limits for scrolling to begin. If the camera is outside of this limit,
.. rst-class:: classref-property
:ref:`Vector2<class_Vector2>` **limit_end** = ``Vector2(1e+07, 1e+07)`` :ref:`🔗<class_Parallax2D_property_limit_end>`
:ref:`Vector2<class_Vector2>` **limit_end** = ``Vector2(10000000, 10000000)`` :ref:`🔗<class_Parallax2D_property_limit_end>`
.. rst-class:: classref-property-setget

52
classes/class_projectsettings.rst
View File

@@ -447,6 +447,8 @@ Properties
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`display/display_server/driver.macos<class_ProjectSettings_property_display/display_server/driver.macos>` | |
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`display/display_server/driver.visionos<class_ProjectSettings_property_display/display_server/driver.visionos>` | |
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`display/display_server/driver.windows<class_ProjectSettings_property_display/display_server/driver.windows>` | |
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`display/mouse_cursor/custom_image<class_ProjectSettings_property_display/mouse_cursor/custom_image>` | ``""`` |
@@ -1319,7 +1321,7 @@ Properties
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`physics/2d/run_on_separate_thread<class_ProjectSettings_property_physics/2d/run_on_separate_thread>` | ``false`` |
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`physics/2d/sleep_threshold_angular<class_ProjectSettings_property_physics/2d/sleep_threshold_angular>` | ``0.139626`` |
| :ref:`float<class_float>` | :ref:`physics/2d/sleep_threshold_angular<class_ProjectSettings_property_physics/2d/sleep_threshold_angular>` | ``0.13962634`` |
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`physics/2d/sleep_threshold_linear<class_ProjectSettings_property_physics/2d/sleep_threshold_linear>` | ``2.0`` |
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
@@ -1349,7 +1351,7 @@ Properties
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`physics/3d/run_on_separate_thread<class_ProjectSettings_property_physics/3d/run_on_separate_thread>` | ``false`` |
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`physics/3d/sleep_threshold_angular<class_ProjectSettings_property_physics/3d/sleep_threshold_angular>` | ``0.139626`` |
| :ref:`float<class_float>` | :ref:`physics/3d/sleep_threshold_angular<class_ProjectSettings_property_physics/3d/sleep_threshold_angular>` | ``0.13962634`` |
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`physics/3d/sleep_threshold_linear<class_ProjectSettings_property_physics/3d/sleep_threshold_linear>` | ``0.1`` |
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
@@ -1375,13 +1377,13 @@ Properties
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`physics/common/physics_ticks_per_second<class_ProjectSettings_property_physics/common/physics_ticks_per_second>` | ``60`` |
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`physics/jolt_physics_3d/collisions/active_edge_threshold<class_ProjectSettings_property_physics/jolt_physics_3d/collisions/active_edge_threshold>` | ``0.872665`` |
| :ref:`float<class_float>` | :ref:`physics/jolt_physics_3d/collisions/active_edge_threshold<class_ProjectSettings_property_physics/jolt_physics_3d/collisions/active_edge_threshold>` | ``0.87266463`` |
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`physics/jolt_physics_3d/collisions/collision_margin_fraction<class_ProjectSettings_property_physics/jolt_physics_3d/collisions/collision_margin_fraction>` | ``0.08`` |
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`physics/jolt_physics_3d/joints/world_node<class_ProjectSettings_property_physics/jolt_physics_3d/joints/world_node>` | ``0`` |
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`physics/jolt_physics_3d/limits/max_angular_velocity<class_ProjectSettings_property_physics/jolt_physics_3d/limits/max_angular_velocity>` | ``47.1239`` |
| :ref:`float<class_float>` | :ref:`physics/jolt_physics_3d/limits/max_angular_velocity<class_ProjectSettings_property_physics/jolt_physics_3d/limits/max_angular_velocity>` | ``47.12389`` |
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`physics/jolt_physics_3d/limits/max_bodies<class_ProjectSettings_property_physics/jolt_physics_3d/limits/max_bodies>` | ``10240`` |
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
@@ -1411,7 +1413,7 @@ Properties
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`physics/jolt_physics_3d/simulation/baumgarte_stabilization_factor<class_ProjectSettings_property_physics/jolt_physics_3d/simulation/baumgarte_stabilization_factor>` | ``0.2`` |
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`physics/jolt_physics_3d/simulation/body_pair_contact_cache_angle_threshold<class_ProjectSettings_property_physics/jolt_physics_3d/simulation/body_pair_contact_cache_angle_threshold>` | ``0.0349066`` |
| :ref:`float<class_float>` | :ref:`physics/jolt_physics_3d/simulation/body_pair_contact_cache_angle_threshold<class_ProjectSettings_property_physics/jolt_physics_3d/simulation/body_pair_contact_cache_angle_threshold>` | ``0.034906585`` |
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`physics/jolt_physics_3d/simulation/body_pair_contact_cache_distance_threshold<class_ProjectSettings_property_physics/jolt_physics_3d/simulation/body_pair_contact_cache_distance_threshold>` | ``0.001`` |
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
@@ -1699,6 +1701,8 @@ Properties
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`rendering/rendering_device/driver.macos<class_ProjectSettings_property_rendering/rendering_device/driver.macos>` | ``"metal"`` |
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`rendering/rendering_device/driver.visionos<class_ProjectSettings_property_rendering/rendering_device/driver.visionos>` | ``"metal"`` |
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`rendering/rendering_device/driver.windows<class_ProjectSettings_property_rendering/rendering_device/driver.windows>` | ``"vulkan"`` |
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`rendering/rendering_device/fallback_to_d3d12<class_ProjectSettings_property_rendering/rendering_device/fallback_to_d3d12>` | ``true`` |
@@ -4428,6 +4432,18 @@ MacOS override for :ref:`display/display_server/driver<class_ProjectSettings_pro
----
.. _class_ProjectSettings_property_display/display_server/driver.visionos:
.. rst-class:: classref-property
:ref:`String<class_String>` **display/display_server/driver.visionos** :ref:`🔗<class_ProjectSettings_property_display/display_server/driver.visionos>`
visionOS override for :ref:`display/display_server/driver<class_ProjectSettings_property_display/display_server/driver>`.
.. rst-class:: classref-item-separator
----
.. _class_ProjectSettings_property_display/display_server/driver.windows:
.. rst-class:: classref-property
@@ -10054,7 +10070,7 @@ If ``true``, the 2D physics server runs on a separate thread, making better use
.. rst-class:: classref-property
:ref:`float<class_float>` **physics/2d/sleep_threshold_angular** = ``0.139626`` :ref:`🔗<class_ProjectSettings_property_physics/2d/sleep_threshold_angular>`
:ref:`float<class_float>` **physics/2d/sleep_threshold_angular** = ``0.13962634`` :ref:`🔗<class_ProjectSettings_property_physics/2d/sleep_threshold_angular>`
Threshold angular velocity under which a 2D physics body will be considered inactive. See :ref:`PhysicsServer2D.SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD<class_PhysicsServer2D_constant_SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD>`.
@@ -10300,7 +10316,7 @@ If ``true``, the 3D physics server runs on a separate thread, making better use
.. rst-class:: classref-property
:ref:`float<class_float>` **physics/3d/sleep_threshold_angular** = ``0.139626`` :ref:`🔗<class_ProjectSettings_property_physics/3d/sleep_threshold_angular>`
:ref:`float<class_float>` **physics/3d/sleep_threshold_angular** = ``0.13962634`` :ref:`🔗<class_ProjectSettings_property_physics/3d/sleep_threshold_angular>`
Threshold angular velocity under which a 3D physics body will be considered inactive. See :ref:`PhysicsServer3D.SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD<class_PhysicsServer3D_constant_SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD>`.
@@ -10476,7 +10492,7 @@ The number of fixed iterations per second. This controls how often physics simul
.. rst-class:: classref-property
:ref:`float<class_float>` **physics/jolt_physics_3d/collisions/active_edge_threshold** = ``0.872665`` :ref:`🔗<class_ProjectSettings_property_physics/jolt_physics_3d/collisions/active_edge_threshold>`
:ref:`float<class_float>` **physics/jolt_physics_3d/collisions/active_edge_threshold** = ``0.87266463`` :ref:`🔗<class_ProjectSettings_property_physics/jolt_physics_3d/collisions/active_edge_threshold>`
The maximum angle, in radians, between two adjacent triangles in a :ref:`ConcavePolygonShape3D<class_ConcavePolygonShape3D>` or :ref:`HeightMapShape3D<class_HeightMapShape3D>` for which the edge between those triangles is considered inactive.
@@ -10526,7 +10542,7 @@ Which of the two nodes bound by a joint should represent the world when one of t
.. rst-class:: classref-property
:ref:`float<class_float>` **physics/jolt_physics_3d/limits/max_angular_velocity** = ``47.1239`` :ref:`🔗<class_ProjectSettings_property_physics/jolt_physics_3d/limits/max_angular_velocity>`
:ref:`float<class_float>` **physics/jolt_physics_3d/limits/max_angular_velocity** = ``47.12389`` :ref:`🔗<class_ProjectSettings_property_physics/jolt_physics_3d/limits/max_angular_velocity>`
The maximum angular velocity that a :ref:`RigidBody3D<class_RigidBody3D>` can reach, in radians per second.
@@ -10736,7 +10752,7 @@ How much of the position error of a :ref:`RigidBody3D<class_RigidBody3D>` to fix
.. rst-class:: classref-property
:ref:`float<class_float>` **physics/jolt_physics_3d/simulation/body_pair_contact_cache_angle_threshold** = ``0.0349066`` :ref:`🔗<class_ProjectSettings_property_physics/jolt_physics_3d/simulation/body_pair_contact_cache_angle_threshold>`
:ref:`float<class_float>` **physics/jolt_physics_3d/simulation/body_pair_contact_cache_angle_threshold** = ``0.034906585`` :ref:`🔗<class_ProjectSettings_property_physics/jolt_physics_3d/simulation/body_pair_contact_cache_angle_threshold>`
The maximum relative angle by which a body pair can move and still reuse the collision results from the previous physics step, in radians.
@@ -12712,6 +12728,22 @@ Two options are supported:
----
.. _class_ProjectSettings_property_rendering/rendering_device/driver.visionos:
.. rst-class:: classref-property
:ref:`String<class_String>` **rendering/rendering_device/driver.visionos** = ``"metal"`` :ref:`🔗<class_ProjectSettings_property_rendering/rendering_device/driver.visionos>`
visionOS override for :ref:`rendering/rendering_device/driver<class_ProjectSettings_property_rendering/rendering_device/driver>`.
Only one option is supported:
- ``metal`` (default), Metal from native drivers.
.. rst-class:: classref-item-separator
----
.. _class_ProjectSettings_property_rendering/rendering_device/driver.windows:
.. rst-class:: classref-property

42
classes/class_skeletonmodifier3d.rst
View File

@@ -56,13 +56,17 @@ Methods
.. table::
:widths: auto
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`_process_modification<class_SkeletonModifier3D_private_method__process_modification>`\ (\ ) |virtual| |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`_process_modification_with_delta<class_SkeletonModifier3D_private_method__process_modification_with_delta>`\ (\ delta\: :ref:`float<class_float>`\ ) |virtual| |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Skeleton3D<class_Skeleton3D>` | :ref:`get_skeleton<class_SkeletonModifier3D_method_get_skeleton>`\ (\ ) |const| |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`_process_modification<class_SkeletonModifier3D_private_method__process_modification>`\ (\ ) |virtual| |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`_process_modification_with_delta<class_SkeletonModifier3D_private_method__process_modification_with_delta>`\ (\ delta\: :ref:`float<class_float>`\ ) |virtual| |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`_skeleton_changed<class_SkeletonModifier3D_private_method__skeleton_changed>`\ (\ old_skeleton\: :ref:`Skeleton3D<class_Skeleton3D>`, new_skeleton\: :ref:`Skeleton3D<class_Skeleton3D>`\ ) |virtual| |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`_validate_bone_names<class_SkeletonModifier3D_private_method__validate_bone_names>`\ (\ ) |virtual| |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Skeleton3D<class_Skeleton3D>` | :ref:`get_skeleton<class_SkeletonModifier3D_method_get_skeleton>`\ (\ ) |const| |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
@@ -228,6 +232,30 @@ Override this virtual method to implement a custom skeleton modifier. You should
----
.. _class_SkeletonModifier3D_private_method__skeleton_changed:
.. rst-class:: classref-method
|void| **_skeleton_changed**\ (\ old_skeleton\: :ref:`Skeleton3D<class_Skeleton3D>`, new_skeleton\: :ref:`Skeleton3D<class_Skeleton3D>`\ ) |virtual| :ref:`🔗<class_SkeletonModifier3D_private_method__skeleton_changed>`
Called when the skeleton is changed.
.. rst-class:: classref-item-separator
----
.. _class_SkeletonModifier3D_private_method__validate_bone_names:
.. rst-class:: classref-method
|void| **_validate_bone_names**\ (\ ) |virtual| :ref:`🔗<class_SkeletonModifier3D_private_method__validate_bone_names>`
Called when bone name and index need to be validated such as the timing of the entering tree or changing skeleton.
.. rst-class:: classref-item-separator
----
.. _class_SkeletonModifier3D_method_get_skeleton:
.. rst-class:: classref-method

35
classes/class_springbonecollisioncapsule3d.rst
View File

@@ -29,13 +29,15 @@ Properties
.. table::
:widths: auto
+---------------------------+-------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`height<class_SpringBoneCollisionCapsule3D_property_height>` | ``0.5`` |
+---------------------------+-------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>` | :ref:`inside<class_SpringBoneCollisionCapsule3D_property_inside>` | ``false`` |
+---------------------------+-------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`radius<class_SpringBoneCollisionCapsule3D_property_radius>` | ``0.1`` |
+---------------------------+-------------------------------------------------------------------+-----------+
+---------------------------+---------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`height<class_SpringBoneCollisionCapsule3D_property_height>` | ``0.5`` |
+---------------------------+---------------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>` | :ref:`inside<class_SpringBoneCollisionCapsule3D_property_inside>` | ``false`` |
+---------------------------+---------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`mid_height<class_SpringBoneCollisionCapsule3D_property_mid_height>` | |
+---------------------------+---------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`radius<class_SpringBoneCollisionCapsule3D_property_radius>` | ``0.1`` |
+---------------------------+---------------------------------------------------------------------------+-----------+
.. rst-class:: classref-section-separator
@@ -57,7 +59,7 @@ Property Descriptions
- |void| **set_height**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_height**\ (\ )
The capsule's height.
The capsule's full height, including the hemispheres.
.. rst-class:: classref-item-separator
@@ -80,6 +82,23 @@ If ``true``, the collision acts to trap the joint within the collision.
----
.. _class_SpringBoneCollisionCapsule3D_property_mid_height:
.. rst-class:: classref-property
:ref:`float<class_float>` **mid_height** :ref:`🔗<class_SpringBoneCollisionCapsule3D_property_mid_height>`
.. rst-class:: classref-property-setget
- |void| **set_mid_height**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_mid_height**\ (\ )
The capsule's height, excluding the hemispheres. This is the height of the central cylindrical part in the middle of the capsule, and is the distance between the centers of the two hemispheres. This is a wrapper for :ref:`height<class_SpringBoneCollisionCapsule3D_property_height>`.
.. rst-class:: classref-item-separator
----
.. _class_SpringBoneCollisionCapsule3D_property_radius:
.. rst-class:: classref-property

4
classes/class_string.rst
View File

@@ -1032,7 +1032,7 @@ Returns ``true`` if the string is a path, and its starting point is dependent on
:ref:`bool<class_bool>` **is_subsequence_of**\ (\ text\: :ref:`String<class_String>`\ ) |const| :ref:`🔗<class_String_method_is_subsequence_of>`
Returns ``true`` if all characters of this string can be found in ``text`` in their original order.
Returns ``true`` if all characters of this string can be found in ``text`` in their original order. This is not the same as :ref:`contains()<class_String_method_contains>`.
::
@@ -1053,7 +1053,7 @@ Returns ``true`` if all characters of this string can be found in ``text`` in th
:ref:`bool<class_bool>` **is_subsequence_ofn**\ (\ text\: :ref:`String<class_String>`\ ) |const| :ref:`🔗<class_String_method_is_subsequence_ofn>`
Returns ``true`` if all characters of this string can be found in ``text`` in their original order, **ignoring case**.
Returns ``true`` if all characters of this string can be found in ``text`` in their original order, **ignoring case**. This is not the same as :ref:`containsn()<class_String_method_containsn>`.
.. rst-class:: classref-item-separator

4
classes/class_stringname.rst
View File

@@ -972,7 +972,7 @@ Returns ``true`` if the string is a path, and its starting point is dependent on
:ref:`bool<class_bool>` **is_subsequence_of**\ (\ text\: :ref:`String<class_String>`\ ) |const| :ref:`🔗<class_StringName_method_is_subsequence_of>`
Returns ``true`` if all characters of this string can be found in ``text`` in their original order.
Returns ``true`` if all characters of this string can be found in ``text`` in their original order. This is not the same as :ref:`contains()<class_StringName_method_contains>`.
::
@@ -993,7 +993,7 @@ Returns ``true`` if all characters of this string can be found in ``text`` in th
:ref:`bool<class_bool>` **is_subsequence_ofn**\ (\ text\: :ref:`String<class_String>`\ ) |const| :ref:`🔗<class_StringName_method_is_subsequence_ofn>`
Returns ``true`` if all characters of this string can be found in ``text`` in their original order, **ignoring case**.
Returns ``true`` if all characters of this string can be found in ``text`` in their original order, **ignoring case**. This is not the same as :ref:`containsn()<class_StringName_method_containsn>`.
.. rst-class:: classref-item-separator

4
classes/class_videostreamplayer.rst
View File

@@ -261,8 +261,6 @@ The assigned video stream. See description for supported formats.
The current position of the stream, in seconds.
\ **Note:** Changing this value won't have any effect as seeking is not implemented yet, except in video formats implemented by a GDExtension add-on.
.. rst-class:: classref-item-separator
----
@@ -314,8 +312,6 @@ Method Descriptions
The length of the current stream, in seconds.
\ **Note:** For :ref:`VideoStreamTheora<class_VideoStreamTheora>` streams (the built-in format supported by Godot), this value will always be zero, as getting the stream length is not implemented yet. The feature may be supported by video formats implemented by a GDExtension add-on.
.. rst-class:: classref-item-separator
----

4
classes/index.rst
View File

@@ -754,11 +754,13 @@ Other objects
class_editordebuggersession
class_editorexportplatform
class_editorexportplatformandroid
class_editorexportplatformappleembedded
class_editorexportplatformextension
class_editorexportplatformios
class_editorexportplatformlinuxbsd
class_editorexportplatformmacos
class_editorexportplatformpc
class_editorexportplatformvisionos
class_editorexportplatformweb
class_editorexportplatformwindows
class_editorexportplugin
@@ -1022,11 +1024,13 @@ Editor-only
class_editordebuggersession
class_editorexportplatform
class_editorexportplatformandroid
class_editorexportplatformappleembedded
class_editorexportplatformextension
class_editorexportplatformios
class_editorexportplatformlinuxbsd
class_editorexportplatformmacos
class_editorexportplatformpc
class_editorexportplatformvisionos
class_editorexportplatformweb
class_editorexportplatformwindows
class_editorexportplugin