class_navigation2d.rst 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the Navigation2D.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_Navigation2D:
  5. Navigation2D
  6. ============
  7. **Inherits:** :ref:`Node2D<class_node2d>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Member Functions
  12. ----------------
  13. +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  14. | :ref:`Vector2<class_vector2>` | :ref:`get_closest_point<class_Navigation2D_get_closest_point>` **(** :ref:`Vector2<class_vector2>` to_point **)** |
  15. +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  16. | :ref:`Object<class_object>` | :ref:`get_closest_point_owner<class_Navigation2D_get_closest_point_owner>` **(** :ref:`Vector2<class_vector2>` to_point **)** |
  17. +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  18. | :ref:`PoolVector2Array<class_poolvector2array>` | :ref:`get_simple_path<class_Navigation2D_get_simple_path>` **(** :ref:`Vector2<class_vector2>` start, :ref:`Vector2<class_vector2>` end, :ref:`bool<class_bool>` optimize=true **)** |
  19. +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  20. | :ref:`int<class_int>` | :ref:`navpoly_add<class_Navigation2D_navpoly_add>` **(** :ref:`NavigationPolygon<class_navigationpolygon>` mesh, :ref:`Transform2D<class_transform2d>` xform, :ref:`Object<class_object>` owner=null **)** |
  21. +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  22. | void | :ref:`navpoly_remove<class_Navigation2D_navpoly_remove>` **(** :ref:`int<class_int>` id **)** |
  23. +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  24. | void | :ref:`navpoly_set_transform<class_Navigation2D_navpoly_set_transform>` **(** :ref:`int<class_int>` id, :ref:`Transform2D<class_transform2d>` xform **)** |
  25. +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  26. Member Function Description
  27. ---------------------------
  28. .. _class_Navigation2D_get_closest_point:
  29. - :ref:`Vector2<class_vector2>` **get_closest_point** **(** :ref:`Vector2<class_vector2>` to_point **)**
  30. .. _class_Navigation2D_get_closest_point_owner:
  31. - :ref:`Object<class_object>` **get_closest_point_owner** **(** :ref:`Vector2<class_vector2>` to_point **)**
  32. .. _class_Navigation2D_get_simple_path:
  33. - :ref:`PoolVector2Array<class_poolvector2array>` **get_simple_path** **(** :ref:`Vector2<class_vector2>` start, :ref:`Vector2<class_vector2>` end, :ref:`bool<class_bool>` optimize=true **)**
  34. .. _class_Navigation2D_navpoly_add:
  35. - :ref:`int<class_int>` **navpoly_add** **(** :ref:`NavigationPolygon<class_navigationpolygon>` mesh, :ref:`Transform2D<class_transform2d>` xform, :ref:`Object<class_object>` owner=null **)**
  36. .. _class_Navigation2D_navpoly_remove:
  37. - void **navpoly_remove** **(** :ref:`int<class_int>` id **)**
  38. .. _class_Navigation2D_navpoly_set_transform:
  39. - void **navpoly_set_transform** **(** :ref:`int<class_int>` id, :ref:`Transform2D<class_transform2d>` xform **)**