:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/4.1/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/4.1/doc/classes/PhysicsShapeQueryParameters2D.xml. .. _class_PhysicsShapeQueryParameters2D: PhysicsShapeQueryParameters2D ============================= **Inherits:** :ref:`RefCounted` **<** :ref:`Object` Provides parameters for :ref:`PhysicsDirectSpaceState2D.intersect_shape`. .. rst-class:: classref-introduction-group Description ----------- By changing various properties of this object, such as the shape, you can configure the parameters for :ref:`PhysicsDirectSpaceState2D.intersect_shape`. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`bool` | :ref:`collide_with_areas` | ``false`` | +---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`bool` | :ref:`collide_with_bodies` | ``true`` | +---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`int` | :ref:`collision_mask` | ``4294967295`` | +---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`RID[]` | :ref:`exclude` | ``[]`` | +---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`float` | :ref:`margin` | ``0.0`` | +---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`Vector2` | :ref:`motion` | ``Vector2(0, 0)`` | +---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`Resource` | :ref:`shape` | | +---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`RID` | :ref:`shape_rid` | ``RID()`` | +---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`Transform2D` | :ref:`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: .. rst-class:: classref-property :ref:`bool` **collide_with_areas** = ``false`` .. rst-class:: classref-property-setget - void **set_collide_with_areas** **(** :ref:`bool` value **)** - :ref:`bool` **is_collide_with_areas_enabled** **(** **)** If ``true``, the query will take :ref:`Area2D`\ s into account. .. rst-class:: classref-item-separator ---- .. _class_PhysicsShapeQueryParameters2D_property_collide_with_bodies: .. rst-class:: classref-property :ref:`bool` **collide_with_bodies** = ``true`` .. rst-class:: classref-property-setget - void **set_collide_with_bodies** **(** :ref:`bool` value **)** - :ref:`bool` **is_collide_with_bodies_enabled** **(** **)** If ``true``, the query will take :ref:`PhysicsBody2D`\ s into account. .. rst-class:: classref-item-separator ---- .. _class_PhysicsShapeQueryParameters2D_property_collision_mask: .. rst-class:: classref-property :ref:`int` **collision_mask** = ``4294967295`` .. rst-class:: classref-property-setget - void **set_collision_mask** **(** :ref:`int` value **)** - :ref:`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: .. rst-class:: classref-property :ref:`RID[]` **exclude** = ``[]`` .. rst-class:: classref-property-setget - void **set_exclude** **(** :ref:`RID[]` value **)** - :ref:`RID[]` **get_exclude** **(** **)** The list of object :ref:`RID`\ s that will be excluded from collisions. Use :ref:`CollisionObject2D.get_rid` to get the :ref:`RID` associated with a :ref:`CollisionObject2D`-derived node. .. rst-class:: classref-item-separator ---- .. _class_PhysicsShapeQueryParameters2D_property_margin: .. rst-class:: classref-property :ref:`float` **margin** = ``0.0`` .. rst-class:: classref-property-setget - void **set_margin** **(** :ref:`float` value **)** - :ref:`float` **get_margin** **(** **)** The collision margin for the shape. .. rst-class:: classref-item-separator ---- .. _class_PhysicsShapeQueryParameters2D_property_motion: .. rst-class:: classref-property :ref:`Vector2` **motion** = ``Vector2(0, 0)`` .. rst-class:: classref-property-setget - void **set_motion** **(** :ref:`Vector2` value **)** - :ref:`Vector2` **get_motion** **(** **)** The motion of the shape being queried for. .. rst-class:: classref-item-separator ---- .. _class_PhysicsShapeQueryParameters2D_property_shape: .. rst-class:: classref-property :ref:`Resource` **shape** .. rst-class:: classref-property-setget - void **set_shape** **(** :ref:`Resource` value **)** - :ref:`Resource` **get_shape** **(** **)** The :ref:`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`. .. rst-class:: classref-item-separator ---- .. _class_PhysicsShapeQueryParameters2D_property_shape_rid: .. rst-class:: classref-property :ref:`RID` **shape_rid** = ``RID()`` .. rst-class:: classref-property-setget - void **set_shape_rid** **(** :ref:`RID` value **)** - :ref:`RID` **get_shape_rid** **(** **)** The queried shape's :ref:`RID` that will be used for collision/intersection queries. Use this over :ref:`shape` if you want to optimize for performance using the Servers API: .. tabs:: .. code-tab:: gdscript var shape_rid = PhysicsServer2D.circle_shape_create() var radius = 64 PhysicsServer2D.shape_set_data(shape_rid, radius) var params = PhysicsShapeQueryParameters2D.new() params.shape_rid = shape_rid # Execute physics queries here... # Release the shape when done with physics queries. PhysicsServer2D.free_rid(shape_rid) .. code-tab:: csharp RID shapeRid = PhysicsServer2D.CircleShapeCreate(); int radius = 64; PhysicsServer2D.ShapeSetData(shapeRid, radius); var params = new PhysicsShapeQueryParameters2D(); params.ShapeRid = shapeRid; // Execute physics queries here... // Release the shape when done with physics queries. PhysicsServer2D.FreeRid(shapeRid); .. rst-class:: classref-item-separator ---- .. _class_PhysicsShapeQueryParameters2D_property_transform: .. rst-class:: classref-property :ref:`Transform2D` **transform** = ``Transform2D(1, 0, 0, 1, 0, 0)`` .. rst-class:: classref-property-setget - void **set_transform** **(** :ref:`Transform2D` value **)** - :ref:`Transform2D` **get_transform** **(** **)** The queried shape's transform matrix. .. |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.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`