llGetAgentList

Template:Needs Translation/LSL/de Template:Needs Translation/LSL/es Template:Needs Translation/LSL/el Template:Needs Translation/LSL/fr Template:Needs Translation/LSL/he Template:Needs Translation/LSL/it Template:Needs Translation/LSL/ko Template:Needs Translation/LSL/nl Template:Needs Translation/LSL/hu Template:Needs Translation/LSL/no Template:Needs Translation/LSL/da Template:Needs Translation/LSL/sv Template:Needs Translation/LSL/tr Template:Needs Translation/LSL/pl Template:Needs Translation/LSL/pt Template:Needs Translation/LSL/ru Template:Needs Translation/LSL/th Template:Needs Translation/LSL/uk Template:Needs Translation/LSL/zh-Hans Template:Needs Translation/LSL/zh-Hant

/LSL

GetAgentList

llGetAgentList

Summary

Function: list llGetAgentList( integer scope, list options );

0	Forced Delay
0	Energy

Requests a list of agents currently in the region, limited by the scope parameter.
Returns a list [key id0, key id1, ..., key idn] or [string error_msg] - returns avatar keys for all agents in the region limited to the area(s) specified by scope

• integer	scope	–	AGENT_LIST_* flag specifies the selection scope AGENT_LIST_PARCEL - returns only agents on the same parcel where the script is running. AGENT_LIST_PARCEL_OWNER - returns only agents on any parcel in the region where the parcel owner is the same as the owner of the parcel under the scripted object. AGENT_LIST_REGION - returns any/all agents in the region.
• list	options	–	Unused.

Caveats

• There is no guaranteed understandable order or randomness to the list returned.
• Will only return up to 100 agents.

Examples

Important: To check if an avatar is in the same sim, please check whether llGetAgentSize does NOT return ZERO_VECTOR. It's much faster and easier than calling llGetAgentList and running through the list to compare a given key with each list item.

Important: As of now, this function does not have a delimiter for its option list. This means, the function MIGHT return up to a hundred avatar keys. You'll need a lot of free memory to be able to store those keys, be warned of possible STACK_HEAP_COLLISION_ERRORs.

<lsl> //Displays up to 100 avatar key: name pairs detected in the entire region

default {

   touch_start(integer total_number)
   {
       list avatarsInRegion = llGetAgentList(AGENT_LIST_REGION, []);
       integer numOfAvatars = llGetListLength(avatarsInRegion);

       // if no avatars, abort avatar listing process and give a short notice
       if (!numOfAvatars)
       {
           llOwnerSay("No avatars found within the region!");
           return;
       }

       integer index;
       while (index < numOfAvatars)
       {
           key id = llList2Key(avatarsInRegion, index);
           string name = llKey2Name(id);

           llOwnerSay(name + " [ " + (string)id + " ]");
           ++index;
       }
   }

} </lsl> <lsl> // Orders new list based on distance // and returns names and distances on touch

default {

   touch_start(integer num_detected)
   {
       list keys = llGetAgentList(AGENT_LIST_REGION, []);
       integer numberOfKeys = llGetListLength(keys);

       vector currentPos = llGetPos();
       list newkeys;
       key thisAvKey;

       integer i;
       for (i = 0; i < numberOfKeys; ++i) {
           thisAvKey = llList2Key(keys,i);
           newkeys += [llRound(llVecDist(currentPos,
                           llList2Vector(llGetObjectDetails(thisAvKey, [OBJECT_POS]), 0))),
                       thisAvKey];
       }
 
       newkeys = llListSort(newkeys, 2, FALSE);     //  sort strided list by descending distance

       for (i = 0; i < (numberOfKeys * 2); i += 2) {
           llOwnerSay(llGetDisplayName(llList2Key(newkeys, i+1))
               +" ["+ (string) llList2Integer(newkeys, i) + "m]");
       }
   }

}

</lsl>

See Also

Functions

• llGetRegionAgentCount

Deep Notes

History

• New function proposed by LL, reconciling the feature suggestions SVC-805, SVC-6427, MISC-243 and SVC-5488.
• Pre-Released Release_Notes/Second_Life_RC_Magnum/12 - Original JIRA requested "llGetRegionAgents()", the name changed since the released function does more.

Signature
function list llGetAgentList( integer scope, list options );