Difference between revisions of "LlListen"

From Second Life Wiki
Jump to navigation Jump to search
m (handle is the correct term)
(11 intermediate revisions by 6 users not shown)
Line 26: Line 26:
|also_tests
|also_tests
|also_articles
|also_articles
|notes=*Avoid channel [[PUBLIC_CHANNEL]] and set {{LSLP|name}} or {{LSLP|id}} where possible to avoid [http://rpgstats.com/wiki/index.php?title=Lag Lag]. <code>[[llListen]]([[PUBLIC_CHANNEL]], "", [[NULL_KEY]],"")</code> can be extremely laggy as it listens to all chat from everyone in chat range and so it should be avoided at all cost.
|haiku=
{{Haiku|Choose not much to say|Someone might overhear it|Blab no big secrets}}
|notes=*Avoid channel zero (PUBLIC_CHANNEL) and set {{LSLP|name}} or {{LSLP|id}} where possible to avoid lag. <code>llListen(0, "", NULL_KEY,"")</code> can be laggy as it listens to all chat from everyone in chat range and so should be avoided.


*In November 2007, [[User:Kelly_Linden|Kelly Linden]] offered [https://lists.secondlife.com/pipermail/secondlifescripters/2007-November/001993.html this explanation] to help scripters plan listeners more efficiently:
*In November 2007, [[User:Kelly_Linden|Kelly Linden]] offered [https://lists.secondlife.com/pipermail/secondlifescripters/2007-November/001993.html this explanation] to help scripters plan listeners more efficiently:
Line 44: Line 46:
:So, the most efficient communication method is [[llRegionSay]] on a rarely used {{LSLP|channel}}.
:So, the most efficient communication method is [[llRegionSay]] on a rarely used {{LSLP|channel}}.
:Nowadays, [[llRegionSayTo]] is to be preferred, where appropriate.
:Nowadays, [[llRegionSayTo]] is to be preferred, where appropriate.
*The integer returned can be assigned to a variable (then called a handle) and used to control the listen via [[llListenRemove]] or [[llListenControl]]. These handles are assigned sequentially starting at 1. If an [[llListen]] is repeated with the exact same filters as a currently active listener, then the same handle number is returned. If an [[llListen|llListen's]] filters do not match any currently active listener, then the next handle in sequence is allocated (it will not re-allocate a recently removed handle).
*The integer returned can be assigned to a variable (then called a handle) and used to control the listen via [[llListenRemove]] or [[llListenControl]]. These handles are assigned sequentially starting at <tt>+1</tt> through to <tt>+2,147,483,647</tt>, going beyond which, according to [[User:Simon Linden|Simon Linden]], will roll the returned integer over to <tt>−2,147,483,648</tt>, when positive incrementation resumes. If an [[llListen]] is repeated with the exact same filters as a currently active listener, then the same handle number is returned. If an [[llListen|llListen's]] filters do not match any currently active listener, then the next handle in sequence is allocated (it will not re-allocate a recently removed handle).
*If you are using multiple listens in one script, each listen can be assigned its own handle with which to control it.
*If you are using multiple listens in one script, each listen can be assigned its own handle with which to control it.
|caveats=*On [[state]] change or [[llResetScript|script reset]] all listens are removed automatically.
|caveats=*On [[state]] change or [[llResetScript|script reset]] all listens are removed automatically.
Line 50: Line 52:
*Only 65 listens can simultaneously be open in any single script.
*Only 65 listens can simultaneously be open in any single script.
**If this number is exceeded ''Script run-time error'' and ''Too Many Listens'' errors occur.
**If this number is exceeded ''Script run-time error'' and ''Too Many Listens'' errors occur.
*The standard SL viewer can only send chat on negative channels through [[llDialog]] or [[llTextBox]] responses. (Several third party viewers can use these channels from the chat bar.) For maximum compatibility, negative channels are best suited for applications that do not require direct avatar chat.
*For some time the official SL viewer and several third party viewers can use negative channels from the chat bar directly just as any other non-zero channel. Formerly, the standard SL viewer could only send chat on negative channels through [[llDialog]] or [[llTextBox]] responses, meaning negative channels were best suited for applications that did not require direct avatar chat.
* Messages sent by script on positive and negative channels are truncated to 1024 bytes. Messages sent by chat on positive channels are truncated to 1023 bytes. Messages sent by chat from negative channels are truncated to 254 bytes.
*Once a [[listen]] is registered its filters cannot be updated, if the listen is registered to [[llGetOwner]], the listen will remain registered to the old owner upon owner change.
*Once a [[listen]] is registered its filters cannot be updated, if the listen is registered to [[llGetOwner]], the listen will remain registered to the old owner upon owner change.
**[[CHANGED_OWNER|Owner change]] can be detected with the [[changed]] event.
**[[CHANGED_OWNER|Owner change]] can be detected with the [[changed]] event.
Line 57: Line 60:
**Chat indirectly generated (as a result of [[llDialog]], [[llTextBox]] or from a [[Link|linked prim]]) can be heard if in range.
**Chat indirectly generated (as a result of [[llDialog]], [[llTextBox]] or from a [[Link|linked prim]]) can be heard if in range.
|examples=
|examples=
Trivial example to [[listen]] to any chat from the [[object]] owner and respond once. To reduce lag and avoid spamming surrounding users, it is vastly preferable to listen on {{LSLP|channel}}s other than [[PUBLIC_CHANNEL]] and to trigger the listen event by chatting on an alternative channel such as <code>/5 hello</code>.
Trivial example to listen to any chat from the object owner and respond once.
{{{!}} class="sortable" width="100%" {{Prettytable}}
{{{!}} class="sortable" width="100%" {{Prettytable}}
{{!}}- {{Hl2}}
{{!}}- {{Hl2}}
! '''Single listen handle'''
! '''Single listen handle'''
{{!}}-
{{!}}-
{{!!}}<lsl>
{{!!}}<source lang="lsl2">
//  Says beep to owner the first time owner says something in main chat
//  Says beep to owner the first time owner says something in main chat
//  and then stops listening
//  and then stops listening
Line 71: Line 74:
{
{
     llListenRemove(listenHandle);
     llListenRemove(listenHandle);
//  because active listen handles are assigned a positive integer number
//  we set the handle's value to zero so we know it has been removed
    listenHandle = FALSE;
}
}


Line 82: Line 80:
     state_entry()
     state_entry()
     {
     {
//      Change channel to a positive integer number
//      Change the channel number to a positive integer  
//      to listen for '/5 hello' style of chat.
//      to listen for '/5 hello' style of chat.


//      target only the owner's chat on channel PUBLIC_CHANNEL (0)
//      target only the owner's chat on channel 0 (PUBLIC_CHANNEL)
         listenHandle = llListen(PUBLIC_CHANNEL, "", llGetOwner(), "");
         listenHandle = llListen(0, "", llGetOwner(), "");
     }
     }


     listen(integer channel, string name, key id, string message)
     listen(integer channel, string name, key id, string message)
     {
     {
//      we filtered to only listen on PUBLIC_CHANNEL (0)
//      we filtered to only listen on channel 0
//      to the owner's chat in the llListen call above
//      to the owner's chat in the llListen call above


Line 113: Line 111:
     }
     }
}
}
</lsl>
</source>
{{!}}}
{{!}}}


Line 120: Line 118:
! '''Two listen handles'''
! '''Two listen handles'''
{{!}}-
{{!}}-
{{!!}}<lsl>
{{!!}}<source lang="lsl2">
//  Opens two listen handles upon touch_start and
//  Opens two listen handles upon touch_start and
//  stops listening whenever something heard passes either filter
//  stops listening whenever something heard passes either filter
Line 131: Line 129:
     llListenRemove(listenHandle_a);
     llListenRemove(listenHandle_a);
     llListenRemove(listenHandle_b);
     llListenRemove(listenHandle_b);
    listenHandle_a = FALSE;
    listenHandle_b = FALSE;
}
}


default
default
{
{
    on_rez(integer start_param)
    {
        llResetScript();
    }
    changed(integer change)
    {
        if (change & CHANGED_OWNER)
        {
            llResetScript();
        }
    }
     touch_start(integer num_detected)
     touch_start(integer num_detected)
     {
     {
Line 159: Line 141:
         listenHandle_b = llListen(6, "", NULL_KEY, "");
         listenHandle_b = llListen(6, "", NULL_KEY, "");


         llSay(PUBLIC_CHANNEL, "Listening now to '" + name + "' on channel 5.");
         llSay(0, "Listening now to '" + name + "' on channel 5.");
         llSay(PUBLIC_CHANNEL, "Listening now to anybody/anything on channel 6.");
         llSay(0, "Listening now to anybody/anything on channel 6.");
     }
     }


Line 166: Line 148:
     {
     {
         if (channel == 5)
         if (channel == 5)
             llSay(PUBLIC_CHANNEL, name + " said: '/5 " + message + "'");
             llSay(0, name + " said: '/5 " + message + "'");


         if (channel == 6)
         if (channel == 6)
             llSay(PUBLIC_CHANNEL, name + " said: '/6 " + message + "'");
             llSay(0, name + " said: '/6 " + message + "'");


         remove_listen_handles();
         remove_listen_handles();
     }
     }
}
}
</lsl>
</source>
{{!}}}
{{!}}}
|cat1=Communications
|cat1=Communications

Revision as of 23:05, 11 November 2020

Summary

Function: integer llListen( integer channel, string name, key id, string msg );

Sets a handle for msg on channel from name and id.
Returns a handle (an integer) that can be used to deactivate or remove the listen.

• integer channel input chat channel, any integer value (-2147483648 through 2147483647)
• string name filter for specific prim name or avatar legacy name
• key id filter for specific group, avatar or prim UUID
• string msg filter for specific message

If msg, name or id are blank (i.e. "") they are not used to filter incoming messages. If id is an invalid key or assigned the value NULL_KEY, it is considered blank as well.

Specification

For the listen event to be triggered it must first match the criteria set forth by the filters; only when all the criteria have been met is a listen event generated. First the message must have been transmitted on channel. If id is both a valid key and not a null key then the speaker's key must be equivalent[2] to id. If name is set then the speaker's legacy name must match name exactly (case sensitive). If msg is set then the spoken message must match msg exactly (case sensitive).

Channel Constant Description
DEBUG_CHANNEL 0x7FFFFFFF Chat channel reserved for script debugging and error messages, broadcasts to all nearby users.
PUBLIC_CHANNEL 0x0 Chat channel that broadcasts to all nearby users. This channel is sometimes referred to as: open chat, local chat and public chat.

Caveats

  • Messages sent on channel zero[1] and DEBUG_CHANNEL are throttled to a rate of <200/10sec, per region, per owner/user.
    • Once the rate is exceeded, all following messages on channel zero or DEBUG_CHANNEL will be dropped until the send rate is again below 200/10sec for the previous 10 sec. Dropped messages, despite being dropped still count against the limit.
  • On state change or script reset all listens are removed automatically.
    • A state change can be used as a shortcut to releasing listens.
  • Only 65 listens can simultaneously be open in any single script.
    • If this number is exceeded Script run-time error and Too Many Listens errors occur.
  • For some time the official SL viewer and several third party viewers can use negative channels from the chat bar directly just as any other non-zero channel. Formerly, the standard SL viewer could only send chat on negative channels through llDialog or llTextBox responses, meaning negative channels were best suited for applications that did not require direct avatar chat.
  • Messages sent by script on positive and negative channels are truncated to 1024 bytes. Messages sent by chat on positive channels are truncated to 1023 bytes. Messages sent by chat from negative channels are truncated to 254 bytes.
  • Once a listen is registered its filters cannot be updated, if the listen is registered to llGetOwner, the listen will remain registered to the old owner upon owner change.
    • Owner change can be detected with the changed event.
    • To work around this the old listen will need to be closed and a new one opened for the new owner.
  • A prim cannot hear/listen to chat it generates. It can, however, hear a linked prim.
All Issues ~ Search JIRA for related Bugs

Examples

Trivial example to listen to any chat from the object owner and respond once.

Single listen handle
//  Says beep to owner the first time owner says something in main chat
//  and then stops listening

integer listenHandle;

remove_listen_handle()
{
    llListenRemove(listenHandle);
}

default
{
    state_entry()
    {
//      Change the channel number to a positive integer 
//      to listen for '/5 hello' style of chat.

//      target only the owner's chat on channel 0 (PUBLIC_CHANNEL)
        listenHandle = llListen(0, "", llGetOwner(), "");
    }

    listen(integer channel, string name, key id, string message)
    {
//      we filtered to only listen on channel 0
//      to the owner's chat in the llListen call above

        llOwnerSay("beep");

//      stop listening until script is reset
        remove_listen_handle();
    }

    on_rez(integer start_param)
    {
        llResetScript();
    }

    changed(integer change)
    {
        if (change & CHANGED_OWNER)
        {
            llResetScript();
        }
    }
}
Two listen handles
//  Opens two listen handles upon touch_start and
//  stops listening whenever something heard passes either filter

integer listenHandle_a;
integer listenHandle_b;

remove_listen_handles()
{
    llListenRemove(listenHandle_a);
    llListenRemove(listenHandle_b);
}

default
{
    touch_start(integer num_detected)
    {
        key    id   = llDetectedKey(0);
        string name = llDetectedName(0);

        listenHandle_a = llListen(5, "", id, "");
        listenHandle_b = llListen(6, "", NULL_KEY, "");

        llSay(0, "Listening now to '" + name + "' on channel 5.");
        llSay(0, "Listening now to anybody/anything on channel 6.");
    }

    listen(integer channel, string name, key id, string message)
    {
        if (channel == 5)
            llSay(0, name + " said: '/5 " + message + "'");

        if (channel == 6)
            llSay(0, name + " said: '/6 " + message + "'");

        remove_listen_handles();
    }
}

Notes

  • Avoid channel zero (PUBLIC_CHANNEL) and set name or id where possible to avoid lag. llListen(0, "", NULL_KEY,"") can be laggy as it listens to all chat from everyone in chat range and so should be avoided.
  1. Chat that is said gets added to a history.
  2. A script that is running and has a listen event will ask the history for a chat message during its slice of run time.
  3. When the script asks the history for a chat message the checks are done in this order:
    • channel
    • self chat (prims can't hear themselves)
    • distance/RegionSay
    • id
    • name
    • msg
  4. If a msg is found then a listen event is added to the event queue.
The id/name/msg checks only happen at all if those are specified of course.
So, the most efficient communication method is llRegionSay on a rarely used channel.
Nowadays, llRegionSayTo is to be preferred, where appropriate.
  • The integer returned can be assigned to a variable (then called a handle) and used to control the listen via llListenRemove or llListenControl. These handles are assigned sequentially starting at +1 through to +2,147,483,647, going beyond which, according to Simon Linden, will roll the returned integer over to −2,147,483,648, when positive incrementation resumes. If an llListen is repeated with the exact same filters as a currently active listener, then the same handle number is returned. If an llListen's filters do not match any currently active listener, then the next handle in sequence is allocated (it will not re-allocate a recently removed handle).
  • If you are using multiple listens in one script, each listen can be assigned its own handle with which to control it.

See Also

Events

•  listen

Functions

•  llListenRemove Removes a listen
•  llListenControl Enables/Disables a listen
•  llWhisper Sends chat limited to 10 meters
•  llSay Sends chat limited to 20 meters
•  llShout Sends chat limited to 100 meters
•  llRegionSay Sends chat limited current sim
•  llRegionSayTo Sends chat region wide to a specific avatar, or their attachments, or to a rezzed object of known UUID

Deep Notes

All Issues

~ Search JIRA for related Issues
   Listeners in child prims get positioned at root prim position first, then switch to child prim position after re-rez (resulting in wrong listener / whisper radius)
   llTargetSay() - region-wide direct communication
   llListen in linked objects is listening at root instead of linked object local position *after re-rezzing the linkset*

Footnotes

  1. ^ Channel zero is also known as: PUBLIC_CHANNEL, open chat, local chat and public chat
  2. ^ In general terms this means the matching for id is not case sensitive. See key#equivalency for details on key equivalency.

Signature

function integer llListen( integer channel, string name, key id, string msg );

Haiku

Choose not much to say
Someone might overhear it
Blab no big secrets