Area2D

Hereda: CollisionObject2D < Node2D < CanvasItem < Node < Object

Una región de espacio 2D que detecta otros CollisionObject2Ds entrando o saliendo de él.

Descripción

Area2D is a region of 2D space defined by one or multiple CollisionShape2D or CollisionPolygon2D child nodes. It detects when other CollisionObject2Ds enter or exit it, and it also keeps track of which collision objects haven't exited it yet (i.e. which one are overlapping it).

This node can also locally alter or override physics parameters (gravity, damping) and route audio to custom audio buses.

Note: Areas and bodies created with PhysicsServer2D might not interact as expected with Area2Ds, and might not emit signals or track objects correctly.

Tutoriales

Propiedades

float

angular_damp

1.0

SpaceOverride

angular_damp_space_override

0

StringName

audio_bus_name

&"Master"

bool

audio_bus_override

false

float

gravity

980.0

Vector2

gravity_direction

Vector2(0, 1)

bool

gravity_point

false

Vector2

gravity_point_center

Vector2(0, 1)

float

gravity_point_unit_distance

0.0

SpaceOverride

gravity_space_override

0

float

linear_damp

0.1

SpaceOverride

linear_damp_space_override

0

bool

monitorable

true

bool

monitoring

true

int

priority

0

Métodos

Array[Area2D]

get_overlapping_areas() const

Array[Node2D]

get_overlapping_bodies() const

bool

has_overlapping_areas() const

bool

has_overlapping_bodies() const

bool

overlaps_area(area: Node) const

bool

overlaps_body(body: Node) const

Señales

area_entered(area: Area2D) 🔗

Emitida cuando el area recibido entra en esta área. Requiere que monitoring se configure como true.

area_exited(area: Area2D) 🔗

Emitida cuando el area recibido sale de esta área. Requiere que monitoring se configure como true.

area_shape_entered(area_rid: RID, area: Area2D, area_shape_index: int, local_shape_index: int) 🔗

Emitted when a Shape2D of the received area enters a shape of this area. Requires monitoring to be set to true.

local_shape_index and area_shape_index contain indices of the interacting shapes from this area and the other area, respectively. area_rid contains the RID of the other area. These values can be used with the PhysicsServer2D.

Example: Get the CollisionShape2D node from the shape index:

var other_shape_owner = area.shape_find_owner(area_shape_index)
var other_shape_node = area.shape_owner_get_owner(other_shape_owner)

var local_shape_owner = shape_find_owner(local_shape_index)
var local_shape_node = shape_owner_get_owner(local_shape_owner)

area_shape_exited(area_rid: RID, area: Area2D, area_shape_index: int, local_shape_index: int) 🔗

Emitted when a Shape2D of the received area exits a shape of this area. Requires monitoring to be set to true.

See also area_shape_entered.

body_entered(body: Node2D) 🔗

Emitido cuando el body recibido entra a este área. body puede ser un PhysicsBody2D o un TileMap. Los TileMaps son detectados si su TileSet tiene formas de colisión configuradas. Requiere que monitoring se establezca a true.

body_exited(body: Node2D) 🔗

Emitido cuando el body recibido sale de este área. body puede ser un PhysicsBody2D o un TileMap. Los TileMaps son detectados si su TileSet tiene formas de colisión configuradas. Requiere que monitoring se establezca a true.

body_shape_entered(body_rid: RID, body: Node2D, body_shape_index: int, local_shape_index: int) 🔗

Emitted when a Shape2D of the received body enters a shape of this area. body can be a PhysicsBody2D or a TileMap. TileMaps are detected if their TileSet has collision shapes configured. Requires monitoring to be set to true.

local_shape_index and body_shape_index contain indices of the interacting shapes from this area and the interacting body, respectively. body_rid contains the RID of the body. These values can be used with the PhysicsServer2D.

Example: Get the CollisionShape2D node from the shape index:

var body_shape_owner = body.shape_find_owner(body_shape_index)
var body_shape_node = body.shape_owner_get_owner(body_shape_owner)

var local_shape_owner = shape_find_owner(local_shape_index)
var local_shape_node = shape_owner_get_owner(local_shape_owner)

body_shape_exited(body_rid: RID, body: Node2D, body_shape_index: int, local_shape_index: int) 🔗

Emitido cuando un Shape2D del body recibido sale de una forma de este área. body puede ser un PhysicsBody2D o un TileMap. Los TileMaps son detectados si su TileSet tiene formas de colisión configuradas. Requiere que monitoring se establezca a true.

Véase también body_shape_entered.

Enumeraciones

enum SpaceOverride: 🔗

SpaceOverride SPACE_OVERRIDE_DISABLED = 0

Esta zona no afecta a la gravedad/amortiguación.

SpaceOverride SPACE_OVERRIDE_COMBINE = 1

Esta área añade sus valores de gravedad/amortiguación a lo que se ha calculado hasta ahora (en el orden priority).

SpaceOverride SPACE_OVERRIDE_COMBINE_REPLACE = 2

Esta área añade sus valores de gravedad/amortiguación a lo que se ha calculado hasta ahora (en el orden priority), ignorando cualquier área de menor prioridad.

SpaceOverride SPACE_OVERRIDE_REPLACE = 3

Esta área reemplaza cualquier gravedad/amortiguación, incluso las predeterminadas, ignorando cualquier área de menor prioridad.

SpaceOverride SPACE_OVERRIDE_REPLACE_COMBINE = 4

Esta área reemplaza cualquier gravedad/amortiguación calculada hasta ahora (en orden de priority), pero sigue calculando el resto de las áreas.

Descripciones de Propiedades

float angular_damp = 1.0 🔗

  • void set_angular_damp(value: float)

  • float get_angular_damp()

The rate at which objects stop spinning in this area. Represents the angular velocity lost per second.

See ProjectSettings.physics/2d/default_angular_damp for more details about damping.

SpaceOverride angular_damp_space_override = 0 🔗

Override mode for angular damping calculations within this area.

StringName audio_bus_name = &"Master" 🔗

El nombre del bus de audio de la zona.

bool audio_bus_override = false 🔗

  • void set_audio_bus_override(value: bool)

  • bool is_overriding_audio_bus()

Si es true, el área del bus de audio sobrescribe el bus de audio por defecto.

float gravity = 980.0 🔗

  • void set_gravity(value: float)

  • float get_gravity()

The area's gravity intensity (in pixels per second squared). This value multiplies the gravity direction. This is useful to alter the force of gravity without altering its direction.

Vector2 gravity_direction = Vector2(0, 1) 🔗

  • void set_gravity_direction(value: Vector2)

  • Vector2 get_gravity_direction()

El vector de gravedad del área (no normalizado).

bool gravity_point = false 🔗

  • void set_gravity_is_point(value: bool)

  • bool is_gravity_a_point()

If true, gravity is calculated from a point (set via gravity_point_center). See also gravity_space_override.

Vector2 gravity_point_center = Vector2(0, 1) 🔗

  • void set_gravity_point_center(value: Vector2)

  • Vector2 get_gravity_point_center()

If gravity is a point (see gravity_point), this will be the point of attraction.

float gravity_point_unit_distance = 0.0 🔗

  • void set_gravity_point_unit_distance(value: float)

  • float get_gravity_point_unit_distance()

La distancia a la que la fuerza de gravedad es igual a gravity. Por ejemplo, en un planeta de 100 píxeles de radio con una gravedad superficial de 4.0 px/s², establezca la gravity a 4.0 y la unidad de distancia a 100.0. La gravedad disminuirá según la ley del cuadrado inverso, entonces en este ejemplo, a 200 pixeles del centro la gravedad será 1.0 px/s² (doble de distancia, 1/4 más gravedad), a 50 píxeles será 16.0 px/s² (mitad de distancia, 4 veces más gravedad), y así sucesivamente.

Lo anterior es cierto solo cuando la unidad de distancia es un número positivo. Cuando está establecido a 0.0, la gravedad será constante independientemente de la distancia.

SpaceOverride gravity_space_override = 0 🔗

Modo de sobrescritura para los cálculos de gravedad dentro de esta área.

float linear_damp = 0.1 🔗

  • void set_linear_damp(value: float)

  • float get_linear_damp()

The rate at which objects stop moving in this area. Represents the linear velocity lost per second.

See ProjectSettings.physics/2d/default_linear_damp for more details about damping.

SpaceOverride linear_damp_space_override = 0 🔗

Override mode for linear damping calculations within this area.

bool monitorable = true 🔗

  • void set_monitorable(value: bool)

  • bool is_monitorable()

Si es true, otras áreas de monitoreo pueden detectar esta área.

bool monitoring = true 🔗

  • void set_monitoring(value: bool)

  • bool is_monitoring()

Si es true, el área detecta cuerpos o áreas que entran y salen de ella.

int priority = 0 🔗

  • void set_priority(value: int)

  • int get_priority()

The area's priority. Higher priority areas are processed first. The World2D's physics is always processed last, after all areas.

Descripciones de Métodos

Array[Area2D] get_overlapping_areas() const 🔗

Returns a list of intersecting Area2Ds. The overlapping area's CollisionObject2D.collision_layer must be part of this area's CollisionObject2D.collision_mask in order to be detected.

For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.

Array[Node2D] get_overlapping_bodies() const 🔗

Devuelve una lista de PhysicsBody2D y TileMap que se intersecan. La capa de colisión del cuerpo superpuesto (CollisionObject2D.collision_layer) debe formar parte de la máscara de colisión de esta área (CollisionObject2D.collision_mask) para poder ser detectado.

Por razones de rendimiento (todas las colisiones se procesan al mismo tiempo), esta lista se modifica una vez durante el paso de física, no inmediatamente después de mover los objetos. Considera utilizar señales en su lugar.

bool has_overlapping_areas() const 🔗

Returns true if intersecting any Area2Ds, otherwise returns false. The overlapping area's CollisionObject2D.collision_layer must be part of this area's CollisionObject2D.collision_mask in order to be detected.

For performance reasons (collisions are all processed at the same time) the list of overlapping areas is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.

bool has_overlapping_bodies() const 🔗

Returns true if intersecting any PhysicsBody2Ds or TileMaps, otherwise returns false. The overlapping body's CollisionObject2D.collision_layer must be part of this area's CollisionObject2D.collision_mask in order to be detected.

For performance reasons (collisions are all processed at the same time) the list of overlapping bodies is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.

bool overlaps_area(area: Node) const 🔗

Returns true if the given Area2D intersects or overlaps this Area2D, false otherwise.

Note: The result of this test is not immediate after moving objects. For performance, the list of overlaps is updated once per frame and before the physics step. Consider using signals instead.

bool overlaps_body(body: Node) const 🔗

Returns true if the given physics body intersects or overlaps this Area2D, false otherwise.

Note: The result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead.

The body argument can either be a PhysicsBody2D or a TileMap instance. While TileMaps are not physics bodies themselves, they register their tiles with collision shapes as a virtual physics body.