hertog/godot-module-template
Template
2
1
Fork 1
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve the Shape/Shape2D classes documentation

Browse source
This commit is contained in:
Hugo Locurcio 2019-12-09 15:16:28 +01:00
parent 2ebc783e9c
commit 16d612dccc
No known key found for this signature in database
GPG key ID: 39E8F8BE30B0A49C
8 changed files with 37 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

7
doc/classes/Physics2DShapeQueryResult.xml
View file

@ -1,8 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Physics2DShapeQueryResult" inherits="Reference" category="Core" version="3.2">
<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>
@ -11,6 +13,7 @@
<return type="int">
</return>
<description>
Returns the number of objects that intersected with the shape.
</description>
</method>
<method name="get_result_object" qualifiers="const">
@ -19,6 +22,7 @@
<argument index="0" name="idx" type="int">
</argument>
<description>
Returns the [Object] that intersected with the shape at index [code]idx[/code].
</description>
</method>
<method name="get_result_object_id" qualifiers="const">
@ -27,6 +31,7 @@
<argument index="0" name="idx" type="int">
</argument>
<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">
@ -35,6 +40,7 @@
<argument index="0" name="idx" type="int">
</argument>
<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">
@ -43,6 +49,7 @@
<argument index="0" name="idx" type="int">
</argument>
<description>
Returns the [RID] of the object that intersected with the shape at index [code]idx[/code].
</description>
</method>
</methods>