Physics2DShapeQueryResult.xml 1.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="Physics2DShapeQueryResult" inherits="Reference" version="3.3">
  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. <description>
  15. Returns the number of objects that intersected with the shape.
  16. </description>
  17. </method>
  18. <method name="get_result_object" qualifiers="const">
  19. <return type="Object" />
  20. <argument index="0" name="idx" type="int" />
  21. <description>
  22. Returns the [Object] that intersected with the shape at index [code]idx[/code].
  23. </description>
  24. </method>
  25. <method name="get_result_object_id" qualifiers="const">
  26. <return type="int" />
  27. <argument index="0" name="idx" type="int" />
  28. <description>
  29. Returns the instance ID of the [Object] that intersected with the shape at index [code]idx[/code].
  30. </description>
  31. </method>
  32. <method name="get_result_object_shape" qualifiers="const">
  33. <return type="int" />
  34. <argument index="0" name="idx" type="int" />
  35. <description>
  36. Returns the child index of the object's [Shape] that intersected with the shape at index [code]idx[/code].
  37. </description>
  38. </method>
  39. <method name="get_result_rid" qualifiers="const">
  40. <return type="RID" />
  41. <argument index="0" name="idx" type="int" />
  42. <description>
  43. Returns the [RID] of the object that intersected with the shape at index [code]idx[/code].
  44. </description>
  45. </method>
  46. </methods>
  47. <constants>
  48. </constants>
  49. </class>