RigidBody2D
Hereda: PhysicsBody2D < CollisionObject2D < Node2D < CanvasItem < Node < Object
Heredado por: PhysicalBone2D
Un cuerpo físico 2D que se mueve mediante una simulación física.
Descripción
RigidBody2D implements full 2D physics. It cannot be controlled directly, instead, you must apply forces to it (gravity, impulses, etc.), and the physics simulation will calculate the resulting movement, rotation, react to collisions, and affect other physics bodies in its path.
The body's behavior can be adjusted via lock_rotation, freeze, and freeze_mode. By changing various properties of the object, such as mass, you can control how the physics simulation acts on it.
A rigid body will always maintain its shape and size, even when forces are applied to it. It is useful for objects that can be interacted with in an environment, such as a tree that can be knocked over or a stack of crates that can be pushed around.
If you need to directly affect the body, prefer _integrate_forces() as it allows you to directly access the physics state.
If you need to override the default physics behavior, you can write a custom force integration function. See custom_integrator.
Note: Changing the 2D transform or linear_velocity of a RigidBody2D very often may lead to some unpredictable behaviors. This also happens when a RigidBody2D is the descendant of a constantly moving node, like another RigidBody2D, as that will cause its global transform to be set whenever its ancestor moves.
Tutoriales
Propiedades
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
Métodos
void |
_integrate_forces(state: PhysicsDirectBodyState2D) virtual |
void |
add_constant_central_force(force: Vector2) |
void |
add_constant_force(force: Vector2, position: Vector2 = Vector2(0, 0)) |
void |
add_constant_torque(torque: float) |
void |
apply_central_force(force: Vector2) |
void |
apply_central_impulse(impulse: Vector2 = Vector2(0, 0)) |
void |
apply_force(force: Vector2, position: Vector2 = Vector2(0, 0)) |
void |
apply_impulse(impulse: Vector2, position: Vector2 = Vector2(0, 0)) |
void |
apply_torque(torque: float) |
void |
apply_torque_impulse(torque: float) |
get_colliding_bodies() const |
|
get_contact_count() const |
|
void |
set_axis_velocity(axis_velocity: Vector2) |
Señales
Emitted when a collision with another PhysicsBody2D or TileMap occurs. Requires contact_monitor to be set to true and max_contacts_reported to be set high enough to detect all the collisions. TileMaps are detected if the TileSet has Collision Shape2Ds.
body the Node, if it exists in the tree, of the other PhysicsBody2D or TileMap.
Emitted when the collision with another PhysicsBody2D or TileMap ends. Requires contact_monitor to be set to true and max_contacts_reported to be set high enough to detect all the collisions. TileMaps are detected if the TileSet has Collision Shape2Ds.
body the Node, if it exists in the tree, of the other PhysicsBody2D or TileMap.
body_shape_entered(body_rid: RID, body: Node, body_shape_index: int, local_shape_index: int) 🔗
Emitted when one of this RigidBody2D's Shape2Ds collides with another PhysicsBody2D or TileMap's Shape2Ds. Requires contact_monitor to be set to true and max_contacts_reported to be set high enough to detect all the collisions. TileMaps are detected if the TileSet has Collision Shape2Ds.
body_rid the RID of the other PhysicsBody2D or TileSet's CollisionObject2D used by the PhysicsServer2D.
body the Node, if it exists in the tree, of the other PhysicsBody2D or TileMap.
body_shape_index the index of the Shape2D of the other PhysicsBody2D or TileMap used by the PhysicsServer2D. Get the CollisionShape2D node with body.shape_owner_get_owner(body.shape_find_owner(body_shape_index)).
local_shape_index the index of the Shape2D of this RigidBody2D used by the PhysicsServer2D. Get the CollisionShape2D node with self.shape_owner_get_owner(self.shape_find_owner(local_shape_index)).
body_shape_exited(body_rid: RID, body: Node, body_shape_index: int, local_shape_index: int) 🔗
Emitted when the collision between one of this RigidBody2D's Shape2Ds and another PhysicsBody2D or TileMap's Shape2Ds ends. Requires contact_monitor to be set to true and max_contacts_reported to be set high enough to detect all the collisions. TileMaps are detected if the TileSet has Collision Shape2Ds.
body_rid the RID of the other PhysicsBody2D or TileSet's CollisionObject2D used by the PhysicsServer2D.
body the Node, if it exists in the tree, of the other PhysicsBody2D or TileMap.
body_shape_index the index of the Shape2D of the other PhysicsBody2D or TileMap used by the PhysicsServer2D. Get the CollisionShape2D node with body.shape_owner_get_owner(body.shape_find_owner(body_shape_index)).
local_shape_index the index of the Shape2D of this RigidBody2D used by the PhysicsServer2D. Get the CollisionShape2D node with self.shape_owner_get_owner(self.shape_find_owner(local_shape_index)).
sleeping_state_changed() 🔗
Emitida cuando el motor físico cambia el estado de sueño del cuerpo.
Nota: Cambiar el valor sleeping no activará esta señal. Sólo se emite si el motor de física cambia el estado de sueño o si se utiliza emit_signal("sleeping_state_changed").
Enumeraciones
enum FreezeMode: 🔗
FreezeMode FREEZE_MODE_STATIC = 0
Modo de congelación estática del cuerpo (predeterminado). El cuerpo no se ve afectado por la gravedad ni las fuerzas. Solo se puede mover mediante código de usuario y no colisiona con otros cuerpos en su trayectoria.
FreezeMode FREEZE_MODE_KINEMATIC = 1
Modo de congelación cinemática de cuerpos. Similar a FREEZE_MODE_STATIC, pero colisiona con otros cuerpos en su trayectoria al moverse. Útil para cuerpos congelados que necesitan ser animados.
enum CenterOfMassMode: 🔗
CenterOfMassMode CENTER_OF_MASS_MODE_AUTO = 0
En este modo, el centro de masa del cuerpo se calcula automáticamente a partir de sus formas. Esto supone que el origen de las formas también es su centro de masa.
CenterOfMassMode CENTER_OF_MASS_MODE_CUSTOM = 1
En este modo, el centro de masa del cuerpo se establece a través de center_of_mass. El valor predeterminado es la posición de origen del cuerpo.
enum DampMode: 🔗
DampMode DAMP_MODE_COMBINE = 0
En este modo, el valor de amortiguación del cuerpo se añade a cualquier valor establecido en las áreas o al valor predeterminado.
DampMode DAMP_MODE_REPLACE = 1
En este modo, el valor de amortiguación del cuerpo reemplaza cualquier valor establecido en las áreas o al valor predeterminado.
enum CCDMode: 🔗
CCDMode CCD_MODE_DISABLED = 0
Detección de colisión continua desactivada. Es la forma más rápida de detectar colisiones corporales, pero puede pasar por alto pequeños objetos de movimiento rápido.
CCDMode CCD_MODE_CAST_RAY = 1
Detección de colisión continua activada mediante raycasting. Esto es más rápido que el "shapecasting" pero menos preciso.
CCDMode CCD_MODE_CAST_SHAPE = 2
Detección de colisión continua habilitada mediante el uso de "shapecasting". Este es el método CCD más lento y más preciso.
Descripciones de Propiedades
Damps the body's rotation. By default, the body will use the ProjectSettings.physics/2d/default_angular_damp setting or any value override set by an Area2D the body is in. Depending on angular_damp_mode, you can set angular_damp to be added to or to replace the body's damping value.
See ProjectSettings.physics/2d/default_angular_damp for more details about damping.
DampMode angular_damp_mode = 0 🔗
Define cómo se aplica angular_damp.
float angular_velocity = 0.0 🔗
La velocidad de rotación del cuerpo en radianes por segundo.
If true, the body can enter sleep mode when there is no movement. See sleeping.
Vector2 center_of_mass = Vector2(0, 0) 🔗
The body's custom center of mass, relative to the body's origin position, when center_of_mass_mode is set to CENTER_OF_MASS_MODE_CUSTOM. This is the balanced point of the body, where applied forces only cause linear acceleration. Applying forces outside of the center of mass causes angular acceleration.
When center_of_mass_mode is set to CENTER_OF_MASS_MODE_AUTO (default value), the center of mass is automatically determined, but this does not update the value of center_of_mass.
CenterOfMassMode center_of_mass_mode = 0 🔗
void set_center_of_mass_mode(value: CenterOfMassMode)
CenterOfMassMode get_center_of_mass_mode()
Define la forma en que se establece el centro de masa del cuerpo.
Vector2 constant_force = Vector2(0, 0) 🔗
The body's total constant positional forces applied during each physics update.
See add_constant_force() and add_constant_central_force().
The body's total constant rotational forces applied during each physics update.
bool contact_monitor = false 🔗
If true, the RigidBody2D will emit signals when it collides with another body.
Note: By default the maximum contacts reported is set to 0, meaning nothing will be recorded, see max_contacts_reported.
void set_continuous_collision_detection_mode(value: CCDMode)
CCDMode get_continuous_collision_detection_mode()
Continuous collision detection mode.
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.
bool custom_integrator = false 🔗
If true, the standard force integration (like gravity or damping) will be disabled for this body. Other than collision response, the body will only move as determined by the _integrate_forces() method, if that virtual method is overridden.
Setting this property will call the method PhysicsServer2D.body_set_omit_force_integration() internally.
If true, the body is frozen. Gravity and forces are not applied anymore.
See freeze_mode to set the body's behavior when frozen.
For a body that is always frozen, use StaticBody2D or AnimatableBody2D instead.
FreezeMode freeze_mode = 0 🔗
void set_freeze_mode(value: FreezeMode)
FreezeMode get_freeze_mode()
The body's freeze mode. Can be used to set the body's behavior when freeze is enabled.
For a body that is always frozen, use StaticBody2D or AnimatableBody2D instead.
Multiplies the gravity applied to the body. The body's gravity is calculated from the ProjectSettings.physics/2d/default_gravity project setting and/or any additional gravity vector applied by Area2Ds.
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 property allows you to set a custom value.
If set to 0, inertia is automatically computed (default value).
Note: This value does not change when inertia is automatically computed. Use PhysicsServer2D to get the computed inertia.
@onready var ball = $Ball
func get_ball_inertia():
return 1.0 / PhysicsServer2D.body_get_direct_state(ball.get_rid()).inverse_inertia
private RigidBody2D _ball;
public override void _Ready()
{
_ball = GetNode<RigidBody2D>("Ball");
}
private float GetBallInertia()
{
return 1.0f / PhysicsServer2D.BodyGetDirectState(_ball.GetRid()).InverseInertia;
}
Damps the body's movement. By default, the body will use the ProjectSettings.physics/2d/default_linear_damp setting or any value override set by an Area2D the body is in. Depending on linear_damp_mode, you can set linear_damp to be added to or to replace the body's damping value.
See ProjectSettings.physics/2d/default_linear_damp for more details about damping.
DampMode linear_damp_mode = 0 🔗
Defines how linear_damp is applied.
Vector2 linear_velocity = Vector2(0, 0) 🔗
The body's linear velocity in pixels per second. Can be used sporadically, but don't set this every frame, because physics may run in another thread and runs at a different granularity. Use _integrate_forces() as your process loop for precise control of the body state.
If true, the body cannot rotate. Gravity and forces only apply linear movement.
La masa del cuerpo.
int max_contacts_reported = 0 🔗
The maximum number of contacts that will be recorded. Requires a value greater than 0 and contact_monitor to be set to true to start to register contacts. Use get_contact_count() to retrieve the count or get_colliding_bodies() to retrieve bodies that have been collided with.
Note: The number of contacts is different from the number of collisions. Collisions between parallel edges will result in two contacts (one at each end), and collisions between parallel faces will result in four contacts (one at each corner).
PhysicsMaterial physics_material_override 🔗
void set_physics_material_override(value: PhysicsMaterial)
PhysicsMaterial get_physics_material_override()
El material de la física se sobrescribe para el cuerpo.
Si se asigna un material a esta propiedad, se utilizará en lugar de cualquier otro material de física, como por ejemplo uno heredado.
If true, the body will not move and will not calculate forces until woken up by another body through, for example, a collision, or by using the apply_impulse() or apply_force() methods.
Descripciones de Métodos
void _integrate_forces(state: PhysicsDirectBodyState2D) virtual 🔗
Called during physics processing, allowing you to read and safely modify the simulation state for the object. By default, it is called before the standard force integration, but the custom_integrator property allows you to disable the standard force integration and do fully custom force integration for a body.
void add_constant_central_force(force: Vector2) 🔗
Añade una fuerza direccional constante sin afectar la rotación que se sigue aplicando con el tiempo hasta que se borra con constant_force = Vector2(0, 0).
Esto es equivalente a usar add_constant_force() en el centro de masa del cuerpo.
void add_constant_force(force: Vector2, position: Vector2 = Vector2(0, 0)) 🔗
Añade una fuerza constante posicionada al cuerpo que se sigue aplicando con el tiempo hasta que se borra con constant_force = Vector2(0, 0).
position es el desplazamiento desde el origen del cuerpo en coordenadas globales.
void add_constant_torque(torque: float) 🔗
Añade una fuerza rotacional constante sin afectar la posición que se sigue aplicando con el tiempo hasta que se borra con constant_torque = 0.
void apply_central_force(force: Vector2) 🔗
Aplica una fuerza direccional sin afectar la rotación. Una fuerza depende del tiempo y está pensada para ser aplicada en cada actualización de la física.
Esto es equivalente a usar apply_force() en el centro de masa del cuerpo.
void apply_central_impulse(impulse: Vector2 = Vector2(0, 0)) 🔗
Aplica un impulso direccional sin afectar la rotación.
¡Un impulso es independiente del tiempo! Aplicar un impulso en cada fotograma resultaría en una fuerza dependiente de la velocidad de fotogramas. Por esta razón, solo debe usarse al simular impactos únicos (usa las funciones "_force" en su lugar).
Esto es equivalente a usar apply_impulse() en el centro de masa del cuerpo.
void apply_force(force: Vector2, position: Vector2 = Vector2(0, 0)) 🔗
Aplica una fuerza posicionada al cuerpo. Una fuerza depende del tiempo y está pensada para ser aplicada en cada actualización de la física.
position es el desplazamiento desde el origen del cuerpo en coordenadas globales.
void apply_impulse(impulse: Vector2, position: Vector2 = Vector2(0, 0)) 🔗
Aplica un impulso posicionado al cuerpo.
¡Un impulso es independiente del tiempo! Aplicar un impulso en cada fotograma resultaría en una fuerza dependiente de la velocidad de fotogramas. Por esta razón, solo debe usarse al simular impactos únicos (usa las funciones "_force" en su lugar).
position es el desplazamiento desde el origen del cuerpo en coordenadas globales.
void apply_torque(torque: float) 🔗
Aplica una fuerza de rotación sin afectar la posición. Una fuerza depende del tiempo y está destinada a aplicarse en cada actualización de la física.
Nota: Se requiere inertia para que esto funcione. Para tener inertia, un CollisionShape2D activo debe ser hijo del nodo, o puede establecer manualmente inertia.
void apply_torque_impulse(torque: float) 🔗
Aplica un impulso de rotación al cuerpo sin afectar la posición.
¡Un impulso es independiente del tiempo! Aplicar un impulso cada fotograma resultaría en una fuerza dependiente de la velocidad de fotogramas. Por esta razón, solo debe usarse al simular impactos únicos (usa las funciones "_force" de lo contrario).
Nota: Se requiere inertia para que esto funcione. Para tener inertia, un CollisionShape2D activo debe ser hijo del nodo, o puede establecer manualmente inertia.
Array[Node2D] get_colliding_bodies() const 🔗
Returns a list of the bodies colliding with this one. Requires contact_monitor to be set to true and max_contacts_reported to be set high enough to detect all the collisions.
Note: 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.
int get_contact_count() const 🔗
Returns the number of contacts this body has with other bodies. By default, this returns 0 unless bodies are configured to monitor contacts (see contact_monitor).
Note: To retrieve the colliding bodies, use get_colliding_bodies().
void set_axis_velocity(axis_velocity: Vector2) 🔗
Asigna la velocidad del cuerpo en el eje dado. La velocidad en el eje del vector será asignada como la longitud del vector. Esto es útil para comportamiento pertinente al salto.