.. 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/docs/gdscript/doc/classes/PhysicsDirectBodyState2D.xml. .. _class_PhysicsDirectBodyState2D: PhysicsDirectBodyState2D ======================== **Inherits:** :ref:`Object` **Inherited By:** :ref:`PhysicsDirectBodyState2DExtension` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. 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:`Vector2` | :ref:`get_contact_local_velocity_at_position` **(** :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** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. 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** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. 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** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. 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** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. 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** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. 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** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. 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** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. 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** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. 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** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. 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** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. 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** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. 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** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. 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) **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. 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) **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_method_add_constant_torque: .. rst-class:: classref-method void **add_constant_torque** **(** :ref:`float` torque **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. 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) **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_method_apply_central_impulse: .. rst-class:: classref-method void **apply_central_impulse** **(** :ref:`Vector2` impulse **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. 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) **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. 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) **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_method_apply_torque: .. rst-class:: classref-method void **apply_torque** **(** :ref:`float` torque **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_method_apply_torque_impulse: .. rst-class:: classref-method void **apply_torque_impulse** **(** :ref:`float` impulse **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_method_get_constant_force: .. rst-class:: classref-method :ref:`Vector2` **get_constant_force** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_method_get_constant_torque: .. rst-class:: classref-method :ref:`float` **get_constant_torque** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. 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| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. 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| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. 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| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. 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| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. 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| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. 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| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_method_get_contact_count: .. rst-class:: classref-method :ref:`int` **get_contact_count** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. 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| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. 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| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. 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| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. 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| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_method_get_contact_local_velocity_at_position: .. rst-class:: classref-method :ref:`Vector2` **get_contact_local_velocity_at_position** **(** :ref:`int` contact_idx **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_method_get_space_state: .. rst-class:: classref-method :ref:`PhysicsDirectSpaceState2D` **get_space_state** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. 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| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_method_integrate_forces: .. rst-class:: classref-method void **integrate_forces** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_method_set_constant_force: .. rst-class:: classref-method void **set_constant_force** **(** :ref:`Vector2` force **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_PhysicsDirectBodyState2D_method_set_constant_torque: .. rst-class:: classref-method void **set_constant_torque** **(** :ref:`float` torque **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. |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.)`