mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-05 22:09:56 +03:00
186 lines
7.7 KiB
ReStructuredText
186 lines
7.7 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the Physics2DShapeQueryParameters.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_Physics2DShapeQueryParameters:
|
|
|
|
Physics2DShapeQueryParameters
|
|
=============================
|
|
|
|
**Inherits:** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
Parameters to be sent to a 2D shape physics query.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+---------------------------------------+----------------------------------------------------------------------------------------------+---------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`collide_with_areas<class_Physics2DShapeQueryParameters_property_collide_with_areas>` | false |
|
|
+---------------------------------------+----------------------------------------------------------------------------------------------+---------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`collide_with_bodies<class_Physics2DShapeQueryParameters_property_collide_with_bodies>` | true |
|
|
+---------------------------------------+----------------------------------------------------------------------------------------------+---------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`collision_layer<class_Physics2DShapeQueryParameters_property_collision_layer>` | 2147483647 |
|
|
+---------------------------------------+----------------------------------------------------------------------------------------------+---------------------------------+
|
|
| :ref:`Array<class_Array>` | :ref:`exclude<class_Physics2DShapeQueryParameters_property_exclude>` | [ ] |
|
|
+---------------------------------------+----------------------------------------------------------------------------------------------+---------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`margin<class_Physics2DShapeQueryParameters_property_margin>` | 0.0 |
|
|
+---------------------------------------+----------------------------------------------------------------------------------------------+---------------------------------+
|
|
| :ref:`Vector2<class_Vector2>` | :ref:`motion<class_Physics2DShapeQueryParameters_property_motion>` | Vector2( 0, 0 ) |
|
|
+---------------------------------------+----------------------------------------------------------------------------------------------+---------------------------------+
|
|
| :ref:`RID<class_RID>` | :ref:`shape_rid<class_Physics2DShapeQueryParameters_property_shape_rid>` | |
|
|
+---------------------------------------+----------------------------------------------------------------------------------------------+---------------------------------+
|
|
| :ref:`Transform2D<class_Transform2D>` | :ref:`transform<class_Physics2DShapeQueryParameters_property_transform>` | Transform2D( 1, 0, 0, 1, 0, 0 ) |
|
|
+---------------------------------------+----------------------------------------------------------------------------------------------+---------------------------------+
|
|
|
|
Methods
|
|
-------
|
|
|
|
+------+--------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_shape<class_Physics2DShapeQueryParameters_method_set_shape>` **(** :ref:`Resource<class_Resource>` shape **)** |
|
|
+------+--------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Description
|
|
-----------
|
|
|
|
This class contains the shape and other parameters for intersection/collision queries.
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_Physics2DShapeQueryParameters_property_collide_with_areas:
|
|
|
|
- :ref:`bool<class_bool>` **collide_with_areas**
|
|
|
|
+-----------+---------------------------------+
|
|
| *Default* | false |
|
|
+-----------+---------------------------------+
|
|
| *Setter* | set_collide_with_areas(value) |
|
|
+-----------+---------------------------------+
|
|
| *Getter* | is_collide_with_areas_enabled() |
|
|
+-----------+---------------------------------+
|
|
|
|
----
|
|
|
|
.. _class_Physics2DShapeQueryParameters_property_collide_with_bodies:
|
|
|
|
- :ref:`bool<class_bool>` **collide_with_bodies**
|
|
|
|
+-----------+----------------------------------+
|
|
| *Default* | true |
|
|
+-----------+----------------------------------+
|
|
| *Setter* | set_collide_with_bodies(value) |
|
|
+-----------+----------------------------------+
|
|
| *Getter* | is_collide_with_bodies_enabled() |
|
|
+-----------+----------------------------------+
|
|
|
|
----
|
|
|
|
.. _class_Physics2DShapeQueryParameters_property_collision_layer:
|
|
|
|
- :ref:`int<class_int>` **collision_layer**
|
|
|
|
+-----------+----------------------------+
|
|
| *Default* | 2147483647 |
|
|
+-----------+----------------------------+
|
|
| *Setter* | set_collision_layer(value) |
|
|
+-----------+----------------------------+
|
|
| *Getter* | get_collision_layer() |
|
|
+-----------+----------------------------+
|
|
|
|
The physics layer the query should be made on.
|
|
|
|
----
|
|
|
|
.. _class_Physics2DShapeQueryParameters_property_exclude:
|
|
|
|
- :ref:`Array<class_Array>` **exclude**
|
|
|
|
+-----------+--------------------+
|
|
| *Default* | [ ] |
|
|
+-----------+--------------------+
|
|
| *Setter* | set_exclude(value) |
|
|
+-----------+--------------------+
|
|
| *Getter* | get_exclude() |
|
|
+-----------+--------------------+
|
|
|
|
The list of objects or object :ref:`RID<class_RID>`\ s, that will be excluded from collisions.
|
|
|
|
----
|
|
|
|
.. _class_Physics2DShapeQueryParameters_property_margin:
|
|
|
|
- :ref:`float<class_float>` **margin**
|
|
|
|
+-----------+-------------------+
|
|
| *Default* | 0.0 |
|
|
+-----------+-------------------+
|
|
| *Setter* | set_margin(value) |
|
|
+-----------+-------------------+
|
|
| *Getter* | get_margin() |
|
|
+-----------+-------------------+
|
|
|
|
The collision margin for the shape.
|
|
|
|
----
|
|
|
|
.. _class_Physics2DShapeQueryParameters_property_motion:
|
|
|
|
- :ref:`Vector2<class_Vector2>` **motion**
|
|
|
|
+-----------+-------------------+
|
|
| *Default* | Vector2( 0, 0 ) |
|
|
+-----------+-------------------+
|
|
| *Setter* | set_motion(value) |
|
|
+-----------+-------------------+
|
|
| *Getter* | get_motion() |
|
|
+-----------+-------------------+
|
|
|
|
The motion of the shape being queried for.
|
|
|
|
----
|
|
|
|
.. _class_Physics2DShapeQueryParameters_property_shape_rid:
|
|
|
|
- :ref:`RID<class_RID>` **shape_rid**
|
|
|
|
+----------+----------------------+
|
|
| *Setter* | set_shape_rid(value) |
|
|
+----------+----------------------+
|
|
| *Getter* | get_shape_rid() |
|
|
+----------+----------------------+
|
|
|
|
The :ref:`RID<class_RID>` of the queried shape. See also :ref:`set_shape<class_Physics2DShapeQueryParameters_method_set_shape>`.
|
|
|
|
----
|
|
|
|
.. _class_Physics2DShapeQueryParameters_property_transform:
|
|
|
|
- :ref:`Transform2D<class_Transform2D>` **transform**
|
|
|
|
+-----------+---------------------------------+
|
|
| *Default* | Transform2D( 1, 0, 0, 1, 0, 0 ) |
|
|
+-----------+---------------------------------+
|
|
| *Setter* | set_transform(value) |
|
|
+-----------+---------------------------------+
|
|
| *Getter* | get_transform() |
|
|
+-----------+---------------------------------+
|
|
|
|
the transform matrix of the queried shape.
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_Physics2DShapeQueryParameters_method_set_shape:
|
|
|
|
- void **set_shape** **(** :ref:`Resource<class_Resource>` shape **)**
|
|
|
|
Sets the :ref:`Shape2D<class_Shape2D>` that will be used for collision/intersection queries.
|
|
|