Physics2DShapeQueryResult.xml 1.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="Physics2DShapeQueryResult" inherits="Reference" version="3.2">
  3. <brief_description>
  4. Result of a 2D shape query in [Physics2DServer].
  5. </brief_description>
  6. <description>
  7. The result of a 2D shape query in [Physics2DServer]. See also [Physics2DShapeQueryParameters].
  8. </description>
  9. <tutorials>
  10. </tutorials>
  11. <methods>
  12. <method name="get_result_count" qualifiers="const">
  13. <return type="int">
  14. </return>
  15. <description>
  16. Returns the number of objects that intersected with the shape.
  17. </description>
  18. </method>
  19. <method name="get_result_object" qualifiers="const">
  20. <return type="Object">
  21. </return>
  22. <argument index="0" name="idx" type="int">
  23. </argument>
  24. <description>
  25. Returns the [Object] that intersected with the shape at index [code]idx[/code].
  26. </description>
  27. </method>
  28. <method name="get_result_object_id" qualifiers="const">
  29. <return type="int">
  30. </return>
  31. <argument index="0" name="idx" type="int">
  32. </argument>
  33. <description>
  34. Returns the instance ID of the [Object] that intersected with the shape at index [code]idx[/code].
  35. </description>
  36. </method>
  37. <method name="get_result_object_shape" qualifiers="const">
  38. <return type="int">
  39. </return>
  40. <argument index="0" name="idx" type="int">
  41. </argument>
  42. <description>
  43. Returns the child index of the object's [Shape] that intersected with the shape at index [code]idx[/code].
  44. </description>
  45. </method>
  46. <method name="get_result_rid" qualifiers="const">
  47. <return type="RID">
  48. </return>
  49. <argument index="0" name="idx" type="int">
  50. </argument>
  51. <description>
  52. Returns the [RID] of the object that intersected with the shape at index [code]idx[/code].
  53. </description>
  54. </method>
  55. </methods>
  56. <constants>
  57. </constants>
  58. </class>