seedlingattempt/godot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: Sync classref with current source

Browse Source
This commit is contained in:
Rémi Verschelde
2020-07-03 16:09:12 +02:00
parent 49feec7dc0
commit 96644d23a0
6 changed files with 19 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
modules/gridmap/doc_classes/GridMap.xml
View File

@ -43,27 +43,19 @@
<method name="get_cell_item" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="x" type="int">
</argument>
<argument index="1" name="y" type="int">
</argument>
<argument index="2" name="z" type="int">
<argument index="0" name="position" type="Vector3i">
</argument>
<description>
The [MeshLibrary] item index located at the grid-based X, Y and Z coordinates. If the cell is empty, [constant INVALID_CELL_ITEM] will be returned.
The [MeshLibrary] item index located at the given grid coordinates. If the cell is empty, [constant INVALID_CELL_ITEM] will be returned.
</description>
</method>
<method name="get_cell_item_orientation" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="x" type="int">
</argument>
<argument index="1" name="y" type="int">
</argument>
<argument index="2" name="z" type="int">
<argument index="0" name="position" type="Vector3i">
</argument>
<description>
The orientation of the cell at the grid-based X, Y and Z coordinates. -1 is returned if the cell is empty.
The orientation of the cell at the given grid coordinates. [code]-1[/code] is returned if the cell is empty.
</description>
</method>
<method name="get_collision_layer_bit" qualifiers="const">
@ -111,11 +103,7 @@
<method name="map_to_world" qualifiers="const">
<return type="Vector3">
</return>
<argument index="0" name="x" type="int">
</argument>
<argument index="1" name="y" type="int">
</argument>
<argument index="2" name="z" type="int">
<argument index="0" name="map_position" type="Vector3i">
</argument>
<description>
Returns the position of a grid cell in the GridMap's local coordinate space.
@ -132,18 +120,14 @@
<method name="set_cell_item">
<return type="void">
</return>
<argument index="0" name="x" type="int">
<argument index="0" name="position" type="Vector3i">
</argument>
<argument index="1" name="y" type="int">
<argument index="1" name="item" type="int">
</argument>
<argument index="2" name="z" type="int">
</argument>
<argument index="3" name="item" type="int">
</argument>
<argument index="4" name="orientation" type="int" default="0">
<argument index="2" name="orientation" type="int" default="0">
</argument>
<description>
Sets the mesh index for the cell referenced by its grid-based X, Y and Z coordinates.
Sets the mesh index for the cell referenced by its grid coordinates.
A negative item index such as [constant INVALID_CELL_ITEM] will clear the cell.
Optionally, the item's orientation can be passed. For valid orientation values, see [method Basis.get_orthogonal_index].
</description>
@ -185,9 +169,9 @@
</description>
</method>
<method name="world_to_map" qualifiers="const">
<return type="Vector3">
<return type="Vector3i">
</return>
<argument index="0" name="pos" type="Vector3">
<argument index="0" name="world_position" type="Vector3">
</argument>
<description>
Returns the coordinates of the grid cell containing the given point.