Difference between revisions of "Bot Playground/Commands/scanNearbyAvatars"
From SmartBots Developers Docs
(Created page with "{{DISPLAYTITLE:{{SUBPAGENAME}}}} <onlyinclude>Scans current region for other avatars.</onlyinclude> <syntaxhighlight lang="javascript"> const result = await Bot.scanNearbyAva...") |
|||
| Line 13: | Line 13: | ||
{{API Variable Group|Output}} | {{API Variable Group|Output}} | ||
{{API Return promise}} | {{API Return promise}} | ||
| − | {{API Variable|avatars|Array}} An array containing avatars on sim. | + | {{API Variable|avatars|Array}} An array containing avatars on sim. See "Response details" for more info. |
| − | <syntaxhighlight lang=" | + | |
| + | {{API Variables Table End}} | ||
| + | |||
| + | == Response details == | ||
| + | |||
| + | 'avatars' field of the response is an array and contains the list of avatars our bot sees: | ||
| + | |||
| + | <syntaxhighlight lang="json"> | ||
{ | { | ||
// Avatar name | // Avatar name | ||
| Line 51: | Line 58: | ||
// How much seconds do we see this avatar | // How much seconds do we see this avatar | ||
"SeenSeconds: 123, | "SeenSeconds: 123, | ||
| − | |||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | |||
| − | |||
== Details == | == Details == | ||
| + | 'SeenSince' value shows when we saw the specific avatar for the first time ''when running scanNearbyAvatars''. For example: | ||
| + | |||
| + | # Bot logs on. Time passes (say, 1 hour). | ||
| + | # Script sends 'scanNearbyAvatars' command | ||
| + | # Bot sees one avatar, Guest1 and sets SeenSince to current time (say, "2022-10-18 13:00") | ||
| + | # 5 minutes passes | ||
| + | # Script sends 'scanNearbyAvatars' again | ||
| + | # Now bot sees that another avatar arrived - Guest2. Its SeenSince will be "2022-10-18 13:05" | ||
| + | |||
| + | Thus, all further calls to 'scanNearbyAvatars' will return: | ||
| + | * Guest1: SeenSince = "2022-10-18 13:00" | ||
| + | * Guest2: SeenSince = "2022-10-18 13:05" | ||
| + | |||
| + | SeenSeconds shows the number of seconds we see avatar (Now - SeenSince). | ||
== Examples == | == Examples == | ||
Revision as of 14:44, 18 October 2022
Scans current region for other avatars.
const result = await Bot.scanNearbyAvatars();
Reference
This command accepts the following parameters:
| Variable | Required | Description
| |
|---|---|---|---|
| Input: | |||
| Output: | |||
| Function returns a Promise with the following data: | |||
| success | bool | true if command completed successfully | |
| error | string | error string if command has failed | |
| avatars | Array | An array containing avatars on sim. See "Response details" for more info. | |
Response details
'avatars' field of the response is an array and contains the list of avatars our bot sees:
{
// Avatar name
"Name": "GrrrillaBongo Resident",
// Avatar UUID
"UUID": "d8e20552-ca84-4c42-b8d3-e8fa5fbdcc6b",
// The parcel this avatar currently in
"ParcelID": 177,
// If avatar is sitting on something
"Sitting": false
// Position of avatar in-world
"Position": {
"X": 110,
"Y": 75,
"Z": 32
},
// Local position. If avatar is sitting this position is relative to sit parent
"LocalPosition": {
"X": 110,
"Z": 32,
"Y": 75
},
// Avatar heading (the view direction)
"Heading": 0,
// Local heading (for sitting avatars)
"LocalHeading": 0,
// The distance to this avatar
"Distance": 129.97195,
// When we seen this avatar for first time (see Details)
"SeenSince": "2022-10-18T12:36:58.2626463Z",
// How much seconds do we see this avatar
"SeenSeconds: 123,
}
Details
'SeenSince' value shows when we saw the specific avatar for the first time when running scanNearbyAvatars. For example:
- Bot logs on. Time passes (say, 1 hour).
- Script sends 'scanNearbyAvatars' command
- Bot sees one avatar, Guest1 and sets SeenSince to current time (say, "2022-10-18 13:00")
- 5 minutes passes
- Script sends 'scanNearbyAvatars' again
- Now bot sees that another avatar arrived - Guest2. Its SeenSince will be "2022-10-18 13:05"
Thus, all further calls to 'scanNearbyAvatars' will return:
- Guest1: SeenSince = "2022-10-18 13:00"
- Guest2: SeenSince = "2022-10-18 13:05"
SeenSeconds shows the number of seconds we see avatar (Now - SeenSince).
Examples
See the Currently worn items scripts in our Playground Examples section.
