stan220/godot-docs
1
0
Fork 0
mirror of https://github.com/stan220/godot-docs.git synced 2026-09-08 17:28:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch

Browse Source
This commit is contained in:
Rémi Verschelde
2017-09-02 17:15:33 +02:00
parent e27f0c3cb8
commit 40cb5153bd
203 changed files with 6302 additions and 5188 deletions
Download Patch File Download Diff File Expand all files Collapse all files
classes/class_gridmap.rst
+44 -116
View File
@@ -18,69 +18,45 @@ Brief Description
Member Functions
----------------
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect3<class_rect3>` | :ref:`area_get_bounds<class_GridMap_area_get_bounds>` **(** :ref:`int<class_int>` area **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`area_get_name<class_GridMap_area_get_name>` **(** :ref:`int<class_int>` area **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`area_get_portal_disable_color<class_GridMap_area_get_portal_disable_color>` **(** :ref:`int<class_int>` area **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`area_get_portal_disable_distance<class_GridMap_area_get_portal_disable_distance>` **(** :ref:`int<class_int>` area **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`area_is_exterior_portal<class_GridMap_area_is_exterior_portal>` **(** :ref:`int<class_int>` area **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_exterior_portal<class_GridMap_area_set_exterior_portal>` **(** :ref:`int<class_int>` area, :ref:`bool<class_bool>` enable **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_name<class_GridMap_area_set_name>` **(** :ref:`int<class_int>` area, :ref:`String<class_string>` name **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_portal_disable_color<class_GridMap_area_set_portal_disable_color>` **(** :ref:`int<class_int>` area, :ref:`Color<class_color>` color **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_portal_disable_distance<class_GridMap_area_set_portal_disable_distance>` **(** :ref:`int<class_int>` area, :ref:`float<class_float>` distance **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_GridMap_clear>` **(** **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`create_area<class_GridMap_create_area>` **(** :ref:`int<class_int>` id, :ref:`Rect3<class_rect3>` area **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`erase_area<class_GridMap_erase_area>` **(** :ref:`int<class_int>` area **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_cell_item<class_GridMap_get_cell_item>` **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_cell_item_orientation<class_GridMap_get_cell_item_orientation>` **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_cell_size<class_GridMap_get_cell_size>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_center_x<class_GridMap_get_center_x>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_center_y<class_GridMap_get_center_y>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_center_z<class_GridMap_get_center_z>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_meshes<class_GridMap_get_meshes>` **(** **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_octant_size<class_GridMap_get_octant_size>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`MeshLibrary<class_meshlibrary>` | :ref:`get_theme<class_GridMap_get_theme>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_unused_area_id<class_GridMap_get_unused_area_id>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`resource_changed<class_GridMap_resource_changed>` **(** :ref:`Object<class_object>` resource **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_cell_item<class_GridMap_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 **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_cell_size<class_GridMap_set_cell_size>` **(** :ref:`float<class_float>` size **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_center_x<class_GridMap_set_center_x>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_center_y<class_GridMap_set_center_y>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_center_z<class_GridMap_set_center_z>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_clip<class_GridMap_set_clip>` **(** :ref:`bool<class_bool>` enabled, :ref:`bool<class_bool>` clipabove=true, :ref:`int<class_int>` floor=0, :ref:`int<class_int>` axis=0 **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_octant_size<class_GridMap_set_octant_size>` **(** :ref:`int<class_int>` size **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_theme<class_GridMap_set_theme>` **(** :ref:`MeshLibrary<class_meshlibrary>` theme **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_GridMap_clear>` **(** **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_cell_item<class_GridMap_get_cell_item>` **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_cell_item_orientation<class_GridMap_get_cell_item_orientation>` **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_cell_size<class_GridMap_get_cell_size>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_center_x<class_GridMap_get_center_x>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_center_y<class_GridMap_get_center_y>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_center_z<class_GridMap_get_center_z>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_meshes<class_GridMap_get_meshes>` **(** **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_octant_size<class_GridMap_get_octant_size>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`MeshLibrary<class_meshlibrary>` | :ref:`get_theme<class_GridMap_get_theme>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`resource_changed<class_GridMap_resource_changed>` **(** :ref:`Resource<class_resource>` resource **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_cell_item<class_GridMap_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=null **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_cell_size<class_GridMap_set_cell_size>` **(** :ref:`Vector3<class_vector3>` size **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_center_x<class_GridMap_set_center_x>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_center_y<class_GridMap_set_center_y>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_center_z<class_GridMap_set_center_z>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_clip<class_GridMap_set_clip>` **(** :ref:`bool<class_bool>` enabled, :ref:`bool<class_bool>` clipabove=0, :ref:`int<class_int>` floor=true, :ref:`int<class_int>` axis=null **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_octant_size<class_GridMap_set_octant_size>` **(** :ref:`int<class_int>` size **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_theme<class_GridMap_set_theme>` **(** :ref:`MeshLibrary<class_meshlibrary>` theme **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Numeric Constants
-----------------
@@ -90,54 +66,10 @@ Numeric Constants
Member Function Description
---------------------------
.. _class_GridMap_area_get_bounds:
- :ref:`Rect3<class_rect3>` **area_get_bounds** **(** :ref:`int<class_int>` area **)** const
.. _class_GridMap_area_get_name:
- :ref:`String<class_string>` **area_get_name** **(** :ref:`int<class_int>` area **)** const
.. _class_GridMap_area_get_portal_disable_color:
- :ref:`Color<class_color>` **area_get_portal_disable_color** **(** :ref:`int<class_int>` area **)** const
.. _class_GridMap_area_get_portal_disable_distance:
- :ref:`float<class_float>` **area_get_portal_disable_distance** **(** :ref:`int<class_int>` area **)** const
.. _class_GridMap_area_is_exterior_portal:
- :ref:`bool<class_bool>` **area_is_exterior_portal** **(** :ref:`int<class_int>` area **)** const
.. _class_GridMap_area_set_exterior_portal:
- void **area_set_exterior_portal** **(** :ref:`int<class_int>` area, :ref:`bool<class_bool>` enable **)**
.. _class_GridMap_area_set_name:
- void **area_set_name** **(** :ref:`int<class_int>` area, :ref:`String<class_string>` name **)**
.. _class_GridMap_area_set_portal_disable_color:
- void **area_set_portal_disable_color** **(** :ref:`int<class_int>` area, :ref:`Color<class_color>` color **)**
.. _class_GridMap_area_set_portal_disable_distance:
- void **area_set_portal_disable_distance** **(** :ref:`int<class_int>` area, :ref:`float<class_float>` distance **)**
.. _class_GridMap_clear:
- void **clear** **(** **)**
.. _class_GridMap_create_area:
- :ref:`int<class_int>` **create_area** **(** :ref:`int<class_int>` id, :ref:`Rect3<class_rect3>` area **)**
.. _class_GridMap_erase_area:
- void **erase_area** **(** :ref:`int<class_int>` area **)**
.. _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
@@ -148,7 +80,7 @@ Member Function Description
.. _class_GridMap_get_cell_size:
- :ref:`float<class_float>` **get_cell_size** **(** **)** const
- :ref:`Vector3<class_vector3>` **get_cell_size** **(** **)** const
.. _class_GridMap_get_center_x:
@@ -174,21 +106,17 @@ Member Function Description
- :ref:`MeshLibrary<class_meshlibrary>` **get_theme** **(** **)** const
.. _class_GridMap_get_unused_area_id:
- :ref:`int<class_int>` **get_unused_area_id** **(** **)** const
.. _class_GridMap_resource_changed:
- void **resource_changed** **(** :ref:`Object<class_object>` resource **)**
- void **resource_changed** **(** :ref:`Resource<class_resource>` resource **)**
.. _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 **)**
- 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=null **)**
.. _class_GridMap_set_cell_size:
- void **set_cell_size** **(** :ref:`float<class_float>` size **)**
- void **set_cell_size** **(** :ref:`Vector3<class_vector3>` size **)**
.. _class_GridMap_set_center_x:
@@ -204,7 +132,7 @@ Member Function Description
.. _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:`int<class_int>` axis=0 **)**
- void **set_clip** **(** :ref:`bool<class_bool>` enabled, :ref:`bool<class_bool>` clipabove=0, :ref:`int<class_int>` floor=true, :ref:`int<class_int>` axis=null **)**
.. _class_GridMap_set_octant_size: