godot-steering-ai-framework/project/src/Behaviors/GSTFollowPath.gd

class_name GSTFollowPath
extends GSTArrive
# Produces a linear acceleration that moves the agent along the specified path.


# The path to follow and travel along
var path: GSTPath
# The distance along the path to generate the next target position.
var path_offset := 0.0

# Whether to use `GSTArrive` behavior on an open path.
var arrive_enabled := true
# The amount of time in the future to predict the owning agent's position along the path. Setting
# it to 0 will force non-predictive path following.
var prediction_time := 0.0


func _init(
		agent: GSTSteeringAgent, 
		path: GSTPath, 
		path_offset := 0.0, 
		prediction_time := 0.0).(agent, null) -> void:
	self.path = path
	self.path_offset = path_offset
	self.prediction_time = prediction_time


func _calculate_steering(acceleration: GSTTargetAcceleration) -> GSTTargetAcceleration:
	var location := (
			agent.position if prediction_time == 0
			else agent.position + (agent.linear_velocity * prediction_time))
	
	var distance := path.calculate_distance(location)
	var target_distance := distance + path_offset
	
	var target_position := path.calculate_target_position(target_distance)
	
	if arrive_enabled and path.open:
		if path_offset >= 0:
			if target_distance > path.length - deceleration_radius:
				return _arrive(acceleration, target_position)
		else:
			if target_distance < deceleration_radius:
				return _arrive(acceleration, target_position)
	
	acceleration.linear = (target_position - agent.position).normalized()
	acceleration.linear *= agent.linear_acceleration_max
	acceleration.angular = 0
	
	return acceleration