.. 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/NavigationPolygon.xml. .. _class_NavigationPolygon: NavigationPolygon ================= **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :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:`float` | :ref:`agent_radius` | ``10.0`` | +----------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------+ | :ref:`Rect2` | :ref:`baking_rect` | ``Rect2(0, 0, 0, 0)`` | +----------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------+ | :ref:`Vector2` | :ref:`baking_rect_offset` | ``Vector2(0, 0)`` | +----------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------+ | :ref:`float` | :ref:`border_size` | ``0.0`` | +----------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------+ | :ref:`float` | :ref:`cell_size` | ``1.0`` | +----------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------+ | :ref:`int` | :ref:`parsed_collision_mask` | ``4294967295`` | +----------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------+ | :ref:`ParsedGeometryType` | :ref:`parsed_geometry_type` | ``2`` | +----------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------+ | :ref:`StringName` | :ref:`source_geometry_group_name` | ``&"navigation_polygon_source_geometry_group"`` | +----------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------+ | :ref:`SourceGeometryMode` | :ref:`source_geometry_mode` | ``0`` | +----------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_outline` **(** :ref:`PackedVector2Array` outline **)** | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_outline_at_index` **(** :ref:`PackedVector2Array` outline, :ref:`int` index **)** | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_polygon` **(** :ref:`PackedInt32Array` polygon **)** | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_outlines` **(** **)** | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_polygons` **(** **)** | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`NavigationMesh` | :ref:`get_navigation_mesh` **(** **)** | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedVector2Array` | :ref:`get_outline` **(** :ref:`int` idx **)** |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_outline_count` **(** **)** |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_parsed_collision_mask_value` **(** :ref:`int` layer_number **)** |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedInt32Array` | :ref:`get_polygon` **(** :ref:`int` idx **)** | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_polygon_count` **(** **)** |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedVector2Array` | :ref:`get_vertices` **(** **)** |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`make_polygons_from_outlines` **(** **)** | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_outline` **(** :ref:`int` idx **)** | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_outline` **(** :ref:`int` idx, :ref:`PackedVector2Array` outline **)** | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_parsed_collision_mask_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_vertices` **(** :ref:`PackedVector2Array` vertices **)** | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_NavigationPolygon_ParsedGeometryType: .. rst-class:: classref-enumeration enum **ParsedGeometryType**: .. _class_NavigationPolygon_constant_PARSED_GEOMETRY_MESH_INSTANCES: .. rst-class:: classref-enumeration-constant :ref:`ParsedGeometryType` **PARSED_GEOMETRY_MESH_INSTANCES** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_NavigationPolygon_constant_PARSED_GEOMETRY_STATIC_COLLIDERS: .. rst-class:: classref-enumeration-constant :ref:`ParsedGeometryType` **PARSED_GEOMETRY_STATIC_COLLIDERS** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_NavigationPolygon_constant_PARSED_GEOMETRY_BOTH: .. rst-class:: classref-enumeration-constant :ref:`ParsedGeometryType` **PARSED_GEOMETRY_BOTH** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_NavigationPolygon_constant_PARSED_GEOMETRY_MAX: .. rst-class:: classref-enumeration-constant :ref:`ParsedGeometryType` **PARSED_GEOMETRY_MAX** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_NavigationPolygon_SourceGeometryMode: .. rst-class:: classref-enumeration enum **SourceGeometryMode**: .. _class_NavigationPolygon_constant_SOURCE_GEOMETRY_ROOT_NODE_CHILDREN: .. rst-class:: classref-enumeration-constant :ref:`SourceGeometryMode` **SOURCE_GEOMETRY_ROOT_NODE_CHILDREN** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_NavigationPolygon_constant_SOURCE_GEOMETRY_GROUPS_WITH_CHILDREN: .. rst-class:: classref-enumeration-constant :ref:`SourceGeometryMode` **SOURCE_GEOMETRY_GROUPS_WITH_CHILDREN** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_NavigationPolygon_constant_SOURCE_GEOMETRY_GROUPS_EXPLICIT: .. rst-class:: classref-enumeration-constant :ref:`SourceGeometryMode` **SOURCE_GEOMETRY_GROUPS_EXPLICIT** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_NavigationPolygon_constant_SOURCE_GEOMETRY_MAX: .. rst-class:: classref-enumeration-constant :ref:`SourceGeometryMode` **SOURCE_GEOMETRY_MAX** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_NavigationPolygon_property_agent_radius: .. rst-class:: classref-property :ref:`float` **agent_radius** = ``10.0`` .. rst-class:: classref-property-setget - void **set_agent_radius** **(** :ref:`float` value **)** - :ref:`float` **get_agent_radius** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_NavigationPolygon_property_baking_rect: .. rst-class:: classref-property :ref:`Rect2` **baking_rect** = ``Rect2(0, 0, 0, 0)`` .. rst-class:: classref-property-setget - void **set_baking_rect** **(** :ref:`Rect2` value **)** - :ref:`Rect2` **get_baking_rect** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_NavigationPolygon_property_baking_rect_offset: .. rst-class:: classref-property :ref:`Vector2` **baking_rect_offset** = ``Vector2(0, 0)`` .. rst-class:: classref-property-setget - void **set_baking_rect_offset** **(** :ref:`Vector2` value **)** - :ref:`Vector2` **get_baking_rect_offset** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_NavigationPolygon_property_border_size: .. rst-class:: classref-property :ref:`float` **border_size** = ``0.0`` .. rst-class:: classref-property-setget - void **set_border_size** **(** :ref:`float` value **)** - :ref:`float` **get_border_size** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_NavigationPolygon_property_cell_size: .. rst-class:: classref-property :ref:`float` **cell_size** = ``1.0`` .. rst-class:: classref-property-setget - void **set_cell_size** **(** :ref:`float` value **)** - :ref:`float` **get_cell_size** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_NavigationPolygon_property_parsed_collision_mask: .. rst-class:: classref-property :ref:`int` **parsed_collision_mask** = ``4294967295`` .. rst-class:: classref-property-setget - void **set_parsed_collision_mask** **(** :ref:`int` value **)** - :ref:`int` **get_parsed_collision_mask** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_NavigationPolygon_property_parsed_geometry_type: .. rst-class:: classref-property :ref:`ParsedGeometryType` **parsed_geometry_type** = ``2`` .. rst-class:: classref-property-setget - void **set_parsed_geometry_type** **(** :ref:`ParsedGeometryType` value **)** - :ref:`ParsedGeometryType` **get_parsed_geometry_type** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_NavigationPolygon_property_source_geometry_group_name: .. rst-class:: classref-property :ref:`StringName` **source_geometry_group_name** = ``&"navigation_polygon_source_geometry_group"`` .. rst-class:: classref-property-setget - void **set_source_geometry_group_name** **(** :ref:`StringName` value **)** - :ref:`StringName` **get_source_geometry_group_name** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_NavigationPolygon_property_source_geometry_mode: .. rst-class:: classref-property :ref:`SourceGeometryMode` **source_geometry_mode** = ``0`` .. rst-class:: classref-property-setget - void **set_source_geometry_mode** **(** :ref:`SourceGeometryMode` value **)** - :ref:`SourceGeometryMode` **get_source_geometry_mode** **(** **)** .. 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_NavigationPolygon_method_add_outline: .. rst-class:: classref-method void **add_outline** **(** :ref:`PackedVector2Array` outline **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_NavigationPolygon_method_add_outline_at_index: .. rst-class:: classref-method void **add_outline_at_index** **(** :ref:`PackedVector2Array` outline, :ref:`int` index **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_NavigationPolygon_method_add_polygon: .. rst-class:: classref-method void **add_polygon** **(** :ref:`PackedInt32Array` polygon **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_NavigationPolygon_method_clear: .. rst-class:: classref-method void **clear** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_NavigationPolygon_method_clear_outlines: .. rst-class:: classref-method void **clear_outlines** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_NavigationPolygon_method_clear_polygons: .. rst-class:: classref-method void **clear_polygons** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_NavigationPolygon_method_get_navigation_mesh: .. rst-class:: classref-method :ref:`NavigationMesh` **get_navigation_mesh** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_NavigationPolygon_method_get_outline: .. rst-class:: classref-method :ref:`PackedVector2Array` **get_outline** **(** :ref:`int` idx **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_NavigationPolygon_method_get_outline_count: .. rst-class:: classref-method :ref:`int` **get_outline_count** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_NavigationPolygon_method_get_parsed_collision_mask_value: .. rst-class:: classref-method :ref:`bool` **get_parsed_collision_mask_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_NavigationPolygon_method_get_polygon: .. rst-class:: classref-method :ref:`PackedInt32Array` **get_polygon** **(** :ref:`int` idx **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_NavigationPolygon_method_get_polygon_count: .. rst-class:: classref-method :ref:`int` **get_polygon_count** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_NavigationPolygon_method_get_vertices: .. rst-class:: classref-method :ref:`PackedVector2Array` **get_vertices** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_NavigationPolygon_method_make_polygons_from_outlines: .. rst-class:: classref-method void **make_polygons_from_outlines** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_NavigationPolygon_method_remove_outline: .. rst-class:: classref-method void **remove_outline** **(** :ref:`int` idx **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_NavigationPolygon_method_set_outline: .. rst-class:: classref-method void **set_outline** **(** :ref:`int` idx, :ref:`PackedVector2Array` outline **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_NavigationPolygon_method_set_parsed_collision_mask_value: .. rst-class:: classref-method void **set_parsed_collision_mask_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_NavigationPolygon_method_set_vertices: .. rst-class:: classref-method void **set_vertices** **(** :ref:`PackedVector2Array` vertices **)** .. 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.)`