2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2021-03-23 12:40:34 +00:00
<class name= "Physics2DShapeQueryParameters" inherits= "Reference" version= "3.3" >
2017-09-12 20:42:36 +00:00
<brief_description >
Parameters to be sent to a 2D shape physics query.
</brief_description>
<description >
2019-12-09 14:16:28 +00:00
This class contains the shape and other parameters for 2D intersection/collision queries. See also [Physics2DShapeQueryResult].
2017-09-12 20:42:36 +00:00
</description>
<tutorials >
</tutorials>
<methods >
<method name= "set_shape" >
<return type= "void" >
</return>
<argument index= "0" name= "shape" type= "Resource" >
</argument>
<description >
2019-06-21 23:04:47 +00:00
Sets the [Shape2D] that will be used for collision/intersection queries.
2017-09-12 20:42:36 +00:00
</description>
</method>
</methods>
2018-01-11 22:38:35 +00:00
<members >
2019-06-29 10:38:01 +00:00
<member name= "collide_with_areas" type= "bool" setter= "set_collide_with_areas" getter= "is_collide_with_areas_enabled" default= "false" >
2019-12-09 14:16:28 +00:00
If [code]true[/code], the query will take [Area2D]s into account.
2018-08-29 20:25:11 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "collide_with_bodies" type= "bool" setter= "set_collide_with_bodies" getter= "is_collide_with_bodies_enabled" default= "true" >
2019-12-09 14:16:28 +00:00
If [code]true[/code], the query will take [PhysicsBody2D]s into account.
2018-08-29 20:25:11 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "collision_layer" type= "int" setter= "set_collision_layer" getter= "get_collision_layer" default= "2147483647" >
2020-10-19 13:55:33 +00:00
The physics layer(s) the query will take into account (as a bitmask). See [url=https://docs.godotengine.org/en/3.2/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information.
2018-01-11 22:38:35 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "exclude" type= "Array" setter= "set_exclude" getter= "get_exclude" default= "[ ]" >
2019-12-09 14:16:28 +00:00
The list of objects or object [RID]s that will be excluded from collisions.
2018-01-11 22:38:35 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "margin" type= "float" setter= "set_margin" getter= "get_margin" default= "0.0" >
2018-01-11 22:38:35 +00:00
The collision margin for the shape.
</member>
2019-06-29 10:38:01 +00:00
<member name= "motion" type= "Vector2" setter= "set_motion" getter= "get_motion" default= "Vector2( 0, 0 )" >
2018-01-11 22:38:35 +00:00
The motion of the shape being queried for.
</member>
<member name= "shape_rid" type= "RID" setter= "set_shape_rid" getter= "get_shape_rid" >
2019-12-09 14:16:28 +00:00
The queried shape's [RID]. See also [method set_shape].
2018-01-11 22:38:35 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "transform" type= "Transform2D" setter= "set_transform" getter= "get_transform" default= "Transform2D( 1, 0, 0, 1, 0, 0 )" >
2019-12-09 14:16:28 +00:00
The queried shape's transform matrix.
2018-01-11 22:38:35 +00:00
</member>
</members>
2017-09-12 20:42:36 +00:00
<constants >
</constants>
</class>