PhysicsDirectBodyState2D

Inherits: Object

Inherited By: PhysicsDirectBodyState2DExtension

Direct access object 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 rigid bodies, 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_local_normal ( int contact_idx ) const

Vector2

get_contact_local_position ( int contact_idx ) const

int

get_contact_local_shape ( 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

Setter

set_angular_velocity(value)

Getter

get_angular_velocity()

The body's rotational velocity in radians per second.


Getter

get_center_of_mass()

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


Getter

get_center_of_mass_local()

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


Getter

get_inverse_inertia()

The inverse of the inertia of the body.


Getter

get_inverse_mass()

The inverse of the mass of the body.


Setter

set_linear_velocity(value)

Getter

get_linear_velocity()

The body's linear velocity in pixels per second.


Setter

set_sleep_state(value)

Getter

is_sleeping()

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


Getter

get_step()

The timestep (delta) used for the simulation.


  • float total_angular_damp

Getter

get_total_angular_damp()

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


Getter

get_total_gravity()

The total gravity vector being currently applied to this body.


  • float total_linear_damp

Getter

get_total_linear_damp()

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


Setter

set_transform(value)

Getter

get_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 ( 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 apply_impulse at the body's center of mass.


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.


  • void apply_impulse ( Vector2 impulse, 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.


  • void apply_torque ( float torque )

Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update.


  • void apply_torque_impulse ( 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).


  • Vector2 get_constant_force ( ) const

Returns the body's total constant positional forces applied during each physics update.

See add_constant_force and add_constant_central_force.


  • float get_constant_torque ( ) const

Returns the body's total constant rotational forces applied during each physics update.

See add_constant_torque.


  • RID get_contact_collider ( int contact_idx ) const

Returns the collider's RID.


  • int get_contact_collider_id ( int contact_idx ) const

Returns the collider's object id.


  • Object get_contact_collider_object ( 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).


  • Vector2 get_contact_collider_position ( int contact_idx ) const

Returns the contact position in the collider.


  • int get_contact_collider_shape ( int contact_idx ) const

Returns the collider's shape index.


  • Vector2 get_contact_collider_velocity_at_position ( int contact_idx ) const

Returns the linear velocity vector at the collider's contact point.


  • 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 RigidBody2D.contact_monitor.


  • Vector2 get_contact_local_normal ( int contact_idx ) const

Returns the local normal at the contact point.


  • Vector2 get_contact_local_position ( int contact_idx ) const

Returns the local position of the contact point.


  • int get_contact_local_shape ( int contact_idx ) const

Returns the local shape index of the collision.


Returns the current state of the space, useful for queries.


  • Vector2 get_velocity_at_local_position ( Vector2 local_position ) const

Returns the body's velocity at the given relative position, including both translation and rotation.


  • void integrate_forces ( )

Calls the built-in force integration code.


  • void set_constant_force ( Vector2 force )

Sets the body's total constant positional forces applied during each physics update.

See add_constant_force and add_constant_central_force.


  • void set_constant_torque ( float torque )

Sets the body's total constant rotational forces applied during each physics update.

See add_constant_torque.