mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-08 10:10:54 +03:00
120 lines
4.9 KiB
ReStructuredText
120 lines
4.9 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the NavigationRegion3D.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_NavigationRegion3D:
|
|
|
|
NavigationRegion3D
|
|
==================
|
|
|
|
**Inherits:** :ref:`Node3D<class_Node3D>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
|
|
|
A region of the navigation map.
|
|
|
|
Description
|
|
-----------
|
|
|
|
A region of the navigation map. It tells the :ref:`NavigationServer3D<class_NavigationServer3D>` what can be navigated and what cannot, based on its :ref:`NavigationMesh<class_NavigationMesh>` resource.
|
|
|
|
Two regions can be connected to each other if they share a similar edge. You can set the minimum distance between two vertices required to connect two edges by using :ref:`NavigationServer3D.map_set_edge_connection_margin<class_NavigationServer3D_method_map_set_edge_connection_margin>`.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+---------------------------------------------+-----------------------------------------------------------+----------+
|
|
| :ref:`bool<class_bool>` | :ref:`enabled<class_NavigationRegion3D_property_enabled>` | ``true`` |
|
|
+---------------------------------------------+-----------------------------------------------------------+----------+
|
|
| :ref:`int<class_int>` | :ref:`layers<class_NavigationRegion3D_property_layers>` | ``1`` |
|
|
+---------------------------------------------+-----------------------------------------------------------+----------+
|
|
| :ref:`NavigationMesh<class_NavigationMesh>` | :ref:`navmesh<class_NavigationRegion3D_property_navmesh>` | |
|
|
+---------------------------------------------+-----------------------------------------------------------+----------+
|
|
|
|
Methods
|
|
-------
|
|
|
|
+------+-----------------------------------------------------------------------------------------------+
|
|
| void | :ref:`bake_navigation_mesh<class_NavigationRegion3D_method_bake_navigation_mesh>` **(** **)** |
|
|
+------+-----------------------------------------------------------------------------------------------+
|
|
|
|
Signals
|
|
-------
|
|
|
|
.. _class_NavigationRegion3D_signal_bake_finished:
|
|
|
|
- **bake_finished** **(** **)**
|
|
|
|
Notifies when the navigation mesh bake operation is completed.
|
|
|
|
----
|
|
|
|
.. _class_NavigationRegion3D_signal_navigation_mesh_changed:
|
|
|
|
- **navigation_mesh_changed** **(** **)**
|
|
|
|
Notifies when the :ref:`NavigationMesh<class_NavigationMesh>` has changed.
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_NavigationRegion3D_property_enabled:
|
|
|
|
- :ref:`bool<class_bool>` **enabled**
|
|
|
|
+-----------+--------------------+
|
|
| *Default* | ``true`` |
|
|
+-----------+--------------------+
|
|
| *Setter* | set_enabled(value) |
|
|
+-----------+--------------------+
|
|
| *Getter* | is_enabled() |
|
|
+-----------+--------------------+
|
|
|
|
Determines if the ``NavigationRegion3D`` is enabled or disabled.
|
|
|
|
----
|
|
|
|
.. _class_NavigationRegion3D_property_layers:
|
|
|
|
- :ref:`int<class_int>` **layers**
|
|
|
|
+-----------+-------------------+
|
|
| *Default* | ``1`` |
|
|
+-----------+-------------------+
|
|
| *Setter* | set_layers(value) |
|
|
+-----------+-------------------+
|
|
| *Getter* | get_layers() |
|
|
+-----------+-------------------+
|
|
|
|
A bitfield determining all layers the region belongs to. These layers can be checked upon when requesting a path with :ref:`NavigationServer3D.map_get_path<class_NavigationServer3D_method_map_get_path>`.
|
|
|
|
----
|
|
|
|
.. _class_NavigationRegion3D_property_navmesh:
|
|
|
|
- :ref:`NavigationMesh<class_NavigationMesh>` **navmesh**
|
|
|
|
+----------+----------------------------+
|
|
| *Setter* | set_navigation_mesh(value) |
|
|
+----------+----------------------------+
|
|
| *Getter* | get_navigation_mesh() |
|
|
+----------+----------------------------+
|
|
|
|
The :ref:`NavigationMesh<class_NavigationMesh>` resource to use.
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_NavigationRegion3D_method_bake_navigation_mesh:
|
|
|
|
- void **bake_navigation_mesh** **(** **)**
|
|
|
|
Bakes the :ref:`NavigationMesh<class_NavigationMesh>`. The baking is done in a separate thread because navigation baking is not a cheap operation. This can be done at runtime. When it is completed, it automatically sets the new :ref:`NavigationMesh<class_NavigationMesh>`.
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
|
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
|
|
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|
|
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|
|
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|