godot-steering-ai-framework/godot/addons/com.gdquest.godot-steering-ai-framework/GSAITargetAcceleration.gd

# A desired linear and angular amount of acceleration requested by the steering
# system.
# @category - Base types
class_name GSAITargetAcceleration

# Linear acceleration
var linear := Vector3.ZERO
# Angular acceleration
var angular := 0.0


# Sets the linear and angular components to 0.
func set_zero() -> void:
	linear.x = 0.0
	linear.y = 0.0
	linear.z = 0.0
	angular = 0.0


# Adds `accel`'s components, multiplied by `scalar`, to this one.
func add_scaled_accel(accel: GSAITargetAcceleration, scalar: float) -> void:
	linear += accel.linear * scalar
	angular += accel.angular * scalar


# Returns the squared magnitude of the linear and angular components.
func get_magnitude_squared() -> float:
	return linear.length_squared() + angular * angular


# Returns the magnitude of the linear and angular components.
func get_magnitude() -> float:
	return sqrt(get_magnitude_squared())
Update code reference Proof and edit docstrings in all the base types and proximity types Remove docstring for the _init builtin callback 2020-01-28 00:31:10 +01:00			`# A desired linear and angular amount of acceleration requested by the steering`
			`# system.`
Update doc-comments to use JSDoc style 2020-04-03 02:31:59 +02:00			`# @category - Base types`
Use GSAI as a class prefix instead of GST GSAI for Godot Steering AI 2020-02-11 18:33:25 +01:00			`class_name GSAITargetAcceleration`
Implement Face, Evade Pursue, Arrive, Flee, Seek The MVP document goes over the main behaviors that need to be implemented prior to having a product. 2019-12-16 17:22:03 +01:00
Update code reference Proof and edit docstrings in all the base types and proximity types Remove docstring for the _init builtin callback 2020-01-28 00:31:10 +01:00			`# Linear acceleration`
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 linear := Vector3.ZERO`
Update code reference Proof and edit docstrings in all the base types and proximity types Remove docstring for the _init builtin callback 2020-01-28 00:31:10 +01:00			`# Angular acceleration`
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 angular := 0.0`
Implement Face, Evade Pursue, Arrive, Flee, Seek The MVP document goes over the main behaviors that need to be implemented prior to having a product. 2019-12-16 17:22:03 +01:00

Update code reference Proof and edit docstrings in all the base types and proximity types Remove docstring for the _init builtin callback 2020-01-28 00:31:10 +01:00			`# Sets the linear and angular components to 0.`
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			`func set_zero() -> void:`
Implement Face, Evade Pursue, Arrive, Flee, Seek The MVP document goes over the main behaviors that need to be implemented prior to having a product. 2019-12-16 17:22:03 +01:00			`linear.x = 0.0`
			`linear.y = 0.0`
			`linear.z = 0.0`
			`angular = 0.0`
Add Blend and Priority behaviors 2019-12-21 03:32:21 +01:00

Add documentation strings for base types 2020-01-27 18:57:51 +01:00			# Adds `accel`'s components, multiplied by `scalar`, to this one.
Use GSAI as a class prefix instead of GST GSAI for Godot Steering AI 2020-02-11 18:33:25 +01:00			`func add_scaled_accel(accel: GSAITargetAcceleration, scalar: float) -> void:`
Add Blend and Priority behaviors 2019-12-21 03:32:21 +01:00			`linear += accel.linear * scalar`
			`angular += accel.angular * scalar`


Update code reference Proof and edit docstrings in all the base types and proximity types Remove docstring for the _init builtin callback 2020-01-28 00:31:10 +01:00			`# Returns the squared magnitude of the linear and angular components.`
Implement review suggestions to code Razvan reviewed the code and suggested a number of changes to improve readability and make facets of the code more explicit and consistent. 2019-12-23 17:38:27 +01:00			`func get_magnitude_squared() -> float:`
Add Blend and Priority behaviors 2019-12-21 03:32:21 +01:00			`return linear.length_squared() + angular * angular`


Update code reference Proof and edit docstrings in all the base types and proximity types Remove docstring for the _init builtin callback 2020-01-28 00:31:10 +01:00			`# Returns the magnitude of the linear and angular components.`
Add Blend and Priority behaviors 2019-12-21 03:32:21 +01:00			`func get_magnitude() -> float:`
Implement review suggestions to code Razvan reviewed the code and suggested a number of changes to improve readability and make facets of the code more explicit and consistent. 2019-12-23 17:38:27 +01:00			`return sqrt(get_magnitude_squared())`