Allow Pathfinder to update properly when layers are freed

Author: food-please

overworld/maps/gbprops.tres

@@ -1,9 +1,9 @@
 [gd_resource type="Resource" script_class="GameboardProperties" load_steps=2 format=3 uid="uid://k63mv5dbd1uk"]
 
-[ext_resource type="Script" uid="uid://cyl76x7u73s67" path="res://src/field/gameboard/gameboard_properties.gd" id="1_013hj"]
+[ext_resource type="Script" uid="uid://cyl76x7u73s67" path="res://src/field/gameboard/gameboard_properties.gd" id="1_0hcip"]
 
 [resource]
-script = ExtResource("1_013hj")
+script = ExtResource("1_0hcip")
 extents = Rect2i(0, 0, 70, 35)
 cell_size = Vector2i(16, 16)
 metadata/_custom_type_script = "uid://cyl76x7u73s67"

overworld/maps/town/fan_interaction.gd

@@ -27,8 +27,14 @@ func _execute() -> void:
 
 func _on_initial_conversation_finished() -> void:
 	var source_cell: = Gameboard.pixel_to_cell(_adoring_fan.position)
+	
+	# Everything is paused at the moment, so activate the fan's controller so that he can move on a
+	# path during the cutscene.
+	controller.is_active = true
 	controller.move_path = Gameboard.pathfinder.get_path_to_cell(source_cell, Vector2(23, 13))
+	
 	await _adoring_fan.arrived
+	controller.is_active = false
 
 
 # This conversation only emits a signal once: when the player should receive the quest reward.

src/field/cutscenes/popups/moving_interaction_popup.gd

@@ -34,4 +34,4 @@ func _notification(what: int) -> void:
 # gamepiece, appearing to follow the gamepiece around the field while still playing nicely with the
 # physics/interaction system.
 func _process(_delta: float) -> void:
-	position = _gp.animation_transform.position
+	position = _gp.follower.position

src/field/cutscenes/templates/area_transitions/area_transition.gd

@@ -49,8 +49,10 @@ func _on_area_entered(area: Area2D) -> void:
 	# Move the gamepiece to it's new position and update the camera immediately.
 	var gamepiece: = area.owner as Gamepiece
 	if gamepiece:
-		gamepiece.cell = gamepiece.gameboard.pixel_to_cell(arrival_coordinates)
-		gamepiece.reset_travel()
+		gamepiece.stop()
+		gamepiece.position = arrival_coordinates
+		GamepieceRegistry.move_gamepiece(gamepiece, Gameboard.pixel_to_cell(arrival_coordinates))
+		
 
 		Camera.reset_position()
 

src/field/gameboard/gameboard.gd

@@ -116,7 +116,8 @@ func _add_cells_to_pathfinder(cleared_cells: Array[Vector2i]) -> Dictionary[int,
 	# the pathfinder won't actually be changed.
 	for cell in cleared_cells:
 		# Note that cleared cells need to have all layers checked for a blocking tile.
-		if not pathfinder.has_cell(cell) and _is_cell_clear(cell):
+		if properties.extents.has_point(cell) and not pathfinder.has_cell(cell) \
+				and _is_cell_clear(cell):
 			var uid: = cell_to_index(cell)
 			pathfinder.add_point(uid, cell)
 			added_cells[uid] = cell

src/field/gameboard/gameboard_layer.gd

@@ -24,16 +24,23 @@ const GROUP: = "GameboardTileMapLayers"
 ## by default, block movement.
 const BLOCKED_CELL_DATA_LAYER: = "IsCellBlocked"
 
+# A false value will cause is_cell_clear to always return true. This is used to flag when the
+# TileMapLayers is being cleaned up an should no longer affect the pathfinder.
+var _affects_collision: = true
+
 
 func _ready() -> void:
 	add_to_group(GROUP)
 	Gameboard.register_gameboard_layer(self)
 
 
-## Returns true if the tile at coord existst and does not have a custom blocking data layer with a
+## Returns true if the tile at coord exists and does not have a custom blocking data layer with a
 ## value set to true.
 ## Otherwise, returns false.
 func is_cell_clear(coord: Vector2i) -> bool:
+	if not _affects_collision:
+		return true
+	
 	var tile_data: = get_cell_tile_data(coord)
 	if tile_data:
 		var is_cell_blocked: = tile_data.get_custom_data(BLOCKED_CELL_DATA_LAYER) as bool
@@ -62,7 +69,8 @@ func _update_cells(coords: Array[Vector2i], forced_cleanup: bool) -> void:
 	if forced_cleanup:
 		# This tilemap isn't being used anymore. Flag all of its cells as being removed.
 		# Currently, toggline visibility back on won't re-add existing cells.
-		blocked_cells = get_used_cells()
+		cleared_cells = get_used_cells()
+		_affects_collision = false
 
 	else:
 		for coord in coords:

src/field/gamepieces/controllers/gamepiece_controller.gd

@@ -26,6 +26,11 @@ func _ready() -> void:
 
 		_gamepiece.arriving.connect(_on_gamepiece_arriving)
 		_gamepiece.arrived.connect(_on_gamepiece_arrived)
+		
+		FieldEvents.input_paused.connect(
+			func _on_input_paused(value: bool) -> void:
+				is_active = !value
+		)
 
 
 func _get_configuration_warnings() -> PackedStringArray:

src/field/gamepieces/controllers/path_loop_ai_controller.gd

@@ -100,7 +100,8 @@ 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)
+		var path_segment: = Gameboard.pathfinder.get_path_to_cell(source, target,
+			Pathfinder.FLAG_ALLOW_SOURCE_OCCUPANT | Pathfinder.FLAG_ALLOW_TARGET_OCCUPANT)
 		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])
@@ -109,13 +110,15 @@ func _find_move_path() -> bool:
 		move_path.append_array(path_segment)
 
 	# Finally, connect the ending and starting cells to complete the loop.
-	var last_pos: = path_to_follow.get_point_position(path_to_follow.get_point_count()-1) + _path_origin
+	var last_pos: = path_to_follow.get_point_position(path_to_follow.get_point_count()-1) \
+		+ _path_origin
 	var last_cell: = Gameboard.pixel_to_cell(last_pos)
 	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, 
-		Pathfinder.FLAG_ALLOW_SOURCE_OCCUPANT | Pathfinder.FLAG_ALLOW_TARGET_OCCUPANT))
+	if last_cell != first_cell:
+		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/gamepiece.gd

@@ -49,7 +49,7 @@ signal direction_changed(new_direction: Directions.Points)
 				animation_scene = null
 				return
 
-			_follower.add_child(animation)
+			follower.add_child(animation)
 
 ## The gamepiece will traverse a movement path at [code]move_speed[/code] pixels per second.
 ##[/br][/br]Note that extremely high speeds (finish a long path in a single frame) will produce
@@ -98,7 +98,7 @@ var destination: Vector2
 # the gamepiece in _ready(), however) in order to simplify path management. All path coordinates may 
 # be provided in game-world coordinates and will remain relative to the origin even as the 
 # gamepiece's position changes.
-@onready var _follower: = $PathFollow2D as PathFollow2D
+@onready var follower: = $PathFollow2D as PathFollow2D
 
 
 func _ready() -> void:
@@ -117,20 +117,20 @@ func _process(delta: float) -> void:
 	# movement.
 	# The excess travel distance allows us to know how much to extend the path by. A VERY fast
 	# gamepiece may jump a few cells at a time.
-	var excess_travel_distance: =  _follower.progress + move_distance - curve.get_baked_length()
+	var excess_travel_distance: =  follower.progress + move_distance - curve.get_baked_length()
 	if excess_travel_distance >= 0.0:
 		arriving.emit(excess_travel_distance)
 
 	# The path may have been extended, so the gamepiece can move along the path now.
-	_follower.progress += move_distance
+	follower.progress += move_distance
 
 	# Figure out which direction the gamepiece is facing, making sure that the GamepieceAnimation
 	# scene doesn't rotate.
 	animation.global_rotation = 0
-	direction = Directions.angle_to_direction(_follower.rotation)
+	direction = Directions.angle_to_direction(follower.rotation)
 
 	# If the gamepiece has arrived, update it's position and movement details.
-	if _follower.progress >= curve.get_baked_length():
+	if follower.progress >= curve.get_baked_length():
 		stop()
 
 
@@ -160,7 +160,7 @@ func move_to(target_point: Vector2) -> void:
 func stop() -> void:
 	# Sort out gamepiece position, resetting the follower and placing everything at the destination.
 	position = destination
-	_follower.progress = 0
+	follower.progress = 0
 	curve = null
 	destination = Vector2.ZERO
 

src/field/map.gd

@@ -12,7 +12,7 @@ extends Node2D
 
 		_debug_boundaries.gameboard_properties = gameboard_properties 
 
-@onready var _debug_boundaries: DebugGameboardBoundaries = $DebugBoundaries
+@onready var _debug_boundaries: DebugGameboardBoundaries = $Overlay/DebugBoundaries
 
 func _ready() -> void:
 	if not Engine.is_editor_hint():
@@ -28,9 +28,3 @@ func _ready() -> void:
 
 			if GamepieceRegistry.register(gp, cell) == false:
 				gp.queue_free()
-		
-		await get_tree().process_frame
-		await get_tree().process_frame
-		await get_tree().process_frame
-		await get_tree().process_frame
-		print(Gameboard.pathfinder)