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.

Area3D

Eredita: CollisionObject3D < Node3D < Node < Object

Una regione di spazio 3D che rileva altri CollisionObject3D che entrano o escono da esso.

Descrizione

Area3D è una regione di spazio 3D definita da uno o più nodi figli di tipo CollisionShape3D o CollisionPolygon3D. 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 PhysicsServer3D potrebbero non interagire come previsto con gli Area3D, e potrebbero non emettere segnali o monitorare gli oggetti correttamente.

Attenzione: Utilizzando un ConcavePolygonShape3D all'interno di un CollisionShape3D figlio di questo nodo (creato ad esempio utilizzando l'opzione Create Trimesh Collision Sibling nel menu di Mesh che appare selezionando un nodo MeshInstance3D) Se ciò non è desiderato, deve essere diviso in più ConvexPolygonShape3D o forme primitive come BoxShape3D, o in alcuni casi può essere sostituito da un CollisionPolygon3D.

Tutorial

Proprietà

float

angular_damp

0.1

SpaceOverride

angular_damp_space_override

0

StringName

audio_bus_name

&"Master"

bool

audio_bus_override

false

float

gravity

9.8

Vector3

gravity_direction

Vector3(0, -1, 0)

bool

gravity_point

false

Vector3

gravity_point_center

Vector3(0, -1, 0)

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

float

reverb_bus_amount

0.0

bool

reverb_bus_enabled

false

StringName

reverb_bus_name

&"Master"

float

reverb_bus_uniformity

0.0

float

wind_attenuation_factor

0.0

float

wind_force_magnitude

0.0

NodePath

wind_source_path

NodePath("")

Metodi

Array[Area3D]

get_overlapping_areas() const

Array[Node3D]

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

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


area_exited(area: Area3D) 🔗

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


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

Emesso quando un Shape3D 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 PhysicsServer3D.

Esempio: Ottieni il nodo CollisionShape3D 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: Area3D, area_shape_index: int, local_shape_index: int) 🔗

Emesso quando un Shape3D 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: Node3D) 🔗

Emitted when the received body enters this area. body can be a PhysicsBody3D, SoftBody3D or GridMap. GridMaps are detected if their MeshLibrary has collision shapes configured. Requires monitoring to be set to true.

Note: Godot Physics does not support reporting overlaps with SoftBody3D, so will not emit this signal in such cases.


body_exited(body: Node3D) 🔗

Emitted when the received body exits this area. body can be a PhysicsBody3D, SoftBody3D or GridMap. GridMaps are detected if their MeshLibrary has collision shapes configured. Requires monitoring to be set to true.

Note: Godot Physics does not support reporting overlaps with SoftBody3D, so will not emit this signal in such cases.


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

Emitted when a Shape3D of the received body enters a shape of this area. body can be a PhysicsBody3D, SoftBody3D or GridMap. GridMaps are detected if their MeshLibrary 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 PhysicsServer3D.

Note: Godot Physics does not support reporting overlaps with SoftBody3D, so will not emit this signal in such cases.

Example: Get the CollisionShape3D 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: Node3D, body_shape_index: int, local_shape_index: int) 🔗

Emitted when a Shape3D of the received body exits a shape of this area. body can be a PhysicsBody3D, SoftBody3D or GridMap. GridMaps are detected if their MeshLibrary has collision shapes configured. Requires monitoring to be set to true.

See also body_shape_entered.

Note: Godot Physics does not support reporting overlaps with SoftBody3D, so will not emit this signal in such cases.


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 = 0.1 🔗

  • 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/3d/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 = 9.8 🔗

  • void set_gravity(value: float)

  • float get_gravity()

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


Vector3 gravity_direction = Vector3(0, -1, 0) 🔗

  • void set_gravity_direction(value: Vector3)

  • Vector3 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.


Vector3 gravity_point_center = Vector3(0, -1, 0) 🔗

  • void set_gravity_point_center(value: Vector3)

  • Vector3 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 metri con una gravità di superficie di 4.0 m/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 metri dal centro la gravità sarà 1.0 m/s² (due volte la distanza, 1/4 la gravità), a 50 metri sarà 16.0 m/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/3d/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 World3D è sempre elaborata per ultima, dopo tutte le aree.


float reverb_bus_amount = 0.0 🔗

  • void set_reverb_amount(value: float)

  • float get_reverb_amount()

Il grado in cui questa area applica il riverbero al suo audio associato. L'intervallo va da 0 a 1 con una precisione di 0.1.


bool reverb_bus_enabled = false 🔗

  • void set_use_reverb_bus(value: bool)

  • bool is_using_reverb_bus()

Se true, l'area applica il riverbero al suo audio associato.


StringName reverb_bus_name = &"Master" 🔗

Il nome del bus di riverbero da usare per l'audio associato di questa area.


float reverb_bus_uniformity = 0.0 🔗

  • void set_reverb_uniformity(value: float)

  • float get_reverb_uniformity()

Il grado in cui il riverbero di questa area è un effetto uniforme. L'intervallo va da 0 a 1 con una precisione di 0.1.


float wind_attenuation_factor = 0.0 🔗

  • void set_wind_attenuation_factor(value: float)

  • float get_wind_attenuation_factor()

La frequenza esponenziale alla quale la forza del vento diminuisce con la distanza dalla sua origine.

Nota: Questa forza del vento si applica solo ai nodi SoftBody3D. Altri corpi di fisica non sono attualmente influenzati dal vento.


float wind_force_magnitude = 0.0 🔗

  • void set_wind_force_magnitude(value: float)

  • float get_wind_force_magnitude()

Il magnitudo della forza del vento specifica all'area.

Nota: Questa forza del vento si applica solo ai nodi SoftBody3D. Altri corpi di fisica non sono attualmente influenzati dal vento.


NodePath wind_source_path = NodePath("") 🔗

Il Node3D che viene utilizzato per specificare la direzione e l'origine di una forza del vento specifica all'area. La direzione è opposta all'asse z della trasformazione locale del Node3D, e la sua origine è l'origine della trasformazione locale del Node3D.

Nota: Questa forza del vento si applica solo ai nodi SoftBody3D. Altri corpi di fisica non sono attualmente influenzati dal vento.


Descrizioni dei metodi

Array[Area3D] get_overlapping_areas() const 🔗

Restituisce una lista di Area3D intersecanti. Il CollisionObject3D.collision_layer delll'area in sovrapposizione deve essere parte di CollisionObject3D.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[Node3D] get_overlapping_bodies() const 🔗

Returns a list of intersecting PhysicsBody3Ds, SoftBody3Ds, and GridMaps. The overlapping body's CollisionObject3D.collision_layer must be part of this area's CollisionObject3D.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.

Note: Godot Physics does not support reporting overlaps with SoftBody3D, so will not return any such bodies.


bool has_overlapping_areas() const 🔗

Restituisce true se sta intersecano qualsiasi Area3D, altrimenti restituisce false. Il CollisionObject3D.collision_layer dell'area in sovrapposizione deve essere parte di CollisionObject3D.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 🔗

Returns true if intersecting any PhysicsBody3Ds, SoftBody3Ds, or GridMaps, otherwise returns false. The overlapping body's CollisionObject3D.collision_layer must be part of this area's CollisionObject3D.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.

Note: Godot Physics does not support reporting overlaps with SoftBody3D, so will not consider such bodies.


bool overlaps_area(area: Node) const 🔗

Restituisce true se l'Area3D indicata interseca o si sovrappone a questa Area3D, 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 🔗

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

body argument can either be a PhysicsBody3D, SoftBody3D, or a GridMap instance. While GridMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body.

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.

Note: Godot Physics does not support reporting overlaps with SoftBody3D, so will return false in such cases.