PhysicsShapeQueryParameters.xml 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="PhysicsShapeQueryParameters" inherits="Reference" version="3.2">
  3. <brief_description>
  4. Parameters to be sent to a 3D shape physics query.
  5. </brief_description>
  6. <description>
  7. This class contains the shape and other parameters for 3D intersection/collision queries. See also [PhysicsShapeQueryResult].
  8. </description>
  9. <tutorials>
  10. </tutorials>
  11. <methods>
  12. <method name="set_shape">
  13. <return type="void">
  14. </return>
  15. <argument index="0" name="shape" type="Resource">
  16. </argument>
  17. <description>
  18. Sets the [Shape] that will be used for collision/intersection queries.
  19. </description>
  20. </method>
  21. </methods>
  22. <members>
  23. <member name="collide_with_areas" type="bool" setter="set_collide_with_areas" getter="is_collide_with_areas_enabled" default="false">
  24. If [code]true[/code], the query will take [Area]s into account.
  25. </member>
  26. <member name="collide_with_bodies" type="bool" setter="set_collide_with_bodies" getter="is_collide_with_bodies_enabled" default="true">
  27. If [code]true[/code], the query will take [PhysicsBody]s into account.
  28. </member>
  29. <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" default="2147483647">
  30. The physics layer(s) the query will take into account (as a bitmask).
  31. </member>
  32. <member name="exclude" type="Array" setter="set_exclude" getter="get_exclude" default="[ ]">
  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" default="0.0">
  36. The collision margin for the shape.
  37. </member>
  38. <member name="shape_rid" type="RID" setter="set_shape_rid" getter="get_shape_rid">
  39. The queried shape's [RID]. See also [method set_shape].
  40. </member>
  41. <member name="transform" type="Transform" setter="set_transform" getter="get_transform" default="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
  42. The queried shape's transform matrix.
  43. </member>
  44. </members>
  45. <constants>
  46. </constants>
  47. </class>