Physics2DDirectBodyState

Inherits: Object

Inherited By: Physics2DDirectBodyStateSW

Category: Core

Brief Description

Direct access object to a physics body in the Physics2DServer.

Member Functions

float	get_angular_velocity ( ) 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_pos ( int contact_idx ) const
int	get_contact_collider_shape ( int contact_idx ) const
Variant	get_contact_collider_shape_metadata ( int contact_idx ) const
Vector2	get_contact_collider_velocity_at_pos ( int contact_idx ) const
int	get_contact_count ( ) const
Vector2	get_contact_local_normal ( int contact_idx ) const
Vector2	get_contact_local_pos ( int contact_idx ) const
int	get_contact_local_shape ( int contact_idx ) const
float	get_inverse_inertia ( ) const
float	get_inverse_mass ( ) const
Vector2	get_linear_velocity ( ) const
Physics2DDirectSpaceState	get_space_state ( )
float	get_step ( ) const
float	get_total_angular_damp ( ) const
Vector2	get_total_gravity ( ) const
float	get_total_linear_damp ( ) const
Matrix32	get_transform ( ) const
void	integrate_forces ( )
bool	is_sleeping ( ) const
void	set_angular_velocity ( float velocity )
void	set_linear_velocity ( Vector2 velocity )
void	set_sleep_state ( bool enabled )
void	set_transform ( Matrix32 transform )

Description

Direct access object to a physics body in the Physics2DServer. This object is passed via the direct state callback of rigid/character bodies, and is intended for changing the direct state of that body.

Member Function Description

float get_angular_velocity ( ) const

Return the angular velocity of the body.

RID get_contact_collider ( int contact_idx ) const

Return the RID of the collider.

int get_contact_collider_id ( int contact_idx ) const

Return the object id of the collider.

Object get_contact_collider_object ( int contact_idx ) const

Return 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_pos ( int contact_idx ) const

Return the contact position in the collider.

int get_contact_collider_shape ( int contact_idx ) const

Return the collider shape index.

Variant get_contact_collider_shape_metadata ( int contact_idx ) const

Return the metadata of the collided shape. This metadata is different from Object.get_meta, and is set with Physics2DServer.shape_set_data.

Vector2 get_contact_collider_velocity_at_pos ( int contact_idx ) const

Return the linear velocity vector at contact point of the collider.

int get_contact_count ( ) const

Return the amount of contacts this body has with other bodies. Note that by default this returns 0 unless bodies are configured to log contacts.

Vector2 get_contact_local_normal ( int contact_idx ) const

Return the local normal (of this body) of the contact point.

Vector2 get_contact_local_pos ( int contact_idx ) const

Return the local position (of this body) of the contact point.

int get_contact_local_shape ( int contact_idx ) const

Return the local shape index of the collision.

float get_inverse_inertia ( ) const

Return the inverse of the inertia of the body.

float get_inverse_mass ( ) const

Return the inverse of the mass of the body.

Vector2 get_linear_velocity ( ) const

Return the current linear velocity of the body.

Physics2DDirectSpaceState get_space_state ( )

Return the current state of space, useful for queries.

float get_step ( ) const

Return the timestep (delta) used for the simulation.

float get_total_angular_damp ( ) const

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

Vector2 get_total_gravity ( ) const

Return the total gravity vector being currently applied to this body.

float get_total_linear_damp ( ) const

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

Matrix32 get_transform ( ) const

Return the transform matrix of the body.

void integrate_forces ( )

Call the built-in force integration code.

bool is_sleeping ( ) const

Return true if this body is currently sleeping (not active).

void set_angular_velocity ( float velocity )

Change the angular velocity of the body.

void set_linear_velocity ( Vector2 velocity )

Change the linear velocity of the body.

void set_sleep_state ( bool enabled )

Set the sleeping state of the body, only affects character/rigid bodies.

void set_transform ( Matrix32 transform )

Change the transform matrix of the body.