Follow target

The follow target module makes your agent travel towards the goal position.

Attributes

Attributes	Type	Overridable	Description
goal	vector3	yes	The goal position.
maxTurnAngle	double	yes	The max turn angle.
isAnimated	bool	no	If this is off, the agents will point towards the goal position only at the first frame of the simulation.
weight	double	yes	Weight
followDelta	bool	no	Follows the delta movement of the target instead of actually pointing to the target. Useful for just copying the motion direction from the target to the agents.
deltaThreshold	double	no	When followDelta is on, the agents will ignore the target movement if the position difference magnitude is lower than the threshold.
keepDirectionOnReach	bool	yes	If on, the agents will keep the direction after reaching the target
targetRadius	double	yes	When the agent distance to the target position is less than this value, the target is reached
useVelocityThreshold	bool	yes	If on, the velocity threshold will be used.
velocityThreshold	bool	yes	If the agent velocity length is smaller than this value, the agent direction is not modified
editMetadata	bool	yes	If on, the module will assign the value of the ratio between the movement vector and the current agent velocity to the given metadata.
metadataType	int	no	The metadata type, can be int (3) or double (4)
metadataName	string	no	The target metadata name
metadataMin	double	no	Min clamping metadata value
metadataMax	double	no	Max clamping metadata value
metadataDistanceDropOff	double	no	Drop off value for smoothly transitioning the editing of the metadata
ignoreNextDirectionalModules	bool	yes	If enabled, all next directional modules in the stack will be ignored.
projectForward	bool	yes	If the goal is behind the agent, then it is projected in front of the current agent using its direction. Useful for just copying the motion direction from the target to the agent.
editLocomotionLinearVelocity	bool	yes	If on, this module will edit the targetLinearVelocity metadata used by the locomotion system.
linearVelocityMin	double	yes	The minimum value for the locomotion linear velocity
linearVelocityMax	double	yes	The maximum value for the locomotion linear velocity
negativeLinearVelocityMax	double	yes	The maximum value for the locomotion linear velocity when the target is behind the agent
locomotionFalloffRadius	double	yes	Distance used for decreasing the linear velocity when getting closer to the target. Not used in delta mode
locomotionTargetDistance	double	yes	When the agent reaches this distance from the target the linear velocity is set to the minimum value provided
editLocomotionAngularVelocity	bool	yes	If on, this module will edit the targetAngularVelocity metadata used by the locomotion system.