Merge pull request #62052 from smix8/navigation_layer_functions_4.x

Streamline Navigation layer function names.

doc/classes/NavigationAgent2D.xml

@@ -108,8 +108,8 @@
 		<member name="max_speed" type="float" setter="set_max_speed" getter="get_max_speed" default="200.0">
 			The maximum speed that an agent can move.
 		</member>
-		<member name="navigable_layers" type="int" setter="set_navigable_layers" getter="get_navigable_layers" default="1">
-			A bitfield determining what layers of navigation regions this agent will use to calculate path. Changing it runtime will clear current navigation path and generate new one, according to new layers.
+		<member name="navigation_layers" type="int" setter="set_navigation_layers" getter="get_navigation_layers" default="1">
+			A bitfield determining what navigation layers of navigation regions this agent will use to calculate path. Changing it runtime will clear current navigation path and generate new one, according to new navigation layers.
 		</member>
 		<member name="neighbor_dist" type="float" setter="set_neighbor_dist" getter="get_neighbor_dist" default="500.0">
 			The distance to search for other agents.

doc/classes/NavigationAgent3D.xml

@@ -114,8 +114,8 @@
 		<member name="max_speed" type="float" setter="set_max_speed" getter="get_max_speed" default="10.0">
 			The maximum speed that an agent can move.
 		</member>
-		<member name="navigable_layers" type="int" setter="set_navigable_layers" getter="get_navigable_layers" default="1">
-			A bitfield determining what layers of navigation regions this agent will use to calculate path. Changing it runtime will clear current navigation path and generate new one, according to new layers.
+		<member name="navigation_layers" type="int" setter="set_navigation_layers" getter="get_navigation_layers" default="1">
+			A bitfield determining what navigation layers of navigation regions this NavigationAgent will use to calculate path. Changing it runtime will clear current navigation path and generate new one, according to new navigation layers.
 		</member>
 		<member name="neighbor_dist" type="float" setter="set_neighbor_dist" getter="get_neighbor_dist" default="50.0">
 			The distance to search for other agents.

doc/classes/NavigationRegion2D.xml

@@ -28,8 +28,8 @@
 		<member name="enter_cost" type="float" setter="set_enter_cost" getter="get_enter_cost" default="0.0">
 			When pathfinding enters this regions navmesh from another regions navmesh the [code]enter_cost[/code] value is added to the path distance for determining the shortest path.
 		</member>
-		<member name="layers" type="int" setter="set_layers" getter="get_layers" default="1">
-			A bitfield determining all layers the region belongs to. These layers can be checked upon when requesting a path with [method NavigationServer2D.map_get_path].
+		<member name="navigation_layers" type="int" setter="set_navigation_layers" getter="get_navigation_layers" default="1">
+			A bitfield determining all navigation layers the region belongs to. These navigation layers can be checked upon when requesting a path with [method NavigationServer2D.map_get_path].
 		</member>
 		<member name="navpoly" type="NavigationPolygon" setter="set_navigation_polygon" getter="get_navigation_polygon">
 			The [NavigationPolygon] resource to use.

doc/classes/NavigationRegion3D.xml

@@ -35,8 +35,8 @@
 		<member name="enter_cost" type="float" setter="set_enter_cost" getter="get_enter_cost" default="0.0">
 			When pathfinding enters this regions navmesh from another regions navmesh the [code]enter_cost[/code] value is added to the path distance for determining the shortest path.
 		</member>
-		<member name="layers" type="int" setter="set_layers" getter="get_layers" default="1">
-			A bitfield determining all layers the region belongs to. These layers can be checked upon when requesting a path with [method NavigationServer3D.map_get_path].
+		<member name="navigation_layers" type="int" setter="set_navigation_layers" getter="get_navigation_layers" default="1">
+			A bitfield determining all navigation layers the region belongs to. These navigation layers can be checked upon when requesting a path with [method NavigationServer3D.map_get_path].
 		</member>
 		<member name="navmesh" type="NavigationMesh" setter="set_navigation_mesh" getter="get_navigation_mesh">
 			The [NavigationMesh] resource to use.

doc/classes/NavigationServer2D.xml

@@ -8,7 +8,7 @@
 		Maps are made up of regions, which are made of navigation polygons. Together, they define the navigable areas in the 2D world.
 		[b]Note:[/b] Most NavigationServer changes take effect after the next physics frame and not immediately. This includes all changes made to maps, regions or agents by navigation related Nodes in the SceneTree or made through scripts.
 		For two regions to be connected to each other, they must share a similar edge. An edge is considered connected to another if both of its two vertices are at a distance less than [code]edge_connection_margin[/code] to the respective other edge's vertex.
-		You may assign navigation layers to regions with [method NavigationServer2D.region_set_layers], which then can be checked upon when requesting a path with [method NavigationServer2D.map_get_path]. This allows allowing or forbidding some areas to 2D objects.
+		You may assign navigation layers to regions with [method NavigationServer2D.region_set_navigation_layers], which then can be checked upon when requesting a path with [method NavigationServer2D.map_get_path]. This allows allowing or forbidding some areas to 2D objects.
 		To use the collision avoidance system, you may use agents. You can set an agent's target velocity, then the servers will emit a callback with a modified velocity.
 		[b]Note:[/b] The collision avoidance system ignores regions. Using the modified velocity as-is might lead to pushing and agent outside of a navigable area. This is a limitation of the collision avoidance system, any more complex situation may require the use of the physics engine.
 		This server keeps tracks of any call and executes them during the sync phase. This means that you can request any change to the map, using any thread, without worrying.
@@ -176,9 +176,9 @@
 			<argument index="1" name="origin" type="Vector2" />
 			<argument index="2" name="destination" type="Vector2" />
 			<argument index="3" name="optimize" type="bool" />
-			<argument index="4" name="layers" type="int" default="1" />
+			<argument index="4" name="navigation_layers" type="int" default="1" />
 			<description>
-				Returns the navigation path to reach the destination from the origin. [code]layers[/code] is a bitmask of all region layers that are allowed to be in the path.
+				Returns the navigation path to reach the destination from the origin. [code]navigation_layers[/code] is a bitmask of all region navigation layers that are allowed to be in the path.
 			</description>
 		</method>
 		<method name="map_get_regions" qualifiers="const">
@@ -255,18 +255,18 @@
 				Returns the [code]enter_cost[/code] of this [code]region[/code].
 			</description>
 		</method>
-		<method name="region_get_layers" qualifiers="const">
-			<return type="int" />
+		<method name="region_get_map" qualifiers="const">
+			<return type="RID" />
 			<argument index="0" name="region" type="RID" />
 			<description>
-				Returns the region's layers.
+				Returns the navigation map [RID] the requested [code]region[/code] is currently assigned to.
 			</description>
 		</method>
-		<method name="region_get_map" qualifiers="const">
-			<return type="RID" />
+		<method name="region_get_navigation_layers" qualifiers="const">
+			<return type="int" />
 			<argument index="0" name="region" type="RID" />
 			<description>
-				Returns the navigation map [RID] the requested [code]region[/code] is currently assigned to.
+				Returns the region's navigation layers.
 			</description>
 		</method>
 		<method name="region_get_travel_cost" qualifiers="const">
@@ -284,20 +284,20 @@
 				Sets the [code]enter_cost[/code] for this [code]region[/code].
 			</description>
 		</method>
-		<method name="region_set_layers" qualifiers="const">
+		<method name="region_set_map" qualifiers="const">
 			<return type="void" />
 			<argument index="0" name="region" type="RID" />
-			<argument index="1" name="layers" type="int" />
+			<argument index="1" name="map" type="RID" />
 			<description>
-				Set the region's layers. This allows selecting regions from a path request (when using [method NavigationServer2D.map_get_path]).
+				Sets the map for the region.
 			</description>
 		</method>
-		<method name="region_set_map" qualifiers="const">
+		<method name="region_set_navigation_layers" qualifiers="const">
 			<return type="void" />
 			<argument index="0" name="region" type="RID" />
-			<argument index="1" name="map" type="RID" />
+			<argument index="1" name="navigation_layers" type="int" />
 			<description>
-				Sets the map for the region.
+				Set the region's navigation layers. This allows selecting regions from a path request (when using [method NavigationServer2D.map_get_path]).
 			</description>
 		</method>
 		<method name="region_set_navpoly" qualifiers="const">

doc/classes/NavigationServer3D.xml

@@ -8,7 +8,7 @@
 		Maps are made up of regions, which are made of navigation meshes. Together, they define the navigable areas in the 3D world.
 		[b]Note:[/b] Most NavigationServer changes take effect after the next physics frame and not immediately. This includes all changes made to maps, regions or agents by navigation related Nodes in the SceneTree or made through scripts.
 		For two regions to be connected to each other, they must share a similar edge. An edge is considered connected to another if both of its two vertices are at a distance less than [code]edge_connection_margin[/code] to the respective other edge's vertex.
-		You may assign navigation layers to regions with [method NavigationServer3D.region_set_layers], which then can be checked upon when requesting a path with [method NavigationServer3D.map_get_path]. This allows allowing or forbidding some areas to 3D objects.
+		You may assign navigation layers to regions with [method NavigationServer3D.region_set_navigation_layers], which then can be checked upon when requesting a path with [method NavigationServer3D.map_get_path]. This allows allowing or forbidding some areas to 3D objects.
 		To use the collision avoidance system, you may use agents. You can set an agent's target velocity, then the servers will emit a callback with a modified velocity.
 		[b]Note:[/b] The collision avoidance system ignores regions. Using the modified velocity as-is might lead to pushing and agent outside of a navigable area. This is a limitation of the collision avoidance system, any more complex situation may require the use of the physics engine.
 		This server keeps tracks of any call and executes them during the sync phase. This means that you can request any change to the map, using any thread, without worrying.
@@ -194,9 +194,9 @@
 			<argument index="1" name="origin" type="Vector3" />
 			<argument index="2" name="destination" type="Vector3" />
 			<argument index="3" name="optimize" type="bool" />
-			<argument index="4" name="layers" type="int" default="1" />
+			<argument index="4" name="navigation_layers" type="int" default="1" />
 			<description>
-				Returns the navigation path to reach the destination from the origin. [code]layers[/code] is a bitmask of all region layers that are allowed to be in the path.
+				Returns the navigation path to reach the destination from the origin. [code]navigation_layers[/code] is a bitmask of all region navigation layers that are allowed to be in the path.
 			</description>
 		</method>
 		<method name="map_get_regions" qualifiers="const">
@@ -305,18 +305,18 @@
 				Returns the [code]enter_cost[/code] of this [code]region[/code].
 			</description>
 		</method>
-		<method name="region_get_layers" qualifiers="const">
-			<return type="int" />
+		<method name="region_get_map" qualifiers="const">
+			<return type="RID" />
 			<argument index="0" name="region" type="RID" />
 			<description>
-				Returns the region's layers.
+				Returns the navigation map [RID] the requested [code]region[/code] is currently assigned to.
 			</description>
 		</method>
-		<method name="region_get_map" qualifiers="const">
-			<return type="RID" />
+		<method name="region_get_navigation_layers" qualifiers="const">
+			<return type="int" />
 			<argument index="0" name="region" type="RID" />
 			<description>
-				Returns the navigation map [RID] the requested [code]region[/code] is currently assigned to.
+				Returns the region's navigation layers.
 			</description>
 		</method>
 		<method name="region_get_travel_cost" qualifiers="const">
@@ -334,20 +334,20 @@
 				Sets the [code]enter_cost[/code] for this [code]region[/code].
 			</description>
 		</method>
-		<method name="region_set_layers" qualifiers="const">
+		<method name="region_set_map" qualifiers="const">
 			<return type="void" />
 			<argument index="0" name="region" type="RID" />
-			<argument index="1" name="layers" type="int" />
+			<argument index="1" name="map" type="RID" />
 			<description>
-				Set the region's layers. This allows selecting regions from a path request (when using [method NavigationServer3D.map_get_path]).
+				Sets the map for the region.
 			</description>
 		</method>
-		<method name="region_set_map" qualifiers="const">
+		<method name="region_set_navigation_layers" qualifiers="const">
 			<return type="void" />
 			<argument index="0" name="region" type="RID" />
-			<argument index="1" name="map" type="RID" />
+			<argument index="1" name="navigation_layers" type="int" />
 			<description>
-				Sets the map for the region.
+				Set the region's navigation layers. This allows selecting regions from a path request (when using [method NavigationServer3D.map_get_path]).
 			</description>
 		</method>
 		<method name="region_set_navmesh" qualifiers="const">

modules/gridmap/grid_map.cpp

@@ -226,8 +226,8 @@ bool GridMap::is_baking_navigation() {
 	return bake_navigation;
 }
 
-void GridMap::set_navigation_layers(uint32_t p_layers) {
-	navigation_layers = p_layers;
+void GridMap::set_navigation_layers(uint32_t p_navigation_layers) {
+	navigation_layers = p_navigation_layers;
 	_recreate_octant_data();
 }
 
@@ -548,7 +548,7 @@ bool GridMap::_octant_update(const OctantKey &p_key) {
 
 			if (bake_navigation) {
 				RID region = NavigationServer3D::get_singleton()->region_create();
-				NavigationServer3D::get_singleton()->region_set_layers(region, navigation_layers);
+				NavigationServer3D::get_singleton()->region_set_navigation_layers(region, navigation_layers);
 				NavigationServer3D::get_singleton()->region_set_navmesh(region, navmesh);
 				NavigationServer3D::get_singleton()->region_set_transform(region, get_global_transform() * nm.xform);
 				NavigationServer3D::get_singleton()->region_set_map(region, get_world_3d()->get_navigation_map());
@@ -659,7 +659,7 @@ void GridMap::_octant_enter_world(const OctantKey &p_key) {
 				Ref<NavigationMesh> nm = mesh_library->get_item_navmesh(cell_map[F.key].item);
 				if (nm.is_valid()) {
 					RID region = NavigationServer3D::get_singleton()->region_create();
-					NavigationServer3D::get_singleton()->region_set_layers(region, navigation_layers);
+					NavigationServer3D::get_singleton()->region_set_navigation_layers(region, navigation_layers);
 					NavigationServer3D::get_singleton()->region_set_navmesh(region, nm);
 					NavigationServer3D::get_singleton()->region_set_transform(region, get_global_transform() * F.value.xform);
 					NavigationServer3D::get_singleton()->region_set_map(region, get_world_3d()->get_navigation_map());

modules/gridmap/grid_map.h

@@ -238,7 +238,7 @@ class GridMap : public Node3D {
 	void set_bake_navigation(bool p_bake_navigation);
 	bool is_baking_navigation();
 
-	void set_navigation_layers(uint32_t p_layers);
+	void set_navigation_layers(uint32_t p_navigation_layers);
 	uint32_t get_navigation_layers();
 
 	void set_mesh_library(const Ref<MeshLibrary> &p_mesh_library);

modules/navigation/godot_navigation_server.cpp

@@ -198,11 +198,11 @@ real_t GodotNavigationServer::map_get_edge_connection_margin(RID p_map) const {
 	return map->get_edge_connection_margin();
 }
 
-Vector<Vector3> GodotNavigationServer::map_get_path(RID p_map, Vector3 p_origin, Vector3 p_destination, bool p_optimize, uint32_t p_layers) const {
+Vector<Vector3> GodotNavigationServer::map_get_path(RID p_map, Vector3 p_origin, Vector3 p_destination, bool p_optimize, uint32_t p_navigation_layers) const {
 	const NavMap *map = map_owner.get_or_null(p_map);
 	ERR_FAIL_COND_V(map == nullptr, Vector<Vector3>());
 
-	return map->get_path(p_origin, p_destination, p_optimize, p_layers);
+	return map->get_path(p_origin, p_destination, p_optimize, p_navigation_layers);
 }
 
 Vector3 GodotNavigationServer::map_get_closest_point_to_segment(RID p_map, const Vector3 &p_from, const Vector3 &p_to, const bool p_use_collision) const {
@@ -339,18 +339,18 @@ real_t GodotNavigationServer::region_get_travel_cost(RID p_region) const {
 	return region->get_travel_cost();
 }
 
-COMMAND_2(region_set_layers, RID, p_region, uint32_t, p_layers) {
+COMMAND_2(region_set_navigation_layers, RID, p_region, uint32_t, p_navigation_layers) {
 	NavRegion *region = region_owner.get_or_null(p_region);
 	ERR_FAIL_COND(region == nullptr);
 
-	region->set_layers(p_layers);
+	region->set_navigation_layers(p_navigation_layers);
 }
 
-uint32_t GodotNavigationServer::region_get_layers(RID p_region) const {
+uint32_t GodotNavigationServer::region_get_navigation_layers(RID p_region) const {
 	NavRegion *region = region_owner.get_or_null(p_region);
 	ERR_FAIL_COND_V(region == nullptr, 0);
 
-	return region->get_layers();
+	return region->get_navigation_layers();
 }
 
 COMMAND_2(region_set_navmesh, RID, p_region, Ref<NavigationMesh>, p_nav_mesh) {

modules/navigation/godot_navigation_server.h

@@ -98,7 +98,7 @@ class GodotNavigationServer : public NavigationServer3D {
 	COMMAND_2(map_set_edge_connection_margin, RID, p_map, real_t, p_connection_margin);
 	virtual real_t map_get_edge_connection_margin(RID p_map) const override;
 
-	virtual Vector<Vector3> map_get_path(RID p_map, Vector3 p_origin, Vector3 p_destination, bool p_optimize, uint32_t p_layers = 1) const override;
+	virtual Vector<Vector3> map_get_path(RID p_map, Vector3 p_origin, Vector3 p_destination, bool p_optimize, uint32_t p_navigation_layers = 1) const override;
 
 	virtual Vector3 map_get_closest_point_to_segment(RID p_map, const Vector3 &p_from, const Vector3 &p_to, const bool p_use_collision = false) const override;
 	virtual Vector3 map_get_closest_point(RID p_map, const Vector3 &p_point) const override;
@@ -117,8 +117,8 @@ class GodotNavigationServer : public NavigationServer3D {
 
 	COMMAND_2(region_set_map, RID, p_region, RID, p_map);
 	virtual RID region_get_map(RID p_region) const override;
-	COMMAND_2(region_set_layers, RID, p_region, uint32_t, p_layers);
-	virtual uint32_t region_get_layers(RID p_region) const override;
+	COMMAND_2(region_set_navigation_layers, RID, p_region, uint32_t, p_navigation_layers);
+	virtual uint32_t region_get_navigation_layers(RID p_region) const override;
 	COMMAND_2(region_set_transform, RID, p_region, Transform3D, p_transform);
 	COMMAND_2(region_set_navmesh, RID, p_region, Ref<NavigationMesh>, p_nav_mesh);
 	virtual void region_bake_navmesh(Ref<NavigationMesh> r_mesh, Node *p_node) const override;

modules/navigation/nav_map.cpp

@@ -65,7 +65,7 @@ gd::PointKey NavMap::get_point_key(const Vector3 &p_pos) const {
 	return p;
 }
 
-Vector<Vector3> NavMap::get_path(Vector3 p_origin, Vector3 p_destination, bool p_optimize, uint32_t p_layers) const {
+Vector<Vector3> NavMap::get_path(Vector3 p_origin, Vector3 p_destination, bool p_optimize, uint32_t p_navigation_layers) const {
 	// Find the start poly and the end poly on this map.
 	const gd::Polygon *begin_poly = nullptr;
 	const gd::Polygon *end_poly = nullptr;
@@ -78,7 +78,7 @@ Vector<Vector3> NavMap::get_path(Vector3 p_origin, Vector3 p_destination, bool p
 		const gd::Polygon &p = polygons[i];
 
 		// Only consider the polygon if it in a region with compatible layers.
-		if ((p_layers & p.owner->get_layers()) == 0) {
+		if ((p_navigation_layers & p.owner->get_navigation_layers()) == 0) {
 			continue;
 		}
 
@@ -154,7 +154,7 @@ Vector<Vector3> NavMap::get_path(Vector3 p_origin, Vector3 p_destination, bool p
 				const gd::Edge::Connection &connection = edge.connections[connection_index];
 
 				// Only consider the connection to another polygon if this polygon is in a region with compatible layers.
-				if ((p_layers & connection.polygon->owner->get_layers()) == 0) {
+				if ((p_navigation_layers & connection.polygon->owner->get_navigation_layers()) == 0) {
 					continue;
 				}