mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-05 22:09:56 +03:00
141 lines
6.5 KiB
ReStructuredText
141 lines
6.5 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the PhysicsPointQueryParameters2D.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_PhysicsPointQueryParameters2D:
|
|
|
|
PhysicsPointQueryParameters2D
|
|
=============================
|
|
|
|
**Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
|
|
|
|
Parameters to be sent to a 2D point physics query.
|
|
|
|
Description
|
|
-----------
|
|
|
|
This class contains the position and other parameters to be used for :ref:`PhysicsDirectSpaceState2D.intersect_point<class_PhysicsDirectSpaceState2D_method_intersect_point>`.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+-------------------------------+----------------------------------------------------------------------------------------------+-------------------+
|
|
| :ref:`int<class_int>` | :ref:`canvas_instance_id<class_PhysicsPointQueryParameters2D_property_canvas_instance_id>` | ``0`` |
|
|
+-------------------------------+----------------------------------------------------------------------------------------------+-------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`collide_with_areas<class_PhysicsPointQueryParameters2D_property_collide_with_areas>` | ``false`` |
|
|
+-------------------------------+----------------------------------------------------------------------------------------------+-------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`collide_with_bodies<class_PhysicsPointQueryParameters2D_property_collide_with_bodies>` | ``true`` |
|
|
+-------------------------------+----------------------------------------------------------------------------------------------+-------------------+
|
|
| :ref:`int<class_int>` | :ref:`collision_mask<class_PhysicsPointQueryParameters2D_property_collision_mask>` | ``4294967295`` |
|
|
+-------------------------------+----------------------------------------------------------------------------------------------+-------------------+
|
|
| :ref:`Array<class_Array>` | :ref:`exclude<class_PhysicsPointQueryParameters2D_property_exclude>` | ``[]`` |
|
|
+-------------------------------+----------------------------------------------------------------------------------------------+-------------------+
|
|
| :ref:`Vector2<class_Vector2>` | :ref:`position<class_PhysicsPointQueryParameters2D_property_position>` | ``Vector2(0, 0)`` |
|
|
+-------------------------------+----------------------------------------------------------------------------------------------+-------------------+
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_PhysicsPointQueryParameters2D_property_canvas_instance_id:
|
|
|
|
- :ref:`int<class_int>` **canvas_instance_id**
|
|
|
|
+-----------+-------------------------------+
|
|
| *Default* | ``0`` |
|
|
+-----------+-------------------------------+
|
|
| *Setter* | set_canvas_instance_id(value) |
|
|
+-----------+-------------------------------+
|
|
| *Getter* | get_canvas_instance_id() |
|
|
+-----------+-------------------------------+
|
|
|
|
If different from ``0``, restricts the query to a specific canvas layer specified by its instance id. See :ref:`Object.get_instance_id<class_Object_method_get_instance_id>`.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsPointQueryParameters2D_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_PhysicsPointQueryParameters2D_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_PhysicsPointQueryParameters2D_property_collision_mask:
|
|
|
|
- :ref:`int<class_int>` **collision_mask**
|
|
|
|
+-----------+---------------------------+
|
|
| *Default* | ``4294967295`` |
|
|
+-----------+---------------------------+
|
|
| *Setter* | set_collision_mask(value) |
|
|
+-----------+---------------------------+
|
|
| *Getter* | 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.
|
|
|
|
----
|
|
|
|
.. _class_PhysicsPointQueryParameters2D_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_PhysicsPointQueryParameters2D_property_position:
|
|
|
|
- :ref:`Vector2<class_Vector2>` **position**
|
|
|
|
+-----------+---------------------+
|
|
| *Default* | ``Vector2(0, 0)`` |
|
|
+-----------+---------------------+
|
|
| *Setter* | set_position(value) |
|
|
+-----------+---------------------+
|
|
| *Getter* | get_position() |
|
|
+-----------+---------------------+
|
|
|
|
The position being queried for, in global coordinates.
|
|
|
|
.. |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.)`
|
|
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|
|
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|