Physics2DShapeQueryParameters.xml 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="Physics2DShapeQueryParameters" inherits="Reference" category="Core" version="3.1">
  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 intersection/collision queries.
  8. </description>
  9. <tutorials>
  10. </tutorials>
  11. <demos>
  12. </demos>
  13. <methods>
  14. <method name="set_shape">
  15. <return type="void">
  16. </return>
  17. <argument index="0" name="shape" type="Resource">
  18. </argument>
  19. <description>
  20. Set the [Shape2D] that will be used for collision/intersection queries.
  21. </description>
  22. </method>
  23. </methods>
  24. <members>
  25. <member name="collide_with_areas" type="bool" setter="set_collide_with_areas" getter="is_collide_with_areas_enabled">
  26. </member>
  27. <member name="collide_with_bodies" type="bool" setter="set_collide_with_bodies" getter="is_collide_with_bodies_enabled">
  28. </member>
  29. <member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer">
  30. The physics layer the query should be made on.
  31. </member>
  32. <member name="exclude" type="Array" setter="set_exclude" getter="get_exclude">
  33. The list of objects or object [RID]s, that will be excluded from collisions.
  34. </member>
  35. <member name="margin" type="float" setter="set_margin" getter="get_margin">
  36. The collision margin for the shape.
  37. </member>
  38. <member name="motion" type="Vector2" setter="set_motion" getter="get_motion">
  39. The motion of the shape being queried for.
  40. </member>
  41. <member name="shape_rid" type="RID" setter="set_shape_rid" getter="get_shape_rid">
  42. The [RID] of the queried shape. See [method set_shape] also.
  43. </member>
  44. <member name="transform" type="Transform2D" setter="set_transform" getter="get_transform">
  45. the transform matrix of the queried shape.
  46. </member>
  47. </members>
  48. <constants>
  49. </constants>
  50. </class>