Skip to content

class_rigidbody2d

Jump to bottom Edit New page
Lukas Sägesser edited this page Jun 22, 2015 · 14 revisions

RigidBody2D

####Inherits: PhysicsBody2D ####Category: Core

Brief Description

Rigid body 2D node.

Member Functions

Signals

  • body_enter ( Object body )
  • body_enter_shape ( int body_id, Object body, int body_shape, int local_shape )
  • body_exit ( Object body )
  • body_exit_shape ( int body_id, Object body, int body_shape, int local_shape )

Numeric Constants

  • MODE_STATIC = 1 - Static mode (does not move, can't be moved).
  • MODE_KINEMATIC = 3
  • MODE_RIGID = 0 - Rigid body, can move and rotate.
  • MODE_CHARACTER = 2 - Character body, can move but not rotate.
  • CCD_MODE_DISABLED = 0
  • CCD_MODE_CAST_RAY = 1
  • CCD_MODE_CAST_SHAPE = 2

Description

Rigid body 2D node. This node is used for placing rigid bodies in the scene. It can contain a number of shapes, and also shift state between regular Rigid Body to Character or even Static. Character mode forbids the node from being rotated. This node can have a custom force integrator function, for writing complex physics motion behavior per node.

As a warning, don't change this node position every frame or very often. Sporadic changes work fine, but physics runs at a different granularity (fixed hz) than usual rendering (process callback) and maybe even in a separate thread, so changing this from a process loop will yield strange behavior.

Member Function Description

_integrate_forces

Override this function to use a custom force integrator. This allows to hook up to the physics processing and alter the simulation state for the object on every frame.

set_mode

  • void set_mode ( int mode )

Set the body mode, fromt he MODE_* enum. This allows to change to a static body or a character body.

get_mode

  • int get_mode ( ) const

Return the current body mode, see [set_mode].

set_mass

  • void set_mass ( float mass )

Set the body mass.

get_mass

  • float get_mass ( ) const

Return the body mass.

set_weight

  • void set_weight ( float weight )

Set the body mass given standard earth-weight (gravity 9.8). Not really useful for 2D since most measuers for this node are in pixels.

get_weight

  • float get_weight ( ) const

Return the body mass given standard earth-weight (gravity 9.8).

set_friction

  • void set_friction ( float friction )

Set the body friction, from 0 (friction less) to 1 (full friction).

get_friction

  • float get_friction ( ) const

Return the body friction.

set_bounce

  • void set_bounce ( float bounce )

Set the body bounciness, from 0 (no bounce) to 1 (bounce).

get_bounce

  • float get_bounce ( ) const

Return the body bouncyness.

set_linear_velocity

  • void set_linear_velocity ( Vector2 linear_velocity )

Set the body linear velocity. Can be used sporadically, but** DONT SET THIS IN EVERY FRAME **, because physics may be running in another thread and definitely runs at a different granularity. Use [_integrate_forces] as your process loop if you want to have precise control of the body state.

get_linear_velocity

  • Vector2 get_linear_velocity ( ) const

Return the body linear velocity. This changes by physics granularity. See [set_linear_velocity].

set_angular_velocity

  • void set_angular_velocity ( float angular_velocity )

Set the body angular velocity. Can be used sporadically, but** DONT SET THIS IN EVERY FRAME **, because physics may be running in another thread and definitely runs at a different granularity. Use [_integrate_forces] as your process loop if you want to have precise control of the body state.

get_angular_velocity

  • float get_angular_velocity ( ) const

Return the body angular velocity. This changes by physics granularity. See [set_angular_velocity].

set_max_contacts_reported

  • void set_max_contacts_reported ( int amount )

Set the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0.

get_max_contacts_reported

  • int get_max_contacts_reported ( ) const

Return the maximum contacts that can be reported. See [set_max_contacts_reported].

set_use_custom_integrator

  • void set_use_custom_integrator ( bool enable )

Set to true if the body shall not do any internal force integration at all (like gravity or air friction). Only the [_integrate_forces] will be able to integrate them if overrided.

is_using_custom_integrator

  • bool is_using_custom_integrator ( )

Return true if the body is not doing any built-in force integration.

set_contact_monitor

  • void set_contact_monitor ( bool enabled )

Enable contact monitoring. (the signals to notify when a body entered/exited collision).

is_contact_monitor_enabled

  • bool is_contact_monitor_enabled ( ) const

Return wether contact monitoring is enabled.

set_axis_velocity

  • void set_axis_velocity ( Vector2 axis_velocity )

Set an axis velocity. The velocity in the given vector axis will be set as the given vector length. (This is useful for jumping behavior).

apply_impulse

Apply a positioned impulse (which will be affected by the body mass and shape).

set_can_sleep

  • void set_can_sleep ( bool able_to_sleep )

Set the body ability to fall asleep when not moving. This saves an enormous amount of processor time when there are plenty of rigid bodies (non static) in a scene.

is_able_to_sleep

  • bool is_able_to_sleep ( ) const

Return true if the body has the ability to fall asleep when not moving. See [set_can_sleep].

Add a custom footer
Add a custom sidebar
Clone this wiki locally