godot-docs/classes/class_polygonpathfinder.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.

.. _class_PolygonPathFinder:

PolygonPathFinder
=================

**Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`

**Category:** Core

Brief Description
-----------------



Member Functions
----------------

+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2Array<class_vector2array>`  | :ref:`find_path<class_PolygonPathFinder_find_path>`  **(** :ref:`Vector2<class_vector2>` from, :ref:`Vector2<class_vector2>` to  **)**                       |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>`                | :ref:`get_bounds<class_PolygonPathFinder_get_bounds>`  **(** **)** const                                                                                     |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>`            | :ref:`get_closest_point<class_PolygonPathFinder_get_closest_point>`  **(** :ref:`Vector2<class_vector2>` point  **)** const                                  |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2Array<class_vector2array>`  | :ref:`get_intersections<class_PolygonPathFinder_get_intersections>`  **(** :ref:`Vector2<class_vector2>` from, :ref:`Vector2<class_vector2>` to  **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                | :ref:`get_point_penalty<class_PolygonPathFinder_get_point_penalty>`  **(** :ref:`int<class_int>` idx  **)** const                                            |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                  | :ref:`is_point_inside<class_PolygonPathFinder_is_point_inside>`  **(** :ref:`Vector2<class_vector2>` point  **)** const                                      |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                     | :ref:`set_point_penalty<class_PolygonPathFinder_set_point_penalty>`  **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` penalty  **)**               |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                     | :ref:`setup<class_PolygonPathFinder_setup>`  **(** :ref:`Vector2Array<class_vector2array>` points, :ref:`IntArray<class_intarray>` connections  **)**        |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+

Member Function Description
---------------------------

.. _class_PolygonPathFinder_find_path:

- :ref:`Vector2Array<class_vector2array>`  **find_path**  **(** :ref:`Vector2<class_vector2>` from, :ref:`Vector2<class_vector2>` to  **)**

.. _class_PolygonPathFinder_get_bounds:

- :ref:`Rect2<class_rect2>`  **get_bounds**  **(** **)** const

.. _class_PolygonPathFinder_get_closest_point:

- :ref:`Vector2<class_vector2>`  **get_closest_point**  **(** :ref:`Vector2<class_vector2>` point  **)** const

.. _class_PolygonPathFinder_get_intersections:

- :ref:`Vector2Array<class_vector2array>`  **get_intersections**  **(** :ref:`Vector2<class_vector2>` from, :ref:`Vector2<class_vector2>` to  **)** const

.. _class_PolygonPathFinder_get_point_penalty:

- :ref:`float<class_float>`  **get_point_penalty**  **(** :ref:`int<class_int>` idx  **)** const

.. _class_PolygonPathFinder_is_point_inside:

- :ref:`bool<class_bool>`  **is_point_inside**  **(** :ref:`Vector2<class_vector2>` point  **)** const

.. _class_PolygonPathFinder_set_point_penalty:

- void  **set_point_penalty**  **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` penalty  **)**

.. _class_PolygonPathFinder_setup:

- void  **setup**  **(** :ref:`Vector2Array<class_vector2array>` points, :ref:`IntArray<class_intarray>` connections  **)**