Difference between revisions of "LlRegionSay"

From Second Life Wiki
Jump to navigation Jump to search
m
m
Line 1: Line 1:
{{LSL_Function/chat|channel|msg|np=*}}{{LSL_Function
{{LSL_Function
|inject-2={{LSL_Function/chat|channel|msg|np=*}}
|func_id=331
|func_id=331
|func_sleep=0.0
|func_sleep=0.0
Line 6: Line 7:
|p1_type=integer|p1_name=channel|p1_desc
|p1_type=integer|p1_name=channel|p1_desc
|p2_type=string|p2_name=msg|p2_desc
|p2_type=string|p2_name=msg|p2_desc
|func_desc=Says the string '''msg''' on channel number '''channel''' that can be heard anywhere in the [[region]] by a script [[listen|listening]] on '''channel'''.
|func_desc=Says the string {{LSLP|msg}} on channel number {{LSLP|channel}} that can be heard anywhere in the [[region]] by a script [[listen|listening]] on {{LSLP|channel}}.
|func_footnote=Regardless of where the prim is, the message will not travel over region borders.
|func_footnote=Regardless of where the prim is, the message will not travel over region borders.
|return_text
|return_text
Line 12: Line 13:
|constants
|constants
|caveats=*This function cannot transmit on the {{#var:PUBLIC_CHANNEL}}, this is a design feature and not a bug.
|caveats=*This function cannot transmit on the {{#var:PUBLIC_CHANNEL}}, this is a design feature and not a bug.
*If '''msg''' is longer than 1023 bytes it is truncated to 1023 bytes.
*If {{LSLP|msg}} is longer than 1023 bytes it is truncated to 1023 bytes.
*A prim can '''not''' hear itself, this to prevent problems with recursion. It can however hear other prims within the same object.
*A prim can '''not''' hear itself, this to prevent problems with recursion. It can however hear other prims within the same object.
|examples=<lsl>default
|examples=<lsl>default
Line 42: Line 43:
Negative channels are popular for script communications because the client is unable to chat directly on those channels ("/-xxxx message" won't chat "message" on channel "-xxxx", it will chat "/-xxxx message" on channel zero). The only way to do so prior to [[llTextBox]] was to use [[llDialog]] which was limited to 24 bytes.
Negative channels are popular for script communications because the client is unable to chat directly on those channels ("/-xxxx message" won't chat "message" on channel "-xxxx", it will chat "/-xxxx message" on channel zero). The only way to do so prior to [[llTextBox]] was to use [[llDialog]] which was limited to 24 bytes.


If {{#var:DEBUG_CHANNEL}} is used as '''channel''', the script will say '''msg''' to the Script Warning/Error window.  
If {{#var:DEBUG_CHANNEL}} is used as {{LSLP|channel}}, the script will say {{LSLP|msg}} to the Script Warning/Error window.  


* As of 1.18.3, using llRegionSay on the {{#var:DEBUG_CHANNEL}} will wrap around and display on channel 0, with a range of 100m.
* As of 1.18.3, using llRegionSay on the {{#var:DEBUG_CHANNEL}} will wrap around and display on channel 0, with a range of 100m.

Revision as of 19:56, 10 June 2012

Summary

Function: llRegionSay( integer channel, string msg );

Says the string msg on channel number channel that can be heard anywhere in the region by a script listening on channel.

• integer channel output chat channel, any integer value except zero
• string msg message to be transmitted

Regardless of where the prim is, the message will not travel over region borders.

Channel Constant Description
DEBUG_CHANNEL 0x7FFFFFFF Chat channel reserved for script debugging and error messages, broadcasts to all nearby users.

Caveats

  • Messages sent on DEBUG_CHANNEL are throttled to a rate of <200/10sec, per region, per owner/user.
    • Once the rate is exceeded, all following messages on DEBUG_CHANNEL will be dropped until the send rate is again below 200/10sec for the previous 10 sec. Dropped messages, despite being dropped still count against the limit.
  • This function cannot transmit on the PUBLIC_CHANNEL, this is a design feature and not a bug.
  • If msg is longer than 1023 bytes it is truncated to 1023 bytes.
  • A prim can not hear itself, this to prevent problems with recursion. It can however hear other prims within the same object.
All Issues ~ Search JIRA for related Bugs

Examples

<lsl>default {

   state_entry()
   {
       llRegionSay(25,"This is an incredibly useless program." );
   }

}</lsl>

To avoid making your object spam its neighborhood, use llOwnerSay or llInstantMessage.

Notes

If one object 'says' something to another object (e.g., a button that, when touched, turns on a lamp), it is a good idea to use a very negative channel, e.g., <lsl> llRegionSay(-5243212,"turn on");</lsl> Negative channels are popular for script communications because the client is unable to chat directly on those channels ("/-xxxx message" won't chat "message" on channel "-xxxx", it will chat "/-xxxx message" on channel zero). The only way to do so prior to llTextBox was to use llDialog which was limited to 24 bytes.

If DEBUG_CHANNEL is used as channel, the script will say msg to the Script Warning/Error window.

  • As of 1.18.3, using llRegionSay on the DEBUG_CHANNEL will wrap around and display on channel 0, with a range of 100m.

See Also

Events

•  listen

Functions

•  llListen
•  llRegionSayTo Sends chat directly to specified target within region
•  llOwnerSay Sends chat to the owner only
•  llWhisper Sends chat limited to 10 meters
•  llSay Sends chat limited to 20 meters
•  llShout Sends chat limited to 100 meters
•  llInstantMessage
•  llDialog
•  llTextBox

Deep Notes

History

  • Introduced with SL 1.16.0

Search JIRA for related Issues

Signature

function void llRegionSay( integer channel, string msg );