16fd1c421e
For the time being we don't support writing a description for those, preferring
having all details in the method's description.
Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
(cherry picked from commit 7adf4cc9b5)
50 lines
1.7 KiB
XML
50 lines
1.7 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="Physics2DShapeQueryResult" inherits="Reference" version="3.3">
|
|
<brief_description>
|
|
Result of a 2D shape query in [Physics2DServer].
|
|
</brief_description>
|
|
<description>
|
|
The result of a 2D shape query in [Physics2DServer]. See also [Physics2DShapeQueryParameters].
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="get_result_count" qualifiers="const">
|
|
<return type="int" />
|
|
<description>
|
|
Returns the number of objects that intersected with the shape.
|
|
</description>
|
|
</method>
|
|
<method name="get_result_object" qualifiers="const">
|
|
<return type="Object" />
|
|
<argument index="0" name="idx" type="int" />
|
|
<description>
|
|
Returns the [Object] that intersected with the shape at index [code]idx[/code].
|
|
</description>
|
|
</method>
|
|
<method name="get_result_object_id" qualifiers="const">
|
|
<return type="int" />
|
|
<argument index="0" name="idx" type="int" />
|
|
<description>
|
|
Returns the instance ID of the [Object] that intersected with the shape at index [code]idx[/code].
|
|
</description>
|
|
</method>
|
|
<method name="get_result_object_shape" qualifiers="const">
|
|
<return type="int" />
|
|
<argument index="0" name="idx" type="int" />
|
|
<description>
|
|
Returns the child index of the object's [Shape] that intersected with the shape at index [code]idx[/code].
|
|
</description>
|
|
</method>
|
|
<method name="get_result_rid" qualifiers="const">
|
|
<return type="RID" />
|
|
<argument index="0" name="idx" type="int" />
|
|
<description>
|
|
Returns the [RID] of the object that intersected with the shape at index [code]idx[/code].
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<constants>
|
|
</constants>
|
|
</class>
|