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

# Base type for group-based steering behaviors.
# @category - Base types
class_name GSAIGroupBehavior
extends GSAISteeringBehavior

# Container to find neighbors of the agent and calculate group behavior.
var proximity : GSAIProximity

var _callback : FuncRef = funcref(self, "_report_neighbor")


func _init(agent : GSAISteeringAgent, _proximity : GSAIProximity).(agent) -> void:
	self.proximity = _proximity


# Internal callback for the behavior to define whether or not a member is
# relevant
# @tags - virtual
func _report_neighbor(_neighbor : GSAISteeringAgent) -> bool:
	return false
Move class docstring to top of class For documentation purposes, current tools expect it there. 2020-01-29 05:56:10 +01:00			`# Base type for group-based steering behaviors.`
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 GSAIGroupBehavior`
			`extends GSAISteeringBehavior`
Clean up and improve group behaviors' code The first pass was somewhat obtuse and lacked a common class that differentiated them from behaviors that didn't use Proximities. 2020-01-10 18:15:50 +01:00
Move class docstring to top of class For documentation purposes, current tools expect it there. 2020-01-29 05:56:10 +01:00			`# Container to find neighbors of the agent and calculate group behavior.`
Style changes to make c++ conversion easier later. 2023-01-13 13:09:18 +01:00			`var proximity : GSAIProximity`
Clean up and improve group behaviors' code The first pass was somewhat obtuse and lacked a common class that differentiated them from behaviors that didn't use Proximities. 2020-01-10 18:15:50 +01:00
Style changes to make c++ conversion easier later. 2023-01-13 13:09:18 +01:00			`var _callback : FuncRef = funcref(self, "_report_neighbor")`
Clean up and improve group behaviors' code The first pass was somewhat obtuse and lacked a common class that differentiated them from behaviors that didn't use Proximities. 2020-01-10 18:15:50 +01:00

Style changes to make c++ conversion easier later. 2023-01-13 13:09:18 +01:00			`func _init(agent : GSAISteeringAgent, _proximity : GSAIProximity).(agent) -> void:`
Handle all warnings in GSAI* classes and demos 2020-02-11 20:36:06 +01:00			`self.proximity = _proximity`
Clean up and improve group behaviors' code The first pass was somewhat obtuse and lacked a common class that differentiated them from behaviors that didn't use Proximities. 2020-01-10 18:15:50 +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			`# Internal callback for the behavior to define whether or not a member is`
			`# relevant`
Update doc-comments to use JSDoc style 2020-04-03 02:31:59 +02:00			`# @tags - virtual`
Style changes to make c++ conversion easier later. 2023-01-13 13:09:18 +01:00			`func _report_neighbor(_neighbor : GSAISteeringAgent) -> bool:`
Clean up and improve group behaviors' code The first pass was somewhat obtuse and lacked a common class that differentiated them from behaviors that didn't use Proximities. 2020-01-10 18:15:50 +01:00			`return false`