Follow target curve

The follow target curve module makes your agent travel towards the closest point of a curve.

Attributes

Attributes	Type	Overridable	Description
curve	curve	no	Target curve
isAnimated	bool	no	If on, the curve internal KDTree is built at every frame.
weight	double	yes	Weight.
maxTurnAngle	double	yes	Agent max turn angle per frame
maxDistance	dobule	yes	The max distance from the curve. Any agent further than this value from the curve will be ignored.
samples	int	no	Number of curve samples.
useParam	bool	yes	Store the curve parametric coordinate of the closest point at the beginning of the simulation, and use this same point as target during the rest for the simulation.
goalDistance	double	yes	As soon as the agent reaches this distance, then the value for the metadata (metadadaName) is changed.
goalDistanceDropOff	double	yes	Goal distance drop off.
metadataName	string	yes	Metadata name.
metadataBoolValue	bool	yes	Metadata bool value.
metadataIntValue	int	yes	Metadata int value.
metadataDoubleValue	double	yes	Metadata double value.
metadataVector3Value	vector3	yes	Metadata vector3 value.
keepMetadataValue	bool	yes	If set to true, the agent metadata keeps the new value even when it reaches the goalDistance.
ignoreNextDirectionalModules	bool	yes	If enabled, all next directional modules in the stack will be ignored.
alignAtInitFrame	bool	yes	The agents will be driven only at the first frame of the simulation when this flag is turned off
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.