mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
161 lines
6.8 KiB
ReStructuredText
161 lines
6.8 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/4.0/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/4.0/doc/classes/PhysicsPointQueryParameters2D.xml.
|
|
|
|
.. _class_PhysicsPointQueryParameters2D:
|
|
|
|
PhysicsPointQueryParameters2D
|
|
=============================
|
|
|
|
**Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
|
|
|
|
Parameters to be sent to a 2D point physics query.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Description
|
|
-----------
|
|
|
|
This class contains the position and other parameters to be used for :ref:`PhysicsDirectSpaceState2D.intersect_point<class_PhysicsDirectSpaceState2D_method_intersect_point>`.
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Properties
|
|
----------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+-------------------------------+----------------------------------------------------------------------------------------------+-------------------+
|
|
| :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:`RID[]<class_RID>` | :ref:`exclude<class_PhysicsPointQueryParameters2D_property_exclude>` | ``[]`` |
|
|
+-------------------------------+----------------------------------------------------------------------------------------------+-------------------+
|
|
| :ref:`Vector2<class_Vector2>` | :ref:`position<class_PhysicsPointQueryParameters2D_property_position>` | ``Vector2(0, 0)`` |
|
|
+-------------------------------+----------------------------------------------------------------------------------------------+-------------------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_PhysicsPointQueryParameters2D_property_canvas_instance_id:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **canvas_instance_id** = ``0``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_canvas_instance_id** **(** :ref:`int<class_int>` value **)**
|
|
- :ref:`int<class_int>` **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>`.
|
|
|
|
If ``0``, restricts the query to the Viewport's default canvas layer.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_PhysicsPointQueryParameters2D_property_collide_with_areas:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
: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_PhysicsPointQueryParameters2D_property_collide_with_bodies:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
: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_PhysicsPointQueryParameters2D_property_collision_mask:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
: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_PhysicsPointQueryParameters2D_property_exclude:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`RID[]<class_RID>` **exclude** = ``[]``
|
|
|
|
.. 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_PhysicsPointQueryParameters2D_property_position:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`Vector2<class_Vector2>` **position** = ``Vector2(0, 0)``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_position** **(** :ref:`Vector2<class_Vector2>` value **)**
|
|
- :ref:`Vector2<class_Vector2>` **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.)`
|