Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

PhysicsDirectBodyState2D

Inherits: Object

Inherited By: PhysicsDirectBodyState2DExtension

Provides direct access to a physics body in the PhysicsServer2D.

Description

Provides direct access to a physics body in the PhysicsServer2D, allowing safe changes to physics properties. This object is passed via the direct state callback of RigidBody2D, and is intended for changing the direct state of that body. See RigidBody2D._integrate_forces.

Tutorials

Properties

float

angular_velocity

Vector2

center_of_mass

Vector2

center_of_mass_local

float

inverse_inertia

float

inverse_mass

Vector2

linear_velocity

bool

sleeping

float

step

float

total_angular_damp

Vector2

total_gravity

float

total_linear_damp

Transform2D

transform

Methods

void

add_constant_central_force ( Vector2 force=Vector2(0, 0) )

void

add_constant_force ( Vector2 force, Vector2 position=Vector2(0, 0) )

void

add_constant_torque ( float torque )

void

apply_central_force ( Vector2 force=Vector2(0, 0) )

void

apply_central_impulse ( Vector2 impulse )

void

apply_force ( Vector2 force, Vector2 position=Vector2(0, 0) )

void

apply_impulse ( Vector2 impulse, Vector2 position=Vector2(0, 0) )

void

apply_torque ( float torque )

void

apply_torque_impulse ( float impulse )

Vector2

get_constant_force ( ) const

float

get_constant_torque ( ) const

RID

get_contact_collider ( int contact_idx ) const

int

get_contact_collider_id ( int contact_idx ) const

Object

get_contact_collider_object ( int contact_idx ) const

Vector2

get_contact_collider_position ( int contact_idx ) const

int

get_contact_collider_shape ( int contact_idx ) const

Vector2

get_contact_collider_velocity_at_position ( int contact_idx ) const

int

get_contact_count ( ) const

Vector2

get_contact_impulse ( int contact_idx ) const

Vector2

get_contact_local_normal ( int contact_idx ) const

Vector2

get_contact_local_position ( int contact_idx ) const

int

get_contact_local_shape ( int contact_idx ) const

Vector2

get_contact_local_velocity_at_position ( int contact_idx ) const

PhysicsDirectSpaceState2D

get_space_state ( )

Vector2

get_velocity_at_local_position ( Vector2 local_position ) const

void

integrate_forces ( )

void

set_constant_force ( Vector2 force )

void

set_constant_torque ( float torque )

Property Descriptions

float angular_velocity

  • void set_angular_velocity ( float value )

  • float get_angular_velocity ( )

The body's rotational velocity in radians per second.

Vector2 center_of_mass

The body's center of mass position relative to the body's center in the global coordinate system.

Vector2 center_of_mass_local

  • Vector2 get_center_of_mass_local ( )

The body's center of mass position in the body's local coordinate system.

float inverse_inertia

  • float get_inverse_inertia ( )

The inverse of the inertia of the body.

float inverse_mass

  • float get_inverse_mass ( )

The inverse of the mass of the body.

Vector2 linear_velocity

  • void set_linear_velocity ( Vector2 value )

  • Vector2 get_linear_velocity ( )

The body's linear velocity in pixels per second.

bool sleeping

  • void set_sleep_state ( bool value )

  • bool is_sleeping ( )

If true, this body is currently sleeping (not active).

float step

The timestep (delta) used for the simulation.

float total_angular_damp

  • float get_total_angular_damp ( )

The rate at which the body stops rotating, if there are not any other forces moving it.

Vector2 total_gravity

The total gravity vector being currently applied to this body.

float total_linear_damp

  • float get_total_linear_damp ( )

The rate at which the body stops moving, if there are not any other forces moving it.

Transform2D transform

The body's transformation matrix.

Method Descriptions

void add_constant_central_force ( 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 add_constant_force at the body's center of mass.

void add_constant_force ( Vector2 force, 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.

void add_constant_torque ( float torque )

Adds a constant rotational force without affecting position that keeps being applied over time until cleared with constant_torque = 0.

void apply_central_force ( 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 apply_force at the body's center of mass.

void apply_central_impulse (