godot-docs/classes/class_navigationmeshsourcegeometrydata2d.rst

:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/NavigationMeshSourceGeometryData2D.xml.

.. _class_NavigationMeshSourceGeometryData2D:

NavigationMeshSourceGeometryData2D
==================================

**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`

Container for parsed source geometry data used in navigation mesh baking.

.. rst-class:: classref-introduction-group

Description
-----------

Container for parsed source geometry data used in navigation mesh baking.

.. rst-class:: classref-reftable-group

Methods
-------

.. table::
   :widths: auto

   +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                  | :ref:`add_obstruction_outline<class_NavigationMeshSourceGeometryData2D_method_add_obstruction_outline>` **(** :ref:`PackedVector2Array<class_PackedVector2Array>` shape_outline **)**            |
   +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                  | :ref:`add_traversable_outline<class_NavigationMeshSourceGeometryData2D_method_add_traversable_outline>` **(** :ref:`PackedVector2Array<class_PackedVector2Array>` shape_outline **)**            |
   +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                  | :ref:`clear<class_NavigationMeshSourceGeometryData2D_method_clear>` **(** **)**                                                                                                                  |
   +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`PackedVector2Array[]<class_PackedVector2Array>` | :ref:`get_obstruction_outlines<class_NavigationMeshSourceGeometryData2D_method_get_obstruction_outlines>` **(** **)** |const|                                                                    |
   +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`PackedVector2Array[]<class_PackedVector2Array>` | :ref:`get_traversable_outlines<class_NavigationMeshSourceGeometryData2D_method_get_traversable_outlines>` **(** **)** |const|                                                                    |
   +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                               | :ref:`has_data<class_NavigationMeshSourceGeometryData2D_method_has_data>` **(** **)**                                                                                                            |
   +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                  | :ref:`set_obstruction_outlines<class_NavigationMeshSourceGeometryData2D_method_set_obstruction_outlines>` **(** :ref:`PackedVector2Array[]<class_PackedVector2Array>` obstruction_outlines **)** |
   +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                  | :ref:`set_traversable_outlines<class_NavigationMeshSourceGeometryData2D_method_set_traversable_outlines>` **(** :ref:`PackedVector2Array[]<class_PackedVector2Array>` traversable_outlines **)** |
   +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Method Descriptions
-------------------

.. _class_NavigationMeshSourceGeometryData2D_method_add_obstruction_outline:

.. rst-class:: classref-method

void **add_obstruction_outline** **(** :ref:`PackedVector2Array<class_PackedVector2Array>` shape_outline **)**

Adds the outline points of a shape as obstructed area.

.. rst-class:: classref-item-separator

----

.. _class_NavigationMeshSourceGeometryData2D_method_add_traversable_outline:

.. rst-class:: classref-method

void **add_traversable_outline** **(** :ref:`PackedVector2Array<class_PackedVector2Array>` shape_outline **)**

Adds the outline points of a shape as traversable area.

.. rst-class:: classref-item-separator

----

.. _class_NavigationMeshSourceGeometryData2D_method_clear:

.. rst-class:: classref-method

void **clear** **(** **)**

Clears the internal data.

.. rst-class:: classref-item-separator

----

.. _class_NavigationMeshSourceGeometryData2D_method_get_obstruction_outlines:

.. rst-class:: classref-method

:ref:`PackedVector2Array[]<class_PackedVector2Array>` **get_obstruction_outlines** **(** **)** |const|

Returns all the obstructed area outlines arrays.

.. rst-class:: classref-item-separator

----

.. _class_NavigationMeshSourceGeometryData2D_method_get_traversable_outlines:

.. rst-class:: classref-method

:ref:`PackedVector2Array[]<class_PackedVector2Array>` **get_traversable_outlines** **(** **)** |const|

Returns all the traversable area outlines arrays.

.. rst-class:: classref-item-separator

----

.. _class_NavigationMeshSourceGeometryData2D_method_has_data:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **has_data** **(** **)**

Returns ``true`` when parsed source geometry data exists.

.. rst-class:: classref-item-separator

----

.. _class_NavigationMeshSourceGeometryData2D_method_set_obstruction_outlines:

.. rst-class:: classref-method

void **set_obstruction_outlines** **(** :ref:`PackedVector2Array[]<class_PackedVector2Array>` obstruction_outlines **)**

Sets all the obstructed area outlines arrays.

.. rst-class:: classref-item-separator

----

.. _class_NavigationMeshSourceGeometryData2D_method_set_traversable_outlines:

.. rst-class:: classref-method

void **set_traversable_outlines** **(** :ref:`PackedVector2Array[]<class_PackedVector2Array>` traversable_outlines **)**

Sets all the traversable area outlines arrays.

.. |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.)`
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`