Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Area2D

Eredita: CollisionObject2D < Node2D < CanvasItem < Node < Object

Una regione di spazio 2D che rileva altri CollisionObject2D che entrano o escono da esso.

Descrizione

Area2D è una regione di spazio 2D definita da uno o più nodi figli di tipo CollisionShape2D o CollisionPolygon2D. Rileva quando altri CollisionObject2D entrano o escono da esso, e monitora anche quali oggetti di collisione non l'hanno ancora uscito (cioè quali la sovrappongono).

Questo nodo può anche alterare o sovrascrivere i parametri di fisica locali (gravità, smorzamento) e indirizzare l'audio a bus audio personalizzati.

Nota: Aree e corpi creati con il PhysicsServer2D potrebbero non interagire come previsto con gli Area2D, e potrebbero non emettere segnali o monitorare gli oggetti correttamente.

Tutorial

Proprietà

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

Metodi

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


Segnali

area_entered(area: Area2D) 🔗

Emesso quando l'area ricevuta area entra in questa area. Richiede che monitoring sia impostato a true.


area_exited(area: Area2D) 🔗

Emesso quando l'area ricevuta area esce da questa area. Richiede che monitoring sia impostato a true.


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

Emesso quando un Shape2D dell'area ricevuta area entra in una forma di questa area. Richiede che monitoring sia impostato su true.

local_shape_index e area_shape_index contengono gli indici delle forme di collisione che interagiscono da questa area e dall'altra area, rispettivamente. area_rid contiene il RID dell'altra area. Questi valori possono essere utilizzati con il PhysicsServer2D.

Esempio: Ottieni il nodo CollisionShape2D dall'indice della forma:

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) 🔗

Emesso quando un Shape2D dell'area ricevuta area esce da una forma di questa area. Richiede che monitoring sia impostato a true.

Vedi anche area_shape_entered.


body_entered(body: Node2D) 🔗

Emesso quando il corpo ricevuto body entra in questa area. body può essere un PhysicsBody2D o un TileMap. I TileMap sono rilevati se il loro TileSet ha forme di collisione configurate. Richiede che monitoring sia impostato a true.


body_exited(body: Node2D) 🔗

Emesso quando il corpo ricevuto body esce da questa area. body può essere un PhysicsBody2D o un TileMap. I TileMap sono rilevati se il loro TileSet ha forme di collisione configurate. Richiede che monitoring sia impostato a true.


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

Emesso quando un Shape2D del corpo ricevuto body entra in una forma di questa area. body può essere un PhysicsBody2D o un TileMap. I TileMap sono rilevati se il loro TileSet ha forme di collisione configurate. Richiede che monitoring sia impostato a true.

local_shape_index e body_shape_index contengono gli indici delle forme di collisione che interagiscono da questa area e dal corpo, rispettivamente. body_rid contiene il RID del corpo. Questi valori possono essere utilizzati con il PhysicsServer2D.

Esempio: Ottieni il nodo CollisionShape2D dall'indice della forma:

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) 🔗

Emesso quando un Shape2D del corpo ricevuto body esce da una forma di questa area. body può essere un PhysicsBody2D o un TileMap. I TileMap sono rilevati se il loro TileSet ha forme di collisione configurate. Richiede che monitoring sia impostato a true.

Vedi anche body_shape_entered.


Enumerazioni

enum SpaceOverride: 🔗

SpaceOverride SPACE_OVERRIDE_DISABLED = 0

Quest'area non influisce sulla gravità o lo smorzamento.

SpaceOverride SPACE_OVERRIDE_COMBINE = 1

Questa area aggiunge i suoi valori di gravità e smorzamento a tutto ciò che è stato calcolato finora (nell'ordine di priority).

SpaceOverride SPACE_OVERRIDE_COMBINE_REPLACE = 2

Questa area aggiunge i suoi valori di gravità e smorzamento a tutto ciò che è stato calcolato fino ad ora (nell'ordine di priority), ignorando eventuali aree di priorità più bassa.

SpaceOverride SPACE_OVERRIDE_REPLACE = 3

Questa area sostituisce qualsiasi gravità e smorzamento, anche i valori predefiniti, ignorando eventuali aree di priorità più bassa.

SpaceOverride SPACE_OVERRIDE_REPLACE_COMBINE = 4

Questa area sostituisce qualsiasi gravità e smorzamento calcolato fino ad ora (nell'ordine di priority), ma continua a calcolare il resto delle aree.


Descrizioni delle proprietà

float angular_damp = 1.0 🔗

  • void set_angular_damp(value: float)

  • float get_angular_damp()

La frequenza alla quale gli oggetti smettono di girare in quest'area. Rappresenta la velocità angolare persa ogni secondo.

Vedi ProjectSettings.physics/2d/default_angular_damp per ulteriori dettagli sullo smorzamento.


SpaceOverride angular_damp_space_override = 0 🔗

Modalità di sostituzione per i calcoli di smorzamento angolare all'interno di quest'area.


StringName audio_bus_name = &"Master" 🔗

Il nome del bus audio dell'area.


bool audio_bus_override = false 🔗

  • void set_audio_bus_override(value: bool)

  • bool is_overriding_audio_bus()

Se true, il bus audio dell'area sovrascrive il bus audio predefinito.


float gravity = 980.0 🔗

  • void set_gravity(value: float)

  • float get_gravity()

L'intensità della gravità dell'area (in pixel al secondo al quadrato). Questo valore moltiplica la direzione di gravità. Ciò è utile per alterare la forza di gravità senza alterarne la direzione.


Vector2 gravity_direction = Vector2(0, 1) 🔗

  • void set_gravity_direction(value: Vector2)

  • Vector2 get_gravity_direction()

Il vettore di gravità dell'area (non normalizzato).


bool gravity_point = false 🔗

  • void set_gravity_is_point(value: bool)

  • bool is_gravity_a_point()

Se true, la gravità è calcolata da un punto (impostato tramite gravity_point_center). Vedi anche gravity_space_override.


Vector2 gravity_point_center = Vector2(0, 1) 🔗

  • void set_gravity_point_center(value: Vector2)

  • Vector2 get_gravity_point_center()

Se la gravità è un punto (vedi gravity_point), questo sarà il punto di attrazione.


float gravity_point_unit_distance = 0.0 🔗

  • void set_gravity_point_unit_distance(value: float)

  • float get_gravity_point_unit_distance()

La distanza a cui la forza di gravità è uguale a quella di gravity. Ad esempio, su un pianeta con un raggio di 100 pixel con una gravità di superficie di 4.0 px/s², imposta gravity a 4.0 e la distanza unitaria a 100.0. La gravità decadrà secondo la legge dell'inverso del quadrato, quindi nell'esempio, a 200 pixel dal centro la gravità sarà 1.0 px/s² (due volte la distanza, 1/4 la gravità), a 50 pixel sarà 16.0 px/s² (metà della distanza, 4x la gravità), e così via.

Quanto descritto sopra è vero solo quando la distanza unitaria è un numero positivo. Quando questo è impostato a 0.0, la gravità sarà costante a prescindere dalla distanza.


SpaceOverride gravity_space_override = 0 🔗

Modalità di sostituzione per i calcoli della gravità all'interno di questa area.


float linear_damp = 0.1 🔗

  • void set_linear_damp(value: float)

  • float get_linear_damp()

La frequenza alla quale gli oggetti smettono di muoversi in questa zona. Rappresenta la velocità lineare persa ogni secondo.

Vedi ProjectSettings.physics/2d/default_linear_damp per ulteriori dettagli sullo smorzamento.


SpaceOverride linear_damp_space_override = 0 🔗

Modalità di sostituzione per i calcoli di smorzamento lineare all'interno di questa area.


bool monitorable = true 🔗

  • void set_monitorable(value: bool)

  • bool is_monitorable()

Se true, altre aree in monitoraggio possono rilevare questa area.


bool monitoring = true 🔗

  • void set_monitoring(value: bool)

  • bool is_monitoring()

Se true, l'area rileva corpi o aree che entrano ed escono da essa.


int priority = 0 🔗

  • void set_priority(value: int)

  • int get_priority()

La priorità dell'area. Le aree con priorità più alte sono elaborate prima. La fisica del World2D è sempre elaborata per ultima, dopo tutte le aree.


Descrizioni dei metodi

Array[Area2D] get_overlapping_areas() const 🔗

Restituisce una lista di Area2D intersecanti. Il CollisionObject2D.collision_layer delll'area in sovrapposizione deve essere parte di CollisionObject2D.collision_mask per essere rilevato.

Per motivi di prestazioni (le collisioni sono tutte elaborate allo stesso tempo) questa lista viene modificata una sola volta durante la fase di fisica, non subito dopo che gli oggetti sono spostati. Considera utilizzare i segnali invece.


Array[Node2D] get_overlapping_bodies() const 🔗

Restituisce una lista di PhysicsBody2D e TileMap intersecanti. Il CollisionObject2D.collision_layer del corpo in sovrapposizione deve essere parte di CollisionObject2D.collision_mask per essere rilevato.

Per motivi di prestazioni (le collisioni sono tutte elaborate allo stesso tempo) questa lista viene modificata una sola volta durante la fase di fisica, non subito dopo che gli oggetti sono spostati. Considera utilizzare i segnali invece.


bool has_overlapping_areas() const 🔗

Restituisce true se sta intersecano qualsiasi Area2D, altrimenti restituisce false. Il CollisionObject2D.collision_layer dell'area in sovrapposizione deve essere parte di CollisionObject2D.collision_mask per essere rilevato.

Per motivi di prestazioni (le collisioni sono tutte elaborate allo stesso tempo) questa lista viene modificata una sola volta durante la fase di fisica, non subito dopo che gli oggetti sono spostati. Considera utilizzare i segnali invece.


bool has_overlapping_bodies() const 🔗

Restituisce true se sta intersecano qualsiasi PhysicsBody2D o TileMap, altrimenti restituisce false. Il CollisionObject2D.collision_layer del corpo in sovrapposizione deve essere parte di CollisionObject2D.collision_mask per essere rilevato.

Per motivi di prestazioni (le collisioni sono tutte elaborate allo stesso tempo) questa lista viene modificata una sola volta durante la fase di fisica, non subito dopo che gli oggetti sono spostati. Considera utilizzare i segnali invece.


bool overlaps_area(area: Node) const 🔗

Restituisce true se l'Area2D indicata interseca o si sovrappone a questa Area2D, altrimenti false.

Nota: Il risultato di questo test non è immediato dopo aver spostato gli oggetti. Per motivi di prestazioni, la lista delle sovrapposizioni è aggiornato una sola volta per frame e prima della fase fisica. Considera utilizzare i segnali invece.


bool overlaps_body(body: Node) const 🔗

Restituisce true se il corpo di fisica indicato interseca o si sovrappone a questa Area2D, altrimenti false.

Nota: Il risultato di questo test non è immediato dopo aver spostato gli oggetti. Per motivi di prestazioni, la lista delle sovrapposizioni è aggiornato una sola volta per frame e prima della fase fisica. Considera utilizzare i segnali invece.

L'argomento body può essere un'istanza di PhysicsBody2D o TileMap. Sebbene i TileMap non siano corpi di fisica, essi registrano i loro tasselli aventi forme di collisione come un corpo di fisica virtuale.