class-description NEWS COMMUNITY STORE TUTORIALS SIGN UP LOGIN LOGOUT ROKOJORI NEWSLETTER SIGN UP LOGIN LOGOUT NEWS COMMUNITY STORE TUTORIALS TOGGLE FULLSCREEN VOLLBILD AN/AUS ObjectRefCountedResource NavigationPolygon
A 2D navigation mesh that describes a traversable surface for pathfinding.

A navigation mesh can be created either by baking it with the help of the NavigationServer2D, or by adding vertices and convex polygon indices arrays manually.

To bake a navigation mesh at least one outline needs to be added that defines the outer bounds of the baked area.

var new_navigation_mesh = NavigationPolygon.new() var bounding_outline = PackedVector2Array([Vector2(0, 0), Vector2(0, 50), Vector2(50, 50), Vector2(50, 0)]) new_navigation_mesh.add_outline(bounding_outline) NavigationServer2D.bake_from_source_geometry_data(new_navigation_mesh, NavigationMeshSourceGeometryData2D.new()); $NavigationRegion2D.navigation_polygon = new_navigation_mesh

Adding vertices and polygon indices manually.

var new_navigation_mesh = NavigationPolygon.new() var new_vertices = PackedVector2Array([Vector2(0, 0), Vector2(0, 50), Vector2(50, 50), Vector2(50, 0)]) new_navigation_mesh.vertices = new_vertices var new_polygon_indices = PackedInt32Array([0, 1, 2, 3]) new_navigation_mesh.add_polygon(new_polygon_indices) $NavigationRegion2D.navigation_polygon = new_navigation_mesh
Enum ParsedGeometryType<>():Enum

PARSED_GEOMETRY_MESH_INSTANCES = 0

Parses mesh instances as obstruction geometry. This includes Polygon2D, MeshInstance2D, MultiMeshInstance2D, and TileMap nodes.


PARSED_GEOMETRY_STATIC_COLLIDERS = 1

Parses StaticBody2D and TileMap colliders as obstruction geometry. The collider should be in any of the layers specified by parsed_collision_mask.


PARSED_GEOMETRY_BOTH = 2

Both PARSED_GEOMETRY_MESH_INSTANCES and PARSED_GEOMETRY_STATIC_COLLIDERS.


PARSED_GEOMETRY_MAX = 3

Represents the size of the ParsedGeometryType enum.

 Enum SourceGeometryMode<>():Enum

SOURCE_GEOMETRY_ROOT_NODE_CHILDREN = 0

Scans the child nodes of the root node recursively for geometry.


SOURCE_GEOMETRY_GROUPS_WITH_CHILDREN = 1

Scans nodes in a group and their child nodes recursively for geometry. The group is specified by source_geometry_group_name.


SOURCE_GEOMETRY_GROUPS_EXPLICIT = 2

Uses nodes in a group for geometry. The group is specified by source_geometry_group_name.


SOURCE_GEOMETRY_MAX = 3

Represents the size of the SourceGeometryMode enum.

 float agent_radius<>():float

The distance to erode/shrink the walkable surface when baking the navigation mesh.

 Rect2 baking_rect<>():Rect2

If the baking Rect2 has an area the navigation mesh baking will be restricted to its enclosing area.

 Vector2 baking_rect_offset<>():Vector2

The position offset applied to the baking_rect Rect2.

 float border_size<>():float

The size of the non-navigable border around the bake bounding area defined by the baking_rect Rect2.

In conjunction with the baking_rect the border size can be used to bake tile aligned navigation meshes without the tile edges being shrunk by agent_radius.

 float cell_size<>():float

The cell size used to rasterize the navigation mesh vertices. Must match with the cell size on the navigation map.

 int parsed_collision_mask<>():int

The physics layers to scan for static colliders.

Only used when parsed_geometry_type is PARSED_GEOMETRY_STATIC_COLLIDERS or PARSED_GEOMETRY_BOTH.

 ParsedGeometryType parsed_geometry_type<>():ParsedGeometryType

Determines which type of nodes will be parsed as geometry. See ParsedGeometryType for possible values.

 StringName source_geometry_group_name<>():StringName

The group name of nodes that should be parsed for baking source geometry.

Only used when source_geometry_mode is SOURCE_GEOMETRY_GROUPS_WITH_CHILDREN or SOURCE_GEOMETRY_GROUPS_EXPLICIT.

 SourceGeometryMode source_geometry_mode<>():SourceGeometryMode

The source of the geometry used when baking. See SourceGeometryMode for possible values.

 void add_outline<>( PackedVector2Array outline=, outline:PackedVector2Array=, ):void

Appends a PackedVector2Array that contains the vertices of an outline to the internal array that contains all the outlines.

 void add_outline_at_index<>( PackedVector2Array outline=, outline:PackedVector2Array=, int index=, index:int=, ):void

Adds a PackedVector2Array that contains the vertices of an outline to the internal array that contains all the outlines at a fixed position.

 void add_polygon<>( PackedInt32Array polygon=, polygon:PackedInt32Array=, ):void

Adds a polygon using the indices of the vertices you get when calling get_vertices.

 void clear<>():void

Clears the internal arrays for vertices and polygon indices.

 void clear_outlines<>():void

Clears the array of the outlines, but it doesn't clear the vertices and the polygons that were created by them.

 void clear_polygons<>():void

Clears the array of polygons, but it doesn't clear the array of outlines and vertices.

 NavigationMesh get_navigation_mesh<>():NavigationMesh

Returns the NavigationMesh resulting from this navigation polygon. This navigation mesh can be used to update the navigation mesh of a region with the NavigationServer3D.region_set_navigation_mesh API directly (as 2D uses the 3D server behind the scene).

 PackedVector2Array get_outline<>( int idx=, idx:int=, ):PackedVector2Array

Returns a PackedVector2Array containing the vertices of an outline that was created in the editor or by script.

 int get_outline_count<>():int

Returns the number of outlines that were created in the editor or by script.

 bool get_parsed_collision_mask_value<>( int layer_number=, layer_number:int=, ):bool

Returns whether or not the specified layer of the parsed_collision_mask is enabled, given a layer_number between 1 and 32.

 PackedInt32Array get_polygon<>( int idx=, idx:int=, ):PackedInt32Array

Returns a PackedInt32Array containing the indices of the vertices of a created polygon.

 int get_polygon_count<>():int

Returns the count of all polygons.

 PackedVector2Array get_vertices<>():PackedVector2Array

Returns a PackedVector2Array containing all the vertices being used to create the polygons.

 void make_polygons_from_outlines<>():void

Creates polygons from the outlines added in the editor or by script.

Deprecated. This function is deprecated, and might be removed in a future release. Use NavigationServer2D.parse_source_geometry_data and NavigationServer2D.bake_from_source_geometry_data instead.

 void remove_outline<>( int idx=, idx:int=, ):void

Removes an outline created in the editor or by script. You have to call make_polygons_from_outlines for the polygons to update.

 void set_outline<>( int idx=, idx:int=, PackedVector2Array outline=, outline:PackedVector2Array=, ):void

Changes an outline created in the editor or by script. You have to call make_polygons_from_outlines for the polygons to update.

 void set_parsed_collision_mask_value<>( int layer_number=, layer_number:int=, bool value=, value:bool=, ):void

Based on value, enables or disables the specified layer in the parsed_collision_mask, given a layer_number between 1 and 32.

 void set_vertices<>( PackedVector2Array vertices=, vertices:PackedVector2Array=, ):void

Sets the vertices that can be then indexed to create polygons with the add_polygon method.


All social media brands are registrated trademarks and belong to their respective owners.





CONTACT IMPRINT TERMS OF USE PRIVACY © ROKOROJI ® 2021 rokojori.com CONTACT IMPRINT TERMS OF USE PRIVACY © ROKOROJI ® 2021 rokojori.com We are using cookies on this site. Read more... Wir benutzen Cookies auf dieser Seite. Mehr lesen...