| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768 |
- :github_url: hide
- .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the NavigationObstacle2D.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_NavigationObstacle2D:
- NavigationObstacle2D
- ====================
- **Inherits:** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
- 2D Obstacle used in navigation for collision avoidance.
- Description
- -----------
- 2D Obstacle used in navigation for collision avoidance. The obstacle needs navigation data to work correctly. ``NavigationObstacle2D`` is physics safe.
- Properties
- ----------
- +---------------------------+-----------------------------------------------------------------------------+----------+
- | :ref:`bool<class_bool>` | :ref:`estimate_radius<class_NavigationObstacle2D_property_estimate_radius>` | ``true`` |
- +---------------------------+-----------------------------------------------------------------------------+----------+
- | :ref:`float<class_float>` | :ref:`radius<class_NavigationObstacle2D_property_radius>` | ``1.0`` |
- +---------------------------+-----------------------------------------------------------------------------+----------+
- Property Descriptions
- ---------------------
- .. _class_NavigationObstacle2D_property_estimate_radius:
- - :ref:`bool<class_bool>` **estimate_radius**
- +-----------+----------------------------+
- | *Default* | ``true`` |
- +-----------+----------------------------+
- | *Setter* | set_estimate_radius(value) |
- +-----------+----------------------------+
- | *Getter* | is_radius_estimated() |
- +-----------+----------------------------+
- Enables radius estimation algorithm which uses parent's collision shapes to determine the obstacle radius.
- ----
- .. _class_NavigationObstacle2D_property_radius:
- - :ref:`float<class_float>` **radius**
- +-----------+-------------------+
- | *Default* | ``1.0`` |
- +-----------+-------------------+
- | *Setter* | set_radius(value) |
- +-----------+-------------------+
- | *Getter* | get_radius() |
- +-----------+-------------------+
- The radius of the agent. Used only if :ref:`estimate_radius<class_NavigationObstacle2D_property_estimate_radius>` is set to false.
- .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
- .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
- .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
- .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
- .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
- .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|
