godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
ca680690246a36caf37a1afb4d6fa4305b4084df
godot-docs/classes/class_area2d.rst
Rémi Verschelde 03d40ff29e Sync classref with master branch (4.0 changes)
2020-03-13 17:17:50 +01:00

476 lines
22 KiB
ReStructuredText
Raw Blame History

:github_url: hide
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the Area2D.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_Area2D:
Area2D
======
**Inherits:** :ref:`CollisionObject2D<class_CollisionObject2D>` **<** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
2D area for detection and 2D physics influence.
Description
-----------
2D area that detects :ref:`CollisionObject2D<class_CollisionObject2D>` nodes overlapping, entering, or exiting. Can also alter or override local physics parameters (gravity, damping).
Tutorials
---------
- :doc:`../tutorials/physics/using_area_2d`
Properties
----------
+-------------------------------------------------+-----------------------------------------------------------------------------+---------------------+
| :ref:`float<class_float>` | :ref:`angular_damp<class_Area2D_property_angular_damp>` | ``1.0`` |
+-------------------------------------------------+-----------------------------------------------------------------------------+---------------------+
| :ref:`StringName<class_StringName>` | :ref:`audio_bus_name<class_Area2D_property_audio_bus_name>` | ``@"Master"`` |
+-------------------------------------------------+-----------------------------------------------------------------------------+---------------------+
| :ref:`bool<class_bool>` | :ref:`audio_bus_override<class_Area2D_property_audio_bus_override>` | ``false`` |
+-------------------------------------------------+-----------------------------------------------------------------------------+---------------------+
| :ref:`int<class_int>` | :ref:`collision_layer<class_Area2D_property_collision_layer>` | ``1`` |
+-------------------------------------------------+-----------------------------------------------------------------------------+---------------------+
| :ref:`int<class_int>` | :ref:`collision_mask<class_Area2D_property_collision_mask>` | ``1`` |
+-------------------------------------------------+-----------------------------------------------------------------------------+---------------------+
| :ref:`float<class_float>` | :ref:`gravity<class_Area2D_property_gravity>` | ``98.0`` |
+-------------------------------------------------+-----------------------------------------------------------------------------+---------------------+
| :ref:`float<class_float>` | :ref:`gravity_distance_scale<class_Area2D_property_gravity_distance_scale>` | ``0.0`` |
+-------------------------------------------------+-----------------------------------------------------------------------------+---------------------+
| :ref:`bool<class_bool>` | :ref:`gravity_point<class_Area2D_property_gravity_point>` | ``false`` |
+-------------------------------------------------+-----------------------------------------------------------------------------+---------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`gravity_vec<class_Area2D_property_gravity_vec>` | ``Vector2( 0, 1 )`` |
+-------------------------------------------------+-----------------------------------------------------------------------------+---------------------+
| :ref:`float<class_float>` | :ref:`linear_damp<class_Area2D_property_linear_damp>` | ``0.1`` |
+-------------------------------------------------+-----------------------------------------------------------------------------+---------------------+
| :ref:`bool<class_bool>` | :ref:`monitorable<class_Area2D_property_monitorable>` | ``true`` |
+-------------------------------------------------+-----------------------------------------------------------------------------+---------------------+
| :ref:`bool<class_bool>` | :ref:`monitoring<class_Area2D_property_monitoring>` | ``true`` |
+-------------------------------------------------+-----------------------------------------------------------------------------+---------------------+
| :ref:`float<class_float>` | :ref:`priority<class_Area2D_property_priority>` | ``0.0`` |
+-------------------------------------------------+-----------------------------------------------------------------------------+---------------------+
| :ref:`SpaceOverride<enum_Area2D_SpaceOverride>` | :ref:`space_override<class_Area2D_property_space_override>` | ``0`` |
+-------------------------------------------------+-----------------------------------------------------------------------------+---------------------+
Methods
-------
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_collision_layer_bit<class_Area2D_method_get_collision_layer_bit>` **(** :ref:`int<class_int>` bit **)** const |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_collision_mask_bit<class_Area2D_method_get_collision_mask_bit>` **(** :ref:`int<class_int>` bit **)** const |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>` | :ref:`get_overlapping_areas<class_Area2D_method_get_overlapping_areas>` **(** **)** const |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>` | :ref:`get_overlapping_bodies<class_Area2D_method_get_overlapping_bodies>` **(** **)** const |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`overlaps_area<class_Area2D_method_overlaps_area>` **(** :ref:`Node<class_Node>` area **)** const |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`overlaps_body<class_Area2D_method_overlaps_body>` **(** :ref:`Node<class_Node>` body **)** const |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_collision_layer_bit<class_Area2D_method_set_collision_layer_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_collision_mask_bit<class_Area2D_method_set_collision_mask_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
.. _class_Area2D_signal_area_entered:
- **area_entered** **(** :ref:`Area2D<class_Area2D>` area **)**
Emitted when another area enters.
----
.. _class_Area2D_signal_area_exited:
- **area_exited** **(** :ref:`Area2D<class_Area2D>` area **)**
Emitted when another area exits.
----
.. _class_Area2D_signal_area_shape_entered:
- **area_shape_entered** **(** :ref:`int<class_int>` area_id, :ref:`Area2D<class_Area2D>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` self_shape **)**
Emitted when another area enters, reporting which shapes overlapped. ``shape_owner_get_owner(shape_find_owner(shape))`` returns the parent object of the owner of the ``shape``.
----
.. _class_Area2D_signal_area_shape_exited:
- **area_shape_exited** **(** :ref:`int<class_int>` area_id, :ref:`Area2D<class_Area2D>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` self_shape **)**
Emitted when another area exits, reporting which shapes were overlapping.
----
.. _class_Area2D_signal_body_entered:
- **body_entered** **(** :ref:`Node<class_Node>` body **)**
Emitted when a physics body enters.
The ``body`` argument can either be a :ref:`PhysicsBody2D<class_PhysicsBody2D>` or a :ref:`TileMap<class_TileMap>` instance (while TileMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body).
----
.. _class_Area2D_signal_body_exited:
- **body_exited** **(** :ref:`Node<class_Node>` body **)**
Emitted when a physics body exits.
The ``body`` argument can either be a :ref:`PhysicsBody2D<class_PhysicsBody2D>` or a :ref:`TileMap<class_TileMap>` instance (while TileMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body).
----
.. _class_Area2D_signal_body_shape_entered:
- **body_shape_entered** **(** :ref:`int<class_int>` body_id, :ref:`Node<class_Node>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
Emitted when a physics body enters, reporting which shapes overlapped.
The ``body`` argument can either be a :ref:`PhysicsBody2D<class_PhysicsBody2D>` or a :ref:`TileMap<class_TileMap>` instance (while TileMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body).
----
.. _class_Area2D_signal_body_shape_exited:
- **body_shape_exited** **(** :ref:`int<class_int>` body_id, :ref:`Node<class_Node>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
Emitted when a physics body exits, reporting which shapes were overlapping.
The ``body`` argument can either be a :ref:`PhysicsBody2D<class_PhysicsBody2D>` or a :ref:`TileMap<class_TileMap>` instance (while TileMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body).
Enumerations
------------
.. _enum_Area2D_SpaceOverride:
.. _class_Area2D_constant_SPACE_OVERRIDE_DISABLED:
.. _class_Area2D_constant_SPACE_OVERRIDE_COMBINE:
.. _class_Area2D_constant_SPACE_OVERRIDE_COMBINE_REPLACE:
.. _class_Area2D_constant_SPACE_OVERRIDE_REPLACE:
.. _class_Area2D_constant_SPACE_OVERRIDE_REPLACE_COMBINE:
enum **SpaceOverride**:
- **SPACE_OVERRIDE_DISABLED** = **0** --- This area does not affect gravity/damping.
- **SPACE_OVERRIDE_COMBINE** = **1** --- This area adds its gravity/damping values to whatever has been calculated so far (in :ref:`priority<class_Area2D_property_priority>` order).
- **SPACE_OVERRIDE_COMBINE_REPLACE** = **2** --- This area adds its gravity/damping values to whatever has been calculated so far (in :ref:`priority<class_Area2D_property_priority>` order), ignoring any lower priority areas.
- **SPACE_OVERRIDE_REPLACE** = **3** --- This area replaces any gravity/damping, even the defaults, ignoring any lower priority areas.
- **SPACE_OVERRIDE_REPLACE_COMBINE** = **4** --- This area replaces any gravity/damping calculated so far (in :ref:`priority<class_Area2D_property_priority>` order), but keeps calculating the rest of the areas.
Property Descriptions
---------------------
.. _class_Area2D_property_angular_damp:
- :ref:`float<class_float>` **angular_damp**
+-----------+-------------------------+
| *Default* | ``1.0`` |
+-----------+-------------------------+
| *Setter* | set_angular_damp(value) |
+-----------+-------------------------+
| *Getter* | get_angular_damp() |
+-----------+-------------------------+
The rate at which objects stop spinning in this area. Represents the angular velocity lost per second. Values range from ``0`` (no damping) to ``1`` (full damping).
----
.. _class_Area2D_property_audio_bus_name:
- :ref:`StringName<class_StringName>` **audio_bus_name**
+-----------+---------------------------+
| *Default* | ``@"Master"`` |
+-----------+---------------------------+
| *Setter* | set_audio_bus_name(value) |
+-----------+---------------------------+
| *Getter* | get_audio_bus_name() |
+-----------+---------------------------+
The name of the area's audio bus.
----
.. _class_Area2D_property_audio_bus_override:
- :ref:`bool<class_bool>` **audio_bus_override**
+-----------+-------------------------------+
| *Default* | ``false`` |
+-----------+-------------------------------+
| *Setter* | set_audio_bus_override(value) |
+-----------+-------------------------------+
| *Getter* | is_overriding_audio_bus() |
+-----------+-------------------------------+
If ``true``, the area's audio bus overrides the default audio bus.
----
.. _class_Area2D_property_collision_layer:
- :ref:`int<class_int>` **collision_layer**
+-----------+----------------------------+
| *Default* | ``1`` |
+-----------+----------------------------+
| *Setter* | set_collision_layer(value) |
+-----------+----------------------------+
| *Getter* | get_collision_layer() |
+-----------+----------------------------+
The area's physics layer(s). Collidable objects can exist in any of 32 different layers. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See also :ref:`collision_mask<class_Area2D_property_collision_mask>`.
----
.. _class_Area2D_property_collision_mask:
- :ref:`int<class_int>` **collision_mask**
+-----------+---------------------------+
| *Default* | ``1`` |
+-----------+---------------------------+
| *Setter* | set_collision_mask(value) |
+-----------+---------------------------+
| *Getter* | get_collision_mask() |
+-----------+---------------------------+
The physics layers this area scans to determine collision detection.
----
.. _class_Area2D_property_gravity:
- :ref:`float<class_float>` **gravity**
+-----------+--------------------+
| *Default* | ``98.0`` |
+-----------+--------------------+
| *Setter* | set_gravity(value) |
+-----------+--------------------+
| *Getter* | get_gravity() |
+-----------+--------------------+
The area's gravity intensity (ranges from -1024 to 1024). This value multiplies the gravity vector. This is useful to alter the force of gravity without altering its direction.
----
.. _class_Area2D_property_gravity_distance_scale:
- :ref:`float<class_float>` **gravity_distance_scale**
+-----------+-----------------------------------+
| *Default* | ``0.0`` |
+-----------+-----------------------------------+
| *Setter* | set_gravity_distance_scale(value) |
+-----------+-----------------------------------+
| *Getter* | get_gravity_distance_scale() |
+-----------+-----------------------------------+
The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance.
----
.. _class_Area2D_property_gravity_point:
- :ref:`bool<class_bool>` **gravity_point**
+-----------+-----------------------------+
| *Default* | ``false`` |
+-----------+-----------------------------+
| *Setter* | set_gravity_is_point(value) |
+-----------+-----------------------------+
| *Getter* | is_gravity_a_point() |
+-----------+-----------------------------+
If ``true``, gravity is calculated from a point (set via :ref:`gravity_vec<class_Area2D_property_gravity_vec>`). See also :ref:`space_override<class_Area2D_property_space_override>`.
----
.. _class_Area2D_property_gravity_vec:
- :ref:`Vector2<class_Vector2>` **gravity_vec**
+-----------+---------------------------+
| *Default* | ``Vector2( 0, 1 )`` |
+-----------+---------------------------+
| *Setter* | set_gravity_vector(value) |
+-----------+---------------------------+
| *Getter* | get_gravity_vector() |
+-----------+---------------------------+
The area's gravity vector (not normalized). If gravity is a point (see :ref:`gravity_point<class_Area2D_property_gravity_point>`), this will be the point of attraction.
----
.. _class_Area2D_property_linear_damp:
- :ref:`float<class_float>` **linear_damp**
+-----------+------------------------+
| *Default* | ``0.1`` |
+-----------+------------------------+
| *Setter* | set_linear_damp(value) |
+-----------+------------------------+
| *Getter* | get_linear_damp() |
+-----------+------------------------+
The rate at which objects stop moving in this area. Represents the linear velocity lost per second. Values range from ``0`` (no damping) to ``1`` (full damping).
----
.. _class_Area2D_property_monitorable:
- :ref:`bool<class_bool>` **monitorable**
+-----------+------------------------+
| *Default* | ``true`` |
+-----------+------------------------+
| *Setter* | set_monitorable(value) |
+-----------+------------------------+
| *Getter* | is_monitorable() |
+-----------+------------------------+
If ``true``, other monitoring areas can detect this area.
----
.. _class_Area2D_property_monitoring:
- :ref:`bool<class_bool>` **monitoring**
+-----------+-----------------------+
| *Default* | ``true`` |
+-----------+-----------------------+
| *Setter* | set_monitoring(value) |
+-----------+-----------------------+
| *Getter* | is_monitoring() |
+-----------+-----------------------+
If ``true``, the area detects bodies or areas entering and exiting it.
----
.. _class_Area2D_property_priority:
- :ref:`float<class_float>` **priority**
+-----------+---------------------+
| *Default* | ``0.0`` |
+-----------+---------------------+
| *Setter* | set_priority(value) |
+-----------+---------------------+
| *Getter* | get_priority() |
+-----------+---------------------+
The area's priority. Higher priority areas are processed first.
----
.. _class_Area2D_property_space_override:
- :ref:`SpaceOverride<enum_Area2D_SpaceOverride>` **space_override**
+-----------+--------------------------------+
| *Default* | ``0`` |
+-----------+--------------------------------+
| *Setter* | set_space_override_mode(value) |
+-----------+--------------------------------+
| *Getter* | get_space_override_mode() |
+-----------+--------------------------------+
Override mode for gravity and damping calculations within this area. See :ref:`SpaceOverride<enum_Area2D_SpaceOverride>` for possible values.
Method Descriptions
-------------------
.. _class_Area2D_method_get_collision_layer_bit:
- :ref:`bool<class_bool>` **get_collision_layer_bit** **(** :ref:`int<class_int>` bit **)** const
Returns an individual bit on the layer mask. Describes whether other areas will collide with this one on the given layer.
----
.. _class_Area2D_method_get_collision_mask_bit:
- :ref:`bool<class_bool>` **get_collision_mask_bit** **(** :ref:`int<class_int>` bit **)** const
Returns an individual bit on the collision mask. Describes whether this area will collide with others on the given layer.
----
.. _class_Area2D_method_get_overlapping_areas:
- :ref:`Array<class_Array>` **get_overlapping_areas** **(** **)** const
Returns a list of intersecting ``Area2D``\ s. 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.
----
.. _class_Area2D_method_get_overlapping_bodies:
- :ref:`Array<class_Array>` **get_overlapping_bodies** **(** **)** const
Returns a list of intersecting :ref:`PhysicsBody2D<class_PhysicsBody2D>`\ s. 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.
----
.. _class_Area2D_method_overlaps_area:
- :ref:`bool<class_bool>` **overlaps_area** **(** :ref:`Node<class_Node>` area **)** const
If ``true``, the given area overlaps the Area2D.
**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.
----
.. _class_Area2D_method_overlaps_body:
- :ref:`bool<class_bool>` **overlaps_body** **(** :ref:`Node<class_Node>` body **)** const
If ``true``, the given physics body overlaps the Area2D.
**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 :ref:`PhysicsBody2D<class_PhysicsBody2D>` or a :ref:`TileMap<class_TileMap>` instance (while TileMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body).
----
.. _class_Area2D_method_set_collision_layer_bit:
- void **set_collision_layer_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)**
Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier.
----
.. _class_Area2D_method_set_collision_mask_bit:
- void **set_collision_mask_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)**
Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier.
Reference in New Issue View Git Blame Copy Permalink