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

classref: Sync with current master branch (705b7a0)

Browse Source
This commit is contained in:
Godot Organization
2024-05-31 13:54:35 +00:00
parent 32f1b6ea48
commit eacfba2716
835 changed files with 17350 additions and 17256 deletions
Download Patch File Download Diff File Expand all files Collapse all files

84
classes/class_physicsdirectbodystate3d.rst
View File

@@ -149,7 +149,7 @@ Property Descriptions
.. rst-class:: classref-property
:ref:`Vector3<class_Vector3>` **angular_velocity**
:ref:`Vector3<class_Vector3>` **angular_velocity** :ref:`🔗<class_PhysicsDirectBodyState3D_property_angular_velocity>`
.. rst-class:: classref-property-setget
@@ -166,7 +166,7 @@ The body's rotational velocity in *radians* per second.
.. rst-class:: classref-property
:ref:`Vector3<class_Vector3>` **center_of_mass**
:ref:`Vector3<class_Vector3>` **center_of_mass** :ref:`🔗<class_PhysicsDirectBodyState3D_property_center_of_mass>`
.. rst-class:: classref-property-setget
@@ -182,7 +182,7 @@ The body's center of mass position relative to the body's center in the global c
.. rst-class:: classref-property
:ref:`Vector3<class_Vector3>` **center_of_mass_local**
:ref:`Vector3<class_Vector3>` **center_of_mass_local** :ref:`🔗<class_PhysicsDirectBodyState3D_property_center_of_mass_local>`
.. rst-class:: classref-property-setget
@@ -198,7 +198,7 @@ The body's center of mass position in the body's local coordinate system.
.. rst-class:: classref-property
:ref:`Vector3<class_Vector3>` **inverse_inertia**
:ref:`Vector3<class_Vector3>` **inverse_inertia** :ref:`🔗<class_PhysicsDirectBodyState3D_property_inverse_inertia>`
.. rst-class:: classref-property-setget
@@ -214,7 +214,7 @@ The inverse of the inertia of the body.
.. rst-class:: classref-property
:ref:`Basis<class_Basis>` **inverse_inertia_tensor**
:ref:`Basis<class_Basis>` **inverse_inertia_tensor** :ref:`🔗<class_PhysicsDirectBodyState3D_property_inverse_inertia_tensor>`
.. rst-class:: classref-property-setget
@@ -230,7 +230,7 @@ The inverse of the inertia tensor of the body.
.. rst-class:: classref-property
:ref:`float<class_float>` **inverse_mass**
:ref:`float<class_float>` **inverse_mass** :ref:`🔗<class_PhysicsDirectBodyState3D_property_inverse_mass>`
.. rst-class:: classref-property-setget
@@ -246,7 +246,7 @@ The inverse of the mass of the body.
.. rst-class:: classref-property
:ref:`Vector3<class_Vector3>` **linear_velocity**
:ref:`Vector3<class_Vector3>` **linear_velocity** :ref:`🔗<class_PhysicsDirectBodyState3D_property_linear_velocity>`
.. rst-class:: classref-property-setget
@@ -263,7 +263,7 @@ The body's linear velocity in units per second.
.. rst-class:: classref-property
:ref:`Basis<class_Basis>` **principal_inertia_axes**
:ref:`Basis<class_Basis>` **principal_inertia_axes** :ref:`🔗<class_PhysicsDirectBodyState3D_property_principal_inertia_axes>`
.. rst-class:: classref-property-setget
@@ -281,7 +281,7 @@ The body's linear velocity in units per second.
.. rst-class:: classref-property
:ref:`bool<class_bool>` **sleeping**
:ref:`bool<class_bool>` **sleeping** :ref:`🔗<class_PhysicsDirectBodyState3D_property_sleeping>`
.. rst-class:: classref-property-setget
@@ -298,7 +298,7 @@ If ``true``, this body is currently sleeping (not active).
.. rst-class:: classref-property
:ref:`float<class_float>` **step**
:ref:`float<class_float>` **step** :ref:`🔗<class_PhysicsDirectBodyState3D_property_step>`
.. rst-class:: classref-property-setget
@@ -314,7 +314,7 @@ The timestep (delta) used for the simulation.
.. rst-class:: classref-property
:ref:`float<class_float>` **total_angular_damp**
:ref:`float<class_float>` **total_angular_damp** :ref:`🔗<class_PhysicsDirectBodyState3D_property_total_angular_damp>`
.. rst-class:: classref-property-setget
@@ -330,7 +330,7 @@ The rate at which the body stops rotating, if there are not any other forces mov
.. rst-class:: classref-property
:ref:`Vector3<class_Vector3>` **total_gravity**
:ref:`Vector3<class_Vector3>` **total_gravity** :ref:`🔗<class_PhysicsDirectBodyState3D_property_total_gravity>`
.. rst-class:: classref-property-setget
@@ -346,7 +346,7 @@ The total gravity vector being currently applied to this body.
.. rst-class:: classref-property
:ref:`float<class_float>` **total_linear_damp**
:ref:`float<class_float>` **total_linear_damp** :ref:`🔗<class_PhysicsDirectBodyState3D_property_total_linear_damp>`
.. rst-class:: classref-property-setget
@@ -362,7 +362,7 @@ The rate at which the body stops moving, if there are not any other forces movin
.. rst-class:: classref-property
:ref:`Transform3D<class_Transform3D>` **transform**
:ref:`Transform3D<class_Transform3D>` **transform** :ref:`🔗<class_PhysicsDirectBodyState3D_property_transform>`
.. rst-class:: classref-property-setget
@@ -384,7 +384,7 @@ Method Descriptions
.. rst-class:: classref-method
|void| **add_constant_central_force**\ (\ force\: :ref:`Vector3<class_Vector3>` = Vector3(0, 0, 0)\ )
|void| **add_constant_central_force**\ (\ force\: :ref:`Vector3<class_Vector3>` = Vector3(0, 0, 0)\ ) :ref:`🔗<class_PhysicsDirectBodyState3D_method_add_constant_central_force>`
Adds a constant directional force without affecting rotation that keeps being applied over time until cleared with ``constant_force = Vector3(0, 0, 0)``.
@@ -398,7 +398,7 @@ This is equivalent to using :ref:`add_constant_force<class_PhysicsDirectBodyStat
.. rst-class:: classref-method
|void| **add_constant_force**\ (\ force\: :ref:`Vector3<class_Vector3>`, position\: :ref:`Vector3<class_Vector3>` = Vector3(0, 0, 0)\ )
|void| **add_constant_force**\ (\ force\: :ref:`Vector3<class_Vector3>`, position\: :ref:`Vector3<class_Vector3>` = Vector3(0, 0, 0)\ ) :ref:`🔗<class_PhysicsDirectBodyState3D_method_add_constant_force>`
Adds a constant positioned force to the body that keeps being applied over time until cleared with ``constant_force = Vector3(0, 0, 0)``.
@@ -412,7 +412,7 @@ Adds a constant positioned force to the body that keeps being applied over time
.. rst-class:: classref-method
|void| **add_constant_torque**\ (\ torque\: :ref:`Vector3<class_Vector3>`\ )
|void| **add_constant_torque**\ (\ torque\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_PhysicsDirectBodyState3D_method_add_constant_torque>`
Adds a constant rotational force without affecting position that keeps being applied over time until cleared with ``constant_torque = Vector3(0, 0, 0)``.
@@ -424,7 +424,7 @@ Adds a constant rotational force without affecting position that keeps being app
.. rst-class:: classref-method
|void| **apply_central_force**\ (\ force\: :ref:`Vector3<class_Vector3>` = Vector3(0, 0, 0)\ )
|void| **apply_central_force**\ (\ force\: :ref:`Vector3<class_Vector3>` = Vector3(0, 0, 0)\ ) :ref:`🔗<class_PhysicsDirectBodyState3D_method_apply_central_force>`
Applies a directional force without affecting rotation. A force is time dependent and meant to be applied every physics update.
@@ -438,7 +438,7 @@ This is equivalent to using :ref:`apply_force<class_PhysicsDirectBodyState3D_met
.. rst-class:: classref-method
|void| **apply_central_impulse**\ (\ impulse\: :ref:`Vector3<class_Vector3>` = Vector3(0, 0, 0)\ )
|void| **apply_central_impulse**\ (\ impulse\: :ref:`Vector3<class_Vector3>` = Vector3(0, 0, 0)\ ) :ref:`🔗<class_PhysicsDirectBodyState3D_method_apply_central_impulse>`
Applies a directional impulse without affecting rotation.
@@ -454,7 +454,7 @@ This is equivalent to using :ref:`apply_impulse<class_PhysicsDirectBodyState3D_m
.. rst-class:: classref-method
|void| **apply_force**\ (\ force\: :ref:`Vector3<class_Vector3>`, position\: :ref:`Vector3<class_Vector3>` = Vector3(0, 0, 0)\ )
|void| **apply_force**\ (\ force\: :ref:`Vector3<class_Vector3>`, position\: :ref:`Vector3<class_Vector3>` = Vector3(0, 0, 0)\ ) :ref:`🔗<class_PhysicsDirectBodyState3D_method_apply_force>`
Applies a positioned force to the body. A force is time dependent and meant to be applied every physics update.
@@ -468,7 +468,7 @@ Applies a positioned force to the body. A force is time dependent and meant to b
.. rst-class:: classref-method
|void| **apply_impulse**\ (\ impulse\: :ref:`Vector3<class_Vector3>`, position\: :ref:`Vector3<class_Vector3>` = Vector3(0, 0, 0)\ )
|void| **apply_impulse**\ (\ impulse\: :ref:`Vector3<class_Vector3>`, position\: :ref:`Vector3<class_Vector3>` = Vector3(0, 0, 0)\ ) :ref:`🔗<class_PhysicsDirectBodyState3D_method_apply_impulse>`
Applies a positioned impulse to the body.
@@ -484,7 +484,7 @@ An impulse is time-independent! Applying an impulse every frame would result in
.. rst-class:: classref-method
|void| **apply_torque**\ (\ torque\: :ref:`Vector3<class_Vector3>`\ )
|void| **apply_torque**\ (\ torque\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_PhysicsDirectBodyState3D_method_apply_torque>`
Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update.
@@ -498,7 +498,7 @@ Applies a rotational force without affecting position. A force is time dependent
.. rst-class:: classref-method
|void| **apply_torque_impulse**\ (\ impulse\: :ref:`Vector3<class_Vector3>`\ )
|void| **apply_torque_impulse**\ (\ impulse\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_PhysicsDirectBodyState3D_method_apply_torque_impulse>`
Applies a rotational impulse to the body without affecting the position.
@@ -514,7 +514,7 @@ An impulse is time-independent! Applying an impulse every frame would result in
.. rst-class:: classref-method
:ref:`Vector3<class_Vector3>` **get_constant_force**\ (\ ) |const|
:ref:`Vector3<class_Vector3>` **get_constant_force**\ (\ ) |const| :ref:`🔗<class_PhysicsDirectBodyState3D_method_get_constant_force>`
Returns the body's total constant positional forces applied during each physics update.
@@ -528,7 +528,7 @@ See :ref:`add_constant_force<class_PhysicsDirectBodyState3D_method_add_constant_
.. rst-class:: classref-method
:ref:`Vector3<class_Vector3>` **get_constant_torque**\ (\ ) |const|
:ref:`Vector3<class_Vector3>` **get_constant_torque**\ (\ ) |const| :ref:`🔗<class_PhysicsDirectBodyState3D_method_get_constant_torque>`
Returns the body's total constant rotational forces applied during each physics update.
@@ -542,7 +542,7 @@ See :ref:`add_constant_torque<class_PhysicsDirectBodyState3D_method_add_constant
.. rst-class:: classref-method
:ref:`RID<class_RID>` **get_contact_collider**\ (\ contact_idx\: :ref:`int<class_int>`\ ) |const|
:ref:`RID<class_RID>` **get_contact_collider**\ (\ contact_idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_PhysicsDirectBodyState3D_method_get_contact_collider>`
Returns the collider's :ref:`RID<class_RID>`.
@@ -554,7 +554,7 @@ Returns the collider's :ref:`RID<class_RID>`.
.. rst-class:: classref-method
:ref:`int<class_int>` **get_contact_collider_id**\ (\ contact_idx\: :ref:`int<class_int>`\ ) |const|
:ref:`int<class_int>` **get_contact_collider_id**\ (\ contact_idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_PhysicsDirectBodyState3D_method_get_contact_collider_id>`
Returns the collider's object id.
@@ -566,7 +566,7 @@ Returns the collider's object id.
.. rst-class:: classref-method
:ref:`Object<class_Object>` **get_contact_collider_object**\ (\ contact_idx\: :ref:`int<class_int>`\ ) |const|
:ref:`Object<class_Object>` **get_contact_collider_object**\ (\ contact_idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_PhysicsDirectBodyState3D_method_get_contact_collider_object>`
Returns the collider object.
@@ -578,7 +578,7 @@ Returns the collider object.
.. rst-class:: classref-method
:ref:`Vector3<class_Vector3>` **get_contact_collider_position**\ (\ contact_idx\: :ref:`int<class_int>`\ ) |const|
:ref:`Vector3<class_Vector3>` **get_contact_collider_position**\ (\ contact_idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_PhysicsDirectBodyState3D_method_get_contact_collider_position>`
Returns the position of the contact point on the collider in the global coordinate system.
@@ -590,7 +590,7 @@ Returns the position of the contact point on the collider in the global coordina
.. rst-class:: classref-method
:ref:`int<class_int>` **get_contact_collider_shape**\ (\ contact_idx\: :ref:`int<class_int>`\ ) |const|
:ref:`int<class_int>` **get_contact_collider_shape**\ (\ contact_idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_PhysicsDirectBodyState3D_method_get_contact_collider_shape>`
Returns the collider's shape index.
@@ -602,7 +602,7 @@ Returns the collider's shape index.
.. rst-class:: classref-method
:ref:`Vector3<class_Vector3>` **get_contact_collider_velocity_at_position**\ (\ contact_idx\: :ref:`int<class_int>`\ ) |const|
:ref:`Vector3<class_Vector3>` **get_contact_collider_velocity_at_position**\ (\ contact_idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_PhysicsDirectBodyState3D_method_get_contact_collider_velocity_at_position>`
Returns the linear velocity vector at the collider's contact point.
@@ -614,7 +614,7 @@ Returns the linear velocity vector at the collider's contact point.
.. rst-class:: classref-method
:ref:`int<class_int>` **get_contact_count**\ (\ ) |const|
:ref:`int<class_int>` **get_contact_count**\ (\ ) |const| :ref:`🔗<class_PhysicsDirectBodyState3D_method_get_contact_count>`
Returns the number of contacts this body has with other bodies.
@@ -628,7 +628,7 @@ Returns the number of contacts this body has with other bodies.
.. rst-class:: classref-method
:ref:`Vector3<class_Vector3>` **get_contact_impulse**\ (\ contact_idx\: :ref:`int<class_int>`\ ) |const|
:ref:`Vector3<class_Vector3>` **get_contact_impulse**\ (\ contact_idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_PhysicsDirectBodyState3D_method_get_contact_impulse>`
Impulse created by the contact.
@@ -640,7 +640,7 @@ Impulse created by the contact.
.. rst-class:: classref-method
:ref:`Vector3<class_Vector3>` **get_contact_local_normal**\ (\ contact_idx\: :ref:`int<class_int>`\ ) |const|
:ref:`Vector3<class_Vector3>` **get_contact_local_normal**\ (\ contact_idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_PhysicsDirectBodyState3D_method_get_contact_local_normal>`
Returns the local normal at the contact point.
@@ -652,7 +652,7 @@ Returns the local normal at the contact point.
.. rst-class:: classref-method
:ref:`Vector3<class_Vector3>` **get_contact_local_position**\ (\ contact_idx\: :ref:`int<class_int>`\ ) |const|
:ref:`Vector3<class_Vector3>` **get_contact_local_position**\ (\ contact_idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_PhysicsDirectBodyState3D_method_get_contact_local_position>`
Returns the position of the contact point on the body in the global coordinate system.
@@ -664,7 +664,7 @@ Returns the position of the contact point on the body in the global coordinate s
.. rst-class:: classref-method
:ref:`int<class_int>` **get_contact_local_shape**\ (\ contact_idx\: :ref:`int<class_int>`\ ) |const|
:ref:`int<class_int>` **get_contact_local_shape**\ (\ contact_idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_PhysicsDirectBodyState3D_method_get_contact_local_shape>`
Returns the local shape index of the collision.
@@ -676,7 +676,7 @@ Returns the local shape index of the collision.
.. rst-class:: classref-method
:ref:`Vector3<class_Vector3>` **get_contact_local_velocity_at_position**\ (\ contact_idx\: :ref:`int<class_int>`\ ) |const|
:ref:`Vector3<class_Vector3>` **get_contact_local_velocity_at_position**\ (\ contact_idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_PhysicsDirectBodyState3D_method_get_contact_local_velocity_at_position>`
Returns the linear velocity vector at the body's contact point.
@@ -688,7 +688,7 @@ Returns the linear velocity vector at the body's contact point.
.. rst-class:: classref-method
:ref:`PhysicsDirectSpaceState3D<class_PhysicsDirectSpaceState3D>` **get_space_state**\ (\ )
:ref:`PhysicsDirectSpaceState3D<class_PhysicsDirectSpaceState3D>` **get_space_state**\ (\ ) :ref:`🔗<class_PhysicsDirectBodyState3D_method_get_space_state>`
Returns the current state of the space, useful for queries.
@@ -700,7 +700,7 @@ Returns the current state of the space, useful for queries.
.. rst-class:: classref-method
:ref:`Vector3<class_Vector3>` **get_velocity_at_local_position**\ (\ local_position\: :ref:`Vector3<class_Vector3>`\ ) |const|
:ref:`Vector3<class_Vector3>` **get_velocity_at_local_position**\ (\ local_position\: :ref:`Vector3<class_Vector3>`\ ) |const| :ref:`🔗<class_PhysicsDirectBodyState3D_method_get_velocity_at_local_position>`
Returns the body's velocity at the given relative position, including both translation and rotation.
@@ -712,7 +712,7 @@ Returns the body's velocity at the given relative position, including both trans
.. rst-class:: classref-method
|void| **integrate_forces**\ (\ )
|void| **integrate_forces**\ (\ ) :ref:`🔗<class_PhysicsDirectBodyState3D_method_integrate_forces>`
Updates the body's linear and angular velocity by applying gravity and damping for the equivalent of one physics tick.
@@ -724,7 +724,7 @@ Updates the body's linear and angular velocity by applying gravity and damping f
.. rst-class:: classref-method
|void| **set_constant_force**\ (\ force\: :ref:`Vector3<class_Vector3>`\ )
|void| **set_constant_force**\ (\ force\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_PhysicsDirectBodyState3D_method_set_constant_force>`
Sets the body's total constant positional forces applied during each physics update.
@@ -738,7 +738,7 @@ See :ref:`add_constant_force<class_PhysicsDirectBodyState3D_method_add_constant_
.. rst-class:: classref-method
|void| **set_constant_torque**\ (\ torque\: :ref:`Vector3<class_Vector3>`\ )
|void| **set_constant_torque**\ (\ torque\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_PhysicsDirectBodyState3D_method_set_constant_torque>`
Sets the body's total constant rotational forces applied during each physics update.