Sync classref with current source

This commit is contained in:
Rémi Verschelde
2018-09-21 09:49:38 +02:00
parent df6316f918
commit ce0bb7b277
494 changed files with 7138 additions and 7027 deletions
+30 -28
View File
@@ -86,6 +86,7 @@ Constants
---------
- **INVALID_CELL_ITEM** = **-1** --- Invalid cell item that can be used in :ref:`set_cell_item<class_GridMap_set_cell_item>` to clear cells (or represent an empty cell in :ref:`get_cell_item<class_GridMap_get_cell_item>`).
Description
-----------
@@ -101,10 +102,11 @@ Tutorials
---------
- :doc:`../tutorials/3d/using_gridmaps`
Property Descriptions
---------------------
.. _class_GridMap_cell_center_x:
.. _class_GridMap_cell_center_x:
- :ref:`bool<class_bool>` **cell_center_x**
@@ -116,7 +118,7 @@ Property Descriptions
If ``true`` grid items are centered on the X axis.
.. _class_GridMap_cell_center_y:
.. _class_GridMap_cell_center_y:
- :ref:`bool<class_bool>` **cell_center_y**
@@ -128,7 +130,7 @@ If ``true`` grid items are centered on the X axis.
If ``true`` grid items are centered on the Y axis.
.. _class_GridMap_cell_center_z:
.. _class_GridMap_cell_center_z:
- :ref:`bool<class_bool>` **cell_center_z**
@@ -140,7 +142,7 @@ If ``true`` grid items are centered on the Y axis.
If ``true`` grid items are centered on the Z axis.
.. _class_GridMap_cell_octant_size:
.. _class_GridMap_cell_octant_size:
- :ref:`int<class_int>` **cell_octant_size**
@@ -152,7 +154,7 @@ If ``true`` grid items are centered on the Z axis.
The size of each octant measured in number of cells. This applies to all three axis.
.. _class_GridMap_cell_scale:
.. _class_GridMap_cell_scale:
- :ref:`float<class_float>` **cell_scale**
@@ -162,7 +164,7 @@ The size of each octant measured in number of cells. This applies to all three a
| *Getter* | get_cell_scale() |
+----------+-----------------------+
.. _class_GridMap_cell_size:
.. _class_GridMap_cell_size:
- :ref:`Vector3<class_Vector3>` **cell_size**
@@ -174,7 +176,7 @@ The size of each octant measured in number of cells. This applies to all three a
The dimensions of the grid's cells.
.. _class_GridMap_collision_layer:
.. _class_GridMap_collision_layer:
- :ref:`int<class_int>` **collision_layer**
@@ -184,7 +186,7 @@ The dimensions of the grid's cells.
| *Getter* | get_collision_layer() |
+----------+----------------------------+
.. _class_GridMap_collision_mask:
.. _class_GridMap_collision_mask:
- :ref:`int<class_int>` **collision_mask**
@@ -194,7 +196,7 @@ The dimensions of the grid's cells.
| *Getter* | get_collision_mask() |
+----------+---------------------------+
.. _class_GridMap_mesh_library:
.. _class_GridMap_mesh_library:
- :ref:`MeshLibrary<class_MeshLibrary>` **mesh_library**
@@ -206,7 +208,7 @@ The dimensions of the grid's cells.
The assigned :ref:`MeshLibrary<class_MeshLibrary>`.
.. _class_GridMap_theme:
.. _class_GridMap_theme:
- :ref:`MeshLibrary<class_MeshLibrary>` **theme**
@@ -221,69 +223,69 @@ Deprecated, use :ref:`mesh_library<class_GridMap_mesh_library>` instead.
Method Descriptions
-------------------
.. _class_GridMap_clear:
.. _class_GridMap_clear:
- void **clear** **(** **)**
Clear all cells.
.. _class_GridMap_clear_baked_meshes:
.. _class_GridMap_clear_baked_meshes:
- void **clear_baked_meshes** **(** **)**
.. _class_GridMap_get_bake_mesh_instance:
.. _class_GridMap_get_bake_mesh_instance:
- :ref:`RID<class_RID>` **get_bake_mesh_instance** **(** :ref:`int<class_int>` idx **)**
.. _class_GridMap_get_bake_meshes:
.. _class_GridMap_get_bake_meshes:
- :ref:`Array<class_Array>` **get_bake_meshes** **(** **)**
.. _class_GridMap_get_cell_item:
.. _class_GridMap_get_cell_item:
- :ref:`int<class_int>` **get_cell_item** **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z **)** const
The :ref:`MeshLibrary<class_MeshLibrary>` item index located at the grid-based X, Y and Z coordinates. If the cell is empty, INVALID_CELL_ITEM will be returned.
.. _class_GridMap_get_cell_item_orientation:
.. _class_GridMap_get_cell_item_orientation:
- :ref:`int<class_int>` **get_cell_item_orientation** **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z **)** const
The orientation of the cell at the grid-based X, Y and Z coordinates. -1 is returned if the cell is empty.
.. _class_GridMap_get_collision_layer_bit:
.. _class_GridMap_get_collision_layer_bit:
- :ref:`bool<class_bool>` **get_collision_layer_bit** **(** :ref:`int<class_int>` bit **)** const
.. _class_GridMap_get_collision_mask_bit:
.. _class_GridMap_get_collision_mask_bit:
- :ref:`bool<class_bool>` **get_collision_mask_bit** **(** :ref:`int<class_int>` bit **)** const
.. _class_GridMap_get_meshes:
.. _class_GridMap_get_meshes:
- :ref:`Array<class_Array>` **get_meshes** **(** **)**
Array of :ref:`Transform<class_Transform>` and :ref:`Mesh<class_Mesh>` references corresponding to the non empty cells in the grid. The transforms are specified in world space.
.. _class_GridMap_get_used_cells:
.. _class_GridMap_get_used_cells:
- :ref:`Array<class_Array>` **get_used_cells** **(** **)** const
Array of :ref:`Vector3<class_Vector3>` with the non empty cell coordinates in the grid map.
.. _class_GridMap_make_baked_meshes:
.. _class_GridMap_make_baked_meshes:
- void **make_baked_meshes** **(** :ref:`bool<class_bool>` gen_lightmap_uv=false, :ref:`float<class_float>` lightmap_uv_texel_size=0.1 **)**
.. _class_GridMap_map_to_world:
.. _class_GridMap_map_to_world:
- :ref:`Vector3<class_Vector3>` **map_to_world** **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z **)** const
.. _class_GridMap_resource_changed:
.. _class_GridMap_resource_changed:
- void **resource_changed** **(** :ref:`Resource<class_Resource>` resource **)**
.. _class_GridMap_set_cell_item:
.. _class_GridMap_set_cell_item:
- void **set_cell_item** **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z, :ref:`int<class_int>` item, :ref:`int<class_int>` orientation=0 **)**
@@ -293,19 +295,19 @@ A negative item index will clear the cell.
Optionally, the item's orientation can be passed.
.. _class_GridMap_set_clip:
.. _class_GridMap_set_clip:
- void **set_clip** **(** :ref:`bool<class_bool>` enabled, :ref:`bool<class_bool>` clipabove=true, :ref:`int<class_int>` floor=0, :ref:`Axis<enum_Vector3_Axis>` axis=0 **)**
.. _class_GridMap_set_collision_layer_bit:
.. _class_GridMap_set_collision_layer_bit:
- void **set_collision_layer_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)**
.. _class_GridMap_set_collision_mask_bit:
.. _class_GridMap_set_collision_mask_bit:
- void **set_collision_mask_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)**
.. _class_GridMap_world_to_map:
.. _class_GridMap_world_to_map:
- :ref:`Vector3<class_Vector3>` **world_to_map** **(** :ref:`Vector3<class_Vector3>` pos **)** const