stan220/godot-docs
1
0
Fork 0
mirror of https://github.com/stan220/godot-docs.git synced 2026-09-08 17:28:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (f87858a8f)

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files
classes/class_physicsshapequeryparameters2d.rst
+112 -88
View File
@@ -14,156 +14,179 @@ PhysicsShapeQueryParameters2D
Parameters to be sent to a 2D shape physics query.
.. rst-class:: classref-introduction-group
Description
-----------
This class contains the shape and other parameters for :ref:`PhysicsDirectSpaceState2D<class_PhysicsDirectSpaceState2D>` intersection/collision queries.
.. rst-class:: classref-reftable-group
Properties
----------
+---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`bool<class_bool>` | :ref:`collide_with_areas<class_PhysicsShapeQueryParameters2D_property_collide_with_areas>` | ``false`` |
+---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`bool<class_bool>` | :ref:`collide_with_bodies<class_PhysicsShapeQueryParameters2D_property_collide_with_bodies>` | ``true`` |
+---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`int<class_int>` | :ref:`collision_mask<class_PhysicsShapeQueryParameters2D_property_collision_mask>` | ``4294967295`` |
+---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`RID[]<class_RID>` | :ref:`exclude<class_PhysicsShapeQueryParameters2D_property_exclude>` | ``[]`` |
+---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`float<class_float>` | :ref:`margin<class_PhysicsShapeQueryParameters2D_property_margin>` | ``0.0`` |
+---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`motion<class_PhysicsShapeQueryParameters2D_property_motion>` | ``Vector2(0, 0)`` |
+---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`Resource<class_Resource>` | :ref:`shape<class_PhysicsShapeQueryParameters2D_property_shape>` | |
+---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`RID<class_RID>` | :ref:`shape_rid<class_PhysicsShapeQueryParameters2D_property_shape_rid>` | |
+---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`Transform2D<class_Transform2D>` | :ref:`transform<class_PhysicsShapeQueryParameters2D_property_transform>` | ``Transform2D(1, 0, 0, 1, 0, 0)`` |
+---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+
.. table::
:widths: auto
+---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`bool<class_bool>` | :ref:`collide_with_areas<class_PhysicsShapeQueryParameters2D_property_collide_with_areas>` | ``false`` |
+---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`bool<class_bool>` | :ref:`collide_with_bodies<class_PhysicsShapeQueryParameters2D_property_collide_with_bodies>` | ``true`` |
+---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`int<class_int>` | :ref:`collision_mask<class_PhysicsShapeQueryParameters2D_property_collision_mask>` | ``4294967295`` |
+---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`RID[]<class_RID>` | :ref:`exclude<class_PhysicsShapeQueryParameters2D_property_exclude>` | ``[]`` |
+---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`float<class_float>` | :ref:`margin<class_PhysicsShapeQueryParameters2D_property_margin>` | ``0.0`` |
+---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`motion<class_PhysicsShapeQueryParameters2D_property_motion>` | ``Vector2(0, 0)`` |
+---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`Resource<class_Resource>` | :ref:`shape<class_PhysicsShapeQueryParameters2D_property_shape>` | |
+---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`RID<class_RID>` | :ref:`shape_rid<class_PhysicsShapeQueryParameters2D_property_shape_rid>` | |
+---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`Transform2D<class_Transform2D>` | :ref:`transform<class_PhysicsShapeQueryParameters2D_property_transform>` | ``Transform2D(1, 0, 0, 1, 0, 0)`` |
+---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_PhysicsShapeQueryParameters2D_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:`Area2D<class_Area2D>`\ s into account.
.. rst-class:: classref-item-separator
----
.. _class_PhysicsShapeQueryParameters2D_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:`PhysicsBody2D<class_PhysicsBody2D>`\ s into account.
.. rst-class:: classref-item-separator
----
.. _class_PhysicsShapeQueryParameters2D_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_PhysicsShapeQueryParameters2D_property_exclude:
- :ref:`RID[]<class_RID>` **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:`CollisionObject2D.get_rid<class_CollisionObject2D_method_get_rid>` to get the :ref:`RID<class_RID>` associated with a :ref:`CollisionObject2D<class_CollisionObject2D>`-derived node.
.. rst-class:: classref-item-separator
----
.. _class_PhysicsShapeQueryParameters2D_property_margin:
- :ref:`float<class_float>` **margin**
.. rst-class:: classref-property
+-----------+-------------------+
| *Default* | ``0.0`` |
+-----------+-------------------+
| *Setter* | set_margin(value) |
+-----------+-------------------+
| *Getter* | get_margin() |
+-----------+-------------------+
:ref:`float<class_float>` **margin** = ``0.0``
.. rst-class:: classref-property-setget
- void **set_margin** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_margin** **(** **)**
The collision margin for the shape.
.. rst-class:: classref-item-separator
----
.. _class_PhysicsShapeQueryParameters2D_property_motion:
- :ref:`Vector2<class_Vector2>` **motion**
.. rst-class:: classref-property
+-----------+-------------------+
| *Default* | ``Vector2(0, 0)`` |
+-----------+-------------------+
| *Setter* | set_motion(value) |
+-----------+-------------------+
| *Getter* | get_motion() |
+-----------+-------------------+
:ref:`Vector2<class_Vector2>` **motion** = ``Vector2(0, 0)``
.. rst-class:: classref-property-setget
- void **set_motion** **(** :ref:`Vector2<class_Vector2>` value **)**
- :ref:`Vector2<class_Vector2>` **get_motion** **(** **)**
The motion of the shape being queried for.
.. rst-class:: classref-item-separator
----
.. _class_PhysicsShapeQueryParameters2D_property_shape:
- :ref:`Resource<class_Resource>` **shape**
.. rst-class:: classref-property
+----------+------------------+
| *Setter* | set_shape(value) |
+----------+------------------+
| *Getter* | get_shape() |
+----------+------------------+
:ref:`Resource<class_Resource>` **shape**
.. rst-class:: classref-property-setget
- void **set_shape** **(** :ref:`Resource<class_Resource>` value **)**
- :ref:`Resource<class_Resource>` **get_shape** **(** **)**
The :ref:`Shape2D<class_Shape2D>` that will be used for collision/intersection queries. This stores the actual reference which avoids the shape to be released while being used for queries, so always prefer using this over :ref:`shape_rid<class_PhysicsShapeQueryParameters2D_property_shape_rid>`.
.. rst-class:: classref-item-separator
----
.. _class_PhysicsShapeQueryParameters2D_property_shape_rid:
- :ref:`RID<class_RID>` **shape_rid**
.. rst-class:: classref-property
+----------+----------------------+
| *Setter* | set_shape_rid(value) |
+----------+----------------------+
| *Getter* | get_shape_rid() |
+----------+----------------------+
:ref:`RID<class_RID>` **shape_rid**
.. rst-class:: classref-property-setget
- void **set_shape_rid** **(** :ref:`RID<class_RID>` value **)**
- :ref:`RID<class_RID>` **get_shape_rid** **(** **)**
The queried shape's :ref:`RID<class_RID>` that will be used for collision/intersection queries. Use this over :ref:`shape<class_PhysicsShapeQueryParameters2D_property_shape>` if you want to optimize for performance using the Servers API:
@@ -200,19 +223,20 @@ The queried shape's :ref:`RID<class_RID>` that will be used for collision/inters
.. rst-class:: classref-item-separator
----
.. _class_PhysicsShapeQueryParameters2D_property_transform:
- :ref:`Transform2D<class_Transform2D>` **transform**
.. rst-class:: classref-property
+-----------+-----------------------------------+
| *Default* | ``Transform2D(1, 0, 0, 1, 0, 0)`` |
+-----------+-----------------------------------+
| *Setter* | set_transform(value) |
+-----------+-----------------------------------+
| *Getter* | get_transform() |
+-----------+-----------------------------------+
:ref:`Transform2D<class_Transform2D>` **transform** = ``Transform2D(1, 0, 0, 1, 0, 0)``
.. rst-class:: classref-property-setget
- void **set_transform** **(** :ref:`Transform2D<class_Transform2D>` value **)**
- :ref:`Transform2D<class_Transform2D>` **get_transform** **(** **)**
The queried shape's transform matrix.