Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: f26bdbbcd4
Branches Tags
godot-docs
/
classes
/
class_navigationobstacle2d.rst

class_navigationobstacle2d.rst 2.1 KB
History Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243444546 
  1. :github_url: hide
    2. 

  2. 

  3. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    4. 

  4. .. DO NOT EDIT THIS FILE, but the NavigationObstacle2D.xml source instead.
    5. 

  5. .. The source is found in doc/classes or modules/<name>/doc_classes.
    6. 

  6. 

  7. .. _class_NavigationObstacle2D:
    8. 

  8. 

  9. NavigationObstacle2D
    10. 

  10. ====================
    11. 

  11. 

  12. **Inherits:** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
    13. 

  13. 

  14. 2D Obstacle used in navigation for collision avoidance.
    15. 

  15. 

  16. Description
    17. 

  17. -----------
    18. 

  18. 

  19. 2D Obstacle used in navigation for collision avoidance. The obstacle needs navigation data to work correctly. This can be done by having the obstacle as a child of a :ref:`Navigation2D<class_Navigation2D>` node, or using :ref:`set_navigation<class_NavigationObstacle2D_method_set_navigation>`. :ref:`NavigationObstacle<class_NavigationObstacle>` is physics safe.
    20. 

  20. 

  21. Methods
    22. 

  22. -------
    23. 

  23. 

  24. +-------------------------+------------------------------------------------------------------------------------------------------------------------+
    25. 

  25. | :ref:`Node<class_Node>` | :ref:`get_navigation<class_NavigationObstacle2D_method_get_navigation>` **(** **)** const                              |
    26. 

  26. +-------------------------+------------------------------------------------------------------------------------------------------------------------+
    27. 

  27. | void                    | :ref:`set_navigation<class_NavigationObstacle2D_method_set_navigation>` **(** :ref:`Node<class_Node>` navigation **)** |
    28. 

  28. +-------------------------+------------------------------------------------------------------------------------------------------------------------+
    29. 

  29. 

  30. Method Descriptions
    31. 

  31. -------------------
    32. 

  32. 

  33. .. _class_NavigationObstacle2D_method_get_navigation:
    34. 

  34. 

  35. - :ref:`Node<class_Node>` **get_navigation** **(** **)** const
    36. 

  36. 

  37. Returns the :ref:`Navigation2D<class_Navigation2D>` node that the obstacle is using for its navigation system.
    38. 

  38. 

  39. ----
    40. 

  40. 

  41. .. _class_NavigationObstacle2D_method_set_navigation:
    42. 

  42. 

  43. - void **set_navigation** **(** :ref:`Node<class_Node>` navigation **)**
    44. 

  44. 

  45. Sets the :ref:`Navigation2D<class_Navigation2D>` node used by the obstacle. Useful when you don't want to make the obstacle a child of a :ref:`Navigation2D<class_Navigation2D>` node.
    46. 

  46.