pandemonium_engine/modules/steering_ai/doc_classes/GSAISeparation.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="GSAISeparation" inherits="GSAIGroupBehavior" version="4.4">
	<brief_description>
		Calculates an acceleration that repels the agent from its neighbors in the given GSAIProximity.
	</brief_description>
	<description>
		Calculates an acceleration that repels the agent from its neighbors in the given GSAIProximity.
		_callback is the callback for the proximity to call when finding neighbors. Determines the amount of acceleration that neighbor imposes based on its distance from the owner agent.
	</description>
	<tutorials>
	</tutorials>
	<methods>
	</methods>
	<members>
		<member name="_callback" type="FuncRef" setter="set_callback" getter="get_callback" overrides="GSAIGroupBehavior" />
		<member name="acceleration" type="GSAITargetAcceleration" setter="set_acceleration" getter="get_acceleration">
			The acceleration is an average based on all neighbors, multiplied by a strength decreasing by the inverse square law in relation to distance, and it accumulates.
		</member>
		<member name="decay_coefficient" type="float" setter="set_decay_coefficient" getter="get_decay_coefficient" default="1.0">
			The coefficient to calculate how fast the separation strength decays with distance.
		</member>
	</members>
	<constants>
	</constants>
</class>
Re-extracted class docs. 2023-01-14 13:38:58 +01:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Re-extracted class docs. 2024-04-26 17:32:25 +02:00			`<class name="GSAISeparation" inherits="GSAIGroupBehavior" version="4.4">`
Re-extracted class docs. 2023-01-14 13:38:58 +01:00			`<brief_description>`
Move the old comments from the steering ai module to the class doc xmls. 2023-01-14 14:31:39 +01:00			`Calculates an acceleration that repels the agent from its neighbors in the given GSAIProximity.`
Re-extracted class docs. 2023-01-14 13:38:58 +01:00			`</brief_description>`
			`<description>`
Move the old comments from the steering ai module to the class doc xmls. 2023-01-14 14:31:39 +01:00			`Calculates an acceleration that repels the agent from its neighbors in the given GSAIProximity.`
			`_callback is the callback for the proximity to call when finding neighbors. Determines the amount of acceleration that neighbor imposes based on its distance from the owner agent.`
Re-extracted class docs. 2023-01-14 13:38:58 +01:00			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<methods>`
			`</methods>`
			`<members>`
			`<member name="_callback" type="FuncRef" setter="set_callback" getter="get_callback" overrides="GSAIGroupBehavior" />`
			`<member name="acceleration" type="GSAITargetAcceleration" setter="set_acceleration" getter="get_acceleration">`
Move the old comments from the steering ai module to the class doc xmls. 2023-01-14 14:31:39 +01:00			`The acceleration is an average based on all neighbors, multiplied by a strength decreasing by the inverse square law in relation to distance, and it accumulates.`
Re-extracted class docs. 2023-01-14 13:38:58 +01:00			`</member>`
			`<member name="decay_coefficient" type="float" setter="set_decay_coefficient" getter="get_decay_coefficient" default="1.0">`
Move the old comments from the steering ai module to the class doc xmls. 2023-01-14 14:31:39 +01:00			`The coefficient to calculate how fast the separation strength decays with distance.`
Re-extracted class docs. 2023-01-14 13:38:58 +01:00			`</member>`
			`</members>`
			`<constants>`
			`</constants>`
			`</class>`