PhysicsShapeQueryParameters.xml 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="PhysicsShapeQueryParameters" inherits="Reference" version="3.6" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
  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.
  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 [Shape] 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 [Area]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 [PhysicsBody]s into account.
  26. </member>
  27. <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" default="2147483647">
  28. The physics layer(s) the query will take into account (as a bitmask). See [url=$DOCS_URL/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="shape_rid" type="RID" setter="set_shape_rid" getter="get_shape_rid">
  37. The queried shape's [RID]. See also [method set_shape].
  38. </member>
  39. <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 )">
  40. The queried shape's transform matrix.
  41. </member>
  42. </members>
  43. <constants>
  44. </constants>
  45. </class>