|
@@ -1,6 +1,6 @@
|
|
:github_url: hide
|
|
:github_url: hide
|
|
|
|
|
|
-.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
|
|
|
|
+.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the Area3D.xml source instead.
|
|
.. DO NOT EDIT THIS FILE, but the Area3D.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
|
|
@@ -28,45 +28,51 @@ Tutorials
|
|
Properties
|
|
Properties
|
|
----------
|
|
----------
|
|
|
|
|
|
-+-------------------------------------------------+-------------------------------------------------------------------------------+-----------------------+
|
|
|
|
-| :ref:`float<class_float>` | :ref:`angular_damp<class_Area3D_property_angular_damp>` | ``0.1`` |
|
|
|
|
-+-------------------------------------------------+-------------------------------------------------------------------------------+-----------------------+
|
|
|
|
-| :ref:`StringName<class_StringName>` | :ref:`audio_bus_name<class_Area3D_property_audio_bus_name>` | ``&"Master"`` |
|
|
|
|
-+-------------------------------------------------+-------------------------------------------------------------------------------+-----------------------+
|
|
|
|
-| :ref:`bool<class_bool>` | :ref:`audio_bus_override<class_Area3D_property_audio_bus_override>` | ``false`` |
|
|
|
|
-+-------------------------------------------------+-------------------------------------------------------------------------------+-----------------------+
|
|
|
|
-| :ref:`float<class_float>` | :ref:`gravity<class_Area3D_property_gravity>` | ``9.8`` |
|
|
|
|
-+-------------------------------------------------+-------------------------------------------------------------------------------+-----------------------+
|
|
|
|
-| :ref:`float<class_float>` | :ref:`gravity_distance_scale<class_Area3D_property_gravity_distance_scale>` | ``0.0`` |
|
|
|
|
-+-------------------------------------------------+-------------------------------------------------------------------------------+-----------------------+
|
|
|
|
-| :ref:`bool<class_bool>` | :ref:`gravity_point<class_Area3D_property_gravity_point>` | ``false`` |
|
|
|
|
-+-------------------------------------------------+-------------------------------------------------------------------------------+-----------------------+
|
|
|
|
-| :ref:`Vector3<class_Vector3>` | :ref:`gravity_vec<class_Area3D_property_gravity_vec>` | ``Vector3(0, -1, 0)`` |
|
|
|
|
-+-------------------------------------------------+-------------------------------------------------------------------------------+-----------------------+
|
|
|
|
-| :ref:`float<class_float>` | :ref:`linear_damp<class_Area3D_property_linear_damp>` | ``0.1`` |
|
|
|
|
-+-------------------------------------------------+-------------------------------------------------------------------------------+-----------------------+
|
|
|
|
-| :ref:`bool<class_bool>` | :ref:`monitorable<class_Area3D_property_monitorable>` | ``true`` |
|
|
|
|
-+-------------------------------------------------+-------------------------------------------------------------------------------+-----------------------+
|
|
|
|
-| :ref:`bool<class_bool>` | :ref:`monitoring<class_Area3D_property_monitoring>` | ``true`` |
|
|
|
|
-+-------------------------------------------------+-------------------------------------------------------------------------------+-----------------------+
|
|
|
|
-| :ref:`float<class_float>` | :ref:`priority<class_Area3D_property_priority>` | ``0.0`` |
|
|
|
|
-+-------------------------------------------------+-------------------------------------------------------------------------------+-----------------------+
|
|
|
|
-| :ref:`float<class_float>` | :ref:`reverb_bus_amount<class_Area3D_property_reverb_bus_amount>` | ``0.0`` |
|
|
|
|
-+-------------------------------------------------+-------------------------------------------------------------------------------+-----------------------+
|
|
|
|
-| :ref:`bool<class_bool>` | :ref:`reverb_bus_enable<class_Area3D_property_reverb_bus_enable>` | ``false`` |
|
|
|
|
-+-------------------------------------------------+-------------------------------------------------------------------------------+-----------------------+
|
|
|
|
-| :ref:`StringName<class_StringName>` | :ref:`reverb_bus_name<class_Area3D_property_reverb_bus_name>` | ``&"Master"`` |
|
|
|
|
-+-------------------------------------------------+-------------------------------------------------------------------------------+-----------------------+
|
|
|
|
-| :ref:`float<class_float>` | :ref:`reverb_bus_uniformity<class_Area3D_property_reverb_bus_uniformity>` | ``0.0`` |
|
|
|
|
-+-------------------------------------------------+-------------------------------------------------------------------------------+-----------------------+
|
|
|
|
-| :ref:`SpaceOverride<enum_Area3D_SpaceOverride>` | :ref:`space_override<class_Area3D_property_space_override>` | ``0`` |
|
|
|
|
-+-------------------------------------------------+-------------------------------------------------------------------------------+-----------------------+
|
|
|
|
-| :ref:`float<class_float>` | :ref:`wind_attenuation_factor<class_Area3D_property_wind_attenuation_factor>` | ``0.0`` |
|
|
|
|
-+-------------------------------------------------+-------------------------------------------------------------------------------+-----------------------+
|
|
|
|
-| :ref:`float<class_float>` | :ref:`wind_force_magnitude<class_Area3D_property_wind_force_magnitude>` | ``0.0`` |
|
|
|
|
-+-------------------------------------------------+-------------------------------------------------------------------------------+-----------------------+
|
|
|
|
-| :ref:`NodePath<class_NodePath>` | :ref:`wind_source_path<class_Area3D_property_wind_source_path>` | ``NodePath("")`` |
|
|
|
|
-+-------------------------------------------------+-------------------------------------------------------------------------------+-----------------------+
|
|
|
|
|
|
++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+
|
|
|
|
+| :ref:`float<class_float>` | :ref:`angular_damp<class_Area3D_property_angular_damp>` | ``0.1`` |
|
|
|
|
++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+
|
|
|
|
+| :ref:`SpaceOverride<enum_Area3D_SpaceOverride>` | :ref:`angular_damp_space_override<class_Area3D_property_angular_damp_space_override>` | ``0`` |
|
|
|
|
++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+
|
|
|
|
+| :ref:`StringName<class_StringName>` | :ref:`audio_bus_name<class_Area3D_property_audio_bus_name>` | ``&"Master"`` |
|
|
|
|
++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+
|
|
|
|
+| :ref:`bool<class_bool>` | :ref:`audio_bus_override<class_Area3D_property_audio_bus_override>` | ``false`` |
|
|
|
|
++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+
|
|
|
|
+| :ref:`float<class_float>` | :ref:`gravity<class_Area3D_property_gravity>` | ``9.8`` |
|
|
|
|
++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+
|
|
|
|
+| :ref:`Vector3<class_Vector3>` | :ref:`gravity_direction<class_Area3D_property_gravity_direction>` | ``Vector3(0, -1, 0)`` |
|
|
|
|
++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+
|
|
|
|
+| :ref:`bool<class_bool>` | :ref:`gravity_point<class_Area3D_property_gravity_point>` | ``false`` |
|
|
|
|
++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+
|
|
|
|
+| :ref:`Vector3<class_Vector3>` | :ref:`gravity_point_center<class_Area3D_property_gravity_point_center>` | ``Vector3(0, -1, 0)`` |
|
|
|
|
++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+
|
|
|
|
+| :ref:`float<class_float>` | :ref:`gravity_point_distance_scale<class_Area3D_property_gravity_point_distance_scale>` | ``0.0`` |
|
|
|
|
++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+
|
|
|
|
+| :ref:`SpaceOverride<enum_Area3D_SpaceOverride>` | :ref:`gravity_space_override<class_Area3D_property_gravity_space_override>` | ``0`` |
|
|
|
|
++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+
|
|
|
|
+| :ref:`float<class_float>` | :ref:`linear_damp<class_Area3D_property_linear_damp>` | ``0.1`` |
|
|
|
|
++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+
|
|
|
|
+| :ref:`SpaceOverride<enum_Area3D_SpaceOverride>` | :ref:`linear_damp_space_override<class_Area3D_property_linear_damp_space_override>` | ``0`` |
|
|
|
|
++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+
|
|
|
|
+| :ref:`bool<class_bool>` | :ref:`monitorable<class_Area3D_property_monitorable>` | ``true`` |
|
|
|
|
++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+
|
|
|
|
+| :ref:`bool<class_bool>` | :ref:`monitoring<class_Area3D_property_monitoring>` | ``true`` |
|
|
|
|
++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+
|
|
|
|
+| :ref:`float<class_float>` | :ref:`priority<class_Area3D_property_priority>` | ``0.0`` |
|
|
|
|
++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+
|
|
|
|
+| :ref:`float<class_float>` | :ref:`reverb_bus_amount<class_Area3D_property_reverb_bus_amount>` | ``0.0`` |
|
|
|
|
++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+
|
|
|
|
+| :ref:`bool<class_bool>` | :ref:`reverb_bus_enable<class_Area3D_property_reverb_bus_enable>` | ``false`` |
|
|
|
|
++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+
|
|
|
|
+| :ref:`StringName<class_StringName>` | :ref:`reverb_bus_name<class_Area3D_property_reverb_bus_name>` | ``&"Master"`` |
|
|
|
|
++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+
|
|
|
|
+| :ref:`float<class_float>` | :ref:`reverb_bus_uniformity<class_Area3D_property_reverb_bus_uniformity>` | ``0.0`` |
|
|
|
|
++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+
|
|
|
|
+| :ref:`float<class_float>` | :ref:`wind_attenuation_factor<class_Area3D_property_wind_attenuation_factor>` | ``0.0`` |
|
|
|
|
++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+
|
|
|
|
+| :ref:`float<class_float>` | :ref:`wind_force_magnitude<class_Area3D_property_wind_force_magnitude>` | ``0.0`` |
|
|
|
|
++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+
|
|
|
|
+| :ref:`NodePath<class_NodePath>` | :ref:`wind_source_path<class_Area3D_property_wind_source_path>` | ``NodePath("")`` |
|
|
|
|
++-------------------------------------------------+-----------------------------------------------------------------------------------------+-----------------------+
|
|
|
|
|
|
Methods
|
|
Methods
|
|
-------
|
|
-------
|
|
@@ -106,33 +112,33 @@ Emitted when another Area3D exits this Area3D. Requires :ref:`monitoring<class_A
|
|
|
|
|
|
.. _class_Area3D_signal_area_shape_entered:
|
|
.. _class_Area3D_signal_area_shape_entered:
|
|
|
|
|
|
-- **area_shape_entered** **(** :ref:`RID<class_RID>` area_rid, :ref:`Area3D<class_Area3D>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` local_shape **)**
|
|
|
|
|
|
+- **area_shape_entered** **(** :ref:`RID<class_RID>` area_rid, :ref:`Area3D<class_Area3D>` area, :ref:`int<class_int>` area_shape_index, :ref:`int<class_int>` local_shape_index **)**
|
|
|
|
|
|
Emitted when one of another Area3D's :ref:`Shape3D<class_Shape3D>`\ s enters one of this Area3D's :ref:`Shape3D<class_Shape3D>`\ s. Requires :ref:`monitoring<class_Area3D_property_monitoring>` to be set to ``true``.
|
|
Emitted when one of another Area3D's :ref:`Shape3D<class_Shape3D>`\ s enters one of this Area3D's :ref:`Shape3D<class_Shape3D>`\ s. Requires :ref:`monitoring<class_Area3D_property_monitoring>` to be set to ``true``.
|
|
|
|
|
|
-``area_id`` the :ref:`RID<class_RID>` of the other Area3D's :ref:`CollisionObject3D<class_CollisionObject3D>` used by the :ref:`PhysicsServer3D<class_PhysicsServer3D>`.
|
|
|
|
|
|
+``area_rid`` the :ref:`RID<class_RID>` of the other Area3D's :ref:`CollisionObject3D<class_CollisionObject3D>` used by the :ref:`PhysicsServer3D<class_PhysicsServer3D>`.
|
|
|
|
|
|
``area`` the other Area3D.
|
|
``area`` the other Area3D.
|
|
|
|
|
|
-``area_shape`` the index of the :ref:`Shape3D<class_Shape3D>` of the other Area3D used by the :ref:`PhysicsServer3D<class_PhysicsServer3D>`.
|
|
|
|
|
|
+``area_shape_index`` the index of the :ref:`Shape3D<class_Shape3D>` of the other Area3D used by the :ref:`PhysicsServer3D<class_PhysicsServer3D>`. Get the :ref:`CollisionShape3D<class_CollisionShape3D>` node with ``area.shape_owner_get_owner(area_shape_index)``.
|
|
|
|
|
|
-``local_shape`` the index of the :ref:`Shape3D<class_Shape3D>` of this Area3D used by the :ref:`PhysicsServer3D<class_PhysicsServer3D>`.
|
|
|
|
|
|
+``local_shape_index`` the index of the :ref:`Shape3D<class_Shape3D>` of this Area3D used by the :ref:`PhysicsServer3D<class_PhysicsServer3D>`. Get the :ref:`CollisionShape3D<class_CollisionShape3D>` node with ``self.shape_owner_get_owner(local_shape_index)``.
|
|
|
|
|
|
----
|
|
----
|
|
|
|
|
|
.. _class_Area3D_signal_area_shape_exited:
|
|
.. _class_Area3D_signal_area_shape_exited:
|
|
|
|
|
|
-- **area_shape_exited** **(** :ref:`RID<class_RID>` area_rid, :ref:`Area3D<class_Area3D>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` local_shape **)**
|
|
|
|
|
|
+- **area_shape_exited** **(** :ref:`RID<class_RID>` area_rid, :ref:`Area3D<class_Area3D>` area, :ref:`int<class_int>` area_shape_index, :ref:`int<class_int>` local_shape_index **)**
|
|
|
|
|
|
-Emitted when one of another Area3D's :ref:`Shape3D<class_Shape3D>`\ s enters one of this Area3D's :ref:`Shape3D<class_Shape3D>`\ s. Requires :ref:`monitoring<class_Area3D_property_monitoring>` to be set to ``true``.
|
|
|
|
|
|
+Emitted when one of another Area3D's :ref:`Shape3D<class_Shape3D>`\ s exits one of this Area3D's :ref:`Shape3D<class_Shape3D>`\ s. Requires :ref:`monitoring<class_Area3D_property_monitoring>` to be set to ``true``.
|
|
|
|
|
|
-``area_id`` the :ref:`RID<class_RID>` of the other Area3D's :ref:`CollisionObject3D<class_CollisionObject3D>` used by the :ref:`PhysicsServer3D<class_PhysicsServer3D>`.
|
|
|
|
|
|
+``area_rid`` the :ref:`RID<class_RID>` of the other Area3D's :ref:`CollisionObject3D<class_CollisionObject3D>` used by the :ref:`PhysicsServer3D<class_PhysicsServer3D>`.
|
|
|
|
|
|
``area`` the other Area3D.
|
|
``area`` the other Area3D.
|
|
|
|
|
|
-``area_shape`` the index of the :ref:`Shape3D<class_Shape3D>` of the other Area3D used by the :ref:`PhysicsServer3D<class_PhysicsServer3D>`.
|
|
|
|
|
|
+``area_shape_index`` the index of the :ref:`Shape3D<class_Shape3D>` of the other Area3D used by the :ref:`PhysicsServer3D<class_PhysicsServer3D>`. Get the :ref:`CollisionShape3D<class_CollisionShape3D>` node with ``area.shape_owner_get_owner(area_shape_index)``.
|
|
|
|
|
|
-``local_shape`` the index of the :ref:`Shape3D<class_Shape3D>` of this Area3D used by the :ref:`PhysicsServer3D<class_PhysicsServer3D>`.
|
|
|
|
|
|
+``local_shape_index`` the index of the :ref:`Shape3D<class_Shape3D>` of this Area3D used by the :ref:`PhysicsServer3D<class_PhysicsServer3D>`. Get the :ref:`CollisionShape3D<class_CollisionShape3D>` node with ``self.shape_owner_get_owner(local_shape_index)``.
|
|
|
|
|
|
----
|
|
----
|
|
|
|
|
|
@@ -158,33 +164,33 @@ Emitted when a :ref:`PhysicsBody3D<class_PhysicsBody3D>` or :ref:`GridMap<class_
|
|
|
|
|
|
.. _class_Area3D_signal_body_shape_entered:
|
|
.. _class_Area3D_signal_body_shape_entered:
|
|
|
|
|
|
-- **body_shape_entered** **(** :ref:`RID<class_RID>` body_rid, :ref:`Node3D<class_Node3D>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` local_shape **)**
|
|
|
|
|
|
+- **body_shape_entered** **(** :ref:`RID<class_RID>` body_rid, :ref:`Node3D<class_Node3D>` body, :ref:`int<class_int>` body_shape_index, :ref:`int<class_int>` local_shape_index **)**
|
|
|
|
|
|
Emitted when one of a :ref:`PhysicsBody3D<class_PhysicsBody3D>` or :ref:`GridMap<class_GridMap>`'s :ref:`Shape3D<class_Shape3D>`\ s enters one of this Area3D's :ref:`Shape3D<class_Shape3D>`\ s. Requires :ref:`monitoring<class_Area3D_property_monitoring>` to be set to ``true``. :ref:`GridMap<class_GridMap>`\ s are detected if the :ref:`MeshLibrary<class_MeshLibrary>` has Collision :ref:`Shape3D<class_Shape3D>`\ s.
|
|
Emitted when one of a :ref:`PhysicsBody3D<class_PhysicsBody3D>` or :ref:`GridMap<class_GridMap>`'s :ref:`Shape3D<class_Shape3D>`\ s enters one of this Area3D's :ref:`Shape3D<class_Shape3D>`\ s. Requires :ref:`monitoring<class_Area3D_property_monitoring>` to be set to ``true``. :ref:`GridMap<class_GridMap>`\ s are detected if the :ref:`MeshLibrary<class_MeshLibrary>` has Collision :ref:`Shape3D<class_Shape3D>`\ s.
|
|
|
|
|
|
-``body_id`` the :ref:`RID<class_RID>` of the :ref:`PhysicsBody3D<class_PhysicsBody3D>` or :ref:`MeshLibrary<class_MeshLibrary>`'s :ref:`CollisionObject3D<class_CollisionObject3D>` used by the :ref:`PhysicsServer3D<class_PhysicsServer3D>`.
|
|
|
|
|
|
+``body_rid`` the :ref:`RID<class_RID>` of the :ref:`PhysicsBody3D<class_PhysicsBody3D>` or :ref:`MeshLibrary<class_MeshLibrary>`'s :ref:`CollisionObject3D<class_CollisionObject3D>` used by the :ref:`PhysicsServer3D<class_PhysicsServer3D>`.
|
|
|
|
|
|
``body`` the :ref:`Node<class_Node>`, if it exists in the tree, of the :ref:`PhysicsBody3D<class_PhysicsBody3D>` or :ref:`GridMap<class_GridMap>`.
|
|
``body`` the :ref:`Node<class_Node>`, if it exists in the tree, of the :ref:`PhysicsBody3D<class_PhysicsBody3D>` or :ref:`GridMap<class_GridMap>`.
|
|
|
|
|
|
-``body_shape`` the index of the :ref:`Shape3D<class_Shape3D>` of the :ref:`PhysicsBody3D<class_PhysicsBody3D>` or :ref:`GridMap<class_GridMap>` used by the :ref:`PhysicsServer3D<class_PhysicsServer3D>`.
|
|
|
|
|
|
+``body_shape_index`` the index of the :ref:`Shape3D<class_Shape3D>` of the :ref:`PhysicsBody3D<class_PhysicsBody3D>` or :ref:`GridMap<class_GridMap>` used by the :ref:`PhysicsServer3D<class_PhysicsServer3D>`. Get the :ref:`CollisionShape3D<class_CollisionShape3D>` node with ``body.shape_owner_get_owner(body_shape_index)``.
|
|
|
|
|
|
-``local_shape`` the index of the :ref:`Shape3D<class_Shape3D>` of this Area3D used by the :ref:`PhysicsServer3D<class_PhysicsServer3D>`.
|
|
|
|
|
|
+``local_shape_index`` the index of the :ref:`Shape3D<class_Shape3D>` of this Area3D used by the :ref:`PhysicsServer3D<class_PhysicsServer3D>`. Get the :ref:`CollisionShape3D<class_CollisionShape3D>` node with ``self.shape_owner_get_owner(local_shape_index)``.
|
|
|
|
|
|
----
|
|
----
|
|
|
|
|
|
.. _class_Area3D_signal_body_shape_exited:
|
|
.. _class_Area3D_signal_body_shape_exited:
|
|
|
|
|
|
-- **body_shape_exited** **(** :ref:`RID<class_RID>` body_rid, :ref:`Node3D<class_Node3D>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` local_shape **)**
|
|
|
|
|
|
+- **body_shape_exited** **(** :ref:`RID<class_RID>` body_rid, :ref:`Node3D<class_Node3D>` body, :ref:`int<class_int>` body_shape_index, :ref:`int<class_int>` local_shape_index **)**
|
|
|
|
|
|
Emitted when one of a :ref:`PhysicsBody3D<class_PhysicsBody3D>` or :ref:`GridMap<class_GridMap>`'s :ref:`Shape3D<class_Shape3D>`\ s enters one of this Area3D's :ref:`Shape3D<class_Shape3D>`\ s. Requires :ref:`monitoring<class_Area3D_property_monitoring>` to be set to ``true``. :ref:`GridMap<class_GridMap>`\ s are detected if the :ref:`MeshLibrary<class_MeshLibrary>` has Collision :ref:`Shape3D<class_Shape3D>`\ s.
|
|
Emitted when one of a :ref:`PhysicsBody3D<class_PhysicsBody3D>` or :ref:`GridMap<class_GridMap>`'s :ref:`Shape3D<class_Shape3D>`\ s enters one of this Area3D's :ref:`Shape3D<class_Shape3D>`\ s. Requires :ref:`monitoring<class_Area3D_property_monitoring>` to be set to ``true``. :ref:`GridMap<class_GridMap>`\ s are detected if the :ref:`MeshLibrary<class_MeshLibrary>` has Collision :ref:`Shape3D<class_Shape3D>`\ s.
|
|
|
|
|
|
-``body_id`` the :ref:`RID<class_RID>` of the :ref:`PhysicsBody3D<class_PhysicsBody3D>` or :ref:`MeshLibrary<class_MeshLibrary>`'s :ref:`CollisionObject3D<class_CollisionObject3D>` used by the :ref:`PhysicsServer3D<class_PhysicsServer3D>`.
|
|
|
|
|
|
+``body_rid`` the :ref:`RID<class_RID>` of the :ref:`PhysicsBody3D<class_PhysicsBody3D>` or :ref:`MeshLibrary<class_MeshLibrary>`'s :ref:`CollisionObject3D<class_CollisionObject3D>` used by the :ref:`PhysicsServer3D<class_PhysicsServer3D>`.
|
|
|
|
|
|
``body`` the :ref:`Node<class_Node>`, if it exists in the tree, of the :ref:`PhysicsBody3D<class_PhysicsBody3D>` or :ref:`GridMap<class_GridMap>`.
|
|
``body`` the :ref:`Node<class_Node>`, if it exists in the tree, of the :ref:`PhysicsBody3D<class_PhysicsBody3D>` or :ref:`GridMap<class_GridMap>`.
|
|
|
|
|
|
-``body_shape`` the index of the :ref:`Shape3D<class_Shape3D>` of the :ref:`PhysicsBody3D<class_PhysicsBody3D>` or :ref:`GridMap<class_GridMap>` used by the :ref:`PhysicsServer3D<class_PhysicsServer3D>`.
|
|
|
|
|
|
+``body_shape_index`` the index of the :ref:`Shape3D<class_Shape3D>` of the :ref:`PhysicsBody3D<class_PhysicsBody3D>` or :ref:`GridMap<class_GridMap>` used by the :ref:`PhysicsServer3D<class_PhysicsServer3D>`. Get the :ref:`CollisionShape3D<class_CollisionShape3D>` node with ``body.shape_owner_get_owner(body_shape_index)``.
|
|
|
|
|
|
-``local_shape`` the index of the :ref:`Shape3D<class_Shape3D>` of this Area3D used by the :ref:`PhysicsServer3D<class_PhysicsServer3D>`.
|
|
|
|
|
|
+``local_shape_index`` the index of the :ref:`Shape3D<class_Shape3D>` of this Area3D used by the :ref:`PhysicsServer3D<class_PhysicsServer3D>`. Get the :ref:`CollisionShape3D<class_CollisionShape3D>` node with ``self.shape_owner_get_owner(local_shape_index)``.
|
|
|
|
|
|
Enumerations
|
|
Enumerations
|
|
------------
|
|
------------
|
|
@@ -234,6 +240,22 @@ See :ref:`ProjectSettings.physics/3d/default_angular_damp<class_ProjectSettings_
|
|
|
|
|
|
----
|
|
----
|
|
|
|
|
|
|
|
+.. _class_Area3D_property_angular_damp_space_override:
|
|
|
|
+
|
|
|
|
+- :ref:`SpaceOverride<enum_Area3D_SpaceOverride>` **angular_damp_space_override**
|
|
|
|
+
|
|
|
|
++-----------+---------------------------------------------+
|
|
|
|
+| *Default* | ``0`` |
|
|
|
|
++-----------+---------------------------------------------+
|
|
|
|
+| *Setter* | set_angular_damp_space_override_mode(value) |
|
|
|
|
++-----------+---------------------------------------------+
|
|
|
|
+| *Getter* | get_angular_damp_space_override_mode() |
|
|
|
|
++-----------+---------------------------------------------+
|
|
|
|
+
|
|
|
|
+Override mode for angular damping calculations within this area. See :ref:`SpaceOverride<enum_Area3D_SpaceOverride>` for possible values.
|
|
|
|
+
|
|
|
|
+----
|
|
|
|
+
|
|
.. _class_Area3D_property_audio_bus_name:
|
|
.. _class_Area3D_property_audio_bus_name:
|
|
|
|
|
|
- :ref:`StringName<class_StringName>` **audio_bus_name**
|
|
- :ref:`StringName<class_StringName>` **audio_bus_name**
|
|
@@ -278,23 +300,23 @@ If ``true``, the area's audio bus overrides the default audio bus.
|
|
| *Getter* | get_gravity() |
|
|
| *Getter* | get_gravity() |
|
|
+-----------+--------------------+
|
|
+-----------+--------------------+
|
|
|
|
|
|
-The area's gravity intensity (in meters per second squared). This value multiplies the gravity vector. This is useful to alter the force of gravity without altering its direction.
|
|
|
|
|
|
+The area's gravity intensity (in meters per second squared). This value multiplies the gravity direction. This is useful to alter the force of gravity without altering its direction.
|
|
|
|
|
|
----
|
|
----
|
|
|
|
|
|
-.. _class_Area3D_property_gravity_distance_scale:
|
|
|
|
|
|
+.. _class_Area3D_property_gravity_direction:
|
|
|
|
|
|
-- :ref:`float<class_float>` **gravity_distance_scale**
|
|
|
|
|
|
+- :ref:`Vector3<class_Vector3>` **gravity_direction**
|
|
|
|
|
|
-+-----------+-----------------------------------+
|
|
|
|
-| *Default* | ``0.0`` |
|
|
|
|
-+-----------+-----------------------------------+
|
|
|
|
-| *Setter* | set_gravity_distance_scale(value) |
|
|
|
|
-+-----------+-----------------------------------+
|
|
|
|
-| *Getter* | get_gravity_distance_scale() |
|
|
|
|
-+-----------+-----------------------------------+
|
|
|
|
|
|
++-----------+------------------------------+
|
|
|
|
+| *Default* | ``Vector3(0, -1, 0)`` |
|
|
|
|
++-----------+------------------------------+
|
|
|
|
+| *Setter* | set_gravity_direction(value) |
|
|
|
|
++-----------+------------------------------+
|
|
|
|
+| *Getter* | get_gravity_direction() |
|
|
|
|
++-----------+------------------------------+
|
|
|
|
|
|
-The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance.
|
|
|
|
|
|
+The area's gravity vector (not normalized).
|
|
|
|
|
|
----
|
|
----
|
|
|
|
|
|
@@ -310,23 +332,55 @@ The falloff factor for point gravity. The greater the value, the faster gravity
|
|
| *Getter* | is_gravity_a_point() |
|
|
| *Getter* | is_gravity_a_point() |
|
|
+-----------+-----------------------------+
|
|
+-----------+-----------------------------+
|
|
|
|
|
|
-If ``true``, gravity is calculated from a point (set via :ref:`gravity_vec<class_Area3D_property_gravity_vec>`). See also :ref:`space_override<class_Area3D_property_space_override>`.
|
|
|
|
|
|
+If ``true``, gravity is calculated from a point (set via :ref:`gravity_point_center<class_Area3D_property_gravity_point_center>`). See also :ref:`gravity_space_override<class_Area3D_property_gravity_space_override>`.
|
|
|
|
|
|
----
|
|
----
|
|
|
|
|
|
-.. _class_Area3D_property_gravity_vec:
|
|
|
|
|
|
+.. _class_Area3D_property_gravity_point_center:
|
|
|
|
|
|
-- :ref:`Vector3<class_Vector3>` **gravity_vec**
|
|
|
|
|
|
+- :ref:`Vector3<class_Vector3>` **gravity_point_center**
|
|
|
|
|
|
-+-----------+---------------------------+
|
|
|
|
-| *Default* | ``Vector3(0, -1, 0)`` |
|
|
|
|
-+-----------+---------------------------+
|
|
|
|
-| *Setter* | set_gravity_vector(value) |
|
|
|
|
-+-----------+---------------------------+
|
|
|
|
-| *Getter* | get_gravity_vector() |
|
|
|
|
-+-----------+---------------------------+
|
|
|
|
|
|
++-----------+---------------------------------+
|
|
|
|
+| *Default* | ``Vector3(0, -1, 0)`` |
|
|
|
|
++-----------+---------------------------------+
|
|
|
|
+| *Setter* | set_gravity_point_center(value) |
|
|
|
|
++-----------+---------------------------------+
|
|
|
|
+| *Getter* | get_gravity_point_center() |
|
|
|
|
++-----------+---------------------------------+
|
|
|
|
|
|
-The area's gravity vector (not normalized). If gravity is a point (see :ref:`gravity_point<class_Area3D_property_gravity_point>`), this will be the point of attraction.
|
|
|
|
|
|
+If gravity is a point (see :ref:`gravity_point<class_Area3D_property_gravity_point>`), this will be the point of attraction.
|
|
|
|
+
|
|
|
|
+----
|
|
|
|
+
|
|
|
|
+.. _class_Area3D_property_gravity_point_distance_scale:
|
|
|
|
+
|
|
|
|
+- :ref:`float<class_float>` **gravity_point_distance_scale**
|
|
|
|
+
|
|
|
|
++-----------+-----------------------------------------+
|
|
|
|
+| *Default* | ``0.0`` |
|
|
|
|
++-----------+-----------------------------------------+
|
|
|
|
+| *Setter* | set_gravity_point_distance_scale(value) |
|
|
|
|
++-----------+-----------------------------------------+
|
|
|
|
+| *Getter* | get_gravity_point_distance_scale() |
|
|
|
|
++-----------+-----------------------------------------+
|
|
|
|
+
|
|
|
|
+The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance.
|
|
|
|
+
|
|
|
|
+----
|
|
|
|
+
|
|
|
|
+.. _class_Area3D_property_gravity_space_override:
|
|
|
|
+
|
|
|
|
+- :ref:`SpaceOverride<enum_Area3D_SpaceOverride>` **gravity_space_override**
|
|
|
|
+
|
|
|
|
++-----------+----------------------------------------+
|
|
|
|
+| *Default* | ``0`` |
|
|
|
|
++-----------+----------------------------------------+
|
|
|
|
+| *Setter* | set_gravity_space_override_mode(value) |
|
|
|
|
++-----------+----------------------------------------+
|
|
|
|
+| *Getter* | get_gravity_space_override_mode() |
|
|
|
|
++-----------+----------------------------------------+
|
|
|
|
+
|
|
|
|
+Override mode for gravity calculations within this area. See :ref:`SpaceOverride<enum_Area3D_SpaceOverride>` for possible values.
|
|
|
|
|
|
----
|
|
----
|
|
|
|
|
|
@@ -348,6 +402,22 @@ See :ref:`ProjectSettings.physics/3d/default_linear_damp<class_ProjectSettings_p
|
|
|
|
|
|
----
|
|
----
|
|
|
|
|
|
|
|
+.. _class_Area3D_property_linear_damp_space_override:
|
|
|
|
+
|
|
|
|
+- :ref:`SpaceOverride<enum_Area3D_SpaceOverride>` **linear_damp_space_override**
|
|
|
|
+
|
|
|
|
++-----------+--------------------------------------------+
|
|
|
|
+| *Default* | ``0`` |
|
|
|
|
++-----------+--------------------------------------------+
|
|
|
|
+| *Setter* | set_linear_damp_space_override_mode(value) |
|
|
|
|
++-----------+--------------------------------------------+
|
|
|
|
+| *Getter* | get_linear_damp_space_override_mode() |
|
|
|
|
++-----------+--------------------------------------------+
|
|
|
|
+
|
|
|
|
+Override mode for linear damping calculations within this area. See :ref:`SpaceOverride<enum_Area3D_SpaceOverride>` for possible values.
|
|
|
|
+
|
|
|
|
+----
|
|
|
|
+
|
|
.. _class_Area3D_property_monitorable:
|
|
.. _class_Area3D_property_monitorable:
|
|
|
|
|
|
- :ref:`bool<class_bool>` **monitorable**
|
|
- :ref:`bool<class_bool>` **monitorable**
|
|
@@ -460,22 +530,6 @@ The degree to which this area's reverb is a uniform effect. Ranges from ``0`` to
|
|
|
|
|
|
----
|
|
----
|
|
|
|
|
|
-.. _class_Area3D_property_space_override:
|
|
|
|
-
|
|
|
|
-- :ref:`SpaceOverride<enum_Area3D_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_Area3D_SpaceOverride>` for possible values.
|
|
|
|
-
|
|
|
|
-----
|
|
|
|
-
|
|
|
|
.. _class_Area3D_property_wind_attenuation_factor:
|
|
.. _class_Area3D_property_wind_attenuation_factor:
|
|
|
|
|
|
- :ref:`float<class_float>` **wind_attenuation_factor**
|
|
- :ref:`float<class_float>` **wind_attenuation_factor**
|
|
@@ -529,7 +583,9 @@ Method Descriptions
|
|
|
|
|
|
- :ref:`Area3D[]<class_Area3D>` **get_overlapping_areas** **(** **)** |const|
|
|
- :ref:`Area3D[]<class_Area3D>` **get_overlapping_areas** **(** **)** |const|
|
|
|
|
|
|
-Returns a list of intersecting ``Area3D``\ 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.
|
|
|
|
|
|
+Returns a list of intersecting ``Area3D``\ s. The overlapping area's :ref:`CollisionObject3D.collision_layer<class_CollisionObject3D_property_collision_layer>` must be part of this area's :ref:`CollisionObject3D.collision_mask<class_CollisionObject3D_property_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.
|
|
|
|
|
|
----
|
|
----
|
|
|
|
|
|
@@ -537,7 +593,9 @@ Returns a list of intersecting ``Area3D``\ s. For performance reasons (collision
|
|
|
|
|
|
- :ref:`Node3D[]<class_Node3D>` **get_overlapping_bodies** **(** **)** |const|
|
|
- :ref:`Node3D[]<class_Node3D>` **get_overlapping_bodies** **(** **)** |const|
|
|
|
|
|
|
-Returns a list of intersecting :ref:`PhysicsBody3D<class_PhysicsBody3D>`\ 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.
|
|
|
|
|
|
+Returns a list of intersecting :ref:`PhysicsBody3D<class_PhysicsBody3D>`\ s. The overlapping body's :ref:`CollisionObject3D.collision_layer<class_CollisionObject3D_property_collision_layer>` must be part of this area's :ref:`CollisionObject3D.collision_mask<class_CollisionObject3D_property_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.
|
|
|
|
|
|
----
|
|
----
|
|
|
|
|