Difference between revisions of "LlWhisper"

From Second Life Wiki
Jump to navigation Jump to search
m (Replaced old <LSL> block with <source lang="lsl2">)
 
(23 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{LSL_Function
{{LSL_Function
|inject-2={{LSL_Function/chat|channel|msg}}
|func_id=22
|func_id=22
|func_sleep=0.0
|func_sleep=0.0
Line 7: Line 8:
|p1_type=integer|p1_name=channel
|p1_type=integer|p1_name=channel
|p2_type=string|p2_name=msg
|p2_type=string|p2_name=msg
|func_desc=whispers the text supplied in string '''msg''' on channel supplied in integer '''channel'''.
|func_desc=Whispers the text supplied in string {{LSLP|msg}} on channel supplied in integer {{LSLP|channel}}.
|return_text
|return_text
|spec
|spec
|constants={{{!}} {{Prettytable}}
|constants
{{!}}-{{Hl2}}
|caveats=*Text can be a maximum of 1024 bytes. This can convey 1024 ASCII characters, or 512 UTF-8 characters such as á
! colspan="2" {{!}} Constant
*Whispers can only be heard within 10 meters of the speaking prim (rather than the root). This is contrary to how [[listen]]s work, where a message can only be heard by any prim in the object if and only if the root prim is capable of hearing it.
! Description
*A prim can '''not''' hear itself, this to prevent problems with recursion. It can however hear other prims within the same object.
{{!}}-
|examples=
{{!}}[[DEBUG_CHANNEL]]
If you prefer, you can make use of certain mnemonic constants such as [[PUBLIC_CHANNEL]] instead of channel 0 and [[DEBUG_CHANNEL]] instead of channel +2,147,483,647.
{{!}}{{LSL Hex|0x0}}
<source lang="lsl2">
{{!}}Chat channel reserved for debug and error messages from scripts
default
{{!}}-
{
{{!}}[[PUBLIC_CHANNEL]]
{{!}}{{LSL Hex|0x7FFFFFFF}}
{{!}}Chat channel that broadcasts to all nearby users
{{!}}}
|caveats=*Text can only be a maximum of 1024 bytes.
*Whispers can only be heard within 10 meters of the speaking object.
*A prim can '''not''' hear itself, to prevent problems with recursion.
|examples=<pre>
default {
     state_entry()
     state_entry()
     {
     {
         llWhisper(0,"This is an incredibly useless program." );
         llWhisper(0, "This is an incredibly useless program.");
     }
     }
}
}
</pre>
</source>
For communicating with the user or owner it is preferable to use [[llOwnerSay]] or [[llInstantMessage]] or [[llRegionSayTo]] as they won't spam other users.
|helpers
|helpers
|also_events=*{{LSLG|listen}}
|also_events={{LSL DefineRow||[[listen]]|}}
|also_functions=*{{LSLG|llSay}}
|also_functions=
*{{LSLG|llOwnerSay}}
{{LSL DefineRow||[[llListen]]|}}
*{{LSLG|llShout}}
{{LSL DefineRow||[[llOwnerSay]]|}}
*{{LSLG|llInstantMessage}}
{{LSL DefineRow||[[llRegionSay]]|Sends chat region wide}}
{{LSL DefineRow||[[llSay]]|Sends chat limited to 20 meters}}
{{LSL DefineRow||[[llShout]]|Sends chat limited to 100 meters}}
{{LSL DefineRow||[[llInstantMessage]]|}}
|also
|also
|notes
|notes
|haiku={{Haiku|The prims speak to me|hushed tones... a secret message?|Tell me your story.}}
|cat1=Communications
|cat1=Communications
|cat2=Chat
|cat2=Chat

Latest revision as of 10:53, 22 January 2015

Summary

Function: llWhisper( integer channel, string msg );
0.0 Forced Delay
10.0 Energy

Whispers the text supplied in string msg on channel supplied in integer channel.

• integer channel – output chat channel, any integer value
• string msg – message to be transmitted
Channel Constant Description
DEBUG_CHANNEL 0x7FFFFFFF Chat channel reserved for script debugging and error messages, broadcasts to all nearby users.
PUBLIC_CHANNEL 0x0 Chat channel that broadcasts to all nearby users. This channel is sometimes referred to as: open chat, local chat and public chat.

Caveats

  • Messages sent on channel zero[1] and DEBUG_CHANNEL are throttled to a rate of <200/10sec, per region, per owner/user.
    • Once the rate is exceeded, all following messages on channel zero or DEBUG_CHANNEL will be dropped until the send rate is again below 200/10sec for the previous 10 sec. Dropped messages, despite being dropped still count against the limit.
  • Text can be a maximum of 1024 bytes. This can convey 1024 ASCII characters, or 512 UTF-8 characters such as á
  • Whispers can only be heard within 10 meters of the speaking prim (rather than the root). This is contrary to how listens work, where a message can only be heard by any prim in the object if and only if the root prim is capable of hearing it.
  • A prim can not hear itself, this to prevent problems with recursion. It can however hear other prims within the same object.

Examples

If you prefer, you can make use of certain mnemonic constants such as PUBLIC_CHANNEL instead of channel 0 and DEBUG_CHANNEL instead of channel +2,147,483,647. 

default
{
    state_entry()
    {
        llWhisper(0, "This is an incredibly useless program.");
    }
}
For communicating with the user or owner it is preferable to use llOwnerSay or llInstantMessage or llRegionSayTo as they won't spam other users.

See Also

Events

•  listen

Functions

•  llListen
•  llOwnerSay
•  llRegionSay – Sends chat region wide
•  llSay – Sends chat limited to 20 meters
•  llShout – Sends chat limited to 100 meters
•  llInstantMessage

Deep Notes

Footnotes

  1. ^ Channel zero is also known as: PUBLIC_CHANNEL, open chat, local chat and public chat

Signature

function void llWhisper( integer channel, string msg );

Haiku

The prims speak to me
hushed tones... a secret message?
Tell me your story.

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