.. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/docs/gdscript/doc/classes/NavigationRegion2D.xml. .. _class_NavigationRegion2D: NavigationRegion2D ================== **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +---------------------------------------------------+-------------------------------------------------------------------------------------+----------+ | :ref:`bool` | :ref:`enabled` | ``true`` | +---------------------------------------------------+-------------------------------------------------------------------------------------+----------+ | :ref:`float` | :ref:`enter_cost` | ``0.0`` | +---------------------------------------------------+-------------------------------------------------------------------------------------+----------+ | :ref:`int` | :ref:`navigation_layers` | ``1`` | +---------------------------------------------------+-------------------------------------------------------------------------------------+----------+ | :ref:`NavigationPolygon` | :ref:`navigation_polygon` | | +---------------------------------------------------+-------------------------------------------------------------------------------------+----------+ | :ref:`float` | :ref:`travel_cost` | ``1.0`` | +---------------------------------------------------+-------------------------------------------------------------------------------------+----------+ | :ref:`bool` | :ref:`use_edge_connections` | ``true`` | +---------------------------------------------------+-------------------------------------------------------------------------------------+----------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`bake_navigation_polygon` **(** :ref:`bool` on_thread=true **)** | +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_navigation_layer_value` **(** :ref:`int` layer_number **)** |const| | +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_navigation_map` **(** **)** |const| | +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_region_rid` **(** **)** |const| | +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_rid` **(** **)** |const| | +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_baking` **(** **)** |const| | +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_navigation_layer_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_navigation_map` **(** :ref:`RID` navigation_map **)** | +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_NavigationRegion2D_signal_bake_finished: .. rst-class:: classref-signal **bake_finished** **(** **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_NavigationRegion2D_signal_navigation_polygon_changed: .. rst-class:: classref-signal **navigation_polygon_changed** **(** **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_NavigationRegion2D_property_enabled: .. rst-class:: classref-property :ref:`bool` **enabled** = ``true`` .. rst-class:: classref-property-setget - void **set_enabled** **(** :ref:`bool` value **)** - :ref:`bool` **is_enabled** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_NavigationRegion2D_property_enter_cost: .. rst-class:: classref-property :ref:`float` **enter_cost** = ``0.0`` .. rst-class:: classref-property-setget - void **set_enter_cost** **(** :ref:`float` value **)** - :ref:`float` **get_enter_cost** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_NavigationRegion2D_property_navigation_layers: .. rst-class:: classref-property :ref:`int` **navigation_layers** = ``1`` .. rst-class:: classref-property-setget - void **set_navigation_layers** **(** :ref:`int` value **)** - :ref:`int` **get_navigation_layers** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_NavigationRegion2D_property_navigation_polygon: .. rst-class:: classref-property :ref:`NavigationPolygon` **navigation_polygon** .. rst-class:: classref-property-setget - void **set_navigation_polygon** **(** :ref:`NavigationPolygon` value **)** - :ref:`NavigationPolygon` **get_navigation_polygon** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_NavigationRegion2D_property_travel_cost: .. rst-class:: classref-property :ref:`float` **travel_cost** = ``1.0`` .. rst-class:: classref-property-setget - void **set_travel_cost** **(** :ref:`float` value **)** - :ref:`float` **get_travel_cost** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_NavigationRegion2D_property_use_edge_connections: .. rst-class:: classref-property :ref:`bool` **use_edge_connections** = ``true`` .. rst-class:: classref-property-setget - void **set_use_edge_connections** **(** :ref:`bool` value **)** - :ref:`bool` **get_use_edge_connections** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_NavigationRegion2D_method_bake_navigation_polygon: .. rst-class:: classref-method void **bake_navigation_polygon** **(** :ref:`bool` on_thread=true **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_NavigationRegion2D_method_get_navigation_layer_value: .. rst-class:: classref-method :ref:`bool` **get_navigation_layer_value** **(** :ref:`int` layer_number **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_NavigationRegion2D_method_get_navigation_map: .. rst-class:: classref-method :ref:`RID` **get_navigation_map** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_NavigationRegion2D_method_get_region_rid: .. rst-class:: classref-method :ref:`RID` **get_region_rid** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_NavigationRegion2D_method_get_rid: .. rst-class:: classref-method :ref:`RID` **get_rid** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_NavigationRegion2D_method_is_baking: .. rst-class:: classref-method :ref:`bool` **is_baking** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_NavigationRegion2D_method_set_navigation_layer_value: .. rst-class:: classref-method void **set_navigation_layer_value** **(** :ref:`int` layer_number, :ref:`bool` value **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_NavigationRegion2D_method_set_navigation_map: .. rst-class:: classref-method void **set_navigation_map** **(** :ref:`RID` navigation_map **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. |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.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`