From 99c27742ead04257c55298195a4551dfdedb509b Mon Sep 17 00:00:00 2001 From: tapple Date: Mon, 8 Jun 2026 13:06:57 -0700 Subject: [PATCH] Improve the documentation for chat and email functions --- generated/builtins.txt | 14 +- generated/experimental/category_docs.yaml | 265 ++++++++++-------- .../experimental/category_functions.yaml | 27 +- generated/lsl_keywords_pretty.xml | 97 +++---- generated/lua_keywords_pretty.xml | 101 +++---- generated/secondlife.d.luau | 24 +- generated/secondlife.docs.json | 46 +-- generated/secondlife_selene.yml | 215 ++++++++------ lsl_definitions.yaml | 144 +++++----- slua_definitions.yaml | 6 +- 10 files changed, 507 insertions(+), 432 deletions(-) diff --git a/generated/builtins.txt b/generated/builtins.txt index fd447972..c58826f7 100644 --- a/generated/builtins.txt +++ b/generated/builtins.txt @@ -67,12 +67,12 @@ vector llDetectedTouchST( integer index ) vector llDetectedTouchUV( integer index ) integer llDetectedType( integer number ) vector llDetectedVel( integer number ) -void llDialog( key avatar, string message, list buttons, integer channel ) +void llDialog( key agent, string msg, list buttons, integer channel ) void llDie( ) string llDumpList2String( list src, string separator ) integer llEdgeOfWorld( vector pos, vector dir ) void llEjectFromLand( key avatar ) -void llEmail( string address, string subject, string message ) +void llEmail( string address, string subject, string msg ) string llEscapeURL( string url ) rotation llEuler2Rot( vector v ) void llEvade( key target, list options ) @@ -240,7 +240,7 @@ key llHTTPRequest( string url, list parameters, string body ) void llHTTPResponse( key request_id, integer status, string body ) integer llHash( string val ) string llInsertString( string dst, integer pos, string src ) -void llInstantMessage( key user, string message ) +void llInstantMessage( key agent, string msg ) string llIntegerToBase64( integer number ) integer llIsFriend( key agent_id ) integer llIsLinkGLTFMaterial( integer link, integer face ) @@ -496,11 +496,11 @@ float llTan( float theta ) integer llTarget( vector position, float range ) void llTargetOmega( vector axis, float spinrate, float gain ) void llTargetRemove( integer handle ) -void llTargetedEmail( integer target, string subject, string message ) +void llTargetedEmail( integer target, string subject, string msg ) void llTeleportAgent( key agent, string landmark, vector position, vector look_at ) void llTeleportAgentGlobalCoords( key agent, vector global_coordinates, vector region_coordinates, vector look_at ) void llTeleportAgentHome( key avatar ) -void llTextBox( key avatar, string message, integer channel ) +void llTextBox( key agent, string msg, integer channel ) string llToLower( string src ) string llToUpper( string src ) key llTransferLindenDollars( key destination, integer amount ) @@ -1562,7 +1562,7 @@ event collision_end( integer num_detected ) event collision_start( integer num_detected ) event control( key id, integer level, integer edge ) event dataserver( key queryid, string data ) -event email( string time, string address, string subject, string message, integer num_left ) +event email( string time, string address, string subject, string msg, integer num_left ) event experience_permissions( key agent_id ) event experience_permissions_denied( key agent_id, integer reason ) event final_damage( integer num_detected ) @@ -1574,7 +1574,7 @@ event land_collision_end( vector pos ) event land_collision_start( vector pos ) event link_message( integer sender_num, integer num, string str, key id ) event linkset_data( integer action, string name, string value ) -event listen( integer channel, string name, key id, string message ) +event listen( integer channel, string name, key id, string msg ) event money( key id, integer amount ) event moving_end( ) event moving_start( ) diff --git a/generated/experimental/category_docs.yaml b/generated/experimental/category_docs.yaml index d0ac5f8d..4d744add 100644 --- a/generated/experimental/category_docs.yaml +++ b/generated/experimental/category_docs.yaml @@ -266,38 +266,32 @@ avatar_animation: tooltip: Stops the specified animation anim (inventory, built-in, or UUID) on the avatar who granted the script the PERMISSION_TRIGGER_ANIMATION permission (automatically granted for attached or sat-on objects). avatar_communication: - email( string time, string address, string subject, string message, integer num_left ): - time: Timestamp of when the email was received. - address: Email address of the sender. - subject: Subject of the email. - message: Body text of the email. - num_left: Number of pending emails still waiting in the queue. - tooltip: Triggered when an email sent to this script's address arrives. num_left indicates the number of pending emails remaining in the queue. - listen( integer channel, string name, key id, string message ): + listen( integer channel, string name, key id, string msg ): channel: Chat channel where the message appeared. - name: Name of the sending prim or the legacy name of the sending avatar. - id: UUID of the sending avatar or prim. - message: Spoken text string. - tooltip: Triggered when a chat message matching active llListen filters is received on channel. Passes the sender's name and UUID key id, along with the spoken message string. - llDialog( key avatar, string message, list buttons, integer channel ) -> void: - avatar: UUID of the avatar in the same region. - message: Text message to display in the dialog box. + name: Name of the sending prim or the legacy name of the sending agent. + id: UUID of the sending agent or prim. + msg: Spoken text string. + tooltip: Triggered when a chat message matching active llListen filters is received on channel. Passes the sender's name and UUID key id, along with the spoken string msg. + llDialog( key agent, string msg, list buttons, integer channel ) -> void: + agent: UUID of the agent in the same region. + msg: Text message to display in the dialog box. buttons: A list of up to 12 strings representing button labels. - channel: Output chat channel (any integer value) where button clicks are chatted. - tooltip: Shows a dialog box on the screen of the avatar specified by avatar, displaying message along with up to 12 choice buttons. Clicking a button chats its label on channel. - llEmail( string address, string subject, string message ) -> void: + channel: Output chat channel (any 32-bit signed integer value) where button clicks are chatted. + tooltip: Shows a dialog box on the screen of the specified agent, displaying msg along with up to 12 choice buttons. Clicking a button chats its label on channel. The chat originates at the object's + position, but uses the agent's name and UUID, so it can be heard as long as the agent is still in the region. + llEmail( string address, string subject, string msg ) -> void: address: Destination email address. subject: Subject of the email. - message: Message body of the email. - tooltip: Sends an email to address with subject and message. - llInstantMessage( key user, string message ) -> void: - user: UUID of the destination user. - message: Text message string to send. - tooltip: Sends an instant message containing message to the user identified by their key. + msg: Message body of the email. + tooltip: Sends an email with the given destination address, subject, and body msg. The email will be sent from `{ll.GetKey()}@lsl.secondlife.com`. This can be used for script communication; see llGetNextEmail() + llInstantMessage( key agent, string msg ) -> void: + agent: UUID of the destination agent. + msg: Text message string to send. + tooltip: Sends an instant message containing msg to the agent identified by their key. llListen( integer channel, string name, key id, string msg ) -> integer: - channel: Input chat channel to listen on (any integer from -2147483648 to 2147483647). - name: Specific prim name or avatar legacy name to filter by (or empty string for no filter). - id: Specific avatar or prim UUID to filter by (or NULL_KEY for no filter). + channel: Chat channel (any 32-bit signed integer value) to listen on. Exact range is -2147483648 to 2147483647. + name: Specific prim name or agent legacy name to filter by (or empty string for no filter). + id: Specific agent or prim UUID to filter by (or NULL_KEY for no filter). msg: Specific chat message string to filter by (or empty string for no filter). tooltip: Creates a listener on channel from name and id for msg. Returns an integer listener handle used to control or remove the listener. Empty strings or NULL_KEY filters do not filter on those parameters. llListenControl( integer handle, integer active ) -> void: @@ -330,44 +324,45 @@ avatar_communication: params: Options or parameters to apply to the opened floater. tooltip: Opens the specified viewer floater_name loaded with url and configured via params. Returns an integer error code, or 0 if successful. llOwnerSay( string msg ) -> void: - msg: Text message string to send. + msg: Text message string to send to the object owner. tooltip: Sends the chat message msg privately to the object owner (the owner must be currently in the same region for the message to be received). llRegionSayTo( key target, integer channel, string msg ) -> void: - target: UUID of the destination avatar or prim in the same region. - channel: Output chat channel (any integer value). + target: UUID of the target agent or prim in the same region. + channel: Chat channel (any 32-bit signed integer value) to chat the message on. msg: Text message string to send. - tooltip: Sends the message msg on channel privately to the targeted avatar or object (if within the region). If target is an avatar and channel is non-zero, the message can also be heard by any attachments + tooltip: Sends the message msg on Channel privately to the targeted agent or object (if within the region). If target is an agent and channel is non-zero, the message can also be heard by any attachments worn by the avatar. llSay( integer channel, string msg ) -> void: - channel: Integer chat channel to transmit the message on. - msg: Text message string to transmit. - tooltip: Says the text message msg on the specified channel. The message can be heard up to a 20m radius. Channels other than PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647) are not visible to avatars - and can be used for script-to-script communication. + channel: Chat channel (any 32-bit signed integer value) to chat the message on. + msg: Text message string to broadcast. + tooltip: Broadcasts the message msg to all scripts or agents listening on channel within llGetEnv("chat_range"), which is 20m on most regions. Agents listen on PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647). + All other channels are for script-to-script communication. llSetText( string text, vector color, float alpha ) -> void: text: Floating text string to display. color: Color vector in RGB (values from 0.0 to 1.0). alpha: Transparency value to set, from 0.0 (clear) to 1.0 (solid). tooltip: Displays floating text above the prim with the specified color vector and transparency alpha. llShout( integer channel, string msg ) -> void: - channel: Integer chat channel to shout the message on. - msg: Text message string to transmit. - tooltip: Shouts the text message msg on the specified channel. The message can be heard up to a 100m radius. All channels other than PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647) are not sent to - avatars and are used to communicate with scripts. - llTargetedEmail( integer target, string subject, string message ) -> void: + channel: Chat channel (any 32-bit signed integer value) to shout the message on. + msg: Text message string to broadcast. + tooltip: Broadcasts the message msg to all scripts or agents listening on channel within llGetEnv("shout_range"), which is 100m on most regions. Agents listen on PUBLIC_CHANNEL (0) and DEBUG_CHANNEL + (2147483647). All other channels are for script-to-script communication. + llTargetedEmail( integer target, string subject, string msg ) -> void: target: Target constant (e.g., TARGETED_EMAIL_OBJECT_OWNER or TARGETED_EMAIL_ROOT_CREATOR). subject: Subject of the email. - message: Email message body. - tooltip: Sends an email containing subject and message to the target (which can designate the owner or creator of the object). - llTextBox( key avatar, string message, integer channel ) -> void: - avatar: UUID of the avatar in the same region. - message: Text message to display in the text box. - channel: Output chat channel (any integer value) where the input text is chatted. - tooltip: Opens an input text box dialog displaying message to the avatar. Submitting text chats the input string on channel as if said by the avatar. + msg: Email message body. + tooltip: Sends an email to with the given subject subject and body msg to the target (which can designate the owner or creator of the object). The email will be sent from `{ll.GetKey()}@lsl.secondlife.com`. + llTextBox( key agent, string msg, integer channel ) -> void: + agent: UUID of the agent in the same region. + msg: Text message to display in the text box. + channel: Output chat channel (any 32-bit signed integer value) where the input text is chatted. + tooltip: Opens an input text box dialog displaying msg to the agent. Submitting text chats the input string on channel as if said by the agent. The chat originates at the object's position, but uses + the agent's name and UUID, so it can be heard as long as the agent is still in the region. llWhisper( integer channel, string msg ) -> void: - channel: Integer chat channel to whisper the message on. - msg: Text message string to transmit. - tooltip: Whispers the text message msg on the specified channel. The message can be heard up to a 10m radius. All channels other than PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647) are not sent to - avatars and are used to communicate with scripts. + channel: Chat channel (any 32-bit signed integer value) to whisper the message on. + msg: Text message string to broadcast. + tooltip: Broadcasts the message msg to all scripts or agents listening on channel within llGetEnv("whisper_range"), which is 10m on most regions. Agents listen on PUBLIC_CHANNEL (0) and DEBUG_CHANNEL + (2147483647). All other channels are for script-to-script communication. avatar_inventory: llGiveAgentInventory( key agent, string folder, list inventory, list options ) -> integer: agent: UUID of the receiving agent in the region. @@ -425,22 +420,23 @@ camera: tooltip: Returns the local position vector that places the center of the HUD object directly over the world coordinate world_pos as viewed by the current camera. Requires the PERMISSION_TRACK_CAMERA runtime permission. chat: - listen( integer channel, string name, key id, string message ): + listen( integer channel, string name, key id, string msg ): channel: Chat channel where the message appeared. - name: Name of the sending prim or the legacy name of the sending avatar. - id: UUID of the sending avatar or prim. - message: Spoken text string. - tooltip: Triggered when a chat message matching active llListen filters is received on channel. Passes the sender's name and UUID key id, along with the spoken message string. - llDialog( key avatar, string message, list buttons, integer channel ) -> void: - avatar: UUID of the avatar in the same region. - message: Text message to display in the dialog box. + name: Name of the sending prim or the legacy name of the sending agent. + id: UUID of the sending agent or prim. + msg: Spoken text string. + tooltip: Triggered when a chat message matching active llListen filters is received on channel. Passes the sender's name and UUID key id, along with the spoken string msg. + llDialog( key agent, string msg, list buttons, integer channel ) -> void: + agent: UUID of the agent in the same region. + msg: Text message to display in the dialog box. buttons: A list of up to 12 strings representing button labels. - channel: Output chat channel (any integer value) where button clicks are chatted. - tooltip: Shows a dialog box on the screen of the avatar specified by avatar, displaying message along with up to 12 choice buttons. Clicking a button chats its label on channel. + channel: Output chat channel (any 32-bit signed integer value) where button clicks are chatted. + tooltip: Shows a dialog box on the screen of the specified agent, displaying msg along with up to 12 choice buttons. Clicking a button chats its label on channel. The chat originates at the object's + position, but uses the agent's name and UUID, so it can be heard as long as the agent is still in the region. llListen( integer channel, string name, key id, string msg ) -> integer: - channel: Input chat channel to listen on (any integer from -2147483648 to 2147483647). - name: Specific prim name or avatar legacy name to filter by (or empty string for no filter). - id: Specific avatar or prim UUID to filter by (or NULL_KEY for no filter). + channel: Chat channel (any 32-bit signed integer value) to listen on. Exact range is -2147483648 to 2147483647. + name: Specific prim name or agent legacy name to filter by (or empty string for no filter). + id: Specific agent or prim UUID to filter by (or NULL_KEY for no filter). msg: Specific chat message string to filter by (or empty string for no filter). tooltip: Creates a listener on channel from name and id for msg. Returns an integer listener handle used to control or remove the listener. Empty strings or NULL_KEY filters do not filter on those parameters. llListenControl( integer handle, integer active ) -> void: @@ -451,35 +447,36 @@ chat: handle: Integer listener handle returned by llListen to remove. tooltip: Completely removes the listener specified by the integer handle. llRegionSay( integer channel, string msg ) -> void: - channel: Output chat channel to broadcast on (must be non-zero). + channel: Chat channel (any 32-bit signed integer value except zero) to chat the message on. msg: Text message string to broadcast. - tooltip: Broadcasts the message msg on channel to the entire region (heard by any script listening on that channel; channel 0 is not permitted). + tooltip: Broadcasts the message msg to all scripts listening on channel Channel within the region. PUBLIC_CHANNEL (0) cannot be used, so, only scripts can receive the message. llRegionSayTo( key target, integer channel, string msg ) -> void: - target: UUID of the destination avatar or prim in the same region. - channel: Output chat channel (any integer value). + target: UUID of the target agent or prim in the same region. + channel: Chat channel (any 32-bit signed integer value) to chat the message on. msg: Text message string to send. - tooltip: Sends the message msg on channel privately to the targeted avatar or object (if within the region). If target is an avatar and channel is non-zero, the message can also be heard by any attachments + tooltip: Sends the message msg on Channel privately to the targeted agent or object (if within the region). If target is an agent and channel is non-zero, the message can also be heard by any attachments worn by the avatar. llSay( integer channel, string msg ) -> void: - channel: Integer chat channel to transmit the message on. - msg: Text message string to transmit. - tooltip: Says the text message msg on the specified channel. The message can be heard up to a 20m radius. Channels other than PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647) are not visible to avatars - and can be used for script-to-script communication. + channel: Chat channel (any 32-bit signed integer value) to chat the message on. + msg: Text message string to broadcast. + tooltip: Broadcasts the message msg to all scripts or agents listening on channel within llGetEnv("chat_range"), which is 20m on most regions. Agents listen on PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647). + All other channels are for script-to-script communication. llShout( integer channel, string msg ) -> void: - channel: Integer chat channel to shout the message on. - msg: Text message string to transmit. - tooltip: Shouts the text message msg on the specified channel. The message can be heard up to a 100m radius. All channels other than PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647) are not sent to - avatars and are used to communicate with scripts. - llTextBox( key avatar, string message, integer channel ) -> void: - avatar: UUID of the avatar in the same region. - message: Text message to display in the text box. - channel: Output chat channel (any integer value) where the input text is chatted. - tooltip: Opens an input text box dialog displaying message to the avatar. Submitting text chats the input string on channel as if said by the avatar. + channel: Chat channel (any 32-bit signed integer value) to shout the message on. + msg: Text message string to broadcast. + tooltip: Broadcasts the message msg to all scripts or agents listening on channel within llGetEnv("shout_range"), which is 100m on most regions. Agents listen on PUBLIC_CHANNEL (0) and DEBUG_CHANNEL + (2147483647). All other channels are for script-to-script communication. + llTextBox( key agent, string msg, integer channel ) -> void: + agent: UUID of the agent in the same region. + msg: Text message to display in the text box. + channel: Output chat channel (any 32-bit signed integer value) where the input text is chatted. + tooltip: Opens an input text box dialog displaying msg to the agent. Submitting text chats the input string on channel as if said by the agent. The chat originates at the object's position, but uses + the agent's name and UUID, so it can be heard as long as the agent is still in the region. llWhisper( integer channel, string msg ) -> void: - channel: Integer chat channel to whisper the message on. - msg: Text message string to transmit. - tooltip: Whispers the text message msg on the specified channel. The message can be heard up to a 10m radius. All channels other than PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647) are not sent to - avatars and are used to communicate with scripts. + channel: Chat channel (any 32-bit signed integer value) to whisper the message on. + msg: Text message string to broadcast. + tooltip: Broadcasts the message msg to all scripts or agents listening on channel within llGetEnv("whisper_range"), which is 10m on most regions. Agents listen on PUBLIC_CHANNEL (0) and DEBUG_CHANNEL + (2147483647). All other channels are for script-to-script communication. combat: final_damage( integer num_detected ): num_detected: Number of damage events applied to the avatar or task. @@ -3332,6 +3329,13 @@ script: sec: Duration in seconds to put the script to sleep. tooltip: Puts the script to sleep for sec seconds (at least until the next server-frame, ~0.02222 seconds). The script is inactive during this time. If sec is 0.0 or less, the script does not sleep. script_communication: + email( string time, string address, string subject, string msg, integer num_left ): + time: Timestamp of when the email was received, in (string)llGetUnixTime() format. + address: Email address of the sender. + subject: Subject of the email. + msg: Body text of the email. + num_left: Number of emails still waiting in the queue. + tooltip: Receive an email requested by llGetNextEmail(). NumberRemaining indicates the number of emails remaining in the queue for llGetNextEmail() to retrieve. http_request( key request_id, string method, string body ): request_id: Unique key identifying the incoming HTTP request (used with llHTTPResponse). method: HTTP method string ('GET', 'POST', 'PUT', 'DELETE') or URL request status constants. @@ -3349,12 +3353,12 @@ script_communication: str: A text string value passed from the sending script. id: A key value passed from the sending script. tooltip: Triggered when the script receives a link message from sender_num, containing the parameters num, str, and id sent via llMessageLinked. - listen( integer channel, string name, key id, string message ): + listen( integer channel, string name, key id, string msg ): channel: Chat channel where the message appeared. - name: Name of the sending prim or the legacy name of the sending avatar. - id: UUID of the sending avatar or prim. - message: Spoken text string. - tooltip: Triggered when a chat message matching active llListen filters is received on channel. Passes the sender's name and UUID key id, along with the spoken message string. + name: Name of the sending prim or the legacy name of the sending agent. + id: UUID of the sending agent or prim. + msg: Spoken text string. + tooltip: Triggered when a chat message matching active llListen filters is received on channel. Passes the sender's name and UUID key id, along with the spoken string msg. remote_data( integer event_type, key channel, key message_id, string sender, integer idata, string sdata ) // deprecated: event_type: Integer constant representing the type of XML-RPC event. channel: XML-RPC channel ID key. @@ -3366,10 +3370,21 @@ script_communication: llCloseRemoteDataChannel( key channel ) -> void // deprecated: channel: XML-RPC channel ID to close. tooltip: Deprecated. Closes the specified XML-RPC channel. + llEmail( string address, string subject, string msg ) -> void: + address: Destination email address. + subject: Subject of the email. + msg: Message body of the email. + tooltip: Sends an email with the given destination address, subject, and body msg. The email will be sent from `{ll.GetKey()}@lsl.secondlife.com`. This can be used for script communication; see llGetNextEmail() llGetNextEmail( string address, string subject ) -> void: - address: Sender email address filter. - subject: Email subject filter. - tooltip: Requests the next queued email matching the specified sender address and subject filters via the email event. + address: Sender email address filter, or "" for any address. + subject: Email subject filter, or "" for any subject. + tooltip: 'Requests the next queued email via the email event. Emails must + + 1. Be sent to `{ll.GetKey()}@lsl.secondlife.com` + + 2. Be sent from the specified sender Address (or any address if blank) + + 3. Have the specified subject Subject (or any subject if blank)' llHTTPRequest( string url, list parameters, string body ) -> key: url: Destination HTTP or HTTPS URL. parameters: A list of HTTP_* configuration flags and value pairs. @@ -3381,9 +3396,9 @@ script_communication: body: String contents of the response body. tooltip: Responds to the incoming HTTP request identified by request_id with the HTTP status code status and the payload body. llListen( integer channel, string name, key id, string msg ) -> integer: - channel: Input chat channel to listen on (any integer from -2147483648 to 2147483647). - name: Specific prim name or avatar legacy name to filter by (or empty string for no filter). - id: Specific avatar or prim UUID to filter by (or NULL_KEY for no filter). + channel: Chat channel (any 32-bit signed integer value) to listen on. Exact range is -2147483648 to 2147483647. + name: Specific prim name or agent legacy name to filter by (or empty string for no filter). + id: Specific agent or prim UUID to filter by (or NULL_KEY for no filter). msg: Specific chat message string to filter by (or empty string for no filter). tooltip: Creates a listener on channel from name and id for msg. Returns an integer listener handle used to control or remove the listener. Empty strings or NULL_KEY filters do not filter on those parameters. llListenControl( integer handle, integer active ) -> void: @@ -3402,14 +3417,14 @@ script_communication: llOpenRemoteDataChannel( ) -> void // deprecated: tooltip: Deprecated. Creates a channel to listen for incoming XML-RPC calls, triggering a remote_data event with the channel ID once available. llRegionSay( integer channel, string msg ) -> void: - channel: Output chat channel to broadcast on (must be non-zero). + channel: Chat channel (any 32-bit signed integer value except zero) to chat the message on. msg: Text message string to broadcast. - tooltip: Broadcasts the message msg on channel to the entire region (heard by any script listening on that channel; channel 0 is not permitted). + tooltip: Broadcasts the message msg to all scripts listening on channel Channel within the region. PUBLIC_CHANNEL (0) cannot be used, so, only scripts can receive the message. llRegionSayTo( key target, integer channel, string msg ) -> void: - target: UUID of the destination avatar or prim in the same region. - channel: Output chat channel (any integer value). + target: UUID of the target agent or prim in the same region. + channel: Chat channel (any 32-bit signed integer value) to chat the message on. msg: Text message string to send. - tooltip: Sends the message msg on channel privately to the targeted avatar or object (if within the region). If target is an avatar and channel is non-zero, the message can also be heard by any attachments + tooltip: Sends the message msg on Channel privately to the targeted agent or object (if within the region). If target is an agent and channel is non-zero, the message can also be heard by any attachments worn by the avatar. llRemoteDataReply( key channel, key message_id, string sdata, integer idata ) -> void // deprecated: channel: XML-RPC channel ID. @@ -3424,10 +3439,10 @@ script_communication: llRequestURL( ) -> key: tooltip: Asynchronously requests one HTTP URL for use by this script, triggering an http_request event. Returns a key query handle. llSay( integer channel, string msg ) -> void: - channel: Integer chat channel to transmit the message on. - msg: Text message string to transmit. - tooltip: Says the text message msg on the specified channel. The message can be heard up to a 20m radius. Channels other than PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647) are not visible to avatars - and can be used for script-to-script communication. + channel: Chat channel (any 32-bit signed integer value) to chat the message on. + msg: Text message string to broadcast. + tooltip: Broadcasts the message msg to all scripts or agents listening on channel within llGetEnv("chat_range"), which is 20m on most regions. Agents listen on PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647). + All other channels are for script-to-script communication. llSendRemoteData( key channel, string dest, integer idata, string sdata ) -> key // deprecated: channel: XML-RPC channel ID. dest: Destination XML-RPC URL or server. @@ -3435,15 +3450,15 @@ script_communication: sdata: String payload data. tooltip: Deprecated. Sends an XML-RPC request to dest on channel, containing the channel ID as a string, integer idata, and string sdata. Returns a key representing the message_id. llShout( integer channel, string msg ) -> void: - channel: Integer chat channel to shout the message on. - msg: Text message string to transmit. - tooltip: Shouts the text message msg on the specified channel. The message can be heard up to a 100m radius. All channels other than PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647) are not sent to - avatars and are used to communicate with scripts. + channel: Chat channel (any 32-bit signed integer value) to shout the message on. + msg: Text message string to broadcast. + tooltip: Broadcasts the message msg to all scripts or agents listening on channel within llGetEnv("shout_range"), which is 100m on most regions. Agents listen on PUBLIC_CHANNEL (0) and DEBUG_CHANNEL + (2147483647). All other channels are for script-to-script communication. llWhisper( integer channel, string msg ) -> void: - channel: Integer chat channel to whisper the message on. - msg: Text message string to transmit. - tooltip: Whispers the text message msg on the specified channel. The message can be heard up to a 10m radius. All channels other than PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647) are not sent to - avatars and are used to communicate with scripts. + channel: Chat channel (any 32-bit signed integer value) to whisper the message on. + msg: Text message string to broadcast. + tooltip: Broadcasts the message msg to all scripts or agents listening on channel within llGetEnv("whisper_range"), which is 10m on most regions. Agents listen on PUBLIC_CHANNEL (0) and DEBUG_CHANNEL + (2147483647). All other channels are for script-to-script communication. sensor: collision( integer num_detected ): num_detected: Total number of detected colliders (usable with llDetected* functions). @@ -3785,12 +3800,13 @@ user_interface: touch_start( integer num_detected ): num_detected: Total number of touching agents detected (usable with llDetected* functions). tooltip: Triggered when an avatar first touches the object. Passes num_detected, representing the number of touching agents. - llDialog( key avatar, string message, list buttons, integer channel ) -> void: - avatar: UUID of the avatar in the same region. - message: Text message to display in the dialog box. + llDialog( key agent, string msg, list buttons, integer channel ) -> void: + agent: UUID of the agent in the same region. + msg: Text message to display in the dialog box. buttons: A list of up to 12 strings representing button labels. - channel: Output chat channel (any integer value) where button clicks are chatted. - tooltip: Shows a dialog box on the screen of the avatar specified by avatar, displaying message along with up to 12 choice buttons. Clicking a button chats its label on channel. + channel: Output chat channel (any 32-bit signed integer value) where button clicks are chatted. + tooltip: Shows a dialog box on the screen of the specified agent, displaying msg along with up to 12 choice buttons. Clicking a button chats its label on channel. The chat originates at the object's + position, but uses the agent's name and UUID, so it can be heard as long as the agent is still in the region. llLoadURL( key avatar, string message, string url ) -> void: avatar: UUID of the avatar in the same region. message: Text message to display in the dialog box. @@ -3821,11 +3837,12 @@ user_interface: llSetTouchText( string text ) -> void: text: Context menu text to display. tooltip: Displays the string text instead of 'Touch' in the right-click context menu. - llTextBox( key avatar, string message, integer channel ) -> void: - avatar: UUID of the avatar in the same region. - message: Text message to display in the text box. - channel: Output chat channel (any integer value) where the input text is chatted. - tooltip: Opens an input text box dialog displaying message to the avatar. Submitting text chats the input string on channel as if said by the avatar. + llTextBox( key agent, string msg, integer channel ) -> void: + agent: UUID of the agent in the same region. + msg: Text message to display in the text box. + channel: Output chat channel (any 32-bit signed integer value) where the input text is chatted. + tooltip: Opens an input text box dialog displaying msg to the agent. Submitting text chats the input string on channel as if said by the agent. The chat originates at the object's position, but uses + the agent's name and UUID, so it can be heard as long as the agent is still in the region. llWorldPosToHUD( vector world_pos ) -> vector: world_pos: World-frame position vector to project into HUD space. tooltip: Returns the local position vector that places the center of the HUD object directly over the world coordinate world_pos as viewed by the current camera. Requires the PERMISSION_TRACK_CAMERA diff --git a/generated/experimental/category_functions.yaml b/generated/experimental/category_functions.yaml index b7aa723d..aeb07179 100644 --- a/generated/experimental/category_functions.yaml +++ b/generated/experimental/category_functions.yaml @@ -77,11 +77,10 @@ avatar_animation: - llStartAnimation( string anim ) -> void - llStopAnimation( string anim ) -> void avatar_communication: -- email( string time, string address, string subject, string message, integer num_left ) -- listen( integer channel, string name, key id, string message ) -- llDialog( key avatar, string message, list buttons, integer channel ) -> void -- llEmail( string address, string subject, string message ) -> void -- llInstantMessage( key user, string message ) -> void +- listen( integer channel, string name, key id, string msg ) +- llDialog( key agent, string msg, list buttons, integer channel ) -> void +- llEmail( string address, string subject, string msg ) -> void +- llInstantMessage( key agent, string msg ) -> void - llListen( integer channel, string name, key id, string msg ) -> integer - llListenControl( integer handle, integer active ) -> void - llListenRemove( integer handle ) -> void @@ -94,8 +93,8 @@ avatar_communication: - llSay( integer channel, string msg ) -> void - llSetText( string text, vector color, float alpha ) -> void - llShout( integer channel, string msg ) -> void -- llTargetedEmail( integer target, string subject, string message ) -> void -- llTextBox( key avatar, string message, integer channel ) -> void +- llTargetedEmail( integer target, string subject, string msg ) -> void +- llTextBox( key agent, string msg, integer channel ) -> void - llWhisper( integer channel, string msg ) -> void avatar_inventory: - llGiveAgentInventory( key agent, string folder, list inventory, list options ) -> integer @@ -116,8 +115,8 @@ camera: - llTakeCamera( key avatar ) -> void // deprecated - llWorldPosToHUD( vector world_pos ) -> vector chat: -- listen( integer channel, string name, key id, string message ) -- llDialog( key avatar, string message, list buttons, integer channel ) -> void +- listen( integer channel, string name, key id, string msg ) +- llDialog( key agent, string msg, list buttons, integer channel ) -> void - llListen( integer channel, string name, key id, string msg ) -> integer - llListenControl( integer handle, integer active ) -> void - llListenRemove( integer handle ) -> void @@ -125,7 +124,7 @@ chat: - llRegionSayTo( key target, integer channel, string msg ) -> void - llSay( integer channel, string msg ) -> void - llShout( integer channel, string msg ) -> void -- llTextBox( key avatar, string message, integer channel ) -> void +- llTextBox( key agent, string msg, integer channel ) -> void - llWhisper( integer channel, string msg ) -> void combat: - final_damage( integer num_detected ) @@ -928,12 +927,14 @@ script: - llSetTimerEvent( float sec ) -> void - llSleep( float sec ) -> void script_communication: +- email( string time, string address, string subject, string msg, integer num_left ) - http_request( key request_id, string method, string body ) - http_response( key request_id, integer status, list metadata, string body ) - link_message( integer sender_num, integer num, string str, key id ) -- listen( integer channel, string name, key id, string message ) +- listen( integer channel, string name, key id, string msg ) - remote_data( integer event_type, key channel, key message_id, string sender, integer idata, string sdata ) // deprecated - llCloseRemoteDataChannel( key channel ) -> void // deprecated +- llEmail( string address, string subject, string msg ) -> void - llGetNextEmail( string address, string subject ) -> void - llHTTPRequest( string url, list parameters, string body ) -> key - llHTTPResponse( key request_id, integer status, string body ) -> void @@ -1050,7 +1051,7 @@ user_interface: - touch( integer num_detected ) - touch_end( integer num_detected ) - touch_start( integer num_detected ) -- llDialog( key avatar, string message, list buttons, integer channel ) -> void +- llDialog( key agent, string msg, list buttons, integer channel ) -> void - llLoadURL( key avatar, string message, string url ) -> void - llMapBeacon( string region_name, vector pos, list options ) -> void - llMapDestination( string simname, vector pos, vector look_at ) -> void @@ -1058,7 +1059,7 @@ user_interface: - llSetPayPrice( integer price, list quick_pay_buttons ) -> void - llSetSitText( string text ) -> void - llSetTouchText( string text ) -> void -- llTextBox( key avatar, string message, integer channel ) -> void +- llTextBox( key agent, string msg, integer channel ) -> void - llWorldPosToHUD( vector world_pos ) -> vector uuid: - llDetectedKey( integer number ) -> key diff --git a/generated/lsl_keywords_pretty.xml b/generated/lsl_keywords_pretty.xml index b3fcd02b..e83314f4 100644 --- a/generated/lsl_keywords_pretty.xml +++ b/generated/lsl_keywords_pretty.xml @@ -9523,7 +9523,7 @@ If another state is defined before the default state, the compiler will report a time tooltip - Timestamp of when the email was received. + Timestamp of when the email was received, in (string)llGetUnixTime() format. type string @@ -9547,7 +9547,7 @@ If another state is defined before the default state, the compiler will report a - message + msg tooltip Body text of the email. @@ -9559,14 +9559,14 @@ If another state is defined before the default state, the compiler will report a num_left tooltip - Number of pending emails still waiting in the queue. + Number of emails still waiting in the queue. type integer tooltip - Triggered when an email sent to this script's address arrives. num_left indicates the number of pending emails remaining in the queue. + Receive an email requested by llGetNextEmail(). NumberRemaining indicates the number of emails remaining in the queue for llGetNextEmail() to retrieve. experience_permissions @@ -9889,7 +9889,7 @@ If another state is defined before the default state, the compiler will report a name tooltip - Name of the sending prim or the legacy name of the sending avatar. + Name of the sending prim or the legacy name of the sending agent. type string @@ -9898,13 +9898,13 @@ If another state is defined before the default state, the compiler will report a id tooltip - UUID of the sending avatar or prim. + UUID of the sending agent or prim. type key - message + msg tooltip Spoken text string. @@ -9914,7 +9914,7 @@ If another state is defined before the default state, the compiler will report a tooltip - Triggered when a chat message matching active llListen filters is received on channel. Passes the sender's name and UUID key id, along with the spoken message string. + Triggered when a chat message matching active llListen filters is received on channel. Passes the sender's name and UUID key id, along with the spoken string msg. money @@ -11993,16 +11993,16 @@ If another state is defined before the default state, the compiler will report a arguments - avatar + agent tooltip - UUID of the avatar in the same region. + UUID of the agent in the same region. type key - message + msg tooltip Text message to display in the dialog box. @@ -12023,7 +12023,7 @@ If another state is defined before the default state, the compiler will report a channel tooltip - Output chat channel (any integer value) where button clicks are chatted. + Output chat channel (any 32-bit signed integer value) where button clicks are chatted. type integer @@ -12036,7 +12036,7 @@ If another state is defined before the default state, the compiler will report a sleep 1.0 tooltip - Shows a dialog box on the screen of the avatar specified by avatar, displaying message along with up to 12 choice buttons. Clicking a button chats its label on channel. + Shows a dialog box on the screen of the specified agent, displaying msg along with up to 12 choice buttons. Clicking a button chats its label on channel. The chat originates at the object's position, but uses the agent's name and UUID, so it can be heard as long as the agent is still in the region. llDie @@ -12164,7 +12164,7 @@ If another state is defined before the default state, the compiler will report a - message + msg tooltip Message body of the email. @@ -12180,7 +12180,7 @@ If another state is defined before the default state, the compiler will report a sleep 20.0 tooltip - Sends an email to address with subject and message. + Sends an email with the given destination address, subject, and body msg. The email will be sent from `{ll.GetKey()}@lsl.secondlife.com`. This can be used for script communication; see llGetNextEmail() llEscapeURL @@ -13909,7 +13909,7 @@ If another state is defined before the default state, the compiler will report a address tooltip - Sender email address filter. + Sender email address filter, or "" for any address. type string @@ -13918,7 +13918,7 @@ If another state is defined before the default state, the compiler will report a subject tooltip - Email subject filter. + Email subject filter, or "" for any subject. type string @@ -13931,7 +13931,10 @@ If another state is defined before the default state, the compiler will report a sleep 0.0 tooltip - Requests the next queued email matching the specified sender address and subject filters via the email event. + Requests the next queued email via the email event. Emails must +1. Be sent to `{ll.GetKey()}@lsl.secondlife.com` +2. Be sent from the specified sender Address (or any address if blank) +3. Have the specified subject Subject (or any subject if blank) llGetNotecardLine @@ -15854,16 +15857,16 @@ If another state is defined before the default state, the compiler will report a arguments - user + agent tooltip - UUID of the destination user. + UUID of the destination agent. type key - message + msg tooltip Text message string to send. @@ -15879,7 +15882,7 @@ If another state is defined before the default state, the compiler will report a sleep 2.0 tooltip - Sends an instant message containing message to the user identified by their key. + Sends an instant message containing msg to the agent identified by their key. llIntegerToBase64 @@ -17561,7 +17564,7 @@ If another state is defined before the default state, the compiler will report a channel tooltip - Input chat channel to listen on (any integer from -2147483648 to 2147483647). + Chat channel (any 32-bit signed integer value) to listen on. Exact range is -2147483648 to 2147483647. type integer @@ -17570,7 +17573,7 @@ If another state is defined before the default state, the compiler will report a name tooltip - Specific prim name or avatar legacy name to filter by (or empty string for no filter). + Specific prim name or agent legacy name to filter by (or empty string for no filter). type string @@ -17579,7 +17582,7 @@ If another state is defined before the default state, the compiler will report a id tooltip - Specific avatar or prim UUID to filter by (or NULL_KEY for no filter). + Specific agent or prim UUID to filter by (or NULL_KEY for no filter). type key @@ -18760,7 +18763,7 @@ If another state is defined before the default state, the compiler will report a msg tooltip - Text message string to send. + Text message string to send to the object owner. type string @@ -19254,7 +19257,7 @@ If another state is defined before the default state, the compiler will report a channel tooltip - Output chat channel to broadcast on (must be non-zero). + Chat channel (any 32-bit signed integer value except zero) to chat the message on. type integer @@ -19276,7 +19279,7 @@ If another state is defined before the default state, the compiler will report a sleep 0.0 tooltip - Broadcasts the message msg on channel to the entire region (heard by any script listening on that channel; channel 0 is not permitted). + Broadcasts the message msg to all scripts listening on channel Channel within the region. PUBLIC_CHANNEL (0) cannot be used, so, only scripts can receive the message. llRegionSayTo @@ -19286,7 +19289,7 @@ If another state is defined before the default state, the compiler will report a target tooltip - UUID of the destination avatar or prim in the same region. + UUID of the target agent or prim in the same region. type key @@ -19295,7 +19298,7 @@ If another state is defined before the default state, the compiler will report a channel tooltip - Output chat channel (any integer value). + Chat channel (any 32-bit signed integer value) to chat the message on. type integer @@ -19317,7 +19320,7 @@ If another state is defined before the default state, the compiler will report a sleep 0.0 tooltip - Sends the message msg on channel privately to the targeted avatar or object (if within the region). If target is an avatar and channel is non-zero, the message can also be heard by any attachments worn by the avatar. + Sends the message msg on Channel privately to the targeted agent or object (if within the region). If target is an agent and channel is non-zero, the message can also be heard by any attachments worn by the avatar. llReleaseCamera @@ -20705,7 +20708,7 @@ If another state is defined before the default state, the compiler will report a channel tooltip - Integer chat channel to transmit the message on. + Chat channel (any 32-bit signed integer value) to chat the message on. type integer @@ -20714,7 +20717,7 @@ If another state is defined before the default state, the compiler will report a msg tooltip - Text message string to transmit. + Text message string to broadcast. type string @@ -20727,7 +20730,7 @@ If another state is defined before the default state, the compiler will report a sleep 0.0 tooltip - Says the text message msg on the specified channel. The message can be heard up to a 20m radius. Channels other than PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647) are not visible to avatars and can be used for script-to-script communication. + Broadcasts the message msg to all scripts or agents listening on channel within llGetEnv("chat_range"), which is 20m on most regions. Agents listen on PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647). All other channels are for script-to-script communication. llScaleByFactor @@ -23170,7 +23173,7 @@ If another state is defined before the default state, the compiler will report a channel tooltip - Integer chat channel to shout the message on. + Chat channel (any 32-bit signed integer value) to shout the message on. type integer @@ -23179,7 +23182,7 @@ If another state is defined before the default state, the compiler will report a msg tooltip - Text message string to transmit. + Text message string to broadcast. type string @@ -23192,7 +23195,7 @@ If another state is defined before the default state, the compiler will report a sleep 0.0 tooltip - Shouts the text message msg on the specified channel. The message can be heard up to a 100m radius. All channels other than PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647) are not sent to avatars and are used to communicate with scripts. + Broadcasts the message msg to all scripts or agents listening on channel within llGetEnv("shout_range"), which is 100m on most regions. Agents listen on PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647). All other channels are for script-to-script communication. llSignRSA @@ -23911,7 +23914,7 @@ If another state is defined before the default state, the compiler will report a - message + msg tooltip Email message body. @@ -23927,7 +23930,7 @@ If another state is defined before the default state, the compiler will report a sleep 20.0 tooltip - Sends an email containing subject and message to the target (which can designate the owner or creator of the object). + Sends an email to with the given subject subject and body msg to the target (which can designate the owner or creator of the object). The email will be sent from `{ll.GetKey()}@lsl.secondlife.com`. llTeleportAgent @@ -24057,16 +24060,16 @@ If another state is defined before the default state, the compiler will report a arguments - avatar + agent tooltip - UUID of the avatar in the same region. + UUID of the agent in the same region. type key - message + msg tooltip Text message to display in the text box. @@ -24078,7 +24081,7 @@ If another state is defined before the default state, the compiler will report a channel tooltip - Output chat channel (any integer value) where the input text is chatted. + Output chat channel (any 32-bit signed integer value) where the input text is chatted. type integer @@ -24091,7 +24094,7 @@ If another state is defined before the default state, the compiler will report a sleep 1.0 tooltip - Opens an input text box dialog displaying message to the avatar. Submitting text chats the input string on channel as if said by the avatar. + Opens an input text box dialog displaying msg to the agent. Submitting text chats the input string on channel as if said by the agent. The chat originates at the object's position, but uses the agent's name and UUID, so it can be heard as long as the agent is still in the region. llToLower @@ -24638,7 +24641,7 @@ If another state is defined before the default state, the compiler will report a channel tooltip - Integer chat channel to whisper the message on. + Chat channel (any 32-bit signed integer value) to whisper the message on. type integer @@ -24647,7 +24650,7 @@ If another state is defined before the default state, the compiler will report a msg tooltip - Text message string to transmit. + Text message string to broadcast. type string @@ -24660,7 +24663,7 @@ If another state is defined before the default state, the compiler will report a sleep 0.0 tooltip - Whispers the text message msg on the specified channel. The message can be heard up to a 10m radius. All channels other than PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647) are not sent to avatars and are used to communicate with scripts. + Broadcasts the message msg to all scripts or agents listening on channel within llGetEnv("whisper_range"), which is 10m on most regions. Agents listen on PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647). All other channels are for script-to-script communication. llWind diff --git a/generated/lua_keywords_pretty.xml b/generated/lua_keywords_pretty.xml index ab6af1b9..a468726e 100644 --- a/generated/lua_keywords_pretty.xml +++ b/generated/lua_keywords_pretty.xml @@ -9813,7 +9813,7 @@ float falloff – ranges from 0.01 to 2.0 time tooltip - Timestamp of when the email was received. + Timestamp of when the email was received, in (string)llGetUnixTime() format. type string @@ -9837,7 +9837,7 @@ float falloff – ranges from 0.01 to 2.0 - message + msg tooltip Body text of the email. @@ -9849,14 +9849,14 @@ float falloff – ranges from 0.01 to 2.0 num_left tooltip - Number of pending emails still waiting in the queue. + Number of emails still waiting in the queue. type number tooltip - Triggered when an email sent to this script's address arrives. num_left indicates the number of pending emails remaining in the queue. + Receive an email requested by llGetNextEmail(). NumberRemaining indicates the number of emails remaining in the queue for llGetNextEmail() to retrieve. experience_permissions @@ -10179,7 +10179,7 @@ float falloff – ranges from 0.01 to 2.0 name tooltip - Name of the sending prim or the legacy name of the sending avatar. + Name of the sending prim or the legacy name of the sending agent. type string @@ -10188,13 +10188,13 @@ float falloff – ranges from 0.01 to 2.0 id tooltip - UUID of the sending avatar or prim. + UUID of the sending agent or prim. type uuid - message + msg tooltip Spoken text string. @@ -10204,7 +10204,7 @@ float falloff – ranges from 0.01 to 2.0 tooltip - Triggered when a chat message matching active llListen filters is received on channel. Passes the sender's name and UUID key id, along with the spoken message string. + Triggered when a chat message matching active llListen filters is received on channel. Passes the sender's name and UUID key id, along with the spoken string msg. money @@ -10854,7 +10854,7 @@ float falloff – ranges from 0.01 to 2.0 ... tooltip - Arguments to print to standard output. + Arguments to send as text to the object owner. type T... @@ -10867,7 +10867,7 @@ float falloff – ranges from 0.01 to 2.0 sleep 0.0 tooltip - Prints all arguments to standard output using Tab as a separator. + Sends all arguments as text privately to the object owner, separated by 4 spaces. The owner must be currently in the same region for the message to be received. rawequal @@ -18565,16 +18565,16 @@ Returns true if result is non-zero. arguments - avatar + agent tooltip - UUID of the avatar in the same region. + UUID of the agent in the same region. type uuid - message + msg tooltip Text message to display in the dialog box. @@ -18595,7 +18595,7 @@ Returns true if result is non-zero. channel tooltip - Output chat channel (any integer value) where button clicks are chatted. + Output chat channel (any 32-bit signed integer value) where button clicks are chatted. type number @@ -18608,7 +18608,7 @@ Returns true if result is non-zero. sleep 1.0 tooltip - Shows a dialog box on the screen of the avatar specified by avatar, displaying message along with up to 12 choice buttons. Clicking a button chats its label on channel. + Shows a dialog box on the screen of the specified agent, displaying msg along with up to 12 choice buttons. Clicking a button chats its label on channel. The chat originates at the object's position, but uses the agent's name and UUID, so it can be heard as long as the agent is still in the region. ll.Die @@ -18734,7 +18734,7 @@ Returns true if result is non-zero. - message + msg tooltip Message body of the email. @@ -18750,7 +18750,7 @@ Returns true if result is non-zero. sleep 20.0 tooltip - Sends an email to address with subject and message. + Sends an email with the given destination address, subject, and body msg. The email will be sent from `{ll.GetKey()}@lsl.secondlife.com`. This can be used for script communication; see llGetNextEmail() ll.EscapeURL @@ -20467,7 +20467,7 @@ Returns true if result is non-zero. address tooltip - Sender email address filter. + Sender email address filter, or "" for any address. type string @@ -20476,7 +20476,7 @@ Returns true if result is non-zero. subject tooltip - Email subject filter. + Email subject filter, or "" for any subject. type string @@ -20489,7 +20489,10 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Requests the next queued email matching the specified sender address and subject filters via the email event. + Requests the next queued email via the email event. Emails must +1. Be sent to `{ll.GetKey()}@lsl.secondlife.com` +2. Be sent from the specified sender Address (or any address if blank) +3. Have the specified subject Subject (or any subject if blank) ll.GetNotecardLine @@ -22402,16 +22405,16 @@ Returns true if result is non-zero. arguments - user + agent tooltip - UUID of the destination user. + UUID of the destination agent. type uuid - message + msg tooltip Text message string to send. @@ -22427,7 +22430,7 @@ Returns true if result is non-zero. sleep 2.0 tooltip - Sends an instant message containing message to the user identified by their key. + Sends an instant message containing msg to the agent identified by their key. ll.IntegerToBase64 @@ -24177,7 +24180,7 @@ Returns true if result is non-zero. channel tooltip - Input chat channel to listen on (any integer from -2147483648 to 2147483647). + Chat channel (any 32-bit signed integer value) to listen on. Exact range is -2147483648 to 2147483647. type number @@ -24186,7 +24189,7 @@ Returns true if result is non-zero. name tooltip - Specific prim name or avatar legacy name to filter by (or empty string for no filter). + Specific prim name or agent legacy name to filter by (or empty string for no filter). type string @@ -24195,7 +24198,7 @@ Returns true if result is non-zero. id tooltip - Specific avatar or prim UUID to filter by (or NULL_KEY for no filter). + Specific agent or prim UUID to filter by (or NULL_KEY for no filter). type uuid @@ -25376,7 +25379,7 @@ Returns true if result is non-zero. msg tooltip - Text message string to send. + Text message string to send to the object owner. type string @@ -25872,7 +25875,7 @@ Returns true if result is non-zero. channel tooltip - Output chat channel to broadcast on (must be non-zero). + Chat channel (any 32-bit signed integer value except zero) to chat the message on. type number @@ -25894,7 +25897,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Broadcasts the message msg on channel to the entire region (heard by any script listening on that channel; channel 0 is not permitted). + Broadcasts the message msg to all scripts listening on channel Channel within the region. PUBLIC_CHANNEL (0) cannot be used, so, only scripts can receive the message. ll.RegionSayTo @@ -25904,7 +25907,7 @@ Returns true if result is non-zero. target tooltip - UUID of the destination avatar or prim in the same region. + UUID of the target agent or prim in the same region. type uuid @@ -25913,7 +25916,7 @@ Returns true if result is non-zero. channel tooltip - Output chat channel (any integer value). + Chat channel (any 32-bit signed integer value) to chat the message on. type number @@ -25935,7 +25938,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Sends the message msg on channel privately to the targeted avatar or object (if within the region). If target is an avatar and channel is non-zero, the message can also be heard by any attachments worn by the avatar. + Sends the message msg on Channel privately to the targeted agent or object (if within the region). If target is an agent and channel is non-zero, the message can also be heard by any attachments worn by the avatar. ll.ReleaseCamera @@ -27315,7 +27318,7 @@ Returns true if result is non-zero. channel tooltip - Integer chat channel to transmit the message on. + Chat channel (any 32-bit signed integer value) to chat the message on. type number @@ -27324,7 +27327,7 @@ Returns true if result is non-zero. msg tooltip - Text message string to transmit. + Text message string to broadcast. type string @@ -27337,7 +27340,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Says the text message msg on the specified channel. The message can be heard up to a 20m radius. Channels other than PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647) are not visible to avatars and can be used for script-to-script communication. + Broadcasts the message msg to all scripts or agents listening on channel within llGetEnv("chat_range"), which is 20m on most regions. Agents listen on PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647). All other channels are for script-to-script communication. ll.ScaleByFactor @@ -29726,7 +29729,7 @@ Returns true if result is non-zero. channel tooltip - Integer chat channel to shout the message on. + Chat channel (any 32-bit signed integer value) to shout the message on. type number @@ -29735,7 +29738,7 @@ Returns true if result is non-zero. msg tooltip - Text message string to transmit. + Text message string to broadcast. type string @@ -29748,7 +29751,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Shouts the text message msg on the specified channel. The message can be heard up to a 100m radius. All channels other than PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647) are not sent to avatars and are used to communicate with scripts. + Broadcasts the message msg to all scripts or agents listening on channel within llGetEnv("shout_range"), which is 100m on most regions. Agents listen on PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647). All other channels are for script-to-script communication. ll.SignRSA @@ -30477,7 +30480,7 @@ Returns true if result is non-zero. - message + msg tooltip Email message body. @@ -30493,7 +30496,7 @@ Returns true if result is non-zero. sleep 20.0 tooltip - Sends an email containing subject and message to the target (which can designate the owner or creator of the object). + Sends an email to with the given subject subject and body msg to the target (which can designate the owner or creator of the object). The email will be sent from `{ll.GetKey()}@lsl.secondlife.com`. ll.TeleportAgent @@ -30623,16 +30626,16 @@ Returns true if result is non-zero. arguments - avatar + agent tooltip - UUID of the avatar in the same region. + UUID of the agent in the same region. type uuid - message + msg tooltip Text message to display in the text box. @@ -30644,7 +30647,7 @@ Returns true if result is non-zero. channel tooltip - Output chat channel (any integer value) where the input text is chatted. + Output chat channel (any 32-bit signed integer value) where the input text is chatted. type number @@ -30657,7 +30660,7 @@ Returns true if result is non-zero. sleep 1.0 tooltip - Opens an input text box dialog displaying message to the avatar. Submitting text chats the input string on channel as if said by the avatar. + Opens an input text box dialog displaying msg to the agent. Submitting text chats the input string on channel as if said by the agent. The chat originates at the object's position, but uses the agent's name and UUID, so it can be heard as long as the agent is still in the region. ll.ToLower @@ -31208,7 +31211,7 @@ Returns true if result is non-zero. channel tooltip - Integer chat channel to whisper the message on. + Chat channel (any 32-bit signed integer value) to whisper the message on. type number @@ -31217,7 +31220,7 @@ Returns true if result is non-zero. msg tooltip - Text message string to transmit. + Text message string to broadcast. type string @@ -31230,7 +31233,7 @@ Returns true if result is non-zero. sleep 0.0 tooltip - Whispers the text message msg on the specified channel. The message can be heard up to a 10m radius. All channels other than PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647) are not sent to avatars and are used to communicate with scripts. + Broadcasts the message msg to all scripts or agents listening on channel within llGetEnv("whisper_range"), which is 10m on most regions. Agents listen on PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647). All other channels are for script-to-script communication. ll.Wind diff --git a/generated/secondlife.d.luau b/generated/secondlife.d.luau index 16223968..26044881 100644 --- a/generated/secondlife.d.luau +++ b/generated/secondlife.d.luau @@ -121,7 +121,7 @@ declare extern type LLEvents with collision_start: LLDetectedEventHandler? control: ((id: uuid, level: number, edge: number) -> ())? dataserver: ((queryid: uuid, data: string) -> ())? - email: ((time: string, address: string, subject: string, message: string, num_left: number) -> ())? + email: ((time: string, address: string, subject: string, msg: string, num_left: number) -> ())? experience_permissions: ((agent_id: uuid) -> ())? experience_permissions_denied: ((agent_id: uuid, reason: number) -> ())? final_damage: LLDetectedEventHandler? @@ -133,7 +133,7 @@ declare extern type LLEvents with land_collision_start: ((pos: vector) -> ())? link_message: ((sender_num: number, num: number, str: string, id: string) -> ())? linkset_data: ((action: number, name: string, value: string) -> ())? - listen: ((channel: number, name: string, id: uuid, message: string) -> ())? + listen: ((channel: number, name: string, id: uuid, msg: string) -> ())? money: ((id: uuid, amount: number) -> ())? moving_end: (() -> ())? moving_start: (() -> ())? @@ -644,12 +644,12 @@ declare ll: { DetectedTouchUV: @[deprecated {use='getTouchUV'}](index: number) -> vector, DetectedType: @[deprecated {use='getType'}](number: number) -> number, DetectedVel: @[deprecated {use='getVel'}](number: number) -> vector, - Dialog: (avatar: uuid, message: string, buttons: {string}, channel: number) -> (), + Dialog: (agent: uuid, msg: string, buttons: {string}, channel: number) -> (), Die: () -> (), DumpList2String: (src: list, separator: string) -> string, EdgeOfWorld: (pos: vector, dir: vector) -> boolean, EjectFromLand: (avatar: uuid) -> (), - Email: (address: string, subject: string, message: string) -> (), + Email: (address: string, subject: string, msg: string) -> (), EscapeURL: (url: string) -> string, Euler2Rot: (v: vector) -> quaternion, Evade: (target: uuid, options: list) -> (), @@ -815,7 +815,7 @@ declare ll: { HTTPResponse: (request_id: uuid, status: number, body: string) -> (), Hash: (val: string) -> number, InsertString: (dst: string, pos: number, src: string) -> string, - InstantMessage: (user: uuid, message: string) -> (), + InstantMessage: (agent: uuid, msg: string) -> (), IntegerToBase64: (number: number) -> string, IsFriend: (agent_id: uuid) -> boolean, IsLinkGLTFMaterial: (link: number, face: number) -> boolean, @@ -1064,11 +1064,11 @@ declare ll: { Target: (position: vector, range: number) -> number, TargetOmega: (axis: vector, spinrate: number, gain: number) -> (), TargetRemove: (handle: number) -> (), - TargetedEmail: (target: number, subject: string, message: string) -> (), + TargetedEmail: (target: number, subject: string, msg: string) -> (), TeleportAgent: (agent: uuid, landmark: string, position: vector, look_at: vector) -> (), TeleportAgentGlobalCoords: (agent: uuid, global_coordinates: vector, region_coordinates: vector, look_at: vector) -> (), TeleportAgentHome: (avatar: uuid) -> (), - TextBox: (avatar: uuid, message: string, channel: number) -> (), + TextBox: (agent: uuid, msg: string, channel: number) -> (), ToLower: (src: string) -> string, ToUpper: (src: string) -> string, TransferLindenDollars: (destination: uuid, amount: number) -> uuid, @@ -1167,12 +1167,12 @@ declare llcompat: { DetectedTouchUV: @deprecated (index: number) -> vector, DetectedType: @deprecated (number: number) -> number, DetectedVel: @deprecated (number: number) -> vector, - Dialog: @deprecated (avatar: uuid, message: string, buttons: {string}, channel: number) -> (), + Dialog: @deprecated (agent: uuid, msg: string, buttons: {string}, channel: number) -> (), Die: @deprecated () -> (), DumpList2String: @deprecated (src: list, separator: string) -> string, EdgeOfWorld: @deprecated (pos: vector, dir: vector) -> number, EjectFromLand: @deprecated (avatar: uuid) -> (), - Email: @deprecated (address: string, subject: string, message: string) -> (), + Email: @deprecated (address: string, subject: string, msg: string) -> (), EscapeURL: @deprecated (url: string) -> string, Euler2Rot: @deprecated (v: vector) -> quaternion, Evade: @deprecated (target: uuid, options: list) -> (), @@ -1339,7 +1339,7 @@ declare llcompat: { HTTPResponse: @deprecated (request_id: uuid, status: number, body: string) -> (), Hash: @deprecated (val: string) -> number, InsertString: @deprecated (dst: string, pos: number, src: string) -> string, - InstantMessage: @deprecated (user: uuid, message: string) -> (), + InstantMessage: @deprecated (agent: uuid, msg: string) -> (), IntegerToBase64: @deprecated (number: number) -> string, IsFriend: @deprecated (agent_id: uuid) -> number, IsLinkGLTFMaterial: @deprecated (link: number, face: number) -> number, @@ -1591,11 +1591,11 @@ declare llcompat: { Target: @deprecated (position: vector, range: number) -> number, TargetOmega: @deprecated (axis: vector, spinrate: number, gain: number) -> (), TargetRemove: @deprecated (handle: number) -> (), - TargetedEmail: @deprecated (target: number, subject: string, message: string) -> (), + TargetedEmail: @deprecated (target: number, subject: string, msg: string) -> (), TeleportAgent: @deprecated (agent: uuid, landmark: string, position: vector, look_at: vector) -> (), TeleportAgentGlobalCoords: @deprecated (agent: uuid, global_coordinates: vector, region_coordinates: vector, look_at: vector) -> (), TeleportAgentHome: @deprecated (avatar: uuid) -> (), - TextBox: @deprecated (avatar: uuid, message: string, channel: number) -> (), + TextBox: @deprecated (agent: uuid, msg: string, channel: number) -> (), ToLower: @deprecated (src: string) -> string, ToUpper: @deprecated (src: string) -> string, TransferLindenDollars: @deprecated (destination: uuid, amount: number) -> uuid, diff --git a/generated/secondlife.docs.json b/generated/secondlife.docs.json index 2bc080a3..8468530b 100644 --- a/generated/secondlife.docs.json +++ b/generated/secondlife.docs.json @@ -30,7 +30,7 @@ "documentation": "Calls function f with parameters args, returning success and function results or an error." }, "@sl-slua/global/print": { - "documentation": "Prints all arguments to standard output using Tab as a separator." + "documentation": "Sends all arguments as text privately to the object owner, separated by 4 spaces. The owner must be currently in the same region for the message to be received." }, "@sl-slua/global/rawequal": { "documentation": "Returns true if a and b have the same type and value." @@ -1159,7 +1159,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlDetectedVel" }, "@sl-slua/global/ll.Dialog": { - "documentation": "Shows a dialog box on the screen of the avatar specified by avatar, displaying message along with up to 12 choice buttons. Clicking a button chats its label on channel.", + "documentation": "Shows a dialog box on the screen of the specified agent, displaying msg along with up to 12 choice buttons. Clicking a button chats its label on channel. The chat originates at the object's position, but uses the agent's name and UUID, so it can be heard as long as the agent is still in the region.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlDialog" }, "@sl-slua/global/ll.Die": { @@ -1179,7 +1179,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlEjectFromLand" }, "@sl-slua/global/ll.Email": { - "documentation": "Sends an email to address with subject and message.", + "documentation": "Sends an email with the given destination address, subject, and body msg. The email will be sent from `{ll.GetKey()}@lsl.secondlife.com`. This can be used for script communication; see llGetNextEmail()", "learn_more_link": "https://wiki.secondlife.com/wiki/LlEmail" }, "@sl-slua/global/ll.EscapeURL": { @@ -1491,7 +1491,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlGetMoonRotation" }, "@sl-slua/global/ll.GetNextEmail": { - "documentation": "Requests the next queued email matching the specified sender address and subject filters via the email event.", + "documentation": "Requests the next queued email via the email event. Emails must
1. Be sent to `{ll.GetKey()}@lsl.secondlife.com`
2. Be sent from the specified sender Address (or any address if blank)
3. Have the specified subject Subject (or any subject if blank)", "learn_more_link": "https://wiki.secondlife.com/wiki/LlGetNextEmail" }, "@sl-slua/global/ll.GetNotecardLine": { @@ -1843,7 +1843,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlInsertString" }, "@sl-slua/global/ll.InstantMessage": { - "documentation": "Sends an instant message containing message to the user identified by their key.", + "documentation": "Sends an instant message containing msg to the agent identified by their key.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlInstantMessage" }, "@sl-slua/global/ll.IntegerToBase64": { @@ -2239,11 +2239,11 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlRefreshPrimURL" }, "@sl-slua/global/ll.RegionSay": { - "documentation": "Broadcasts the message msg on channel to the entire region (heard by any script listening on that channel; channel 0 is not permitted).", + "documentation": "Broadcasts the message msg to all scripts listening on channel Channel within the region. PUBLIC_CHANNEL (0) cannot be used, so, only scripts can receive the message.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlRegionSay" }, "@sl-slua/global/ll.RegionSayTo": { - "documentation": "Sends the message msg on channel privately to the targeted avatar or object (if within the region). If target is an avatar and channel is non-zero, the message can also be heard by any attachments worn by the avatar.", + "documentation": "Sends the message msg on Channel privately to the targeted agent or object (if within the region). If target is an agent and channel is non-zero, the message can also be heard by any attachments worn by the avatar.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlRegionSayTo" }, "@sl-slua/global/ll.ReleaseCamera": { @@ -2439,7 +2439,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlSameGroup" }, "@sl-slua/global/ll.Say": { - "documentation": "Says the text message msg on the specified channel. The message can be heard up to a 20m radius. Channels other than PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647) are not visible to avatars and can be used for script-to-script communication.", + "documentation": "Broadcasts the message msg to all scripts or agents listening on channel within llGetEnv(\"chat_range\"), which is 20m on most regions. Agents listen on PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647). All other channels are for script-to-script communication.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlSay" }, "@sl-slua/global/ll.ScaleByFactor": { @@ -2731,7 +2731,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlSetVelocity" }, "@sl-slua/global/ll.Shout": { - "documentation": "Shouts the text message msg on the specified channel. The message can be heard up to a 100m radius. All channels other than PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647) are not sent to avatars and are used to communicate with scripts.", + "documentation": "Broadcasts the message msg to all scripts or agents listening on channel within llGetEnv(\"shout_range\"), which is 100m on most regions. Agents listen on PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647). All other channels are for script-to-script communication.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlShout" }, "@sl-slua/global/ll.SignRSA": { @@ -2839,7 +2839,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlTargetRemove" }, "@sl-slua/global/ll.TargetedEmail": { - "documentation": "Sends an email containing subject and message to the target (which can designate the owner or creator of the object).", + "documentation": "Sends an email to with the given subject subject and body msg to the target (which can designate the owner or creator of the object). The email will be sent from `{ll.GetKey()}@lsl.secondlife.com`.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlTargetedEmail" }, "@sl-slua/global/ll.TeleportAgent": { @@ -2855,7 +2855,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlTeleportAgentHome" }, "@sl-slua/global/ll.TextBox": { - "documentation": "Opens an input text box dialog displaying message to the avatar. Submitting text chats the input string on channel as if said by the avatar.", + "documentation": "Opens an input text box dialog displaying msg to the agent. Submitting text chats the input string on channel as if said by the agent. The chat originates at the object's position, but uses the agent's name and UUID, so it can be heard as long as the agent is still in the region.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlTextBox" }, "@sl-slua/global/ll.ToLower": { @@ -2927,7 +2927,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlWater" }, "@sl-slua/global/ll.Whisper": { - "documentation": "Whispers the text message msg on the specified channel. The message can be heard up to a 10m radius. All channels other than PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647) are not sent to avatars and are used to communicate with scripts.", + "documentation": "Broadcasts the message msg to all scripts or agents listening on channel within llGetEnv(\"whisper_range\"), which is 10m on most regions. Agents listen on PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647). All other channels are for script-to-script communication.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlWhisper" }, "@sl-slua/global/ll.Wind": { @@ -3222,7 +3222,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlDetectedVel" }, "@sl-slua/global/llcompat.Dialog": { - "documentation": "Shows a dialog box on the screen of the avatar specified by avatar, displaying message along with up to 12 choice buttons. Clicking a button chats its label on channel.", + "documentation": "Shows a dialog box on the screen of the specified agent, displaying msg along with up to 12 choice buttons. Clicking a button chats its label on channel. The chat originates at the object's position, but uses the agent's name and UUID, so it can be heard as long as the agent is still in the region.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlDialog" }, "@sl-slua/global/llcompat.Die": { @@ -3242,7 +3242,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlEjectFromLand" }, "@sl-slua/global/llcompat.Email": { - "documentation": "Sends an email to address with subject and message.", + "documentation": "Sends an email with the given destination address, subject, and body msg. The email will be sent from `{ll.GetKey()}@lsl.secondlife.com`. This can be used for script communication; see llGetNextEmail()", "learn_more_link": "https://wiki.secondlife.com/wiki/LlEmail" }, "@sl-slua/global/llcompat.EscapeURL": { @@ -3558,7 +3558,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlGetMoonRotation" }, "@sl-slua/global/llcompat.GetNextEmail": { - "documentation": "Requests the next queued email matching the specified sender address and subject filters via the email event.", + "documentation": "Requests the next queued email via the email event. Emails must
1. Be sent to `{ll.GetKey()}@lsl.secondlife.com`
2. Be sent from the specified sender Address (or any address if blank)
3. Have the specified subject Subject (or any subject if blank)", "learn_more_link": "https://wiki.secondlife.com/wiki/LlGetNextEmail" }, "@sl-slua/global/llcompat.GetNotecardLine": { @@ -3910,7 +3910,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlInsertString" }, "@sl-slua/global/llcompat.InstantMessage": { - "documentation": "Sends an instant message containing message to the user identified by their key.", + "documentation": "Sends an instant message containing msg to the agent identified by their key.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlInstantMessage" }, "@sl-slua/global/llcompat.IntegerToBase64": { @@ -4306,11 +4306,11 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlRefreshPrimURL" }, "@sl-slua/global/llcompat.RegionSay": { - "documentation": "Broadcasts the message msg on channel to the entire region (heard by any script listening on that channel; channel 0 is not permitted).", + "documentation": "Broadcasts the message msg to all scripts listening on channel Channel within the region. PUBLIC_CHANNEL (0) cannot be used, so, only scripts can receive the message.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlRegionSay" }, "@sl-slua/global/llcompat.RegionSayTo": { - "documentation": "Sends the message msg on channel privately to the targeted avatar or object (if within the region). If target is an avatar and channel is non-zero, the message can also be heard by any attachments worn by the avatar.", + "documentation": "Sends the message msg on Channel privately to the targeted agent or object (if within the region). If target is an agent and channel is non-zero, the message can also be heard by any attachments worn by the avatar.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlRegionSayTo" }, "@sl-slua/global/llcompat.ReleaseCamera": { @@ -4510,7 +4510,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlSameGroup" }, "@sl-slua/global/llcompat.Say": { - "documentation": "Says the text message msg on the specified channel. The message can be heard up to a 20m radius. Channels other than PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647) are not visible to avatars and can be used for script-to-script communication.", + "documentation": "Broadcasts the message msg to all scripts or agents listening on channel within llGetEnv(\"chat_range\"), which is 20m on most regions. Agents listen on PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647). All other channels are for script-to-script communication.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlSay" }, "@sl-slua/global/llcompat.ScaleByFactor": { @@ -4810,7 +4810,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlSetVelocity" }, "@sl-slua/global/llcompat.Shout": { - "documentation": "Shouts the text message msg on the specified channel. The message can be heard up to a 100m radius. All channels other than PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647) are not sent to avatars and are used to communicate with scripts.", + "documentation": "Broadcasts the message msg to all scripts or agents listening on channel within llGetEnv(\"shout_range\"), which is 100m on most regions. Agents listen on PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647). All other channels are for script-to-script communication.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlShout" }, "@sl-slua/global/llcompat.SignRSA": { @@ -4918,7 +4918,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlTargetRemove" }, "@sl-slua/global/llcompat.TargetedEmail": { - "documentation": "Sends an email containing subject and message to the target (which can designate the owner or creator of the object).", + "documentation": "Sends an email to with the given subject subject and body msg to the target (which can designate the owner or creator of the object). The email will be sent from `{ll.GetKey()}@lsl.secondlife.com`.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlTargetedEmail" }, "@sl-slua/global/llcompat.TeleportAgent": { @@ -4934,7 +4934,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlTeleportAgentHome" }, "@sl-slua/global/llcompat.TextBox": { - "documentation": "Opens an input text box dialog displaying message to the avatar. Submitting text chats the input string on channel as if said by the avatar.", + "documentation": "Opens an input text box dialog displaying msg to the agent. Submitting text chats the input string on channel as if said by the agent. The chat originates at the object's position, but uses the agent's name and UUID, so it can be heard as long as the agent is still in the region.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlTextBox" }, "@sl-slua/global/llcompat.ToLower": { @@ -5006,7 +5006,7 @@ "learn_more_link": "https://wiki.secondlife.com/wiki/LlWater" }, "@sl-slua/global/llcompat.Whisper": { - "documentation": "Whispers the text message msg on the specified channel. The message can be heard up to a 10m radius. All channels other than PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647) are not sent to avatars and are used to communicate with scripts.", + "documentation": "Broadcasts the message msg to all scripts or agents listening on channel within llGetEnv(\"whisper_range\"), which is 10m on most regions. Agents listen on PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647). All other channels are for script-to-script communication.", "learn_more_link": "https://wiki.secondlife.com/wiki/LlWhisper" }, "@sl-slua/global/llcompat.Wind": { diff --git a/generated/secondlife_selene.yml b/generated/secondlife_selene.yml index 90b14f1b..18be7a52 100644 --- a/generated/secondlife_selene.yml +++ b/generated/secondlife_selene.yml @@ -4959,7 +4959,9 @@ globals: print: args: - type: '...' - description: Prints all arguments to standard output using Tab as a separator. + description: Sends all arguments as text privately to the object owner, separated + by 4 spaces. The owner must be currently in the same region for the message + to be received. rawequal: args: - type: any @@ -6875,9 +6877,10 @@ globals: - type: string - type: table - type: number - description: Shows a dialog box on the screen of the avatar specified by avatar, - displaying message along with up to 12 choice buttons. Clicking a button chats - its label on channel. + description: Shows a dialog box on the screen of the specified agent, displaying + msg along with up to 12 choice buttons. Clicking a button chats its label on + channel. The chat originates at the object's position, but uses the agent's + name and UUID, so it can be heard as long as the agent is still in the region. ll.Die: args: [] description: Deletes the entire object containing the script (the object does @@ -6910,7 +6913,9 @@ globals: - type: string - type: string - type: string - description: Sends an email to address with subject and message. + description: Sends an email with the given destination address, subject, and body + msg. The email will be sent from `{ll.GetKey()}@lsl.secondlife.com`. This can + be used for script communication; see llGetNextEmail() ll.EscapeURL: args: - type: string @@ -7422,8 +7427,13 @@ globals: args: - type: string - type: string - description: Requests the next queued email matching the specified sender address - and subject filters via the email event. + description: 'Requests the next queued email via the email event. Emails must + + 1. Be sent to `{ll.GetKey()}@lsl.secondlife.com` + + 2. Be sent from the specified sender Address (or any address if blank) + + 3. Have the specified subject Subject (or any subject if blank)' ll.GetNotecardLine: args: - type: string @@ -7988,8 +7998,8 @@ globals: - type: display: uuid - type: string - description: Sends an instant message containing message to the user identified - by their key. + description: Sends an instant message containing msg to the agent identified by + their key. ll.IntegerToBase64: args: - type: number @@ -8809,16 +8819,17 @@ globals: args: - type: number - type: string - description: Broadcasts the message msg on channel to the entire region (heard - by any script listening on that channel; channel 0 is not permitted). + description: Broadcasts the message msg to all scripts listening on channel Channel + within the region. PUBLIC_CHANNEL (0) cannot be used, so, only scripts can receive + the message. ll.RegionSayTo: args: - type: display: uuid - type: number - type: string - description: Sends the message msg on channel privately to the targeted avatar - or object (if within the region). If target is an avatar and channel is non-zero, + description: Sends the message msg on Channel privately to the targeted agent + or object (if within the region). If target is an agent and channel is non-zero, the message can also be heard by any attachments worn by the avatar. ll.ReleaseCamera: deprecated: @@ -9174,10 +9185,10 @@ globals: args: - type: number - type: string - description: Says the text message msg on the specified channel. The message can - be heard up to a 20m radius. Channels other than PUBLIC_CHANNEL (0) and DEBUG_CHANNEL - (2147483647) are not visible to avatars and can be used for script-to-script - communication. + description: Broadcasts the message msg to all scripts or agents listening on + channel within llGetEnv("chat_range"), which is 20m on most regions. Agents + listen on PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647). All other channels + are for script-to-script communication. ll.ScaleByFactor: args: - type: number @@ -9693,10 +9704,10 @@ globals: args: - type: number - type: string - description: Shouts the text message msg on the specified channel. The message - can be heard up to a 100m radius. All channels other than PUBLIC_CHANNEL (0) - and DEBUG_CHANNEL (2147483647) are not sent to avatars and are used to communicate - with scripts. + description: Broadcasts the message msg to all scripts or agents listening on + channel within llGetEnv("shout_range"), which is 100m on most regions. Agents + listen on PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647). All other channels + are for script-to-script communication. ll.SignRSA: args: - type: string @@ -9896,8 +9907,9 @@ globals: - type: number - type: string - type: string - description: Sends an email containing subject and message to the target (which - can designate the owner or creator of the object). + description: Sends an email to with the given subject subject and body msg to + the target (which can designate the owner or creator of the object). The email + will be sent from `{ll.GetKey()}@lsl.secondlife.com`. ll.TeleportAgent: args: - type: @@ -9937,8 +9949,10 @@ globals: display: uuid - type: string - type: number - description: Opens an input text box dialog displaying message to the avatar. - Submitting text chats the input string on channel as if said by the avatar. + description: Opens an input text box dialog displaying msg to the agent. Submitting + text chats the input string on channel as if said by the agent. The chat originates + at the object's position, but uses the agent's name and UUID, so it can be heard + as long as the agent is still in the region. ll.ToLower: args: - type: string @@ -10083,10 +10097,10 @@ globals: args: - type: number - type: string - description: Whispers the text message msg on the specified channel. The message - can be heard up to a 10m radius. All channels other than PUBLIC_CHANNEL (0) - and DEBUG_CHANNEL (2147483647) are not sent to avatars and are used to communicate - with scripts. + description: Broadcasts the message msg to all scripts or agents listening on + channel within llGetEnv("whisper_range"), which is 10m on most regions. Agents + listen on PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647). All other channels + are for script-to-script communication. ll.Wind: args: - type: @@ -10834,18 +10848,20 @@ globals: index. llcompat.Dialog: deprecated: - message: Shows a dialog box on the screen of the avatar specified by avatar, - displaying message along with up to 12 choice buttons. Clicking a button chats - its label on channel. + message: Shows a dialog box on the screen of the specified agent, displaying + msg along with up to 12 choice buttons. Clicking a button chats its label + on channel. The chat originates at the object's position, but uses the agent's + name and UUID, so it can be heard as long as the agent is still in the region. args: - type: display: uuid - type: string - type: table - type: number - description: Shows a dialog box on the screen of the avatar specified by avatar, - displaying message along with up to 12 choice buttons. Clicking a button chats - its label on channel. + description: Shows a dialog box on the screen of the specified agent, displaying + msg along with up to 12 choice buttons. Clicking a button chats its label on + channel. The chat originates at the object's position, but uses the agent's + name and UUID, so it can be heard as long as the agent is still in the region. llcompat.Die: deprecated: message: Deletes the entire object containing the script (the object does not @@ -10888,12 +10904,16 @@ globals: owner (group or resident). llcompat.Email: deprecated: - message: Sends an email to address with subject and message. + message: Sends an email with the given destination address, subject, and body + msg. The email will be sent from `{ll.GetKey()}@lsl.secondlife.com`. This + can be used for script communication; see llGetNextEmail() args: - type: string - type: string - type: string - description: Sends an email to address with subject and message. + description: Sends an email with the given destination address, subject, and body + msg. The email will be sent from `{ll.GetKey()}@lsl.secondlife.com`. This can + be used for script communication; see llGetNextEmail() llcompat.EscapeURL: deprecated: message: Returns a string representing the escaped/encoded version of url, replacing @@ -11645,13 +11665,23 @@ globals: if no custom parcel environment is set. llcompat.GetNextEmail: deprecated: - message: Requests the next queued email matching the specified sender address - and subject filters via the email event. + message: 'Requests the next queued email via the email event. Emails must + + 1. Be sent to `{ll.GetKey()}@lsl.secondlife.com` + + 2. Be sent from the specified sender Address (or any address if blank) + + 3. Have the specified subject Subject (or any subject if blank)' args: - type: string - type: string - description: Requests the next queued email matching the specified sender address - and subject filters via the email event. + description: 'Requests the next queued email via the email event. Emails must + + 1. Be sent to `{ll.GetKey()}@lsl.secondlife.com` + + 2. Be sent from the specified sender Address (or any address if blank) + + 3. Have the specified subject Subject (or any subject if blank)' llcompat.GetNotecardLine: deprecated: message: Asynchronously requests the line index line of the notecard name from @@ -12504,14 +12534,14 @@ globals: at the zero-based index pos. Note that this operation does not modify dst itself. llcompat.InstantMessage: deprecated: - message: Sends an instant message containing message to the user identified - by their key. + message: Sends an instant message containing msg to the agent identified by + their key. args: - type: display: uuid - type: string - description: Sends an instant message containing message to the user identified - by their key. + description: Sends an instant message containing msg to the agent identified by + their key. llcompat.IntegerToBase64: deprecated: message: Returns an 8-character Base64 string representing the big-endian encoded @@ -13561,25 +13591,27 @@ globals: prim's faces (currently non-functional). llcompat.RegionSay: deprecated: - message: Broadcasts the message msg on channel to the entire region (heard by - any script listening on that channel; channel 0 is not permitted). + message: Broadcasts the message msg to all scripts listening on channel Channel + within the region. PUBLIC_CHANNEL (0) cannot be used, so, only scripts can + receive the message. args: - type: number - type: string - description: Broadcasts the message msg on channel to the entire region (heard - by any script listening on that channel; channel 0 is not permitted). + description: Broadcasts the message msg to all scripts listening on channel Channel + within the region. PUBLIC_CHANNEL (0) cannot be used, so, only scripts can receive + the message. llcompat.RegionSayTo: deprecated: - message: Sends the message msg on channel privately to the targeted avatar or - object (if within the region). If target is an avatar and channel is non-zero, + message: Sends the message msg on Channel privately to the targeted agent or + object (if within the region). If target is an agent and channel is non-zero, the message can also be heard by any attachments worn by the avatar. args: - type: display: uuid - type: number - type: string - description: Sends the message msg on channel privately to the targeted avatar - or object (if within the region). If target is an avatar and channel is non-zero, + description: Sends the message msg on Channel privately to the targeted agent + or object (if within the region). If target is an agent and channel is non-zero, the message can also be heard by any attachments worn by the avatar. llcompat.ReleaseCamera: deprecated: @@ -14070,17 +14102,17 @@ globals: script; returns FALSE otherwise. llcompat.Say: deprecated: - message: Says the text message msg on the specified channel. The message can - be heard up to a 20m radius. Channels other than PUBLIC_CHANNEL (0) and DEBUG_CHANNEL - (2147483647) are not visible to avatars and can be used for script-to-script - communication. + message: Broadcasts the message msg to all scripts or agents listening on channel + within llGetEnv("chat_range"), which is 20m on most regions. Agents listen + on PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647). All other channels are + for script-to-script communication. args: - type: number - type: string - description: Says the text message msg on the specified channel. The message can - be heard up to a 20m radius. Channels other than PUBLIC_CHANNEL (0) and DEBUG_CHANNEL - (2147483647) are not visible to avatars and can be used for script-to-script - communication. + description: Broadcasts the message msg to all scripts or agents listening on + channel within llGetEnv("chat_range"), which is 20m on most regions. Agents + listen on PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647). All other channels + are for script-to-script communication. llcompat.ScaleByFactor: deprecated: message: Attempts to uniformly resize the entire object by scaling_factor, maintaining @@ -14836,17 +14868,17 @@ globals: region directional vector. Has no effect on non-physical objects. llcompat.Shout: deprecated: - message: Shouts the text message msg on the specified channel. The message can - be heard up to a 100m radius. All channels other than PUBLIC_CHANNEL (0) and - DEBUG_CHANNEL (2147483647) are not sent to avatars and are used to communicate - with scripts. + message: Broadcasts the message msg to all scripts or agents listening on channel + within llGetEnv("shout_range"), which is 100m on most regions. Agents listen + on PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647). All other channels are + for script-to-script communication. args: - type: number - type: string - description: Shouts the text message msg on the specified channel. The message - can be heard up to a 100m radius. All channels other than PUBLIC_CHANNEL (0) - and DEBUG_CHANNEL (2147483647) are not sent to avatars and are used to communicate - with scripts. + description: Broadcasts the message msg to all scripts or agents listening on + channel within llGetEnv("shout_range"), which is 100m on most regions. Agents + listen on PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647). All other channels + are for script-to-script communication. llcompat.SignRSA: deprecated: message: Returns the Base64-encoded RSA signature of msg using the PEM-formatted @@ -15095,14 +15127,16 @@ globals: with llTarget. llcompat.TargetedEmail: deprecated: - message: Sends an email containing subject and message to the target (which - can designate the owner or creator of the object). + message: Sends an email to with the given subject subject and body msg to the + target (which can designate the owner or creator of the object). The email + will be sent from `{ll.GetKey()}@lsl.secondlife.com`. args: - type: number - type: string - type: string - description: Sends an email containing subject and message to the target (which - can designate the owner or creator of the object). + description: Sends an email to with the given subject subject and body msg to + the target (which can designate the owner or creator of the object). The email + will be sent from `{ll.GetKey()}@lsl.secondlife.com`. llcompat.TeleportAgent: deprecated: message: Teleports the owning agent (who must grant PERMISSION_TELEPORT) to @@ -15152,15 +15186,19 @@ globals: a God Summons). llcompat.TextBox: deprecated: - message: Opens an input text box dialog displaying message to the avatar. Submitting - text chats the input string on channel as if said by the avatar. + message: Opens an input text box dialog displaying msg to the agent. Submitting + text chats the input string on channel as if said by the agent. The chat originates + at the object's position, but uses the agent's name and UUID, so it can be + heard as long as the agent is still in the region. args: - type: display: uuid - type: string - type: number - description: Opens an input text box dialog displaying message to the avatar. - Submitting text chats the input string on channel as if said by the avatar. + description: Opens an input text box dialog displaying msg to the agent. Submitting + text chats the input string on channel as if said by the agent. The chat originates + at the object's position, but uses the agent's name and UUID, so it can be heard + as long as the agent is still in the region. llcompat.ToLower: deprecated: message: Returns a copy of the string src converted entirely to lowercase. @@ -15349,17 +15387,17 @@ globals: prim's position offset by the vector offset. llcompat.Whisper: deprecated: - message: Whispers the text message msg on the specified channel. The message - can be heard up to a 10m radius. All channels other than PUBLIC_CHANNEL (0) - and DEBUG_CHANNEL (2147483647) are not sent to avatars and are used to communicate - with scripts. + message: Broadcasts the message msg to all scripts or agents listening on channel + within llGetEnv("whisper_range"), which is 10m on most regions. Agents listen + on PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647). All other channels are + for script-to-script communication. args: - type: number - type: string - description: Whispers the text message msg on the specified channel. The message - can be heard up to a 10m radius. All channels other than PUBLIC_CHANNEL (0) - and DEBUG_CHANNEL (2147483647) are not sent to avatars and are used to communicate - with scripts. + description: Broadcasts the message msg to all scripts or agents listening on + channel within llGetEnv("whisper_range"), which is 10m on most regions. Agents + listen on PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647). All other channels + are for script-to-script communication. llcompat.Wind: deprecated: message: Returns a vector representing the wind velocity at the prim's position @@ -15917,8 +15955,9 @@ structs: email: property: override-fields type: function - description: Triggered when an email sent to this script's address arrives. - num_left indicates the number of pending emails remaining in the queue. + description: Receive an email requested by llGetNextEmail(). NumberRemaining + indicates the number of emails remaining in the queue for llGetNextEmail() + to retrieve. experience_permissions: property: override-fields type: function @@ -15983,7 +16022,7 @@ structs: type: function description: Triggered when a chat message matching active llListen filters is received on channel. Passes the sender's name and UUID key id, along with - the spoken message string. + the spoken string msg. money: property: override-fields type: function diff --git a/lsl_definitions.yaml b/lsl_definitions.yaml index 96c46958..7a45425d 100644 --- a/lsl_definitions.yaml +++ b/lsl_definitions.yaml @@ -6786,7 +6786,7 @@ events: email: arguments: - time: - tooltip: Timestamp of when the email was received. + tooltip: Timestamp of when the email was received, in (string)llGetUnixTime() format. type: string - address: tooltip: Email address of the sender. @@ -6794,16 +6794,16 @@ events: - subject: tooltip: Subject of the email. type: string - - message: + - msg: tooltip: Body text of the email. type: string - num_left: - tooltip: Number of pending emails still waiting in the queue. + tooltip: Number of emails still waiting in the queue. type: integer - tooltip: Triggered when an email sent to this script's address arrives. num_left - indicates the number of pending emails remaining in the queue. + tooltip: Receive an email requested by llGetNextEmail(). NumberRemaining + indicates the number of emails remaining in the queue for llGetNextEmail() to retrieve. categories: - - avatar_communication + - script_communication experience_permissions: arguments: - agent_id: @@ -6975,17 +6975,17 @@ events: tooltip: Chat channel where the message appeared. type: integer - name: - tooltip: Name of the sending prim or the legacy name of the sending avatar. + tooltip: Name of the sending prim or the legacy name of the sending agent. type: string - id: - tooltip: UUID of the sending avatar or prim. + tooltip: UUID of the sending agent or prim. type: key - - message: + - msg: tooltip: Spoken text string. type: string tooltip: Triggered when a chat message matching active llListen filters is received on channel. Passes the sender's name and UUID key id, along with - the spoken message string. + the spoken string msg. categories: - avatar_communication - chat @@ -8471,10 +8471,10 @@ functions: - detected llDialog: arguments: - - avatar: - tooltip: UUID of the avatar in the same region. + - agent: + tooltip: UUID of the agent in the same region. type: key - - message: + - msg: tooltip: Text message to display in the dialog box. type: string - buttons: @@ -8482,16 +8482,18 @@ functions: type: list slua-type: "{string}" - channel: - tooltip: Output chat channel (any integer value) where button clicks are + tooltip: Output chat channel (any 32-bit signed integer value) where button clicks are chatted. type: integer energy: 10.0 func-id: 247 return: void sleep: 1.0 - tooltip: Shows a dialog box on the screen of the avatar specified by avatar, - displaying message along with up to 12 choice buttons. Clicking a button + tooltip: Shows a dialog box on the screen of the specified agent, + displaying msg along with up to 12 choice buttons. Clicking a button chats its label on channel. + The chat originates at the object's position, but uses the agent's name and UUID, + so it can be heard as long as the agent is still in the region. categories: - avatar_communication - chat @@ -8566,16 +8568,19 @@ functions: - subject: tooltip: Subject of the email. type: string - - message: + - msg: tooltip: Message body of the email. type: string energy: 10.0 func-id: 119 return: void sleep: 20.0 - tooltip: Sends an email to address with subject and message. + tooltip: Sends an email with the given destination address, subject, and body msg. + The email will be sent from `{ll.GetKey()}@lsl.secondlife.com`. + This can be used for script communication; see llGetNextEmail() categories: - avatar_communication + - script_communication llEscapeURL: arguments: - url: @@ -9791,17 +9796,20 @@ functions: llGetNextEmail: arguments: - address: - tooltip: Sender email address filter. + tooltip: Sender email address filter, or "" for any address. type: string - subject: - tooltip: Email subject filter. + tooltip: Email subject filter, or "" for any subject. type: string energy: 10.0 func-id: 120 return: void sleep: 0.0 - tooltip: Requests the next queued email matching the specified sender address - and subject filters via the email event. + tooltip: |- + Requests the next queued email via the email event. Emails must + 1. Be sent to `{ll.GetKey()}@lsl.secondlife.com` + 2. Be sent from the specified sender Address (or any address if blank) + 3. Have the specified subject Subject (or any subject if blank) categories: - script_communication llGetNotecardLine: @@ -11129,17 +11137,17 @@ functions: - string llInstantMessage: arguments: - - user: - tooltip: UUID of the destination user. + - agent: + tooltip: UUID of the destination agent. type: key - - message: + - msg: tooltip: Text message string to send. type: string energy: 10.0 func-id: 118 return: void sleep: 2.0 - tooltip: Sends an instant message containing message to the user identified by + tooltip: Sends an instant message containing msg to the agent identified by their key. categories: - avatar_communication @@ -12240,15 +12248,15 @@ functions: llListen: arguments: - channel: - tooltip: Input chat channel to listen on (any integer from -2147483648 to - 2147483647). + tooltip: Chat channel (any 32-bit signed integer value) to listen on. + Exact range is -2147483648 to 2147483647. type: integer - name: - tooltip: Specific prim name or avatar legacy name to filter by (or empty + tooltip: Specific prim name or agent legacy name to filter by (or empty string for no filter). type: string - id: - tooltip: Specific avatar or prim UUID to filter by (or NULL_KEY for no + tooltip: Specific agent or prim UUID to filter by (or NULL_KEY for no filter). type: key - msg: @@ -12875,7 +12883,7 @@ functions: llOwnerSay: arguments: - msg: - tooltip: Text message string to send. + tooltip: Text message string to send to the object owner. type: string slua-deprecated: use: "print" @@ -13202,7 +13210,7 @@ functions: llRegionSay: arguments: - channel: - tooltip: Output chat channel to broadcast on (must be non-zero). + tooltip: Chat channel (any 32-bit signed integer value except zero) to chat the message on. type: integer - msg: tooltip: Text message string to broadcast. @@ -13211,18 +13219,18 @@ functions: func-id: 331 return: void sleep: 0.0 - tooltip: Broadcasts the message msg on channel to the entire region (heard by - any script listening on that channel; channel 0 is not permitted). + tooltip: Broadcasts the message msg to all scripts listening on channel Channel + within the region. PUBLIC_CHANNEL (0) cannot be used, so, only scripts can receive the message. categories: - chat - script_communication llRegionSayTo: arguments: - target: - tooltip: UUID of the destination avatar or prim in the same region. + tooltip: UUID of the target agent or prim in the same region. type: key - channel: - tooltip: Output chat channel (any integer value). + tooltip: Chat channel (any 32-bit signed integer value) to chat the message on. type: integer - msg: tooltip: Text message string to send. @@ -13231,8 +13239,8 @@ functions: func-id: 364 return: void sleep: 0.0 - tooltip: Sends the message msg on channel privately to the targeted avatar or - object (if within the region). If target is an avatar and channel is + tooltip: Sends the message msg on Channel privately to the targeted agent or + object (if within the region). If target is an agent and channel is non-zero, the message can also be heard by any attachments worn by the avatar. categories: @@ -14129,19 +14137,19 @@ functions: llSay: arguments: - channel: - tooltip: Integer chat channel to transmit the message on. + tooltip: Chat channel (any 32-bit signed integer value) to chat the message on. type: integer - msg: - tooltip: Text message string to transmit. + tooltip: Text message string to broadcast. type: string energy: 10.0 func-id: 23 return: void sleep: 0.0 - tooltip: Says the text message msg on the specified channel. The message can be - heard up to a 20m radius. Channels other than PUBLIC_CHANNEL (0) and - DEBUG_CHANNEL (2147483647) are not visible to avatars and can be used for - script-to-script communication. + tooltip: Broadcasts the message msg to all scripts or agents listening on channel + within llGetEnv("chat_range"), which is 20m on most regions. + Agents listen on PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647). + All other channels are for script-to-script communication. categories: - avatar_communication - chat @@ -15553,19 +15561,19 @@ functions: llShout: arguments: - channel: - tooltip: Integer chat channel to shout the message on. + tooltip: Chat channel (any 32-bit signed integer value) to shout the message on. type: integer - msg: - tooltip: Text message string to transmit. + tooltip: Text message string to broadcast. type: string energy: 10.0 func-id: 24 return: void sleep: 0.0 - tooltip: Shouts the text message msg on the specified channel. The message can - be heard up to a 100m radius. All channels other than PUBLIC_CHANNEL (0) - and DEBUG_CHANNEL (2147483647) are not sent to avatars and are used to - communicate with scripts. + tooltip: Broadcasts the message msg to all scripts or agents listening on channel + within llGetEnv("shout_range"), which is 100m on most regions. + Agents listen on PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647). + All other channels are for script-to-script communication. categories: - avatar_communication - chat @@ -16046,15 +16054,16 @@ functions: - subject: tooltip: Subject of the email. type: string - - message: + - msg: tooltip: Email message body. type: string energy: 10.0 func-id: 750 return: void sleep: 20.0 - tooltip: Sends an email containing subject and message to the target (which can - designate the owner or creator of the object). + tooltip: Sends an email to with the given subject subject and body msg + to the target (which can designate the owner or creator of the object). + The email will be sent from `{ll.GetKey()}@lsl.secondlife.com`. categories: - avatar_communication llTeleportAgent: @@ -16136,24 +16145,25 @@ functions: - teleport llTextBox: arguments: - - avatar: - tooltip: UUID of the avatar in the same region. + - agent: + tooltip: UUID of the agent in the same region. type: key - - message: + - msg: tooltip: Text message to display in the text box. type: string - channel: - tooltip: Output chat channel (any integer value) where the input text is - chatted. + tooltip: Output chat channel (any 32-bit signed integer value) where + the input text is chatted. type: integer energy: 10.0 func-id: 335 mono-sleep: 0.0 return: void sleep: 1.0 - tooltip: Opens an input text box dialog displaying message to the avatar. - Submitting text chats the input string on channel as if said by the - avatar. + tooltip: Opens an input text box dialog displaying msg to the agent. + Submitting text chats the input string on channel as if said by the agent. + The chat originates at the object's position, but uses the agent's name and UUID, + so it can be heard as long as the agent is still in the region. categories: - avatar_communication - chat @@ -16487,19 +16497,19 @@ functions: llWhisper: arguments: - channel: - tooltip: Integer chat channel to whisper the message on. + tooltip: Chat channel (any 32-bit signed integer value) to whisper the message on. type: integer - msg: - tooltip: Text message string to transmit. + tooltip: Text message string to broadcast. type: string energy: 10.0 func-id: 22 return: void sleep: 0.0 - tooltip: Whispers the text message msg on the specified channel. The message can - be heard up to a 10m radius. All channels other than PUBLIC_CHANNEL (0) - and DEBUG_CHANNEL (2147483647) are not sent to avatars and are used to - communicate with scripts. + tooltip: Broadcasts the message msg to all scripts or agents listening on channel + within llGetEnv("whisper_range"), which is 10m on most regions. + Agents listen on PUBLIC_CHANNEL (0) and DEBUG_CHANNEL (2147483647). + All other channels are for script-to-script communication. categories: - avatar_communication - chat diff --git a/slua_definitions.yaml b/slua_definitions.yaml index a0938889..05ae6c56 100644 --- a/slua_definitions.yaml +++ b/slua_definitions.yaml @@ -489,11 +489,13 @@ functions: type: A... return-type: (boolean, R...) - name: print - comment: Prints all arguments to standard output using Tab as a separator. + comment: Sends all arguments as text privately to the object owner, + separated by 4 spaces. The owner + must be currently in the same region for the message to be received. type-parameters: [T...] parameters: - name: ... - comment: Arguments to print to standard output. + comment: Arguments to send as text to the object owner. type: T... return-type: () - name: rawequal