godot-docs/classes/class_polygonpathfinder.rst

:github_url: hide

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the PolygonPathFinder.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_PolygonPathFinder:

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

**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`

**Category:** Core

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



Methods
-------

+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`find_path<class_PolygonPathFinder_method_find_path>` **(** :ref:`Vector2<class_Vector2>` from, :ref:`Vector2<class_Vector2>` to **)**                                |
+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_Rect2>`                       | :ref:`get_bounds<class_PolygonPathFinder_method_get_bounds>` **(** **)** const                                                                                             |
+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>`                   | :ref:`get_closest_point<class_PolygonPathFinder_method_get_closest_point>` **(** :ref:`Vector2<class_Vector2>` point **)** const                                           |
+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`get_intersections<class_PolygonPathFinder_method_get_intersections>` **(** :ref:`Vector2<class_Vector2>` from, :ref:`Vector2<class_Vector2>` to **)** const          |
+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                       | :ref:`get_point_penalty<class_PolygonPathFinder_method_get_point_penalty>` **(** :ref:`int<class_int>` idx **)** const                                                     |
+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                         | :ref:`is_point_inside<class_PolygonPathFinder_method_is_point_inside>` **(** :ref:`Vector2<class_Vector2>` point **)** const                                               |
+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                            | :ref:`set_point_penalty<class_PolygonPathFinder_method_set_point_penalty>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` penalty **)**                        |
+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                            | :ref:`setup<class_PolygonPathFinder_method_setup>` **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`PoolIntArray<class_PoolIntArray>` connections **)** |
+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

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

.. _class_PolygonPathFinder_method_find_path:

- :ref:`PoolVector2Array<class_PoolVector2Array>` **find_path** **(** :ref:`Vector2<class_Vector2>` from, :ref:`Vector2<class_Vector2>` to **)**

----

.. _class_PolygonPathFinder_method_get_bounds:

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

----

.. _class_PolygonPathFinder_method_get_closest_point:

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

----

.. _class_PolygonPathFinder_method_get_intersections:

- :ref:`PoolVector2Array<class_PoolVector2Array>` **get_intersections** **(** :ref:`Vector2<class_Vector2>` from, :ref:`Vector2<class_Vector2>` to **)** const

----

.. _class_PolygonPathFinder_method_get_point_penalty:

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

----

.. _class_PolygonPathFinder_method_is_point_inside:

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

----

.. _class_PolygonPathFinder_method_set_point_penalty:

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

----

.. _class_PolygonPathFinder_method_setup:

- void **setup** **(** :ref:`PoolVector2Array<class_PoolVector2Array>` points, :ref:`PoolIntArray<class_PoolIntArray>` connections **)**