PhysicsRayQueryParameters2D.xml 1.8 KB

12345678910111213141516171819202122232425262728293031
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="PhysicsRayQueryParameters2D" inherits="RefCounted" version="4.0">
  3. <brief_description>
  4. Parameters to be sent to a 2D ray physics query.
  5. </brief_description>
  6. <description>
  7. This class contains the ray position and other parameters to be used for [method PhysicsDirectSpaceState2D.intersect_ray].
  8. </description>
  9. <tutorials>
  10. </tutorials>
  11. <members>
  12. <member name="collide_with_areas" type="bool" setter="set_collide_with_areas" getter="is_collide_with_areas_enabled" default="false">
  13. If [code]true[/code], the query will take [Area2D]s into account.
  14. </member>
  15. <member name="collide_with_bodies" type="bool" setter="set_collide_with_bodies" getter="is_collide_with_bodies_enabled" default="true">
  16. If [code]true[/code], the query will take [PhysicsBody2D]s into account.
  17. </member>
  18. <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" default="4294967295">
  19. The physics layers the query will detect (as a bitmask). By default, all collision layers are detected. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information.
  20. </member>
  21. <member name="exclude" type="Array" setter="set_exclude" getter="get_exclude" default="[]">
  22. The list of objects or object [RID]s that will be excluded from collisions.
  23. </member>
  24. <member name="from" type="Vector2" setter="set_from" getter="get_from" default="Vector2(0, 0)">
  25. The starting point of the ray being queried for, in global coordinates.
  26. </member>
  27. <member name="to" type="Vector2" setter="set_to" getter="get_to" default="Vector2(0, 0)">
  28. The ending point of the ray being queried for, in global coordinates.
  29. </member>
  30. </members>
  31. </class>