Difference between revisions of "LlTextBox"

From Second Life Wiki
Jump to: navigation, search
m
(MIssing flag param on STRING_TRIM.)
 
(47 intermediate revisions by 13 users not shown)
Line 1: Line 1:
{{LSL_Function/avatar|avatar|sim=*}}{{LSL_Function/chat|channel}}{{LSL_Function
+
{{LSL_Function
 +
|inject-2=
 +
{{LSL_Function/avatar|avatar|region=*}}
 +
{{LSL_Function/chat|channel|message|dialog=text box}}
 
|func_id=335|func_sleep=1.0|func_energy=10.0
 
|func_id=335|func_sleep=1.0|func_energy=10.0
 
|func=llTextBox
 
|func=llTextBox
|p1_type=key|p1_name=avatar|p1_desc
+
|p1_type=key|p1_name=avatar
|p2_type=string|p2_name=message|p2_desc=Text to display in the message box
+
|p2_type=string|p2_name=message
|p3_type=integer|p3_name=channel|p3_desc
+
|p3_type=integer|p3_name=channel
 
|return_type
 
|return_type
 
|return_text
 
|return_text
|func_desc=Shows a dialog box on '''avatar''''s screen with the text '''message'''. The dialog bog contains a text box for input, any text that is entered is [[llSay|said]] on '''channel''' when the "OK" button is clicked.
+
|func_desc=Shows a dialog box on {{LSLP|avatar}}'s screen with the text {{LSLP|message}}. It contains a text box for input, any text that is entered is [[llSay|said]] by {{LSLP|avatar}} on {{LSLP|channel}} when the "Submit" button is clicked.
 
|func_footnote
 
|func_footnote
|caveats
+
|caveats=* Not supported in official Linden Lab viewers prior to version 2.4, and some [[Third_Party_Viewer_Directory|TPVs]] may not support it. Unsupported viewers will display a dialog box with a single option of "!!llTextBox!!".
|examples
+
* There is no way by script to kill a text box.
 +
* There is no way for the script to detect if the user clicked the small "ignore" button (no chat is generated as a result of pressing this button).
 +
* If the listening prim is out of the 20 meter range of the sending prim when the "Submit" button is pressed, it will not be able to hear the response.
 +
** This limitation affects attachments too if the wearer moves more than 20 meters from where the listener is located.
 +
* The textbox input is limited to 250 bytes (characters). This can be a problem for larger text input; if the input can be over 250 characters, you will have to accept it through chat.
 +
 
 +
===message limits===
 +
*If it exceeds 7 (Viewer 3) or 8 (Viewer 1) lines a scroll bar will appear.
 +
*{{LSLP|message}} must be less than 512 bytes and not empty. Otherwise, it will shout an error on [[DEBUG_CHANNEL]]. One easy way to create an empty message is to use a line feed, as in <source lang="lsl2">llTextBox(avatar_key," \n",dialog_channel);</source>
 +
 
 +
|notes=
 +
Instead of mouse clicking: "Submit", you can use keyboard keys: press {{K|Tab}} and then {{K|Enter}}
 +
 
 +
|examples=
 +
<source lang="lsl2">
 +
integer  gListener;
 +
default
 +
{
 +
    touch_start(integer total_number)
 +
    {
 +
        // See 'discussion' page for more comments on choosing a channel and possible left-open listener
 +
        integer channel = -13572468;
 +
        // "" saves byte-code over NULL_KEY
 +
        gListener = llListen( channel, "", "", "");   
 +
        llTextBox(llDetectedKey(0), "Some info text for the top of the window...", channel);
 +
    }
 +
    listen(integer channel, string name, key id, string message)
 +
    {
 +
        llListenRemove(gListener);
 +
        llSay(0, "You wrote: " + message);
 +
    }
 +
}
 +
</source>
 +
If the user hits {{K|Enter}} before clicking the <code>"Submit"</code> button, there will be a final carriage return in the message. In the rare event that this could be a problem, it is easily removed:
 +
<source lang="lsl2">
 +
        message = llStringTrim(message,STRING_TRIM);
 +
</source>
 +
 
 
|spec
 
|spec
 
|constants
 
|constants
Line 25: Line 65:
 
{{LSL DefineRow||[[listen]]}}
 
{{LSL DefineRow||[[listen]]}}
 
|notes
 
|notes
|history=Introduced in {{SVN|568|rev=88085|branch=Release|ver=1.20.8|anchor=file33|date=Wednesday, 21 May 2008}}
+
|location=
 +
{{SourceLink/bitbucket|viewer-release|indra/llcommon/lllslconstants.h|line=189}}
 +
<cpp>// llTextBox() magic token string - yes this is a hack.  sue me.
 +
const std::string TEXTBOX_MAGIC_TOKEN = "!!llTextBox!!";</cpp>
 +
|history=Introduced in {{SVN|568|rev=88085|trunk=*|anchor=file33|date=Wednesday, 21 May 2008}}
 
|cat1=Dialog
 
|cat1=Dialog
 
|cat2=Chat
 
|cat2=Chat

Latest revision as of 14:42, 2 July 2018

Summary

Function: llTextBox( key avatar, string message, integer channel );

Shows a dialog box on avatar's screen with the text message. It contains a text box for input, any text that is entered is said by avatar on channel when the "Submit" button is clicked.

• key avatar avatar UUID that is in the same region
• string message message to be displayed in the text box
• integer channel output chat channel, any integer value
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

  • This function causes the script to sleep for 1.0 seconds.
  • Not supported in official Linden Lab viewers prior to version 2.4, and some TPVs may not support it. Unsupported viewers will display a dialog box with a single option of "!!llTextBox!!".
  • There is no way by script to kill a text box.
  • There is no way for the script to detect if the user clicked the small "ignore" button (no chat is generated as a result of pressing this button).
  • If the listening prim is out of the 20 meter range of the sending prim when the "Submit" button is pressed, it will not be able to hear the response.
    • This limitation affects attachments too if the wearer moves more than 20 meters from where the listener is located.
  • The textbox input is limited to 250 bytes (characters). This can be a problem for larger text input; if the input can be over 250 characters, you will have to accept it through chat.

message limits

  • If it exceeds 7 (Viewer 3) or 8 (Viewer 1) lines a scroll bar will appear.
  • message must be less than 512 bytes and not empty. Otherwise, it will shout an error on DEBUG_CHANNEL. One easy way to create an empty message is to use a line feed, as in
    llTextBox(avatar_key," \n",dialog_channel);
All Issues ~ Search JIRA for related Bugs

Examples

integer  gListener;
default
{
    touch_start(integer total_number)
    {
        // See 'discussion' page for more comments on choosing a channel and possible left-open listener
        integer channel = -13572468;
        // "" saves byte-code over NULL_KEY
        gListener = llListen( channel, "", "", "");     
        llTextBox(llDetectedKey(0), "Some info text for the top of the window...", channel);
    }
    listen(integer channel, string name, key id, string message)
    {
        llListenRemove(gListener);
        llSay(0, "You wrote: " + message);
    }
}

If the user hits Enter ↵ before clicking the "Submit" button, there will be a final carriage return in the message. In the rare event that this could be a problem, it is easily removed:

        message = llStringTrim(message,STRING_TRIM);

Notes

Instead of mouse clicking: "Submit", you can use keyboard keys: press Tab ⇆ and then Enter ↵

See Also

Events

•  listen

Functions

•  llDialog
•  llListen
•  llSay
•  llWhisper
•  llShout
•  llRegionSay

Deep Notes

History

Search JIRA for related Issues

Source

HG:viewer-release - indra/llcommon/lllslconstants.h <cpp>// llTextBox() magic token string - yes this is a hack. sue me. const std::string TEXTBOX_MAGIC_TOKEN = "!!llTextBox!!";</cpp>

Footnotes

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

Signature

function void llTextBox( key avatar, string message, integer channel );