:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/4.0/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/4.0/doc/classes/PhysicsDirectBodyState2D.xml. .. _class_PhysicsDirectBodyState2D: PhysicsDirectBodyState2D ======================== **Inherits:** :ref:`Object` **Inherited By:** :ref:`PhysicsDirectBodyState2DExtension` Direct access object to a physics body in the :ref:`PhysicsServer2D`. .. rst-class:: classref-introduction-group Description ----------- Provides direct access to a physics body in the :ref:`PhysicsServer2D`, allowing safe changes to physics properties. This object is passed via the direct state callback of rigid bodies, and is intended for changing the direct state of that body. See :ref:`RigidBody2D._integrate_forces`. .. rst-class:: classref-introduction-group Tutorials --------- - :doc:`Physics introduction <../tutorials/physics/physics_introduction>` - :doc:`Ray-casting <../tutorials/physics/ray-casting>` .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +---------------------------------------+-------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angular_velocity` | +---------------------------------------+-------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`center_of_mass` | +---------------------------------------+-------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`center_of_mass_local` | +---------------------------------------+-------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`inverse_inertia` | +---------------------------------------+-------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`inverse_mass` | +---------------------------------------+-------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`linear_velocity` | +---------------------------------------+-------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`sleeping` | +---------------------------------------+-------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`step` | +---------------------------------------+-------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`total_angular_damp` | +---------------------------------------+-------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`total_gravity` | +---------------------------------------+-------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`total_linear_damp` | +---------------------------------------+-------------------------------------------------------------------------------------------+ | :ref:`Transform2D` | :ref:`transform` | +---------------------------------------+-------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_constant_central_force` **(** :ref:`Vector2` force=Vector2(0, 0) **)** | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_constant_force` **(** :ref:`Vector2` force, :ref:`Vector2` position=Vector2(0, 0) **)** | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_constant_torque` **(** :ref:`float` torque **)** | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`apply_central_force` **(** :ref:`Vector2` force=Vector2(0, 0) **)** | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`apply_central_impulse` **(** :ref:`Vector2` impulse **)** | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`apply_force` **(** :ref:`Vector2` force, :ref:`Vector2` position=Vector2(0, 0) **)** | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`apply_impulse` **(** :ref:`Vector2` impulse, :ref:`Vector2` position=Vector2(0, 0) **)** | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`apply_torque` **(** :ref:`float` torque **)** | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`apply_torque_impulse` **(** :ref:`float` impulse **)** | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_constant_force` **(** **)** |const| | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_constant_torque` **(** **)** |const| | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_contact_collider` **(** :ref:`int` contact_idx **)** |const| | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_contact_collider_id` **(** :ref:`int` contact_idx **)** |const| | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Object` | :ref:`get_contact_collider_object` **(** :ref:`int` contact_idx **)** |const| | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_contact_collider_position` **(** :ref:`int` contact_idx **)** |const| | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_contact_collider_shape` **(** :ref:`int` contact_idx **)** |const| | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_contact_collider_velocity_at_position` **(** :ref:`int` contact_idx **)** |const| | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_contact_count` **(** **)** |const| | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_contact_impulse` **(** :ref:`int` contact_idx **)** |const| | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_contact_local_normal` **(** :ref:`int` contact_idx **)** |const| | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_contact_local_position` **(** :ref:`int` contact_idx **)** |const| | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_contact_local_shape` **(** :ref:`int` contact_idx **)** |const| | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PhysicsDirectSpaceState2D` | :ref:`get_space_state` **(** **)** | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_velocity_at_local_position` **(** :ref:`Vector2` local_position **)** |const| | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`integrate_forces` **(** **)** | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_constant_force` **(** :ref:`Vector2` force **)** | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_constant_torque` **(** :ref:`float` torque **)** | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_PhysicsDirectBodyState2D_property_angular_velocity: .. rst-class:: classref-property :ref:`float` **angular_velocity** .. rst-class:: classref-property-setget - void **set_angular_velocity** **(** :ref:`float` value **)** - :ref:`float` **get_angular_velocity** **(** **)** The body's rotational velocity in *radians* per second. .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_property_center_of_mass: .. rst-class:: classref-property :ref:`Vector2` **center_of_mass** .. rst-class:: classref-property-setget - :ref:`Vector2` **get_center_of_mass** **(** **)** The body's center of mass position relative to the body's center in the global coordinate system. .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_property_center_of_mass_local: .. rst-class:: classref-property :ref:`Vector2` **center_of_mass_local** .. rst-class:: classref-property-setget - :ref:`Vector2` **get_center_of_mass_local** **(** **)** The body's center of mass position in the body's local coordinate system. .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_property_inverse_inertia: .. rst-class:: classref-property :ref:`float` **inverse_inertia** .. rst-class:: classref-property-setget - :ref:`float` **get_inverse_inertia** **(** **)** The inverse of the inertia of the body. .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_property_inverse_mass: .. rst-class:: classref-property :ref:`float` **inverse_mass** .. rst-class:: classref-property-setget - :ref:`float` **get_inverse_mass** **(** **)** The inverse of the mass of the body. .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_property_linear_velocity: .. rst-class:: classref-property :ref:`Vector2` **linear_velocity** .. rst-class:: classref-property-setget - void **set_linear_velocity** **(** :ref:`Vector2` value **)** - :ref:`Vector2` **get_linear_velocity** **(** **)** The body's linear velocity in pixels per second. .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_property_sleeping: .. rst-class:: classref-property :ref:`bool` **sleeping** .. rst-class:: classref-property-setget - void **set_sleep_state** **(** :ref:`bool` value **)** - :ref:`bool` **is_sleeping** **(** **)** If ``true``, this body is currently sleeping (not active). .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_property_step: .. rst-class:: classref-property :ref:`float` **step** .. rst-class:: classref-property-setget - :ref:`float` **get_step** **(** **)** The timestep (delta) used for the simulation. .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_property_total_angular_damp: .. rst-class:: classref-property :ref:`float` **total_angular_damp** .. rst-class:: classref-property-setget - :ref:`float` **get_total_angular_damp** **(** **)** The rate at which the body stops rotating, if there are not any other forces moving it. .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_property_total_gravity: .. rst-class:: classref-property :ref:`Vector2` **total_gravity** .. rst-class:: classref-property-setget - :ref:`Vector2` **get_total_gravity** **(** **)** The total gravity vector being currently applied to this body. .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_property_total_linear_damp: .. rst-class:: classref-property :ref:`float` **total_linear_damp** .. rst-class:: classref-property-setget - :ref:`float` **get_total_linear_damp** **(** **)** The rate at which the body stops moving, if there are not any other forces moving it. .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_property_transform: .. rst-class:: classref-property :ref:`Transform2D` **transform** .. rst-class:: classref-property-setget - void **set_transform** **(** :ref:`Transform2D` value **)** - :ref:`Transform2D` **get_transform** **(** **)** The body's transformation matrix. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_PhysicsDirectBodyState2D_method_add_constant_central_force: .. rst-class:: classref-method void **add_constant_central_force** **(** :ref:`Vector2` force=Vector2(0, 0) **)** Adds a constant directional force without affecting rotation that keeps being applied over time until cleared with ``constant_force = Vector2(0, 0)``. This is equivalent to using :ref:`add_constant_force` at the body's center of mass. .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_method_add_constant_force: .. rst-class:: classref-method void **add_constant_force** **(** :ref:`Vector2` force, :ref:`Vector2` position=Vector2(0, 0) **)** Adds a constant positioned force to the body that keeps being applied over time until cleared with ``constant_force = Vector2(0, 0)``. \ ``position`` is the offset from the body origin in global coordinates. .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_method_add_constant_torque: .. rst-class:: classref-method void **add_constant_torque** **(** :ref:`float` torque **)** Adds a constant rotational force without affecting position that keeps being applied over time until cleared with ``constant_torque = 0``. .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_method_apply_central_force: .. rst-class:: classref-method void **apply_central_force** **(** :ref:`Vector2` force=Vector2(0, 0) **)** Applies a directional force without affecting rotation. A force is time dependent and meant to be applied every physics update. This is equivalent to using :ref:`apply_force` at the body's center of mass. .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_method_apply_central_impulse: .. rst-class:: classref-method void **apply_central_impulse** **(** :ref:`Vector2` impulse **)** Applies a directional impulse without affecting rotation. 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 "_force" functions otherwise). This is equivalent to using :ref:`apply_impulse` at the body's center of mass. .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_method_apply_force: .. rst-class:: classref-method void **apply_force** **(** :ref:`Vector2` force, :ref:`Vector2` position=Vector2(0, 0) **)** Applies a positioned force to the body. A force is time dependent and meant to be applied every physics update. \ ``position`` is the offset from the body origin in global coordinates. .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_method_apply_impulse: .. rst-class:: classref-method void **apply_impulse** **(** :ref:`Vector2` impulse, :ref:`Vector2` position=Vector2(0, 0) **)** Applies a positioned impulse to the body. 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 "_force" functions otherwise). \ ``position`` is the offset from the body origin in global coordinates. .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_method_apply_torque: .. rst-class:: classref-method void **apply_torque** **(** :ref:`float` torque **)** Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update. \ **Note:** :ref:`inverse_inertia` is required for this to work. To have :ref:`inverse_inertia`, an active :ref:`CollisionShape2D` must be a child of the node, or you can manually set :ref:`inverse_inertia`. .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_method_apply_torque_impulse: .. rst-class:: classref-method void **apply_torque_impulse** **(** :ref:`float` impulse **)** Applies a rotational impulse to the body without affecting the position. 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 "_force" functions otherwise). \ **Note:** :ref:`inverse_inertia` is required for this to work. To have :ref:`inverse_inertia`, an active :ref:`CollisionShape2D` must be a child of the node, or you can manually set :ref:`inverse_inertia`. .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_method_get_constant_force: .. rst-class:: classref-method :ref:`Vector2` **get_constant_force** **(** **)** |const| Returns the body's total constant positional forces applied during each physics update. See :ref:`add_constant_force` and :ref:`add_constant_central_force`. .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_method_get_constant_torque: .. rst-class:: classref-method :ref:`float` **get_constant_torque** **(** **)** |const| Returns the body's total constant rotational forces applied during each physics update. See :ref:`add_constant_torque`. .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_method_get_contact_collider: .. rst-class:: classref-method :ref:`RID` **get_contact_collider** **(** :ref:`int` contact_idx **)** |const| Returns the collider's :ref:`RID`. .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_method_get_contact_collider_id: .. rst-class:: classref-method :ref:`int` **get_contact_collider_id** **(** :ref:`int` contact_idx **)** |const| Returns the collider's object id. .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_method_get_contact_collider_object: .. rst-class:: classref-method :ref:`Object` **get_contact_collider_object** **(** :ref:`int` contact_idx **)** |const| Returns the collider object. This depends on how it was created (will return a scene node if such was used to create it). .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_method_get_contact_collider_position: .. rst-class:: classref-method :ref:`Vector2` **get_contact_collider_position** **(** :ref:`int` contact_idx **)** |const| Returns the contact position in the collider. .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_method_get_contact_collider_shape: .. rst-class:: classref-method :ref:`int` **get_contact_collider_shape** **(** :ref:`int` contact_idx **)** |const| Returns the collider's shape index. .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_method_get_contact_collider_velocity_at_position: .. rst-class:: classref-method :ref:`Vector2` **get_contact_collider_velocity_at_position** **(** :ref:`int` contact_idx **)** |const| Returns the linear velocity vector at the collider's contact point. .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_method_get_contact_count: .. rst-class:: classref-method :ref:`int` **get_contact_count** **(** **)** |const| Returns the number of contacts this body has with other bodies. \ **Note:** By default, this returns 0 unless bodies are configured to monitor contacts. See :ref:`RigidBody2D.contact_monitor`. .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_method_get_contact_impulse: .. rst-class:: classref-method :ref:`Vector2` **get_contact_impulse** **(** :ref:`int` contact_idx **)** |const| Returns the impulse created by the contact. .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_method_get_contact_local_normal: .. rst-class:: classref-method :ref:`Vector2` **get_contact_local_normal** **(** :ref:`int` contact_idx **)** |const| Returns the local normal at the contact point. .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_method_get_contact_local_position: .. rst-class:: classref-method :ref:`Vector2` **get_contact_local_position** **(** :ref:`int` contact_idx **)** |const| Returns the local position of the contact point. .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_method_get_contact_local_shape: .. rst-class:: classref-method :ref:`int` **get_contact_local_shape** **(** :ref:`int` contact_idx **)** |const| Returns the local shape index of the collision. .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_method_get_space_state: .. rst-class:: classref-method :ref:`PhysicsDirectSpaceState2D` **get_space_state** **(** **)** Returns the current state of the space, useful for queries. .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_method_get_velocity_at_local_position: .. rst-class:: classref-method :ref:`Vector2` **get_velocity_at_local_position** **(** :ref:`Vector2` local_position **)** |const| Returns the body's velocity at the given relative position, including both translation and rotation. .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_method_integrate_forces: .. rst-class:: classref-method void **integrate_forces** **(** **)** Calls the built-in force integration code. .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_method_set_constant_force: .. rst-class:: classref-method void **set_constant_force** **(** :ref:`Vector2` force **)** Sets the body's total constant positional forces applied during each physics update. See :ref:`add_constant_force` and :ref:`add_constant_central_force`. .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_method_set_constant_torque: .. rst-class:: classref-method void **set_constant_torque** **(** :ref:`float` torque **)** Sets the body's total constant rotational forces applied during each physics update. See :ref:`add_constant_torque`. .. |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.)`