pandemonium_engine/modules/steering_ai/doc_classes/GSAIArrive.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="GSAIArrive" inherits="GSAISteeringBehavior" version="3.12">
	<brief_description>
		Calculates acceleration to take an agent to its target's location. The calculation attempts to arrive with zero remaining velocity.
	</brief_description>
	<description>
		Calculates acceleration to take an agent to its target's location. The calculation attempts to arrive with zero remaining velocity.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="_arrive" qualifiers="virtual">
			<return type="void" />
			<argument index="0" name="acceleration" type="GSAITargetAcceleration" />
			<argument index="1" name="target_position" type="Vector3" />
			<description>
			</description>
		</method>
		<method name="arrive">
			<return type="void" />
			<argument index="0" name="acceleration" type="GSAITargetAcceleration" />
			<argument index="1" name="target_position" type="Vector3" />
			<description>
			</description>
		</method>
	</methods>
	<members>
		<member name="arrival_tolerance" type="float" setter="set_arrival_tolerance" getter="get_arrival_tolerance" default="0.0">
			Distance from the target for the agent to be considered successfully arrived.
		</member>
		<member name="deceleration_radius" type="float" setter="set_deceleration_radius" getter="get_deceleration_radius" default="0.0">
			Distance from the target for the agent to begin slowing down.
		</member>
		<member name="target" type="GSAIAgentLocation" setter="set_target" getter="get_target">
			Target agent to arrive to.
		</member>
		<member name="time_to_reach" type="float" setter="set_time_to_reach" getter="get_time_to_reach" default="0.1">
			Represents the time it takes to change acceleration.
		</member>
	</members>
	<constants>
	</constants>
</class>