stan220/godot-docs
1
0
Fork 0
mirror of https://github.com/stan220/godot-docs.git synced 2026-09-08 17:28:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (6c05ec3)

Browse Source
This commit is contained in:
Godot Organization
2024-11-16 03:22:28 +00:00
parent 703d0cdba2
commit e0dc2b106a
149 changed files with 2125 additions and 515 deletions
Download Patch File Download Diff File Expand all files Collapse all files
classes/class_physicalbone3d.rst
+20 -46
View File
@@ -137,11 +137,7 @@ enum **JointType**: :ref:`🔗<enum_PhysicalBone3D_JointType>`
:ref:`JointType<enum_PhysicalBone3D_JointType>` **JOINT_TYPE_NONE** = ``0``
.. container:: contribute
There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
No joint is applied to the PhysicsBone3D.
.. _class_PhysicalBone3D_constant_JOINT_TYPE_PIN:
@@ -149,11 +145,7 @@ enum **JointType**: :ref:`🔗<enum_PhysicalBone3D_JointType>`
:ref:`JointType<enum_PhysicalBone3D_JointType>` **JOINT_TYPE_PIN** = ``1``
.. container:: contribute
There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
A pin joint is applied to the PhysicsBone3D.
.. _class_PhysicalBone3D_constant_JOINT_TYPE_CONE:
@@ -161,11 +153,7 @@ enum **JointType**: :ref:`🔗<enum_PhysicalBone3D_JointType>`
:ref:`JointType<enum_PhysicalBone3D_JointType>` **JOINT_TYPE_CONE** = ``2``
.. container:: contribute
There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
A cone joint is applied to the PhysicsBone3D.
.. _class_PhysicalBone3D_constant_JOINT_TYPE_HINGE:
@@ -173,11 +161,7 @@ enum **JointType**: :ref:`🔗<enum_PhysicalBone3D_JointType>`
:ref:`JointType<enum_PhysicalBone3D_JointType>` **JOINT_TYPE_HINGE** = ``3``
.. container:: contribute
There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
A hinge joint is applied to the PhysicsBone3D.
.. _class_PhysicalBone3D_constant_JOINT_TYPE_SLIDER:
@@ -185,11 +169,7 @@ enum **JointType**: :ref:`🔗<enum_PhysicalBone3D_JointType>`
:ref:`JointType<enum_PhysicalBone3D_JointType>` **JOINT_TYPE_SLIDER** = ``4``
.. container:: contribute
There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
A slider joint is applied to the PhysicsBone3D.
.. _class_PhysicalBone3D_constant_JOINT_TYPE_6DOF:
@@ -197,11 +177,7 @@ enum **JointType**: :ref:`🔗<enum_PhysicalBone3D_JointType>`
:ref:`JointType<enum_PhysicalBone3D_JointType>` **JOINT_TYPE_6DOF** = ``5``
.. container:: contribute
There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
A 6 degrees of freedom joint is applied to the PhysicsBone3D.
.. rst-class:: classref-section-separator
@@ -223,7 +199,7 @@ Property Descriptions
- |void| **set_angular_damp**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_angular_damp**\ (\ )
Damps the body's rotation. By default, the body will use the **Default Angular Damp** in **Project > Project Settings > Physics > 3d** or any value override set by an :ref:`Area3D<class_Area3D>` the body is in. Depending on :ref:`angular_damp_mode<class_PhysicalBone3D_property_angular_damp_mode>`, you can set :ref:`angular_damp<class_PhysicalBone3D_property_angular_damp>` to be added to or to replace the body's damping value.
Damps the body's rotation. By default, the body will use the :ref:`ProjectSettings.physics/3d/default_angular_damp<class_ProjectSettings_property_physics/3d/default_angular_damp>` project setting or any value override set by an :ref:`Area3D<class_Area3D>` the body is in. Depending on :ref:`angular_damp_mode<class_PhysicalBone3D_property_angular_damp_mode>`, you can set :ref:`angular_damp<class_PhysicalBone3D_property_angular_damp>` to be added to or to replace the body's damping value.
See :ref:`ProjectSettings.physics/3d/default_angular_damp<class_ProjectSettings_property_physics/3d/default_angular_damp>` for more details about damping.
@@ -365,7 +341,7 @@ The body's friction, from ``0`` (frictionless) to ``1`` (max friction).
- |void| **set_gravity_scale**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_gravity_scale**\ (\ )
This is multiplied by the global 3D gravity setting found in **Project > Project Settings > Physics > 3d** to produce the body's gravity. For example, a value of 1 will be normal gravity, 2 will apply double gravity, and 0.5 will apply half gravity to this object.
This is multiplied by :ref:`ProjectSettings.physics/3d/default_gravity<class_ProjectSettings_property_physics/3d/default_gravity>` to produce this body's gravity. For example, a value of ``1.0`` will apply normal gravity, ``2.0`` will apply double the gravity, and ``0.5`` will apply half the gravity to this body.
.. rst-class:: classref-item-separator
@@ -433,7 +409,7 @@ Sets the joint type. See :ref:`JointType<enum_PhysicalBone3D_JointType>` for pos
- |void| **set_linear_damp**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_linear_damp**\ (\ )
Damps the body's movement. By default, the body will use the **Default Linear Damp** in **Project > Project Settings > Physics > 3d** or any value override set by an :ref:`Area3D<class_Area3D>` the body is in. Depending on :ref:`linear_damp_mode<class_PhysicalBone3D_property_linear_damp_mode>`, you can set :ref:`linear_damp<class_PhysicalBone3D_property_linear_damp>` to be added to or to replace the body's damping value.
Damps the body's movement. By default, the body will use :ref:`ProjectSettings.physics/3d/default_linear_damp<class_ProjectSettings_property_physics/3d/default_linear_damp>` or any value override set by an :ref:`Area3D<class_Area3D>` the body is in. Depending on :ref:`linear_damp_mode<class_PhysicalBone3D_property_linear_damp_mode>`, :ref:`linear_damp<class_PhysicalBone3D_property_linear_damp>` may be added to or replace the body's damping value.
See :ref:`ProjectSettings.physics/3d/default_linear_damp<class_ProjectSettings_property_physics/3d/default_linear_damp>` for more details about damping.
@@ -515,9 +491,11 @@ Called during physics processing, allowing you to read and safely modify the sim
|void| **apply_central_impulse**\ (\ impulse\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_PhysicalBone3D_method_apply_central_impulse>`
.. container:: contribute
Applies a directional impulse without affecting rotation.
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_integrate_forces" functions otherwise).
This is equivalent to using :ref:`apply_impulse<class_PhysicalBone3D_method_apply_impulse>` at the body's center of mass.
.. rst-class:: classref-item-separator
@@ -529,9 +507,11 @@ Called during physics processing, allowing you to read and safely modify the sim
|void| **apply_impulse**\ (\ impulse\: :ref:`Vector3<class_Vector3>`, position\: :ref:`Vector3<class_Vector3>` = Vector3(0, 0, 0)\ ) :ref:`🔗<class_PhysicalBone3D_method_apply_impulse>`
.. container:: contribute
Applies a positioned impulse to the PhysicsBone3D.
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_integrate_forces" functions otherwise).
\ ``position`` is the offset from the PhysicsBone3D origin in global coordinates.
.. rst-class:: classref-item-separator
@@ -543,9 +523,7 @@ Called during physics processing, allowing you to read and safely modify the sim
:ref:`int<class_int>` **get_bone_id**\ (\ ) |const| :ref:`🔗<class_PhysicalBone3D_method_get_bone_id>`
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Returns the unique identifier of the PhysicsBone3D.
.. rst-class:: classref-item-separator
@@ -557,9 +535,7 @@ Called during physics processing, allowing you to read and safely modify the sim
:ref:`bool<class_bool>` **get_simulate_physics**\ (\ ) :ref:`🔗<class_PhysicalBone3D_method_get_simulate_physics>`
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Returns ``true`` if the PhysicsBone3D is allowed to simulate physics.
.. rst-class:: classref-item-separator
@@ -571,9 +547,7 @@ Called during physics processing, allowing you to read and safely modify the sim
:ref:`bool<class_bool>` **is_simulating_physics**\ (\ ) :ref:`🔗<class_PhysicalBone3D_method_is_simulating_physics>`
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Returns ``true`` if the PhysicsBone3D is currently simulating physics.
.. |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.)`