.. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/docs/gdscript/doc/classes/Area2D.xml. .. _class_Area2D: Area2D ====== **Inherits:** :ref:`CollisionObject2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+ | :ref:`float` | :ref:`angular_damp` | ``1.0`` | +-------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+ | :ref:`SpaceOverride` | :ref:`angular_damp_space_override` | ``0`` | +-------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+ | :ref:`StringName` | :ref:`audio_bus_name` | ``&"Master"`` | +-------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+ | :ref:`bool` | :ref:`audio_bus_override` | ``false`` | +-------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+ | :ref:`float` | :ref:`gravity` | ``980.0`` | +-------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+ | :ref:`Vector2` | :ref:`gravity_direction` | ``Vector2(0, 1)`` | +-------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+ | :ref:`bool` | :ref:`gravity_point` | ``false`` | +-------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+ | :ref:`Vector2` | :ref:`gravity_point_center` | ``Vector2(0, 1)`` | +-------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+ | :ref:`float` | :ref:`gravity_point_unit_distance` | ``0.0`` | +-------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+ | :ref:`SpaceOverride` | :ref:`gravity_space_override` | ``0`` | +-------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+ | :ref:`float` | :ref:`linear_damp` | ``0.1`` | +-------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+ | :ref:`SpaceOverride` | :ref:`linear_damp_space_override` | ``0`` | +-------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+ | :ref:`bool` | :ref:`monitorable` | ``true`` | +-------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+ | :ref:`bool` | :ref:`monitoring` | ``true`` | +-------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+ | :ref:`int` | :ref:`priority` | ``0`` | +-------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------+----------------------------------------------------------------------------------------------------------+ | :ref:`Area2D[]` | :ref:`get_overlapping_areas` **(** **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------+ | :ref:`Node2D[]` | :ref:`get_overlapping_bodies` **(** **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_overlapping_areas` **(** **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_overlapping_bodies` **(** **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`overlaps_area` **(** :ref:`Node` area **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`overlaps_body` **(** :ref:`Node` body **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_Area2D_signal_area_entered: .. rst-class:: classref-signal **area_entered** **(** :ref:`Area2D` area **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Area2D_signal_area_exited: .. rst-class:: classref-signal **area_exited** **(** :ref:`Area2D` area **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Area2D_signal_area_shape_entered: .. rst-class:: classref-signal **area_shape_entered** **(** :ref:`RID` area_rid, :ref:`Area2D` area, :ref:`int` area_shape_index, :ref:`int` local_shape_index **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Area2D_signal_area_shape_exited: .. rst-class:: classref-signal **area_shape_exited** **(** :ref:`RID` area_rid, :ref:`Area2D` area, :ref:`int` area_shape_index, :ref:`int` local_shape_index **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Area2D_signal_body_entered: .. rst-class:: classref-signal **body_entered** **(** :ref:`Node2D` body **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Area2D_signal_body_exited: .. rst-class:: classref-signal **body_exited** **(** :ref:`Node2D` body **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Area2D_signal_body_shape_entered: .. rst-class:: classref-signal **body_shape_entered** **(** :ref:`RID` body_rid, :ref:`Node2D` body, :ref:`int` body_shape_index, :ref:`int` local_shape_index **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Area2D_signal_body_shape_exited: .. rst-class:: classref-signal **body_shape_exited** **(** :ref:`RID` body_rid, :ref:`Node2D` body, :ref:`int` body_shape_index, :ref:`int` local_shape_index **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_Area2D_SpaceOverride: .. rst-class:: classref-enumeration enum **SpaceOverride**: .. _class_Area2D_constant_SPACE_OVERRIDE_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`SpaceOverride` **SPACE_OVERRIDE_DISABLED** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Area2D_constant_SPACE_OVERRIDE_COMBINE: .. rst-class:: classref-enumeration-constant :ref:`SpaceOverride` **SPACE_OVERRIDE_COMBINE** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Area2D_constant_SPACE_OVERRIDE_COMBINE_REPLACE: .. rst-class:: classref-enumeration-constant :ref:`SpaceOverride` **SPACE_OVERRIDE_COMBINE_REPLACE** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Area2D_constant_SPACE_OVERRIDE_REPLACE: .. rst-class:: classref-enumeration-constant :ref:`SpaceOverride` **SPACE_OVERRIDE_REPLACE** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Area2D_constant_SPACE_OVERRIDE_REPLACE_COMBINE: .. rst-class:: classref-enumeration-constant :ref:`SpaceOverride` **SPACE_OVERRIDE_REPLACE_COMBINE** = ``4`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_Area2D_property_angular_damp: .. rst-class:: classref-property :ref:`float` **angular_damp** = ``1.0`` .. rst-class:: classref-property-setget - void **set_angular_damp** **(** :ref:`float` value **)** - :ref:`float` **get_angular_damp** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Area2D_property_angular_damp_space_override: .. rst-class:: classref-property :ref:`SpaceOverride` **angular_damp_space_override** = ``0`` .. rst-class:: classref-property-setget - void **set_angular_damp_space_override_mode** **(** :ref:`SpaceOverride` value **)** - :ref:`SpaceOverride` **get_angular_damp_space_override_mode** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Area2D_property_audio_bus_name: .. rst-class:: classref-property :ref:`StringName` **audio_bus_name** = ``&"Master"`` .. rst-class:: classref-property-setget - void **set_audio_bus_name** **(** :ref:`StringName` value **)** - :ref:`StringName` **get_audio_bus_name** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Area2D_property_audio_bus_override: .. rst-class:: classref-property :ref:`bool` **audio_bus_override** = ``false`` .. rst-class:: classref-property-setget - void **set_audio_bus_override** **(** :ref:`bool` value **)** - :ref:`bool` **is_overriding_audio_bus** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Area2D_property_gravity: .. rst-class:: classref-property :ref:`float` **gravity** = ``980.0`` .. rst-class:: classref-property-setget - void **set_gravity** **(** :ref:`float` value **)** - :ref:`float` **get_gravity** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Area2D_property_gravity_direction: .. rst-class:: classref-property :ref:`Vector2` **gravity_direction** = ``Vector2(0, 1)`` .. rst-class:: classref-property-setget - void **set_gravity_direction** **(** :ref:`Vector2` value **)** - :ref:`Vector2` **get_gravity_direction** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Area2D_property_gravity_point: .. rst-class:: classref-property :ref:`bool` **gravity_point** = ``false`` .. rst-class:: classref-property-setget - void **set_gravity_is_point** **(** :ref:`bool` value **)** - :ref:`bool` **is_gravity_a_point** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Area2D_property_gravity_point_center: .. rst-class:: classref-property :ref:`Vector2` **gravity_point_center** = ``Vector2(0, 1)`` .. rst-class:: classref-property-setget - void **set_gravity_point_center** **(** :ref:`Vector2` value **)** - :ref:`Vector2` **get_gravity_point_center** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Area2D_property_gravity_point_unit_distance: .. rst-class:: classref-property :ref:`float` **gravity_point_unit_distance** = ``0.0`` .. rst-class:: classref-property-setget - void **set_gravity_point_unit_distance** **(** :ref:`float` value **)** - :ref:`float` **get_gravity_point_unit_distance** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Area2D_property_gravity_space_override: .. rst-class:: classref-property :ref:`SpaceOverride` **gravity_space_override** = ``0`` .. rst-class:: classref-property-setget - void **set_gravity_space_override_mode** **(** :ref:`SpaceOverride` value **)** - :ref:`SpaceOverride` **get_gravity_space_override_mode** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Area2D_property_linear_damp: .. rst-class:: classref-property :ref:`float` **linear_damp** = ``0.1`` .. rst-class:: classref-property-setget - void **set_linear_damp** **(** :ref:`float` value **)** - :ref:`float` **get_linear_damp** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Area2D_property_linear_damp_space_override: .. rst-class:: classref-property :ref:`SpaceOverride` **linear_damp_space_override** = ``0`` .. rst-class:: classref-property-setget - void **set_linear_damp_space_override_mode** **(** :ref:`SpaceOverride` value **)** - :ref:`SpaceOverride` **get_linear_damp_space_override_mode** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Area2D_property_monitorable: .. rst-class:: classref-property :ref:`bool` **monitorable** = ``true`` .. rst-class:: classref-property-setget - void **set_monitorable** **(** :ref:`bool` value **)** - :ref:`bool` **is_monitorable** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Area2D_property_monitoring: .. rst-class:: classref-property :ref:`bool` **monitoring** = ``true`` .. rst-class:: classref-property-setget - void **set_monitoring** **(** :ref:`bool` value **)** - :ref:`bool` **is_monitoring** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Area2D_property_priority: .. rst-class:: classref-property :ref:`int` **priority** = ``0`` .. rst-class:: classref-property-setget - void **set_priority** **(** :ref:`int` value **)** - :ref:`int` **get_priority** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_Area2D_method_get_overlapping_areas: .. rst-class:: classref-method :ref:`Area2D[]` **get_overlapping_areas** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Area2D_method_get_overlapping_bodies: .. rst-class:: classref-method :ref:`Node2D[]` **get_overlapping_bodies** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Area2D_method_has_overlapping_areas: .. rst-class:: classref-method :ref:`bool` **has_overlapping_areas** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Area2D_method_has_overlapping_bodies: .. rst-class:: classref-method :ref:`bool` **has_overlapping_bodies** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Area2D_method_overlaps_area: .. rst-class:: classref-method :ref:`bool` **overlaps_area** **(** :ref:`Node` area **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Area2D_method_overlaps_body: .. rst-class:: classref-method :ref:`bool` **overlaps_body** **(** :ref:`Node` body **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`