d516aab8fa
Also enhance RigidBody docs as per https://github.com/godotengine/godot-docs/pull/1018 and fix the version tag in all files (not really stable yet, but it makes no sense to hardcode rc3 at this stage).
212 lines
13 KiB
XML
212 lines
13 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="RigidBody2D" inherits="PhysicsBody2D" category="Core" version="3.0-stable">
|
|
<brief_description>
|
|
A body that is controlled by the 2D physics engine.
|
|
</brief_description>
|
|
<description>
|
|
This node implements simulated 2D physics. You do not control a RigidBody2D directly. Instead you apply forces to it (gravity, impulses, etc.) and the physics simulation calculates the resulting movement based on its mass, friction, and other physical properties.
|
|
A RigidBody2D has 4 behavior modes (see [member mode]):
|
|
- [b]Rigid[/b]: The body behaves as a physical object. It collides with other bodies and responds to forces applied to it. This is the default mode.
|
|
- [b]Static[/b]: The body behaves like a [StaticBody2D] and does not move.
|
|
- [b]Character[/b]: Similar to [code]Rigid[/code] mode, but the body can not rotate.
|
|
- [b]Kinematic[/b]: The body behaves like a [KinematicBody2D], and must be moved by code.
|
|
[b]Note:[/b] You should not change a RigidBody2D's [code]position[/code] or [code]linear_velocity[/code] every frame or even very often. If you need to directly affect the body's state, use [method _integrate_forces], which allows you to directly access the physics state.
|
|
If you need to override the default physics behavior, you can write a custom force integration. See [member custom_integrator].
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<demos>
|
|
</demos>
|
|
<methods>
|
|
<method name="_integrate_forces" qualifiers="virtual">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="state" type="Physics2DDirectBodyState">
|
|
</argument>
|
|
<description>
|
|
Allows you to read and safely modify the simulation state for the object. Use this instead of [Node._physics_process] if you need to directly change the body's [code]position[/code] or other physics properties. By default it works in addition to the usual physics behavior, but [member custom_integrator] allows you to disable the default behavior and write custom force integration for a body.
|
|
</description>
|
|
</method>
|
|
<method name="add_force">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="offset" type="Vector2">
|
|
</argument>
|
|
<argument index="1" name="force" type="Vector2">
|
|
</argument>
|
|
<description>
|
|
Adds a positioned force to the body. Both the force and the offset from the body origin are in global coordinates.
|
|
</description>
|
|
</method>
|
|
<method name="apply_impulse">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="offset" type="Vector2">
|
|
</argument>
|
|
<argument index="1" name="impulse" type="Vector2">
|
|
</argument>
|
|
<description>
|
|
Applies a positioned impulse to the body (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 instantaneously. Both the impulse and the offset from the body origin are in global coordinates.
|
|
</description>
|
|
</method>
|
|
<method name="get_colliding_bodies" qualifiers="const">
|
|
<return type="Array">
|
|
</return>
|
|
<description>
|
|
Returns a list of the bodies colliding with this one. Use [member contacts_reported] to set the maximum number reported. You must also set [member contact_monitor] to [code]true[/code]. Note that the result of this test is not immediate after moving objects. For performance, list of collisions is updated once per frame and before the physics step. Consider using signals instead.
|
|
</description>
|
|
</method>
|
|
<method name="set_axis_velocity">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="axis_velocity" type="Vector2">
|
|
</argument>
|
|
<description>
|
|
Sets the body's velocity on the given axis. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior.
|
|
</description>
|
|
</method>
|
|
<method name="test_motion">
|
|
<return type="bool">
|
|
</return>
|
|
<argument index="0" name="motion" type="Vector2">
|
|
</argument>
|
|
<argument index="1" name="margin" type="float" default="0.08">
|
|
</argument>
|
|
<argument index="2" name="result" type="Physics2DTestMotionResult" default="null">
|
|
</argument>
|
|
<description>
|
|
Returns [code]true[/code] if a collision would result from moving in the given vector. [code]margin[/code] increases the size of the shapes involved in the collision detection, and [code]result[/code] is an object of type [Physics2DTestMotionResult], which contains additional information about the collision (should there be one).
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<members>
|
|
<member name="angular_damp" type="float" setter="set_angular_damp" getter="get_angular_damp">
|
|
Damps the body's [member angular_velocity]. If [code]-1[/code] the body will use the "Default Angular Damp" in "Project > Project Settings > Physics > 2d". Default value: [code]-1[/code].
|
|
</member>
|
|
<member name="angular_velocity" type="float" setter="set_angular_velocity" getter="get_angular_velocity">
|
|
The body's rotational velocity.
|
|
</member>
|
|
<member name="applied_force" type="Vector2" setter="set_applied_force" getter="get_applied_force">
|
|
The body's total applied force.
|
|
</member>
|
|
<member name="applied_torque" type="float" setter="set_applied_torque" getter="get_applied_torque">
|
|
The body's total applied torque.
|
|
</member>
|
|
<member name="bounce" type="float" setter="set_bounce" getter="get_bounce">
|
|
The body's bounciness. Default value: [code]0[/code].
|
|
</member>
|
|
<member name="can_sleep" type="bool" setter="set_can_sleep" getter="is_able_to_sleep">
|
|
If [code]true[/code] the body will not calculate forces and will act as a static body if there is no movement. The body will wake up when other forces are applied via collisions or by using [method apply_impulse] or [method add_force]. Default value: [code]true[/code].
|
|
</member>
|
|
<member name="contact_monitor" type="bool" setter="set_contact_monitor" getter="is_contact_monitor_enabled">
|
|
If [code]true[/code] the body will emit signals when it collides with another RigidBody2D. See also [member contacts_reported]. Default value: [code]false[/code].
|
|
</member>
|
|
<member name="contacts_reported" type="int" setter="set_max_contacts_reported" getter="get_max_contacts_reported">
|
|
The maximum number of contacts to report. Default value: [code]0[/code].
|
|
</member>
|
|
<member name="continuous_cd" type="int" setter="set_continuous_collision_detection_mode" getter="get_continuous_collision_detection_mode" enum="RigidBody2D.CCDMode">
|
|
Continuous collision detection mode. Default value: [code]CCD_MODE_DISABLED[/code].
|
|
Continuous collision detection tries to predict where a moving body will collide instead of moving it and correcting its movement after collision. Continuous collision detection is slower, but more precise and misses fewer collisions with small, fast-moving objects. Raycasting and shapecasting methods are available. See [code]CCD_MODE_[/code] constants for details.
|
|
</member>
|
|
<member name="custom_integrator" type="bool" setter="set_use_custom_integrator" getter="is_using_custom_integrator">
|
|
If [code]true[/code] internal force integration is disabled for this body. Aside from collision response, the body will only move as determined by the [method _integrate_forces] function.
|
|
</member>
|
|
<member name="friction" type="float" setter="set_friction" getter="get_friction">
|
|
The body's friction. Values range from [code]0[/code] (frictionless) to [code]1[/code] (maximum friction). Default value: [code]1[/code].
|
|
</member>
|
|
<member name="gravity_scale" type="float" setter="set_gravity_scale" getter="get_gravity_scale">
|
|
Multiplies the gravity applied to the body. The body's gravity is calculated from the "Default Gravity" value in "Project > Project Settings > Physics > 2d" and/or any additional gravity vector applied by [Area2D]s. Default value: [code]1[/code].
|
|
</member>
|
|
<member name="inertia" type="float" setter="set_inertia" getter="get_inertia">
|
|
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.
|
|
</member>
|
|
<member name="linear_damp" type="float" setter="set_linear_damp" getter="get_linear_damp">
|
|
Damps the body's [member linear_velocity]. If [code]-1[/code] the body will use the "Default Linear Damp" in "Project > Project Settings > Physics > 2d". Default value: [code]-1[/code].
|
|
</member>
|
|
<member name="linear_velocity" type="Vector2" setter="set_linear_velocity" getter="get_linear_velocity">
|
|
The body's linear velocity.
|
|
</member>
|
|
<member name="mass" type="float" setter="set_mass" getter="get_mass">
|
|
The body's mass. Default value: [code]1[/code].
|
|
</member>
|
|
<member name="mode" type="int" setter="set_mode" getter="get_mode" enum="RigidBody2D.Mode">
|
|
The body's mode. See [code]MODE_*[/code] constants. Default value: [code]MODE_RIGID[/code].
|
|
</member>
|
|
<member name="sleeping" type="bool" setter="set_sleeping" getter="is_sleeping">
|
|
If [code]true[/code] the body is sleeping and will not calculate forces until woken up by a collision or by using [method apply_impulse] or [method add_force].
|
|
</member>
|
|
<member name="weight" type="float" setter="set_weight" getter="get_weight">
|
|
The body's weight based on its mass and the "Default Gravity" value in "Project > Project Settings > Physics > 2d".
|
|
</member>
|
|
</members>
|
|
<signals>
|
|
<signal name="body_entered">
|
|
<argument index="0" name="body" type="Object">
|
|
</argument>
|
|
<description>
|
|
Emitted when a body enters into contact with this one. [member contact_monitor] must be [code]true[/code] and [member contacts_reported] greater than [code]0[/code].
|
|
</description>
|
|
</signal>
|
|
<signal name="body_exited">
|
|
<argument index="0" name="body" type="Object">
|
|
</argument>
|
|
<description>
|
|
Emitted when a body exits contact with this one. [member contact_monitor] must be [code]true[/code] and [member contacts_reported] greater than [code]0[/code].
|
|
</description>
|
|
</signal>
|
|
<signal name="body_shape_entered">
|
|
<argument index="0" name="body_id" type="int">
|
|
</argument>
|
|
<argument index="1" name="body" type="Object">
|
|
</argument>
|
|
<argument index="2" name="body_shape" type="int">
|
|
</argument>
|
|
<argument index="3" name="local_shape" type="int">
|
|
</argument>
|
|
<description>
|
|
Emitted when a body enters into contact with this one. Reports colliding shape information. See [CollisionObject2D] for shape index information. [member contact_monitor] must be [code]true[/code] and [member contacts_reported] greater than [code]0[/code].
|
|
</description>
|
|
</signal>
|
|
<signal name="body_shape_exited">
|
|
<argument index="0" name="body_id" type="int">
|
|
</argument>
|
|
<argument index="1" name="body" type="Object">
|
|
</argument>
|
|
<argument index="2" name="body_shape" type="int">
|
|
</argument>
|
|
<argument index="3" name="local_shape" type="int">
|
|
</argument>
|
|
<description>
|
|
Emitted when a body shape exits contact with this one. Reports colliding shape information. See [CollisionObject2D] for shape index information. [member contact_monitor] must be [code]true[/code] and [member contacts_reported] greater than [code]0[/code].
|
|
</description>
|
|
</signal>
|
|
<signal name="sleeping_state_changed">
|
|
<description>
|
|
Emitted when [member sleeping] changes.
|
|
</description>
|
|
</signal>
|
|
</signals>
|
|
<constants>
|
|
<constant name="MODE_RIGID" value="0" enum="Mode">
|
|
Rigid mode. The body behaves as a physical object. It collides with other bodies and responds to forces applied to it. This is the default mode.
|
|
</constant>
|
|
<constant name="MODE_STATIC" value="1" enum="Mode">
|
|
Static mode. The body behaves like a [StaticBody2D] and does not move.
|
|
</constant>
|
|
<constant name="MODE_CHARACTER" value="2" enum="Mode">
|
|
Character mode. Similar to [code]MODE_RIGID[/code], but the body can not rotate.
|
|
</constant>
|
|
<constant name="MODE_KINEMATIC" value="3" enum="Mode">
|
|
Kinematic mode. The body behaves like a [KinematicBody2D], and must be moved by code.
|
|
</constant>
|
|
<constant name="CCD_MODE_DISABLED" value="0" enum="CCDMode">
|
|
Continuous collision detection disabled. This is the fastest way to detect body collisions, but can miss small, fast-moving objects.
|
|
</constant>
|
|
<constant name="CCD_MODE_CAST_RAY" value="1" enum="CCDMode">
|
|
Continuous collision detection enabled using raycasting. This is faster than shapecasting but less precise.
|
|
</constant>
|
|
<constant name="CCD_MODE_CAST_SHAPE" value="2" enum="CCDMode">
|
|
Continuous collision detection enabled using shapecasting. This is the slowest CCD method and the most precise.
|
|
</constant>
|
|
</constants>
|
|
</class>
|