Skip to content
lsl.devlsl.devLSL Dev

llWanderWithin

View as MarkdownThis page as plain textOpen in ChatGPTAsk questions about this pageOpen in ClaudeAsk questions about this page
function
Function syntax
llWanderWithin(
  1. vector origin,// Center coordinate position vector to wander about.
  2. vector dist,// A vector specifying the maximum distance limits (half-extents) along each world-aligned axis from the origin.
  3. list options// A list of WANDER_* flags and parameters to configure the wander behavior.
);
Energy
10

Directs a pathfinding character to wander around a central coordinate origin, restricted within the bounding distance limits of dist and configured by options.

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

How to use
llWanderWithin(ZERO_VECTOR, ZERO_VECTOR, []);

Specification

Section titled “Specification”
From the LSL definitions: CharacterWanderWithinParam (rule, then its arguments)
WANDER_PAUSE_AT_WAYPOINTS  // Option parameter for llWanderWithin specifying whether the character should pause briefly after reaching each wander waypoint.
ConstantTypeValueDescription
WANDER_PAUSE_AT_WAYPOINTSinteger0Whether the character should pause after reaching each wander waypoint.
OptionVParametersDefaultDescription
[ integer boolean ][ FALSE ]Whether the character should pause after reaching each wander waypoint.

Caveats

Section titled “Caveats”
  • 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> 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.
  • if dist has any dimension less than 1.0, an error is shouted on DEBUG_CHANNEL. Scale too small. All dimensions must be at least 1.0.
  • 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. :)

Examples

Section titled “Examples”
Example 1
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>, [WANDER_PAUSE_AT_WAYPOINTS, TRUE]);
    }
}

History

Section titled “History”

Date of Release 31/07/2012

See also

Section titled “See also”

Functions

Section titled “Functions”

Events

Section titled “Events”
Original wiki source

Some wiki templates and tables need their original context. View this article on the Second Life Wiki. Technical wording and examples are retained from the source; historical guidance may differ from current behavior.