Follow Mesh

The follow mesh module makes your agents follow a mesh vertex.

Attributes

Attributes	Type	Overridable	Description
mesh	mesh	no	The input mesh to follow
meshParentMatrix	matrix	no	The mesh parent matrix.
meshTranslation	vector3	no	The mesh translation.
meshScale	vector3	no	The mesh scale.
meshRotation	vector3	no	The mesh rotation.
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.
lockVertex	bool	yes	If on, the agent will be assigned a target vertex only once. If off, the agent will be unlinked from the vertex as soon as the distance is greater than maxDistance.
isAnimated	bool	no	If this is off, the agents will point towards the assigned vertex only at the first frame of the simulation.
minDistance	double	yes	If the distance between the agent and the assigned vertex is lower than this value, the agent keeps following the current direction.
maxDistance	double	yes	The maximum distance
maxDistanceDropOff	double	yes	Drop off value for smoothly transitioning in and out out of the vertex targeting.
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
debug	bool	no	Activate the debugging mode
ignoreNextDirectionalModules	bool	yes	If enabled, all next directional modules in the stack will be ignored.
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	double	yes	If on, this module will edit the targetAngularVelocity metadata used by the locomotion system.