virtualx-engine/doc/classes/Physics2DShapeQueryParameters.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="Physics2DShapeQueryParameters" inherits="Reference" version="3.2">
	<brief_description>
		Parameters to be sent to a 2D shape physics query.
	</brief_description>
	<description>
		This class contains the shape and other parameters for 2D intersection/collision queries. See also [Physics2DShapeQueryResult].
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="set_shape">
			<return type="void">
			</return>
			<argument index="0" name="shape" type="Resource">
			</argument>
			<description>
				Sets the [Shape2D] that will be used for collision/intersection queries.
			</description>
		</method>
	</methods>
	<members>
		<member name="collide_with_areas" type="bool" setter="set_collide_with_areas" getter="is_collide_with_areas_enabled" default="false">
			If [code]true[/code], the query will take [Area2D]s into account.
		</member>
		<member name="collide_with_bodies" type="bool" setter="set_collide_with_bodies" getter="is_collide_with_bodies_enabled" default="true">
			If [code]true[/code], the query will take [PhysicsBody2D]s into account.
		</member>
		<member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer" default="2147483647">
			The physics layer(s) the query will take into account (as a bitmask).
		</member>
		<member name="exclude" type="Array" setter="set_exclude" getter="get_exclude" default="[  ]">
			The list of objects or object [RID]s that will be excluded from collisions.
		</member>
		<member name="margin" type="float" setter="set_margin" getter="get_margin" default="0.0">
			The collision margin for the shape.
		</member>
		<member name="motion" type="Vector2" setter="set_motion" getter="get_motion" default="Vector2( 0, 0 )">
			The motion of the shape being queried for.
		</member>
		<member name="shape_rid" type="RID" setter="set_shape_rid" getter="get_shape_rid">
			The queried shape's [RID]. See also [method set_shape].
		</member>
		<member name="transform" type="Transform2D" setter="set_transform" getter="get_transform" default="Transform2D( 1, 0, 0, 1, 0, 0 )">
			The queried shape's transform matrix.
		</member>
	</members>
	<constants>
	</constants>
</class>