classref: Sync with current master branch (f87858a8f)

This commit is contained in:
Yuri Sizov
2022-12-05 20:38:58 +03:00
parent 913ff5e602
commit a7745c4cc4
843 changed files with 158186 additions and 80821 deletions

View File

@@ -14,104 +14,120 @@ PhysicsPointQueryParameters3D
Parameters to be sent to a 3D point physics query.
.. rst-class:: classref-introduction-group
Description
-----------
This class contains the position and other parameters to be used for :ref:`PhysicsDirectSpaceState3D.intersect_point<class_PhysicsDirectSpaceState3D_method_intersect_point>`.
.. rst-class:: classref-reftable-group
Properties
----------
+-------------------------------+----------------------------------------------------------------------------------------------+----------------------+
| :ref:`bool<class_bool>` | :ref:`collide_with_areas<class_PhysicsPointQueryParameters3D_property_collide_with_areas>` | ``false`` |
+-------------------------------+----------------------------------------------------------------------------------------------+----------------------+
| :ref:`bool<class_bool>` | :ref:`collide_with_bodies<class_PhysicsPointQueryParameters3D_property_collide_with_bodies>` | ``true`` |
+-------------------------------+----------------------------------------------------------------------------------------------+----------------------+
| :ref:`int<class_int>` | :ref:`collision_mask<class_PhysicsPointQueryParameters3D_property_collision_mask>` | ``4294967295`` |
+-------------------------------+----------------------------------------------------------------------------------------------+----------------------+
| :ref:`Array<class_Array>` | :ref:`exclude<class_PhysicsPointQueryParameters3D_property_exclude>` | ``[]`` |
+-------------------------------+----------------------------------------------------------------------------------------------+----------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`position<class_PhysicsPointQueryParameters3D_property_position>` | ``Vector3(0, 0, 0)`` |
+-------------------------------+----------------------------------------------------------------------------------------------+----------------------+
.. table::
:widths: auto
+-------------------------------+----------------------------------------------------------------------------------------------+----------------------+
| :ref:`bool<class_bool>` | :ref:`collide_with_areas<class_PhysicsPointQueryParameters3D_property_collide_with_areas>` | ``false`` |
+-------------------------------+----------------------------------------------------------------------------------------------+----------------------+
| :ref:`bool<class_bool>` | :ref:`collide_with_bodies<class_PhysicsPointQueryParameters3D_property_collide_with_bodies>` | ``true`` |
+-------------------------------+----------------------------------------------------------------------------------------------+----------------------+
| :ref:`int<class_int>` | :ref:`collision_mask<class_PhysicsPointQueryParameters3D_property_collision_mask>` | ``4294967295`` |
+-------------------------------+----------------------------------------------------------------------------------------------+----------------------+
| :ref:`RID[]<class_RID>` | :ref:`exclude<class_PhysicsPointQueryParameters3D_property_exclude>` | ``[]`` |
+-------------------------------+----------------------------------------------------------------------------------------------+----------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`position<class_PhysicsPointQueryParameters3D_property_position>` | ``Vector3(0, 0, 0)`` |
+-------------------------------+----------------------------------------------------------------------------------------------+----------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_PhysicsPointQueryParameters3D_property_collide_with_areas:
- :ref:`bool<class_bool>` **collide_with_areas**
.. rst-class:: classref-property
+-----------+---------------------------------+
| *Default* | ``false`` |
+-----------+---------------------------------+
| *Setter* | set_collide_with_areas(value) |
+-----------+---------------------------------+
| *Getter* | is_collide_with_areas_enabled() |
+-----------+---------------------------------+
:ref:`bool<class_bool>` **collide_with_areas** = ``false``
.. rst-class:: classref-property-setget
- void **set_collide_with_areas** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_collide_with_areas_enabled** **(** **)**
If ``true``, the query will take :ref:`Area3D<class_Area3D>`\ s into account.
.. rst-class:: classref-item-separator
----
.. _class_PhysicsPointQueryParameters3D_property_collide_with_bodies:
- :ref:`bool<class_bool>` **collide_with_bodies**
.. rst-class:: classref-property
+-----------+----------------------------------+
| *Default* | ``true`` |
+-----------+----------------------------------+
| *Setter* | set_collide_with_bodies(value) |
+-----------+----------------------------------+
| *Getter* | is_collide_with_bodies_enabled() |
+-----------+----------------------------------+
:ref:`bool<class_bool>` **collide_with_bodies** = ``true``
.. rst-class:: classref-property-setget
- void **set_collide_with_bodies** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_collide_with_bodies_enabled** **(** **)**
If ``true``, the query will take :ref:`PhysicsBody3D<class_PhysicsBody3D>`\ s into account.
.. rst-class:: classref-item-separator
----
.. _class_PhysicsPointQueryParameters3D_property_collision_mask:
- :ref:`int<class_int>` **collision_mask**
.. rst-class:: classref-property
+-----------+---------------------------+
| *Default* | ``4294967295`` |
+-----------+---------------------------+
| *Setter* | set_collision_mask(value) |
+-----------+---------------------------+
| *Getter* | get_collision_mask() |
+-----------+---------------------------+
:ref:`int<class_int>` **collision_mask** = ``4294967295``
.. rst-class:: classref-property-setget
- void **set_collision_mask** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_collision_mask** **(** **)**
The physics layers the query will detect (as a bitmask). By default, all collision layers are detected. See `Collision layers and masks <../tutorials/physics/physics_introduction.html#collision-layers-and-masks>`__ in the documentation for more information.
.. rst-class:: classref-item-separator
----
.. _class_PhysicsPointQueryParameters3D_property_exclude:
- :ref:`Array<class_Array>` **exclude**
.. rst-class:: classref-property
+-----------+--------------------+
| *Default* | ``[]`` |
+-----------+--------------------+
| *Setter* | set_exclude(value) |
+-----------+--------------------+
| *Getter* | get_exclude() |
+-----------+--------------------+
:ref:`RID[]<class_RID>` **exclude** = ``[]``
The list of objects or object :ref:`RID<class_RID>`\ s that will be excluded from collisions.
.. rst-class:: classref-property-setget
- void **set_exclude** **(** :ref:`RID[]<class_RID>` value **)**
- :ref:`RID[]<class_RID>` **get_exclude** **(** **)**
The list of object :ref:`RID<class_RID>`\ s that will be excluded from collisions. Use :ref:`CollisionObject3D.get_rid<class_CollisionObject3D_method_get_rid>` to get the :ref:`RID<class_RID>` associated with a :ref:`CollisionObject3D<class_CollisionObject3D>`-derived node.
.. rst-class:: classref-item-separator
----
.. _class_PhysicsPointQueryParameters3D_property_position:
- :ref:`Vector3<class_Vector3>` **position**
.. rst-class:: classref-property
+-----------+----------------------+
| *Default* | ``Vector3(0, 0, 0)`` |
+-----------+----------------------+
| *Setter* | set_position(value) |
+-----------+----------------------+
| *Getter* | get_position() |
+-----------+----------------------+
:ref:`Vector3<class_Vector3>` **position** = ``Vector3(0, 0, 0)``
.. rst-class:: classref-property-setget
- void **set_position** **(** :ref:`Vector3<class_Vector3>` value **)**
- :ref:`Vector3<class_Vector3>` **get_position** **(** **)**
The position being queried for, in global coordinates.