llGetAgentList

From Second Life Wiki
Revision as of 15:50, 5 October 2012 by Strife Onizuka (talk | contribs)
Jump to navigation Jump to search

Summary

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

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.
All Issues ~ Search JIRA for related Bugs

Examples

KBcaution.png 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.
KBcaution.png 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)
       {
           // PUBLIC_CHANNEL has the integer value 0
           llSay(PUBLIC_CHANNEL, "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 off distance, and returns //then on touch_start default {

touch_start(integer num){ list keys = llGetAgentList(AGENT_LIST_REGION,[]); list newkeys; integer i; for (i=0; i < llGetListLength(keys); ++i){ newkeys += llVecDist(llGetPos(), llList2Vector(llGetObjectDetails(llList2Key(keys,i), [OBJECT_POS]), 0)); newkeys += llList2Key(keys,i);

}

newkeys = llListSort(newkeys, 2, FALSE);

for (i=0; i < llGetListLength(newkeys); ++i){ llOwnerSay(llGetDisplayName(llList2Key(newkeys,i+1)) + " ["+(string)llRound(llList2Float(newkeys, i)) + "m]"); ++i; } }

}

</lsl>

See Also

Deep Notes

History

All Issues

~ Search JIRA for related Issues
   llGetAgentList() with scope AGENT_LIST_PARCEL or AGENT_LIST_PARCEL_OWNER returns empty list when attached to avatar
   llGetNumberOfAgents() function to return an integer count of agents
   AGENT_LIST_MAX_RESULTS option for llGetAgentList()

Signature

function list llGetAgentList( integer scope, list options );