llMessageLinked
llMessageLinked(integer link,// Link number (1 for root, >1 for children) or a LINK_* flag controlling which prim(s) receive the message. Values: Linksinteger num,// An integer value passed as the second parameter of thelink_messageevent.string str,// A string value passed as the third parameter of thelink_messageevent.key id// A key value passed as the fourth parameter of thelink_messageevent.
);- Energy
- 10
The purpose of this function is to allow scripts in the same object to communicate. It triggers a link_message event with the same parameters num, str, and id in all scripts in the prim(s) described by link.
You can use id as a second string field1. The sizes of str and id are only limited by available script memory.
llMessageLinked(0, 0, "", NULL_KEY);Caveats
Section titled “Caveats”- A script can hear its own linked messages if link targets the prim it is in2. This creates the possibility of an infinite loop (a bad thing); be very careful about how messages are handled and passed along.
- Messages sent via
llMessageLinkedto a script that issleeping, delayed, or lagged, are queued until the end of the delay. The event queue can hold 64 events.- If an event is received and the queue is full the event is silently dropped.
- Avoid sending link_messages to large numbers of scripts simultaneously as it can cause lag spike. This most often happens when using the multi-prim
LINK_*flags and can cause script execution to slow or halts. - Avoid sending link_messages to a target faster than they can be handled. Doing so risks filling the event queue and subsequent messages being silently discarded.
- When a script state changes, all pending events are deleted, including queued link_messages.
- If link is an invalid link number then the function silently fails.
- If str & id exceed the available memory of a script that catches the resulting
link_messageevent, that script will crash with a Stack-Heap Collision.
Examples
Section titled “Examples”Example 1
default{ // assumptions // object name: LSLWiki // script name: _lslwiki state_entry() { llMessageLinked(LINK_THIS, 0, llGetScriptName(), ""); }
link_message(integer sender_num, integer num, string msg, key id) { llOwnerSay(msg); // the owner of object LSLWiki will hear // LSLWiki:_lslwiki }}Example 2
Infinite Loop
Section titled “Infinite Loop”Message_Control(integer l, integer n) // Message_Total_Lack_Of_Control{ integer r = (++n); // Increment the value of n. llMessageLinked( l, r, "", ""); // Send the result to l}
12 collapsed lines
default{ state_entry() { Message_Control(LINK_SET, 0); // Tell all the scripts in the object that we have state_entered. } link_message(integer Sender, integer Number, string String, key Key) // This script is in the object too. { Message_Control(Sender, Number); // No filtering condition exists. llOwnerSay(((string)Number)); // Look at all the pretty numbers! }}Helper functions
Section titled “Helper functions”default{ // Quick and dirty debugging link_messages link_message(integer sender_num, integer num, string msg, key id) { llSay(DEBUG_CHANNEL, llList2CSV([sender_num, num, msg, id])); }}8 collapsed lines
// This is just an example script, you shouldn't handle link message within single script this way.
default{ // To propagate an unlimted number of arguments of any type. // Presumed, the separator string isn't used in any source string! state_entry() { list my_list = [1, 2.0, "a string", <1, 2, 3>, <1, 2, 3, 4>, llGetOwner()]; string list_parameter = llDumpList2String(my_list, "|"); // Convert the list to a string llMessageLinked(LINK_THIS, 0, list_parameter, ""); }
5 collapsed lines
link_message(integer sender_num, integer num, string list_argument, key id) { list re_list = llParseString2List(list_argument, ["|"], []); // Parse the string back to a list }}- Using
llMessageLinkedin a single prim object allows developers to mitigate some LSL limits by breaking up functionality between cooperating scripts and synchronizing actions. When you do this, be extremely careful not to create infinite loops as mentioned above. - Estimated
.25to.50delay between receiving and sending ofllMessageLinkedhas been observed by some users - Some users have noted occasional failures of linked messages when sending a message to a large number of receiving scripts in different prims using
LINK_SET,LINK_ALL_OTHERS, &LINK_ALL_CHILDREN. If you encounter this problem, a workaround is to place all child prim scripts in a single prim, using targeted functions like llSetLinkPrimitiveParams to modify the prim in which the script previously resided. — Void Singer - This function seems to create a lower lag level then
llListensince it does not need a listener.
See also
Section titled “See also”Events
Section titled “Events”Original wiki source
Some wiki templates and tables need their original context. View this article on the Second Life Wiki. Technical wording and examples are retained from the source; historical guidance may differ from current behavior.
Footnotes
Section titled “Footnotes”-
In LSL the key type is implemented as a string (but with different operators and restrictions). Typecasting between string and key types has no effect on the data contained. ↩
-
There are four ways for a script to target itself: by precise link number,
LINK_THIS,LINK_SETandLINK_ALL_CHILDREN(if the prim is a child prim). ↩