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, Kinematic, Character or 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.
Called during physics processing, allowing you to read and safely modify the simulation state for the object. By default it works in addition to the usual physics behavior, but [method set_use_custom_integrator] allows you to disable the default behavior and do fully custom force integration for a body.
</description>
</method>
<methodname="add_force">
<returntype="void">
</return>
<argumentindex="0"name="offset"type="Vector2">
</argument>
<argumentindex="1"name="force"type="Vector2">
</argument>
<description>
Add a positioned force to the applied force and torque. As with [method apply_impulse], both the force and the offset from the body origin are in global coordinates.
</description>
</method>
<methodname="apply_impulse">
<returntype="void">
</return>
<argumentindex="0"name="offset"type="Vector2">
</argument>
<argumentindex="1"name="impulse"type="Vector2">
</argument>
<description>
Apply a positioned impulse (which will be affected by the body mass and shape). This is the equivalent of hitting a billiard ball with a cue: a force that is applied once, and only once. Both the impulse and the offset from the body origin are in global coordinates.
Return a list of the bodies colliding with this one. By default, number of max contacts reported is at 0 , see [method set_max_contacts_reported] to increase it. You must also enable contact monitor, see [method set_contact_monitor]
Return the body's moment of inertia. This is usually automatically computed from the mass and the shapes. Note that this doesn't seem to work in a [code]_ready[/code] function: it apparently has not been auto-computed yet.
Set the body angular velocity. Can be used sporadically, but [b]DON'T SET THIS IN EVERY FRAME[/b], because physics may be running in another thread and definitely runs at a different granularity. Use [method _integrate_forces] as your process loop if you want to have precise control of the body state.
</description>
</method>
<methodname="set_applied_force">
<returntype="void">
</return>
<argumentindex="0"name="force"type="Vector2">
</argument>
<description>
Set the applied force vector. This is the equivalent of pushing a box over the ground: the force applied is applied constantly.
</description>
</method>
<methodname="set_applied_torque">
<returntype="void">
</return>
<argumentindex="0"name="torque"type="float">
</argument>
<description>
Set a constant torque which will be applied to this body.
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.
Sleeping bodies are not affected by forces until a collision or an [method apply_impulse] / [method set_applied_force] wakes them up. Until then, they behave like a static body.
</description>
</method>
<methodname="set_contact_monitor">
<returntype="void">
</return>
<argumentindex="0"name="enabled"type="bool">
</argument>
<description>
Enable contact monitoring. This allows the body to emit signals when it collides with another.
Set the continuous collision detection mode from the enum CCD_MODE_*.
Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. The first is more precise, and misses less impacts by small, fast-moving objects. The second is faster to compute, but can miss small, fast-moving objects.
</description>
</method>
<methodname="set_friction">
<returntype="void">
</return>
<argumentindex="0"name="friction"type="float">
</argument>
<description>
Set the body friction, from 0 (frictionless) to 1 (full friction).
Set the gravity factor. This factor multiplies gravity intensity just for this body.
</description>
</method>
<methodname="set_inertia">
<returntype="void">
</return>
<argumentindex="0"name="inertia"type="float">
</argument>
<description>
Set the body's moment of inertia. This is like mass, but for rotation: it determines how much torque it takes to rotate the body. The moment of inertia is usually computed automatically from the mass and the shapes, but this function allows you to set a custom value. Set 0 (or negative) inertia to return to automatically computing it.
</description>
</method>
<methodname="set_linear_damp">
<returntype="void">
</return>
<argumentindex="0"name="linear_damp"type="float">
</argument>
<description>
Set the linear damp for this body. If this value is different from -1, any linear damp derived from the world or areas will be overridden.
Set the body linear velocity. Can be used sporadically, but [b]DON'T SET THIS IN EVERY FRAME[/b], because physics may be running in another thread and definitely runs at a different granularity. Use [method _integrate_forces] as your process loop if you want to have precise control of the body state.
</description>
</method>
<methodname="set_mass">
<returntype="void">
</return>
<argumentindex="0"name="mass"type="float">
</argument>
<description>
Set the body mass.
</description>
</method>
<methodname="set_max_contacts_reported">
<returntype="void">
</return>
<argumentindex="0"name="amount"type="int">
</argument>
<description>
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.
Set the body mode, from the MODE_* enum. This allows to change to a static body or a character body.
</description>
</method>
<methodname="set_sleeping">
<returntype="void">
</return>
<argumentindex="0"name="sleeping"type="bool">
</argument>
<description>
Set whether a body is sleeping or not. Sleeping bodies are not affected by forces until a collision or an [method apply_impulse] / [method set_applied_force] wakes them up. Until then, they behave like a static body.
</description>
</method>
<methodname="set_use_custom_integrator">
<returntype="void">
</return>
<argumentindex="0"name="enable"type="bool">
</argument>
<description>
Pass true to disable the internal force integration (like gravity or air friction) for this body. Other than collision response, the body will only move as determined by the [method _integrate_forces] function, if defined.
</description>
</method>
<methodname="set_weight">
<returntype="void">
</return>
<argumentindex="0"name="weight"type="float">
</argument>
<description>
Set the body weight given standard earth-weight (gravity 9.8). Not really useful for 2D since most measures for this node are in pixels.
Return whether the body would collide, if it tried to move in the given vector. This method allows two extra parameters: A margin, which increases slightly the size of the shapes involved in the collision detection, and an object of type [Physics2DTestMotionResult], which will store additional information about the collision (should there be one).
Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work.
</description>
</signal>
<signalname="body_exited">
<argumentindex="0"name="body"type="Object">
</argument>
<description>
Emitted when a body exits contact with this one. Contact monitor and contacts reported must be enabled for this to work.
</description>
</signal>
<signalname="body_shape_entered">
<argumentindex="0"name="body_id"type="int">
</argument>
<argumentindex="1"name="body"type="Object">
</argument>
<argumentindex="2"name="body_shape"type="int">
</argument>
<argumentindex="3"name="local_shape"type="int">
</argument>
<description>
Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work.
This signal not only receives the body that collided with this one, but also its [RID] (body_id), the shape index from the colliding body (body_shape), and the shape index from this body (local_shape) the other body collided with.
</description>
</signal>
<signalname="body_shape_exited">
<argumentindex="0"name="body_id"type="int">
</argument>
<argumentindex="1"name="body"type="Object">
</argument>
<argumentindex="2"name="body_shape"type="int">
</argument>
<argumentindex="3"name="local_shape"type="int">
</argument>
<description>
Emitted when a body shape exits contact with this one. Contact monitor and contacts reported must be enabled for this to work.
This signal not only receives the body that stopped colliding with this one, but also its [RID] (body_id), the shape index from the colliding body (body_shape), and the shape index from this body (local_shape) the other body stopped colliding with.
</description>
</signal>
<signalname="sleeping_state_changed">
<description>
Emitted when the body changes its sleeping state. Either by sleeping or waking up.
</description>
</signal>
</signals>
<constants>
<constantname="MODE_STATIC"value="1">
Static mode. The body behaves like a [StaticBody2D], and can only move by user code.
</constant>
<constantname="MODE_KINEMATIC"value="3">
Kinematic body. The body behaves like a [KinematicBody2D], and can only move by user code.
</constant>
<constantname="MODE_RIGID"value="0">
Rigid body. This is the "natural" state of a rigid body. It is affected by forces, and can move, rotate, and be affected by user code.
</constant>
<constantname="MODE_CHARACTER"value="2">
Character body. This behaves like a rigid body, but can not rotate.
</constant>
<constantname="CCD_MODE_DISABLED"value="0">
Disables continuous collision detection. This is the fastest way to detect body collisions, but can miss small, fast-moving objects.
</constant>
<constantname="CCD_MODE_CAST_RAY"value="1">
Enables continuous collision detection by raycasting. It is faster than shapecasting, but less precise.
</constant>
<constantname="CCD_MODE_CAST_SHAPE"value="2">
Enables continuous collision detection by shapecasting. It is the slowest CCD method, and the most precise.
