Files
godot-docs/classes/class_polygonpathfinder.rst
Rémi Verschelde 2f06d055e3 De-headline the Inherits and Category fields
Also escape _ and * characters in e.g. "TYPE_*" description content.
2016-02-08 18:31:35 +01:00

69 lines
4.8 KiB
ReStructuredText

.. _class_PolygonPathFinder:
PolygonPathFinder
=================
**Inherits:** :ref:`Resource<class_resource>`
**Category:** Core
Member Functions
----------------
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`setup<class_PolygonPathFinder_setup>` **(** :ref:`Vector2Array<class_vector2array>` points, :ref:`IntArray<class_intarray>` connections **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2Array<class_vector2array>` | :ref:`find_path<class_PolygonPathFinder_find_path>` **(** :ref:`Vector2<class_vector2>` from, :ref:`Vector2<class_vector2>` to **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2Array<class_vector2array>` | :ref:`get_intersections<class_PolygonPathFinder_get_intersections>` **(** :ref:`Vector2<class_vector2>` from, :ref:`Vector2<class_vector2>` to **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_closest_point<class_PolygonPathFinder_get_closest_point>` **(** :ref:`Vector2<class_vector2>` point **)** 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 **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_point_penalty<class_PolygonPathFinder_get_point_penalty>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`get_bounds<class_PolygonPathFinder_get_bounds>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Function Description
---------------------------
.. _class_PolygonPathFinder_setup:
- void **setup** **(** :ref:`Vector2Array<class_vector2array>` points, :ref:`IntArray<class_intarray>` connections **)**
.. _class_PolygonPathFinder_find_path:
- :ref:`Vector2Array<class_vector2array>` **find_path** **(** :ref:`Vector2<class_vector2>` from, :ref:`Vector2<class_vector2>` to **)**
.. _class_PolygonPathFinder_get_intersections:
- :ref:`Vector2Array<class_vector2array>` **get_intersections** **(** :ref:`Vector2<class_vector2>` from, :ref:`Vector2<class_vector2>` to **)** const
.. _class_PolygonPathFinder_get_closest_point:
- :ref:`Vector2<class_vector2>` **get_closest_point** **(** :ref:`Vector2<class_vector2>` point **)** 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_get_point_penalty:
- :ref:`float<class_float>` **get_point_penalty** **(** :ref:`int<class_int>` idx **)** const
.. _class_PolygonPathFinder_get_bounds:
- :ref:`Rect2<class_rect2>` **get_bounds** **(** **)** const