Files
godot-docs/classes/class_navigationpolygon.rst
2017-10-21 13:55:57 +02:00

128 lines
9.1 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the NavigationPolygon.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_NavigationPolygon:
NavigationPolygon
=================
**Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Functions
----------------
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_outline<class_NavigationPolygon_add_outline>` **(** :ref:`PoolVector2Array<class_poolvector2array>` outline **)** |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_outline_at_index<class_NavigationPolygon_add_outline_at_index>` **(** :ref:`PoolVector2Array<class_poolvector2array>` outline, :ref:`int<class_int>` index **)** |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_polygon<class_NavigationPolygon_add_polygon>` **(** :ref:`PoolIntArray<class_poolintarray>` polygon **)** |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_outlines<class_NavigationPolygon_clear_outlines>` **(** **)** |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_polygons<class_NavigationPolygon_clear_polygons>` **(** **)** |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolVector2Array<class_poolvector2array>` | :ref:`get_outline<class_NavigationPolygon_get_outline>` **(** :ref:`int<class_int>` idx **)** const |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_outline_count<class_NavigationPolygon_get_outline_count>` **(** **)** const |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolIntArray<class_poolintarray>` | :ref:`get_polygon<class_NavigationPolygon_get_polygon>` **(** :ref:`int<class_int>` idx **)** |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_polygon_count<class_NavigationPolygon_get_polygon_count>` **(** **)** const |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolVector2Array<class_poolvector2array>` | :ref:`get_vertices<class_NavigationPolygon_get_vertices>` **(** **)** const |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`make_polygons_from_outlines<class_NavigationPolygon_make_polygons_from_outlines>` **(** **)** |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_outline<class_NavigationPolygon_remove_outline>` **(** :ref:`int<class_int>` idx **)** |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_outline<class_NavigationPolygon_set_outline>` **(** :ref:`int<class_int>` idx, :ref:`PoolVector2Array<class_poolvector2array>` outline **)** |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_vertices<class_NavigationPolygon_set_vertices>` **(** :ref:`PoolVector2Array<class_poolvector2array>` vertices **)** |
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_NavigationPolygon_outlines:
- :ref:`Array<class_array>` **outlines**
.. _class_NavigationPolygon_polygons:
- :ref:`Array<class_array>` **polygons**
.. _class_NavigationPolygon_vertices:
- :ref:`PoolVector2Array<class_poolvector2array>` **vertices**
Member Function Description
---------------------------
.. _class_NavigationPolygon_add_outline:
- void **add_outline** **(** :ref:`PoolVector2Array<class_poolvector2array>` outline **)**
.. _class_NavigationPolygon_add_outline_at_index:
- void **add_outline_at_index** **(** :ref:`PoolVector2Array<class_poolvector2array>` outline, :ref:`int<class_int>` index **)**
.. _class_NavigationPolygon_add_polygon:
- void **add_polygon** **(** :ref:`PoolIntArray<class_poolintarray>` polygon **)**
.. _class_NavigationPolygon_clear_outlines:
- void **clear_outlines** **(** **)**
.. _class_NavigationPolygon_clear_polygons:
- void **clear_polygons** **(** **)**
.. _class_NavigationPolygon_get_outline:
- :ref:`PoolVector2Array<class_poolvector2array>` **get_outline** **(** :ref:`int<class_int>` idx **)** const
.. _class_NavigationPolygon_get_outline_count:
- :ref:`int<class_int>` **get_outline_count** **(** **)** const
.. _class_NavigationPolygon_get_polygon:
- :ref:`PoolIntArray<class_poolintarray>` **get_polygon** **(** :ref:`int<class_int>` idx **)**
.. _class_NavigationPolygon_get_polygon_count:
- :ref:`int<class_int>` **get_polygon_count** **(** **)** const
.. _class_NavigationPolygon_get_vertices:
- :ref:`PoolVector2Array<class_poolvector2array>` **get_vertices** **(** **)** const
.. _class_NavigationPolygon_make_polygons_from_outlines:
- void **make_polygons_from_outlines** **(** **)**
.. _class_NavigationPolygon_remove_outline:
- void **remove_outline** **(** :ref:`int<class_int>` idx **)**
.. _class_NavigationPolygon_set_outline:
- void **set_outline** **(** :ref:`int<class_int>` idx, :ref:`PoolVector2Array<class_poolvector2array>` outline **)**
.. _class_NavigationPolygon_set_vertices:
- void **set_vertices** **(** :ref:`PoolVector2Array<class_poolvector2array>` vertices **)**