Difference between revisions of "LlWanderWithin"

Revision as of 13:29, 9 May 2012

Function: llWanderWithin( vector origin, vector dist, list options );

Sets a character to wander about a central spot within a specified radius.

• vector	origin	–	Central point to wander about.
• vector	dist	–	Sets how far the character may wander from origin, along each world-aligned axis
• list	options	–	Wander options.

Option	V	Parameters	Default	Description
[ WANDER_PAUSE_AT_WAYPOINTS ]	0	[ integer boolean ]	[ FALSE ]	Whether the character should pause after reaching each wander waypoint.

Must use llCreateCharacter or script won't compile.
Wander area is a rough area based on the specified origin, to a specified scale on each axis. So, if <20, 10, 2>m is specified the object will wander within 20m along the world x-axis, 10m along the world y-axis, and 2m along the world z-axis.
When WANDER_PAUSE_AT_WAYPOINTS is enabled, PU_GOAL_REACHED and PU_SLOWDOWN_DISTANCE_REACHED path_update events will be trigged when approaching each waypoint. When this flag is disabled, the aforementioned path_update events will not be triggered when arriving at waypoints.
Wander area can be limited to a smaller area by introducing obstacles such as walls.
Vertical positions specified for any vectors should be chosen to be as close as possible to the actual height of the terrain requested. Large difference between the provided vertical position and the actual terrain/object will result in failure of the behavior.
As for all pathfinding behaviors, DO NOT rely on the detailed implementation here. The wander distance is just a rough estimate. We may change the exact shape on a whim. For fun. Or because it seems better that way. Or to ensure that you aren't relying on the detailed implementation. Don't make this another PATHBUG-69. :)

<lsl> default {

   state_entry()
   {
       llCreateCharacter([CHARACTER_MAX_SPEED, 25, CHARACTER_DESIRED_SPEED, 15.0]);
       //MAX_SPEED is @ 20 by default
   }

   touch_start(integer total_number)
   {
       llWanderWithin(llGetPos(), <10.0, 10.0, 5.0>, []);
   }

}

</lsl>

Signature
function void llWanderWithin( vector origin, vector dist, list options );

@@ Line 16: / Line 16: @@
 * Must use llCreateCharacter or script won't compile.
 * Wander area is a rough area based on the specified origin, to a specified scale on each axis. So, if <20, 10, 2>m is specified the object will wander within 20m along the world x-axis, 10m along the world y-axis, and 2m along the world z-axis.
-* When WANDER_PAUSE_AT_WAYPOINTS is enabled, PU_GOAL_REACHED and PU_SLOWDOWN_DISTANCE_REACHED path_update events will be trigged when approaching each waypoint.  When this flag is disabled, the aforementioned path_update events will not be triggered when arriving at waypoints.
+* When WANDER_PAUSE_AT_WAYPOINTS is enabled, PU_GOAL_REACHED and PU_SLOWDOWN_DISTANCE_REACHED [[path_update]] events will be trigged when approaching each waypoint.  When this flag is disabled, the aforementioned path_update events will not be triggered when arriving at waypoints.
 * Wander area can be limited to a smaller area by introducing obstacles such as walls.
 * Vertical positions specified for any vectors should be chosen to be as close as possible to the actual height of the terrain requested. Large difference between the provided vertical position and the actual terrain/object will result in failure of the behavior.