| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364 |
- :github_url: hide
- .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the NavigationMeshInstance.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_NavigationMeshInstance:
- NavigationMeshInstance
- ======================
- **Inherits:** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
- Node that instances navigation meshes into a scenario.
- Description
- -----------
- NavigationMeshInstance is a node that takes a :ref:`NavigationMesh<class_NavigationMesh>` resource and adds it to the current scenario by creating an instance of it.
- Properties
- ----------
- +---------------------------------------------+---------------------------------------------------------------+----------+
- | :ref:`bool<class_bool>` | :ref:`enabled<class_NavigationMeshInstance_property_enabled>` | ``true`` |
- +---------------------------------------------+---------------------------------------------------------------+----------+
- | :ref:`NavigationMesh<class_NavigationMesh>` | :ref:`navmesh<class_NavigationMeshInstance_property_navmesh>` | |
- +---------------------------------------------+---------------------------------------------------------------+----------+
- Property Descriptions
- ---------------------
- .. _class_NavigationMeshInstance_property_enabled:
- - :ref:`bool<class_bool>` **enabled**
- +-----------+--------------------+
- | *Default* | ``true`` |
- +-----------+--------------------+
- | *Setter* | set_enabled(value) |
- +-----------+--------------------+
- | *Getter* | is_enabled() |
- +-----------+--------------------+
- If ``true``, the navigation mesh will be used by :ref:`Navigation<class_Navigation>`.
- ----
- .. _class_NavigationMeshInstance_property_navmesh:
- - :ref:`NavigationMesh<class_NavigationMesh>` **navmesh**
- +----------+----------------------------+
- | *Setter* | set_navigation_mesh(value) |
- +----------+----------------------------+
- | *Getter* | get_navigation_mesh() |
- +----------+----------------------------+
- The :ref:`NavigationMesh<class_NavigationMesh>` resource for the instance.
- .. |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.)`
|
