Sync classref with current source

This commit is contained in:
Rémi Verschelde
2019-10-29 12:48:46 +01:00
parent bbc6682099
commit a72184300f
449 changed files with 14004 additions and 232 deletions
+59
View File
@@ -84,6 +84,13 @@ Methods
| :ref:`Vector3<class_Vector3>` | :ref:`world_to_map<class_GridMap_method_world_to_map>` **(** :ref:`Vector3<class_Vector3>` pos **)** const |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
.. _class_GridMap_signal_cell_size_changed:
- **cell_size_changed** **(** :ref:`Vector3<class_Vector3>` cell_size **)**
Constants
---------
@@ -124,6 +131,8 @@ Property Descriptions
If ``true``, grid items are centered on the X axis.
----
.. _class_GridMap_property_cell_center_y:
- :ref:`bool<class_bool>` **cell_center_y**
@@ -138,6 +147,8 @@ If ``true``, grid items are centered on the X axis.
If ``true``, grid items are centered on the Y axis.
----
.. _class_GridMap_property_cell_center_z:
- :ref:`bool<class_bool>` **cell_center_z**
@@ -152,6 +163,8 @@ If ``true``, grid items are centered on the Y axis.
If ``true``, grid items are centered on the Z axis.
----
.. _class_GridMap_property_cell_octant_size:
- :ref:`int<class_int>` **cell_octant_size**
@@ -166,6 +179,8 @@ 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_property_cell_scale:
- :ref:`float<class_float>` **cell_scale**
@@ -178,6 +193,8 @@ The size of each octant measured in number of cells. This applies to all three a
| *Getter* | get_cell_scale() |
+-----------+-----------------------+
----
.. _class_GridMap_property_cell_size:
- :ref:`Vector3<class_Vector3>` **cell_size**
@@ -192,6 +209,8 @@ 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_property_collision_layer:
- :ref:`int<class_int>` **collision_layer**
@@ -204,6 +223,8 @@ The dimensions of the grid's cells.
| *Getter* | get_collision_layer() |
+-----------+----------------------------+
----
.. _class_GridMap_property_collision_mask:
- :ref:`int<class_int>` **collision_mask**
@@ -216,6 +237,8 @@ The dimensions of the grid's cells.
| *Getter* | get_collision_mask() |
+-----------+---------------------------+
----
.. _class_GridMap_property_mesh_library:
- :ref:`MeshLibrary<class_MeshLibrary>` **mesh_library**
@@ -228,6 +251,8 @@ The dimensions of the grid's cells.
The assigned :ref:`MeshLibrary<class_MeshLibrary>`.
----
.. _class_GridMap_property_theme:
- :ref:`MeshLibrary<class_MeshLibrary>` **theme**
@@ -249,62 +274,88 @@ Method Descriptions
Clear all cells.
----
.. _class_GridMap_method_clear_baked_meshes:
- void **clear_baked_meshes** **(** **)**
----
.. _class_GridMap_method_get_bake_mesh_instance:
- :ref:`RID<class_RID>` **get_bake_mesh_instance** **(** :ref:`int<class_int>` idx **)**
----
.. _class_GridMap_method_get_bake_meshes:
- :ref:`Array<class_Array>` **get_bake_meshes** **(** **)**
----
.. _class_GridMap_method_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, :ref:`INVALID_CELL_ITEM<class_GridMap_constant_INVALID_CELL_ITEM>` will be returned.
----
.. _class_GridMap_method_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_method_get_collision_layer_bit:
- :ref:`bool<class_bool>` **get_collision_layer_bit** **(** :ref:`int<class_int>` bit **)** const
----
.. _class_GridMap_method_get_collision_mask_bit:
- :ref:`bool<class_bool>` **get_collision_mask_bit** **(** :ref:`int<class_int>` bit **)** const
----
.. _class_GridMap_method_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_method_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_method_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_method_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_method_resource_changed:
- void **resource_changed** **(** :ref:`Resource<class_Resource>` resource **)**
----
.. _class_GridMap_method_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 **)**
@@ -315,18 +366,26 @@ A negative item index will clear the cell.
Optionally, the item's orientation can be passed.
----
.. _class_GridMap_method_set_clip:
- void **set_clip** **(** :ref:`bool<class_bool>` enabled, :ref:`bool<class_bool>` clipabove=true, :ref:`int<class_int>` floor=0, Vector3.Axis axis=0 **)**
----
.. _class_GridMap_method_set_collision_layer_bit:
- void **set_collision_layer_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)**
----
.. _class_GridMap_method_set_collision_mask_bit:
- void **set_collision_mask_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)**
----
.. _class_GridMap_method_world_to_map:
- :ref:`Vector3<class_Vector3>` **world_to_map** **(** :ref:`Vector3<class_Vector3>` pos **)** const