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

Sync classref with master branch (4.0 changes)

Browse Source
This commit is contained in:
Rémi Verschelde
2020-03-13 17:17:50 +01:00
parent 966fd002ed
commit 03d40ff29e
360 changed files with 17483 additions and 16479 deletions
Download Patch File Download Diff File Expand all files Collapse all files
classes/class_navigationmesh.rst
+67 -67
View File
@@ -16,72 +16,72 @@ NavigationMesh
Properties
----------
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`agent/height<class_NavigationMesh_property_agent/height>` | ``2.0`` |
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`agent/max_climb<class_NavigationMesh_property_agent/max_climb>` | ``0.9`` |
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`agent/max_slope<class_NavigationMesh_property_agent/max_slope>` | ``45.0`` |
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`agent/radius<class_NavigationMesh_property_agent/radius>` | ``0.6`` |
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`cell/height<class_NavigationMesh_property_cell/height>` | ``0.2`` |
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`cell/size<class_NavigationMesh_property_cell/size>` | ``0.3`` |
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`detail/sample_distance<class_NavigationMesh_property_detail/sample_distance>` | ``6.0`` |
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`detail/sample_max_error<class_NavigationMesh_property_detail/sample_max_error>` | ``1.0`` |
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`edge/max_error<class_NavigationMesh_property_edge/max_error>` | ``1.3`` |
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`edge/max_length<class_NavigationMesh_property_edge/max_length>` | ``12.0`` |
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>` | :ref:`filter/filter_walkable_low_height_spans<class_NavigationMesh_property_filter/filter_walkable_low_height_spans>` | ``false`` |
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>` | :ref:`filter/ledge_spans<class_NavigationMesh_property_filter/ledge_spans>` | ``false`` |
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>` | :ref:`filter/low_hanging_obstacles<class_NavigationMesh_property_filter/low_hanging_obstacles>` | ``false`` |
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
| :ref:`int<class_int>` | :ref:`geometry/collision_mask<class_NavigationMesh_property_geometry/collision_mask>` | |
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
| :ref:`int<class_int>` | :ref:`geometry/parsed_geometry_type<class_NavigationMesh_property_geometry/parsed_geometry_type>` | ``0`` |
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
| :ref:`int<class_int>` | :ref:`geometry/source_geometry_mode<class_NavigationMesh_property_geometry/source_geometry_mode>` | ``0`` |
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
| :ref:`String<class_String>` | :ref:`geometry/source_group_name<class_NavigationMesh_property_geometry/source_group_name>` | |
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`polygon/verts_per_poly<class_NavigationMesh_property_polygon/verts_per_poly>` | ``6.0`` |
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`region/merge_size<class_NavigationMesh_property_region/merge_size>` | ``20.0`` |
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`region/min_size<class_NavigationMesh_property_region/min_size>` | ``8.0`` |
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
| :ref:`int<class_int>` | :ref:`sample_partition_type/sample_partition_type<class_NavigationMesh_property_sample_partition_type/sample_partition_type>` | ``0`` |
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`agent/height<class_NavigationMesh_property_agent/height>` | ``2.0`` |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`agent/max_climb<class_NavigationMesh_property_agent/max_climb>` | ``0.9`` |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`agent/max_slope<class_NavigationMesh_property_agent/max_slope>` | ``45.0`` |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`agent/radius<class_NavigationMesh_property_agent/radius>` | ``0.6`` |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`cell/height<class_NavigationMesh_property_cell/height>` | ``0.2`` |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`cell/size<class_NavigationMesh_property_cell/size>` | ``0.3`` |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`detail/sample_distance<class_NavigationMesh_property_detail/sample_distance>` | ``6.0`` |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`detail/sample_max_error<class_NavigationMesh_property_detail/sample_max_error>` | ``1.0`` |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`edge/max_error<class_NavigationMesh_property_edge/max_error>` | ``1.3`` |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`edge/max_length<class_NavigationMesh_property_edge/max_length>` | ``12.0`` |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>` | :ref:`filter/filter_walkable_low_height_spans<class_NavigationMesh_property_filter/filter_walkable_low_height_spans>` | ``false`` |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>` | :ref:`filter/ledge_spans<class_NavigationMesh_property_filter/ledge_spans>` | ``false`` |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>` | :ref:`filter/low_hanging_obstacles<class_NavigationMesh_property_filter/low_hanging_obstacles>` | ``false`` |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
| :ref:`int<class_int>` | :ref:`geometry/collision_mask<class_NavigationMesh_property_geometry/collision_mask>` | |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
| :ref:`int<class_int>` | :ref:`geometry/parsed_geometry_type<class_NavigationMesh_property_geometry/parsed_geometry_type>` | ``0`` |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
| :ref:`int<class_int>` | :ref:`geometry/source_geometry_mode<class_NavigationMesh_property_geometry/source_geometry_mode>` | ``0`` |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
| :ref:`StringName<class_StringName>` | :ref:`geometry/source_group_name<class_NavigationMesh_property_geometry/source_group_name>` | |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`polygon/verts_per_poly<class_NavigationMesh_property_polygon/verts_per_poly>` | ``6.0`` |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`region/merge_size<class_NavigationMesh_property_region/merge_size>` | ``20.0`` |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`region/min_size<class_NavigationMesh_property_region/min_size>` | ``8.0`` |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
| :ref:`int<class_int>` | :ref:`sample_partition_type/sample_partition_type<class_NavigationMesh_property_sample_partition_type/sample_partition_type>` | ``0`` |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+
Methods
-------
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_polygon<class_NavigationMesh_method_add_polygon>` **(** :ref:`PoolIntArray<class_PoolIntArray>` polygon **)** |
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_polygons<class_NavigationMesh_method_clear_polygons>` **(** **)** |
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`create_from_mesh<class_NavigationMesh_method_create_from_mesh>` **(** :ref:`Mesh<class_Mesh>` mesh **)** |
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_collision_mask_bit<class_NavigationMesh_method_get_collision_mask_bit>` **(** :ref:`int<class_int>` bit **)** const |
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolIntArray<class_PoolIntArray>` | :ref:`get_polygon<class_NavigationMesh_method_get_polygon>` **(** :ref:`int<class_int>` idx **)** |
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_polygon_count<class_NavigationMesh_method_get_polygon_count>` **(** **)** const |
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolVector3Array<class_PoolVector3Array>` | :ref:`get_vertices<class_NavigationMesh_method_get_vertices>` **(** **)** const |
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_collision_mask_bit<class_NavigationMesh_method_set_collision_mask_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_vertices<class_NavigationMesh_method_set_vertices>` **(** :ref:`PoolVector3Array<class_PoolVector3Array>` vertices **)** |
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_polygon<class_NavigationMesh_method_add_polygon>` **(** :ref:`PackedInt32Array<class_PackedInt32Array>` polygon **)** |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_polygons<class_NavigationMesh_method_clear_polygons>` **(** **)** |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`create_from_mesh<class_NavigationMesh_method_create_from_mesh>` **(** :ref:`Mesh<class_Mesh>` mesh **)** |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_collision_mask_bit<class_NavigationMesh_method_get_collision_mask_bit>` **(** :ref:`int<class_int>` bit **)** const |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`get_polygon<class_NavigationMesh_method_get_polygon>` **(** :ref:`int<class_int>` idx **)** |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_polygon_count<class_NavigationMesh_method_get_polygon_count>` **(** **)** const |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`get_vertices<class_NavigationMesh_method_get_vertices>` **(** **)** const |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_collision_mask_bit<class_NavigationMesh_method_set_collision_mask_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_vertices<class_NavigationMesh_method_set_vertices>` **(** :ref:`PackedVector3Array<class_PackedVector3Array>` vertices **)** |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
Constants
---------
@@ -337,7 +337,7 @@ Property Descriptions
.. _class_NavigationMesh_property_geometry/source_group_name:
- :ref:`String<class_String>` **geometry/source_group_name**
- :ref:`StringName<class_StringName>` **geometry/source_group_name**
+----------+------------------------------+
| *Setter* | set_source_group_name(value) |
@@ -406,7 +406,7 @@ Method Descriptions
.. _class_NavigationMesh_method_add_polygon:
- void **add_polygon** **(** :ref:`PoolIntArray<class_PoolIntArray>` polygon **)**
- void **add_polygon** **(** :ref:`PackedInt32Array<class_PackedInt32Array>` polygon **)**
----
@@ -430,7 +430,7 @@ Method Descriptions
.. _class_NavigationMesh_method_get_polygon:
- :ref:`PoolIntArray<class_PoolIntArray>` **get_polygon** **(** :ref:`int<class_int>` idx **)**
- :ref:`PackedInt32Array<class_PackedInt32Array>` **get_polygon** **(** :ref:`int<class_int>` idx **)**
----
@@ -442,7 +442,7 @@ Method Descriptions
.. _class_NavigationMesh_method_get_vertices:
- :ref:`PoolVector3Array<class_PoolVector3Array>` **get_vertices** **(** **)** const
- :ref:`PackedVector3Array<class_PackedVector3Array>` **get_vertices** **(** **)** const
----
@@ -454,5 +454,5 @@ Method Descriptions
.. _class_NavigationMesh_method_set_vertices:
- void **set_vertices** **(** :ref:`PoolVector3Array<class_PoolVector3Array>` vertices **)**
- void **set_vertices** **(** :ref:`PackedVector3Array<class_PackedVector3Array>` vertices **)**