mirror of
https://github.com/Relintai/pandemonium_engine_docs.git
synced 2025-01-23 15:17:21 +01:00
189 lines
8.4 KiB
ReStructuredText
189 lines
8.4 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Physics2DShapeQueryParameters.xml.
|
|
|
|
.. _class_Physics2DShapeQueryParameters:
|
|
|
|
Physics2DShapeQueryParameters
|
|
=============================
|
|
|
|
**Inherits:** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
|
|
|
Parameters to be sent to a 2D shape physics query.
|
|
|
|
Description
|
|
-----------
|
|
|
|
This class contains the shape and other parameters for 2D intersection/collision queries.
|
|
|
|
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 **)** |
|
|
+------+--------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
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() |
|
|
+-----------+---------------------------------+
|
|
|
|
If ``true``, the query will take :ref:`Area2D<class_Area2D>`\ s into account.
|
|
|
|
----
|
|
|
|
.. _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() |
|
|
+-----------+----------------------------------+
|
|
|
|
If ``true``, the query will take :ref:`PhysicsBody2D<class_PhysicsBody2D>`\ s into account.
|
|
|
|
----
|
|
|
|
.. _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(s) the query will take into account (as a bitmask). See `Collision layers and masks <../tutorials/physics/physics_introduction.html#collision-layers-and-masks>`__ in the documentation for more information.
|
|
|
|
----
|
|
|
|
.. _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 queried shape's :ref:`RID<class_RID>`. 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 queried shape's transform matrix.
|
|
|
|
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.
|
|
|
|
.. |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.)`
|