Add flags to Pathfinder.GetPathToCell()

Author: food-please

src/field/gameboard/pathfinder.gd

@@ -5,6 +5,11 @@ class_name Pathfinder
 extends AStar2D
 
 
+const FLAG_ALLOW_SOURCE_OCCUPANT = 1 << 0
+const FLAG_ALLOW_TARGET_OCCUPANT = 1 << 1
+const FLAG_ALLOW_ALL_OCCUPANTS = 1 << 2
+
+
 func _init() -> void:
 	# Disable/re-enable occupied cells whenever a gamepiece moves.
 	GamepieceRegistry.gamepiece_moved.connect(
@@ -33,36 +38,44 @@ func can_move_to(coord: Vector2i) -> bool:
 ## Find a path between two cells. Returns an empty array if no path is available.
 ## If allow_blocked_source or allow_blocked_target are false, the pathinder wlil fail if a gamepiece
 ## occupies the source or target cells, respectively.
-func get_path_to_cell(source_coord: Vector2i, target_coord: Vector2i,
-		allow_disabled_source: = true, allow_disabled_target: = false) -> Array[Vector2i]:
+func get_path_to_cell(source_coord: Vector2i, target_coord: Vector2i, 
+		occupancy_flags: int = 1) -> Array[Vector2i]:
 	# Store the return value in a variable.
 	var move_path: Array[Vector2i] = []
 
 	# Find the source/target IDs and keep track of whether or not the cells are occupied.
 	var source_id: = Gameboard.cell_to_index(source_coord)
 	var target_id: = Gameboard.cell_to_index(target_coord)
 
+	# The pathfinder has several flags to ignore cell occupancy. We'll need to track which occupants
+	# are temporarily ignored and then re-disable their pathfinder points once a path is found.
+	# Key is point id, value is whether or not the point is disabled.
+	var ignored_points: Dictionary[int, bool] = {}
+	if (occupancy_flags & FLAG_ALLOW_ALL_OCCUPANTS) != 0:
+		print("Allow all occupants!")
+		for id in get_point_ids():
+			if is_point_disabled(id):
+				ignored_points[id] = true
+				set_point_disabled(id, false)
+	
 	if has_point(source_id) and has_point(target_id):
 		# Check to see if we want to un-disable the source/target cells.
-		var is_source_disabled: = is_point_disabled(source_id)
-		var is_target_disabled: = is_point_disabled(target_id)
-		if allow_disabled_source:
+		if (occupancy_flags & FLAG_ALLOW_SOURCE_OCCUPANT) != 0:
+			print("Allow source occupant!")
+			ignored_points[source_id] = is_point_disabled(source_id)
 			set_point_disabled(source_id, false)
-		if allow_disabled_target:
+		if (occupancy_flags & FLAG_ALLOW_TARGET_OCCUPANT) != 0:
+			print("Allow target occupant!")
+			ignored_points[target_id] = is_point_disabled(target_id)
 			set_point_disabled(target_id, false)
 
 		for path_coord: Vector2i in get_point_path(source_id, target_id):
 			if path_coord != source_coord: # Don't include the source as the first path element.
 				move_path.append(path_coord)
 
-		# If the source/target cells had originally been disabled, re-disable them here.
-		if allow_disabled_source:
-			set_point_disabled(source_id, is_source_disabled)
-		if allow_disabled_target:
-			set_point_disabled(target_id, is_target_disabled)
-		
-		
-		#set_point_disabled(source_id, is_source_disabled)
+		# Change any enabled cells back to their previous state.
+		for id in ignored_points:
+			set_point_disabled(id, ignored_points[id])
 
 	return move_path
 

src/field/gamepieces/controllers/path_loop_ai_controller.gd

@@ -100,7 +100,7 @@ func _find_move_path() -> bool:
 		var source: = Gameboard.pixel_to_cell(path_to_follow.get_point_position(i-1) + _path_origin)
 		var target: = Gameboard.pixel_to_cell(path_to_follow.get_point_position(i) + _path_origin)
 
-		var path_segment: = Gameboard.pathfinder.get_path_to_cell(source, target, true, true)
+		var path_segment: = Gameboard.pathfinder.get_path_to_cell(source, target)
 		if path_segment.is_empty():
 			#push_error("'%s' PathLoopAiController::_find_waypoints_from_line2D() error - " % name +
 				#"Failed to find a path between cells %s and %s." % [source, target])
@@ -114,7 +114,8 @@ func _find_move_path() -> bool:
 	var first_cell: = Gameboard.pixel_to_cell(path_to_follow.get_point_position(0) + _path_origin)
 
 	# If we've made it this far there must be a path between the first and last cell.
-	move_path.append_array(Gameboard.pathfinder.get_path_to_cell(last_cell, first_cell, true, true))
+	move_path.append_array(Gameboard.pathfinder.get_path_to_cell(last_cell, first_cell, 
+		Pathfinder.FLAG_ALLOW_SOURCE_OCCUPANT | Pathfinder.FLAG_ALLOW_TARGET_OCCUPANT))
 	return true
 
 

src/field/gamepieces/player_controller.gd

@@ -48,7 +48,7 @@ func _process(_delta: float) -> void:
 			else:
 				GamepieceRegistry.move_gamepiece(_gamepiece, target_cell)
 				_gamepiece.move_to(Gameboard.cell_to_pixel(target_cell))
-			print(new_move_path)
+
 			#print(Gameboard.pathfinder.get_path_to_cell())
 			# If path is valid, move.