Difference between revisions of "LlGetAgentInfo"

From Second Life Wiki
Jump to navigation Jump to search
m (Fix for alphabetical order in Functions list)
m (Added caveat)
 
(52 intermediate revisions by 16 users not shown)
Line 1: Line 1:
{{LSL_Function
{{LSL_Function
|inject-2={{Issues/SVC-91}}{{Issues/SVC-3177}}{{LSL Function/avatar|id|sim=*}}
|func=llGetAgentInfo
|func=llGetAgentInfo
|sort=GetAgentInfo
|sort=GetAgentInfo
|func_id=206|func_sleep=0.0|func_energy=10.0
|func_id=206|func_sleep=0.0|func_energy=10.0
|return_type=integer|p1_type=key|p1_name=id|p1_desc=agent [[UUID]] in [[sim]]
|return_type=integer|return_subtype=bit field
|p1_type=key|p1_name=id
|func_footnote
|func_footnote
|func_desc
|func_desc
|return_text=bitfield containing the agent information about '''id'''.
|return_text=containing the agent information about {{LSLP|id}}.
|spec
|spec
|caveats
|caveats=* [[AGENT_BUSY]] indicates that the "busy" [[Internal Animations|internal animation]] is playing, even if the user is not truly in busy mode.
|constants={{{!}}
* '''On server 1.40 and below''', [[AGENT_TYPING]] indicated that the "type" internal animation is playing, it would not be set if the user disabled [[Debug Settings|PlayTypingAnim]]. '''On server 1.42 and up''', it reflects [[ChatFromViewer|typing start/stop messages]] from the client and does not depend on the  animation. If the old behavior is desired, use [[llGetAnimationList]] and look for {{NoWrap|{{String|c541c47f-e0c0-058b-ad1a-d6ae3a4584d9}}}} — {{Jira|SVC-787}}
{{!}}- valign="top"
* <code>[[AGENT_ALWAYS_RUN]] {{!}} [[AGENT_WALKING]]</code> indicates that the user requested to run using standard viewer controls. Use [[llGetAnimation]] to also detect running caused by physics.
{{!}}
* This function does not return reliable information immediately after a border crossing. Use [[llGetAnimation]] instead, if you can. &mdash; {{Jira|SVC-3177}}
{{{!}}{{Prettytable}}
* [[AGENT_AUTOMATED]] may unexpectedly be enabled, see [[AGENT_AUTOMATED|its caveats]] for more detail.
{{!}}-{{Hl2}}
|constants=
! colspan="2" {{!}} Constant
{{LSL Constants/llGetAgentInfo|table=*}}
! Returned if agent...
|examples=
{{!}}-
<syntaxhighlight lang="lsl2">
{{!}}{{LSLG|AGENT_ALWAYS_RUN}}
default
{{!}}{{LSL Hex|0x1000|4096}}
{
{{!}}has running ("Always Run") enabled
    touch_start(integer buf)
{{!}}-
    {
{{!}}{{LSLG|AGENT_ATTACHMENTS}}
        buf = llGetAgentInfo(llDetectedKey(0));
{{!}}{{LSL Hex|0x0002|2}}
        string out;
{{!}}has attachments
        if(buf & AGENT_FLYING)
{{!}}-
            out += "The agent is flying.\n";
{{!}}{{LSLG|AGENT_AWAY}}
        else
{{!}}{{LSL Hex|0x0040|64}}
            out += "The agent is not flying.\n";
{{!}}is in "away" mode
{{!}}-
        if(buf & AGENT_ATTACHMENTS)
{{!}}{{LSLG|AGENT_BUSY}}
        {
{{!}}{{LSL Hex|0x0800|2048}}
            if(buf & AGENT_SCRIPTED)
{{!}}is in "busy" mode
                out += "The agent has scripted attachments.\n";
{{!}}-
            else
{{!}}{{LSLG|AGENT_CROUCHING}}
                out += "The agent's attachments are unscripted.\n";
{{!}}{{LSL Hex|0x0400|1024}}
        }
{{!}}is crouching
        else
{{!}}-
            out += "The agent does not have attachments.\n";
{{!}}{{LSLG|AGENT_FLYING}}
{{!}}{{LSL Hex|0x0001|1}}
        if(buf & AGENT_MOUSELOOK)
{{!}}is flying
            out += "the agent is in mouselook.";
{{!}}-
        else
{{!}}{{LSLG|AGENT_IN_AIR}}
            out += "the agent is in normal camera mode.";
{{!}}{{LSL Hex|0x0100|256}}
        llWhisper(0, out);
{{!}}is in the air (hovering)
    }
{{!}}}
}
{{!}}
</syntaxhighlight>
{{{!}}{{Prettytable}}
 
{{!}}-{{Hl2}}
! colspan="2" {{!}} Constant
! Returned if agent...
{{!}}-
{{!}}{{LSLG|AGENT_MOUSELOOK}}
{{!}}{{LSL Hex|0x0008|8}}
{{!}}is in mouselook
{{!}}-
{{!}}{{LSLG|AGENT_ON_OBJECT}}
{{!}}{{LSL Hex|0x0020|32}}
{{!}}is sitting on an object
{{!}}-
{{!}}{{LSLG|AGENT_SCRIPTED}}
{{!}}{{LSL Hex|0x0004|4}}
{{!}}has scripted attachments
{{!}}-
{{!}}{{LSLG|AGENT_SITTING}}
{{!}}{{LSL Hex|0x0010|16}}
{{!}}is sitting
{{!}}-
{{!}}{{LSLG|AGENT_TYPING}}
{{!}}{{LSL Hex|0x0200|512}}
{{!}}is typing
{{!}}-
{{!}}{{LSLG|AGENT_WALKING}}
{{!}}{{LSL Hex|0x0080|128}}
{{!}}is walking
{{!}}}
{{!}}}
|examples
|helpers
|helpers
|also_functions={{LSL DefineRow||[[llRequestAgentData]]|}}
|also_functions=
{{LSL DefineRow||[[llRequestAgentData]]|}}
{{LSL DefineRow||[[llGetAnimation]]|}}
{{LSL DefineRow||[[llGetAnimationList]]|}}
|also_events
|also_events
|also_tests
|also_tests=
{{LSL DefineRow||[[llGetAgentInfo_Test]]|}}
|also_articles
|also_articles
|notes
|notes=This is not a good way of testing if an avatar is in the region, use [[llGetAgentSize]] instead.
|permission
|history={{LSL Added|0.4.0|remote=http://secondlife.wikia.com/wiki/Version_0.4.0#Scripting}} along with these flags [[AGENT_FLYING]], [[AGENT_ATTACHMENTS]], & [[AGENT_SCRIPTED]].
|negative_index
*[[AGENT_AUTOPILOT]] was added in {{SVN|2900|rev=136439|trunk=*|ser=1.33.0|anchor=file21}}
|cat1=Avatar and Agent
|haiku={{Haiku|Information search:|The avatar was revealed,|Mystery solved.}}
|cat1=Avatar
|cat2
|cat2
|cat3
|cat3
|cat4
|cat4
}}
}}

Latest revision as of 08:03, 7 February 2024

Summary

Function: integer llGetAgentInfo( key id );
0.0 Forced Delay
10.0 Energy

Returns a bit field (an integer) containing the agent information about id.

• key id – avatar UUID that is in the same region

Constant Val Returned if agent...
AGENT_ALWAYS_RUN 0x1000 has running ("Always Run") enabled, or is using tap-tap-hold
AGENT_ATTACHMENTS 0x0002 has attachments
AGENT_AUTOMATED 0x4000 is marked as a scripted agent/bot
AGENT_AUTOPILOT 0x2000 is in "autopilot" mode
AGENT_AWAY 0x0040 is in "away" mode
AGENT_BUSY 0x0800 is in "busy" mode
AGENT_CROUCHING 0x0400 is crouching
AGENT_FLYING 0x0001 is flying or hovering
AGENT_IN_AIR 0x0100 is in the air (jumping, flying or falling)
AGENT_MOUSELOOK 0x0008 is in mouselook
AGENT_ON_OBJECT 0x0020 is sitting on an object (and linked to it)
AGENT_SCRIPTED 0x0004 has scripted attachments
AGENT_SITTING 0x0010 is sitting[1]
AGENT_TYPING 0x0200 is typing
AGENT_WALKING 0x0080 is walking, running or crouch walking

Caveats

Examples

default
{
    touch_start(integer buf)
    {
        buf = llGetAgentInfo(llDetectedKey(0));
        string out;
        if(buf & AGENT_FLYING)
            out += "The agent is flying.\n";
        else
            out += "The agent is not flying.\n";
 
        if(buf & AGENT_ATTACHMENTS)
        {
            if(buf & AGENT_SCRIPTED)
                out += "The agent has scripted attachments.\n";
            else
                out += "The agent's attachments are unscripted.\n";
        }
        else
            out += "The agent does not have attachments.\n";
 
        if(buf & AGENT_MOUSELOOK)
            out += "the agent is in mouselook.";
        else
            out += "the agent is in normal camera mode.";
        llWhisper(0, out);
    }
}

Notes

This is not a good way of testing if an avatar is in the region, use llGetAgentSize instead.

See Also

Deep Notes

History

Tests

•  llGetAgentInfo_Test

Footnotes

  1. ^ "Sit down" on the avatar context menu allows ground sits anywhere: atop the terrain, on objects or even in the air, so it is possible to sit "on" an object without linking.
  2. ^ Early release notes were not very accurate or thorough, they sometimes included information about features added in previous releases or failed to include information about features added in that release.

Signature

function integer llGetAgentInfo( key id );

Haiku

Information search:
The avatar was revealed,
Mystery solved.

Retrieved from "https://wiki.secondlife.com/w/index.php?title=LlGetAgentInfo&oldid=1216173"