godot-steering-ai-framework/godot/addons/com.gdquest.godot-steering-ai-framework/Behaviors/GSAIFace.gd

# Calculates angular acceleration to rotate a target to face its target's
# position. The behavior attemps to arrive with zero remaining angular velocity.
# @category - Individual behaviors
class_name GSAIFace
extends GSAIMatchOrientation


func _init(agent: GSAISteeringAgent, target: GSAIAgentLocation, use_z := false).(
	agent, target, use_z
) -> void:
	pass


func _face(acceleration: GSAITargetAcceleration, target_position: Vector3) -> void:
	var to_target := target_position - agent.position
	var distance_squared := to_target.length_squared()

	if distance_squared < agent.zero_linear_speed_threshold:
		acceleration.set_zero()
	else:
		var orientation = (
			GSAIUtils.vector3_to_angle(to_target)
			if use_z
			else GSAIUtils.vector2_to_angle(GSAIUtils.to_vector2(to_target))
		)
		_match_orientation(acceleration, orientation)


func _calculate_steering(acceleration: GSAITargetAcceleration) -> void:
	_face(acceleration, target.position)
Edit docstrings in src/Behaviors 2020-01-29 17:04:04 +01:00			`# Calculates angular acceleration to rotate a target to face its target's`
			`# position. The behavior attemps to arrive with zero remaining angular velocity.`
Update doc-comments to use JSDoc style 2020-04-03 02:31:59 +02:00			`# @category - Individual behaviors`
Use GSAI as a class prefix instead of GST GSAI for Godot Steering AI 2020-02-11 18:33:25 +01:00			`class_name GSAIFace`
			`extends GSAIMatchOrientation`
Reorganize project The GST namespace has been added to prevent class name conflicts, and the project has been reorganized to make extensions and purpose easier. 2019-12-19 20:04:08 +01:00

Format the code using gdformat gdformat follows the official style guide, and handles line length and wrapping lines for us. 2020-02-14 17:35:18 +01:00			`func _init(agent: GSAISteeringAgent, target: GSAIAgentLocation, use_z := false).(`
			`agent, target, use_z`
			`) -> void:`
Reorganize project The GST namespace has been added to prevent class name conflicts, and the project has been reorganized to make extensions and purpose easier. 2019-12-19 20:04:08 +01:00			`pass`


Use GSAI as a class prefix instead of GST GSAI for Godot Steering AI 2020-02-11 18:33:25 +01:00			`func _face(acceleration: GSAITargetAcceleration, target_position: Vector3) -> void:`
Update project to follow GDScript guidelines closer Used `var variable := 0.0` as discussed in the Godot issue, instead of `var variable: = 0.0`. Mostly these are minor/cosmetic changes, but I've also reorganized the folder structure (naming of folders) to reflect our guidelines, plus made some minor changes to the demo codes. Still work in progress. 2020-01-16 09:44:44 +01:00			`var to_target := target_position - agent.position`
			`var distance_squared := to_target.length_squared()`
Edit docstrings in src/Behaviors 2020-01-29 17:04:04 +01:00
Reorganize project The GST namespace has been added to prevent class name conflicts, and the project has been reorganized to make extensions and purpose easier. 2019-12-19 20:04:08 +01:00			`if distance_squared < agent.zero_linear_speed_threshold:`
			`acceleration.set_zero()`
			`else:`
Format the code using gdformat gdformat follows the official style guide, and handles line length and wrapping lines for us. 2020-02-14 17:35:18 +01:00			`var orientation = (`
			`GSAIUtils.vector3_to_angle(to_target)`
Add 3D demo and fix 3D agents Closes #30, closes #31, closes #33 2020-02-13 09:33:03 +01:00			`if use_z`
			`else GSAIUtils.vector2_to_angle(GSAIUtils.to_vector2(to_target))`
			`)`
Make calculate_acceleration return void This makes the code more in line with GDQuest gdscript guidelines about not both transforming state and returning a value. 2020-02-06 20:46:21 +01:00			`_match_orientation(acceleration, orientation)`
Reorganize project The GST namespace has been added to prevent class name conflicts, and the project has been reorganized to make extensions and purpose easier. 2019-12-19 20:04:08 +01:00

Use GSAI as a class prefix instead of GST GSAI for Godot Steering AI 2020-02-11 18:33:25 +01:00			`func _calculate_steering(acceleration: GSAITargetAcceleration) -> void:`
Make calculate_acceleration return void This makes the code more in line with GDQuest gdscript guidelines about not both transforming state and returning a value. 2020-02-06 20:46:21 +01:00			`_face(acceleration, target.position)`