pandemonium_engine/modules/steering_ai/doc_classes/GSAIPath.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="GSAIPath" inherits="Reference" version="3.11">
	<brief_description>
		Represents a path made up of Vector3 waypoints, split into segments path follow behaviors can use.
	</brief_description>
	<description>
		Represents a path made up of Vector3 waypoints, split into segments path follow behaviors can use.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="calculate_distance">
			<return type="float" />
			<argument index="0" name="agent_current_position" type="Vector3" />
			<description>
			</description>
		</method>
		<method name="calculate_target_position">
			<return type="Vector3" />
			<argument index="0" name="target_distance" type="float" />
			<description>
				Calculates a target position from the path's starting point based on the target_distance.
			</description>
		</method>
		<method name="create_path">
			<return type="void" />
			<argument index="0" name="waypoints" type="PoolVector3Array" />
			<description>
				Creates a path from a list of waypoints.
			</description>
		</method>
		<method name="get_end_point">
			<return type="Vector3" />
			<description>
				Returns the position of the last point on the path.
			</description>
		</method>
		<method name="get_start_point">
			<return type="Vector3" />
			<description>
				Returns the position of the first point on the path.
			</description>
		</method>
		<method name="initialize">
			<return type="void" />
			<argument index="0" name="waypoints" type="PoolVector3Array" />
			<argument index="1" name="is_open" type="bool" default="false" />
			<description>
			</description>
		</method>
	</methods>
	<members>
		<member name="is_open" type="bool" setter="set_is_open" getter="get_is_open" default="false">
			If false, the path loops.
		</member>
		<member name="length" type="float" setter="set_length" getter="get_length" default="0.0">
			Total length of the path.
		</member>
	</members>
	<constants>
	</constants>
</class>