Physics2DShapeQueryParameters.xml 2.3 KB

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