f7f6115f76
- Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
49 lines
1.9 KiB
XML
49 lines
1.9 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="Physics2DShapeQueryParameters" inherits="Reference" category="Core" 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 intersection/collision queries.
|
|
</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">
|
|
</member>
|
|
<member name="collide_with_bodies" type="bool" setter="set_collide_with_bodies" getter="is_collide_with_bodies_enabled">
|
|
</member>
|
|
<member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer">
|
|
The physics layer the query should be made on.
|
|
</member>
|
|
<member name="exclude" type="Array" setter="set_exclude" getter="get_exclude">
|
|
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">
|
|
The collision margin for the shape.
|
|
</member>
|
|
<member name="motion" type="Vector2" setter="set_motion" getter="get_motion">
|
|
The motion of the shape being queried for.
|
|
</member>
|
|
<member name="shape_rid" type="RID" setter="set_shape_rid" getter="get_shape_rid">
|
|
The [RID] of the queried shape. See also [method set_shape].
|
|
</member>
|
|
<member name="transform" type="Transform2D" setter="set_transform" getter="get_transform">
|
|
the transform matrix of the queried shape.
|
|
</member>
|
|
</members>
|
|
<constants>
|
|
</constants>
|
|
</class>
|