Second Life Wiki - User contributions [en]

MultiUser Dialog Handler

2014-04-27T23:21:32Z

SimonT Quinnell: /* The Script */

==Introduction==

I found that i was constantly rewriting a pile of dialog handling functions in my scrips so i decided to write a single dialog handler script. It needed to have the following features;

* Support multiple simultaneous menus from different users, scripts and prims.
* Support fixed top buttons that will persist on lists.
* Support fixed bottom buttons with include Back and Exit buttons.
* Handle item lists > 12 and automatically insert << and >> buttons to scroll through the lists.
* Handle timeouts and communicate timeout back to calling script.
* Handles truncation of the buttons and text to stop errors in llDialog

==Using The Script==

===Calling a Simple Menu===
In the script that is calling the menu I use a function something like this.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "FALSE"; //Navigation buttons not displayed
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "TopLeft~Top~TopRight~Left~Center~Right~BottomLeft~Bottom~BottomRight"; // The buttons, each button separated by a '~'.

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|TopLeft|| Top|| TopRight
|-
|Left|| Center || Right
|-
|BottomLeft|| Bottom || BottomRight
|}

===Calling a Simple Menu with Auto-Navigation Buttons===
In this case we now add navigation buttons to the bottom of the script. Back and Exit buttons are added to the bottom and if necessary >> and << buttons. In the script that is calling the menu I use a function something like this.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "TRUE"; //The display of the bottom navigation buttons is set to TRUE
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

This will display a menu that looks something like this.

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|-
| || Back || Exit
|}

===Calling a Complex Menu===
In the following case we will have 10 buttons that are going to be displayed. Because we will also display the bottom 3 buttons this will be spanned across 2 menus. We will also include 2 fixed buttons that always display at the top of the menu, PLUS each button has a unique descriptor that is displayed. Here is the menu call.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"
string menuNavigate = "TRUE";
string menuText = "Main text displayed.~text1~text2~text3~text4~text5~text6~text7~text8~text9~text10";
string menuButtons = "B1~B2~B3~B4~B5~B6~B7~B8~B9~B10";
string menuFixedButtons = "FIXED1~FIXED2"

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons+"|"+menuFixedButtons, id);
}
</lsl>

This will display the following 2 menus

Menu1
Main text displayed.
item1
item2
item3
item4
item5
item6
item7

{| border="1"
|FIXED1 || FIXED2 || B1
|-
|B2 || B3 || B4
|-
|B5 || B6 || B7
|-
| || Back || >>
|}

Menu2 (on clicking the >> button)
Main text displayed.
item8
item9
item10

{| border="1"
|FIXED1 || FIXED2 || B8
|-
| B9 || B10 ||
|-
| << || Back || Exit
|}

===Parsing the returning Menu information===

Note that if the user clicks on the << or >> buttons the calling script WILL NOT see any response. The correct menu is displayed. The calling script only receives a response when one of the buttons or Back/Exit are clicked. Clicking on a space button will cause the menu to redisplay.

The script that expects the response back from the menu has the following

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

default
{
link_message(integer intSenderNum, integer num, string message, key id)
{
if (num == LINK_MENU_RETURN)
{
list returnMenu = llParseString2List(message, ["|"], []);
string menuDescriptor = llList2String(returnMenu,0); // The idenfifying descriptor. I sometimes use the name of the script plus menu and parent menu name

if (menuDescriptor == "mymenu")
{ // Is this a response to "mymenu" from the dialog script?
string item = llList2String(returnMenu,1); // The actual button pushed

// id == the key of the menu user.
// The button pressed in the menu is 'item', so now do something with it
}
}
else if (num == LINK_MENU_TIMEOUT)
{
if (message == "mymenu")
{
// We received a timeout (don't worry the listens are all dealt with) so you might want to IM the menu user.
}
}
}
}
</lsl>

==The Script==
<lsl>
// ********************************************************************
//
// Menu Display Script
//
// Menu command format
// string = menuidentifier | display navigate? TRUE/FALSE | menuMaintitle~subtitle1~subtitle2~subtitle3 | button1~button2~button3 {| fixedbutton1~fixedbutton2~fixedbutton3 optional}
// key = menuuser key
//
// Return is in the format
// "menuidentifier | item"
//
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]
// menusActive [menuchannel, menuhandle, time, page]
//
// by SimonT Quinnell
//
// CHANGES
// 2010/10/14 - Timeout message now gets sent to the prim that called the menu, not LINK_THIS. Also includes menuidentifier
// 2010/11/29 - Fixed Bug in RemoveUser function. Thanks for Virtouse Lilienthal for pointing it out.
// 2010/11/29 - Tidied up a little and removed functions NewMenu and RemoveUser that are only called once
// 2014/04/28 - Clarified licence
//
// NOTE: This script is licenced using the Creative Commons Attribution-Share Alike 3.0 license
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

// Main Menu Details
string BACK = "<<";
string FOWARD = ">>";
list MENU_NAVIGATE_BUTTONS = [ " ", "Back", "Exit"];
float MENU_TIMEOUT_CHECK = 10.0;
integer MENU_TIMEOUT = 120;
integer MAX_TEXT = 510;

integer STRIDE_DESCRIPTION = 8;
integer STRIDE_ACTIVE = 4;
integer DEBUG = FALSE;

// ********************************************************************
// Variables
// ********************************************************************

list menusDescription;
list menusActive;

// ********************************************************************
// Functions - General
// ********************************************************************

debug(string debug)
{
if (DEBUG) llSay(DEBUG_CHANNEL,"DEBUG:"+llGetScriptName()+":"+debug+" : Free("+(string)llGetFreeMemory()+")");
}

integer string2Bool (string test)
{
if (test == "TRUE") return TRUE;
else return FALSE;
}

// ********************************************************************
// Functions - Menu Helpers
// ********************************************************************

integer NewChannel()
{ // generates unique channel number
integer channel;

do channel = -(llRound(llFrand(999999)) + 99999);
while (~llListFindList(menusDescription, [channel]));

return channel;
}

string CheckTitleLength(string title)
{
if (llStringLength(title) > MAX_TEXT) title = llGetSubString(title, 0, MAX_TEXT-1);

return title;
}

list FillMenu(list buttons)
{ //adds empty buttons until the list length is multiple of 3, to max of 12
integer i;
list listButtons;

for(i=0;i<llGetListLength(buttons);i++)
{
string name = llList2String(buttons,i);
if (llStringLength(name) > 24) name = llGetSubString(name, 0, 23);
listButtons = listButtons + [name];
}

while (llGetListLength(listButtons) != 3 && llGetListLength(listButtons) != 6 && llGetListLength(listButtons) != 9 && llGetListLength(listButtons) < 12)
{
listButtons = listButtons + [" "];
}

buttons = llList2List(listButtons, 9, 11);
buttons = buttons + llList2List(listButtons, 6, 8);
buttons = buttons + llList2List(listButtons, 3, 5);
buttons = buttons + llList2List(listButtons, 0, 2);

return buttons;
}

RemoveMenu(integer channel, integer echo)
{
integer index = llListFindList(menusDescription, [channel]);

if (index != -1)
{
key menuId = llList2Key(menusDescription, index+1);
string menuDetails = llList2String(menusDescription, index+2);
integer menuLink = llList2Integer(menusDescription, index+3);
menusDescription = llDeleteSubList(menusDescription, index, index + STRIDE_DESCRIPTION - 1);
RemoveListen(channel);

if (echo) llMessageLinked(menuLink, LINK_MENU_TIMEOUT, menuDetails, menuId);
}
}

RemoveListen(integer channel)
{
integer index = llListFindList(menusActive, [channel]);
if (index != -1)
{
llListenRemove(llList2Integer(menusActive, index + 1));
menusActive = llDeleteSubList(menusActive, index, index + STRIDE_ACTIVE - 1);
}
}

// ********************************************************************
// Functions - Menu Main
// ********************************************************************

DisplayMenu(key id, integer channel, integer page)
{
string menuTitle;
list menuSubTitles;
list menuButtonsAll;
list menuButtons;
list menuNavigateButtons;
list menuFixedButtons;

integer max = 12;

// Populate values
integer index = llListFindList(menusDescription, [channel]);
menuButtonsAll = llParseString2List(llList2String(menusDescription, index+6), ["~"], []);
if (llList2String(menusDescription, index+7) != "") menuFixedButtons = llParseString2List(llList2String(menusDescription, index+7), ["~"], []);

// Set up the menu buttons
if (llList2Integer(menusDescription, index+4)) menuNavigateButtons= MENU_NAVIGATE_BUTTONS;
else if (llGetListLength(menuButtonsAll) > (max-llGetListLength(menuFixedButtons))) menuNavigateButtons = [" ", " ", " "];

// FIXME: add sanity check for menu page

max = max - llGetListLength(menuFixedButtons) - llGetListLength(menuNavigateButtons);
integer start = page*max;
integer stop = (page+1)*max - 1;
menuButtons = FillMenu(menuFixedButtons + llList2List(menuButtonsAll, start, stop));

// Generate the title
list tempTitle = llParseString2List(llList2String(menusDescription, index+5), ["~"], []);
menuTitle = llList2String(tempTitle,0);
if (llGetListLength(tempTitle) > 1) menuSubTitles = llList2List(tempTitle, 1, -1);
if (llGetListLength(menuSubTitles) > 0)
{
integer i;
for(i=start;i<(stop+1);++i)
{
if (llList2String(menuSubTitles, i) != "") menuTitle += "\n"+llList2String(menuSubTitles, i);
}
}
menuTitle = CheckTitleLength(menuTitle);

// Add navigate buttons if necessary
if (page > 0) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [BACK], 0, 0);
if (llGetListLength(menuButtonsAll) > (page+1)*max) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [FOWARD], 2, 2);

// Set up listen and add the row details
integer menuHandle = llListen(channel, "", id, "");
menusActive = [channel, menuHandle, llGetUnixTime(), page] + menusActive;

llSetTimerEvent(MENU_TIMEOUT_CHECK);

// Display menu
llDialog(id, menuTitle, menuNavigateButtons + menuButtons, channel);
}

// ********************************************************************
// Event Handlers
// ********************************************************************

default
{
listen(integer channel, string name, key id, string message)
{
if (message == BACK)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)-1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == FOWARD)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)+1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == " ")
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3);
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else
{
integer index = llListFindList(menusDescription, [channel]);
llMessageLinked(llList2Integer(menusDescription, index+3), LINK_MENU_RETURN, llList2String(menusDescription, index+2)+"|"+message, id);
RemoveMenu(channel, FALSE);
}
}

link_message(integer senderNum, integer num, string message, key id)
{
if (num == LINK_MENU_DISPLAY)
{ // Setup New Menu
list temp = llParseString2List(message, ["|"], []);
integer channel = NewChannel();

if (llGetListLength(temp) > 2)
{
menusDescription = [channel, id, llList2String(temp, 0), senderNum, string2Bool(llList2String(temp, 1)), llList2String(temp, 2), llList2String(temp, 3), llList2String(temp, 4)] + menusDescription;

DisplayMenu(id, channel, 0);
}
else llSay (DEBUG_CHANNEL, "ERROR in "+llGetScriptName()+": Dialog Script. Incorrect menu format");
}
else if (num == LINK_MENU_CLOSE)
{ // Will remove all menus that have the user id.
integer index_id = llListFindList(menusDescription, [id]);

while (~index_id)
{
integer channel = llList2Integer(menusDescription, index_id-1);
RemoveMenu(channel, FALSE);

// Check for another menu by same user
index_id = llListFindList(menusDescription, [id]);
}
}
}

timer()
{ // Check through timers and close if necessary
integer i;
list toRemove;
integer currentTime = llGetUnixTime();
integer length = llGetListLength(menusActive);

for(i=0;i<length;i+=STRIDE_ACTIVE)
{
if (currentTime - llList2Integer(menusActive, i+2) > MENU_TIMEOUT) toRemove = [llList2Integer(menusActive, i)] + toRemove;
}

length = llGetListLength(toRemove);
if (length > 0)
{
for(i=0;i<length;i++)
{
RemoveMenu(llList2Integer(toRemove, i), TRUE);
}
}
}
}

</lsl>

==See also==
*[[ Script_Library | Script Library ]]
[[Category:LSL Library|Dialog Handler (MultiUser)]]

MultiUser Dialog Handler

2014-04-27T23:20:40Z

SimonT Quinnell: /* The Script */

==Introduction==

I found that i was constantly rewriting a pile of dialog handling functions in my scrips so i decided to write a single dialog handler script. It needed to have the following features;

* Support multiple simultaneous menus from different users, scripts and prims.
* Support fixed top buttons that will persist on lists.
* Support fixed bottom buttons with include Back and Exit buttons.
* Handle item lists > 12 and automatically insert << and >> buttons to scroll through the lists.
* Handle timeouts and communicate timeout back to calling script.
* Handles truncation of the buttons and text to stop errors in llDialog

==Using The Script==

===Calling a Simple Menu===
In the script that is calling the menu I use a function something like this.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "FALSE"; //Navigation buttons not displayed
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "TopLeft~Top~TopRight~Left~Center~Right~BottomLeft~Bottom~BottomRight"; // The buttons, each button separated by a '~'.

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|TopLeft|| Top|| TopRight
|-
|Left|| Center || Right
|-
|BottomLeft|| Bottom || BottomRight
|}

===Calling a Simple Menu with Auto-Navigation Buttons===
In this case we now add navigation buttons to the bottom of the script. Back and Exit buttons are added to the bottom and if necessary >> and << buttons. In the script that is calling the menu I use a function something like this.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "TRUE"; //The display of the bottom navigation buttons is set to TRUE
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

This will display a menu that looks something like this.

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|-
| || Back || Exit
|}

===Calling a Complex Menu===
In the following case we will have 10 buttons that are going to be displayed. Because we will also display the bottom 3 buttons this will be spanned across 2 menus. We will also include 2 fixed buttons that always display at the top of the menu, PLUS each button has a unique descriptor that is displayed. Here is the menu call.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"
string menuNavigate = "TRUE";
string menuText = "Main text displayed.~text1~text2~text3~text4~text5~text6~text7~text8~text9~text10";
string menuButtons = "B1~B2~B3~B4~B5~B6~B7~B8~B9~B10";
string menuFixedButtons = "FIXED1~FIXED2"

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons+"|"+menuFixedButtons, id);
}
</lsl>

This will display the following 2 menus

Menu1
Main text displayed.
item1
item2
item3
item4
item5
item6
item7

{| border="1"
|FIXED1 || FIXED2 || B1
|-
|B2 || B3 || B4
|-
|B5 || B6 || B7
|-
| || Back || >>
|}

Menu2 (on clicking the >> button)
Main text displayed.
item8
item9
item10

{| border="1"
|FIXED1 || FIXED2 || B8
|-
| B9 || B10 ||
|-
| << || Back || Exit
|}

===Parsing the returning Menu information===

Note that if the user clicks on the << or >> buttons the calling script WILL NOT see any response. The correct menu is displayed. The calling script only receives a response when one of the buttons or Back/Exit are clicked. Clicking on a space button will cause the menu to redisplay.

The script that expects the response back from the menu has the following

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

default
{
link_message(integer intSenderNum, integer num, string message, key id)
{
if (num == LINK_MENU_RETURN)
{
list returnMenu = llParseString2List(message, ["|"], []);
string menuDescriptor = llList2String(returnMenu,0); // The idenfifying descriptor. I sometimes use the name of the script plus menu and parent menu name

if (menuDescriptor == "mymenu")
{ // Is this a response to "mymenu" from the dialog script?
string item = llList2String(returnMenu,1); // The actual button pushed

// id == the key of the menu user.
// The button pressed in the menu is 'item', so now do something with it
}
}
else if (num == LINK_MENU_TIMEOUT)
{
if (message == "mymenu")
{
// We received a timeout (don't worry the listens are all dealt with) so you might want to IM the menu user.
}
}
}
}
</lsl>

==The Script==
<lsl>
// ********************************************************************
//
// Menu Display Script
//
// Menu command format
// string = menuidentifier | display navigate? TRUE/FALSE | menuMaintitle~subtitle1~subtitle2~subtitle3 | button1~button2~button3 {| fixedbutton1~fixedbutton2~fixedbutton3 optional}
// key = menuuser key
//
// Return is in the format
// "menuidentifier | item"
//
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]
// menusActive [menuchannel, menuhandle, time, page]
//
// by SimonT Quinnell
//
// CHANGES
// 2010/10/14 - Timeout message now gets sent to the prim that called the menu, not LINK_THIS. Also includes menuidentifier
// 2010/11/29 - Fixed Bug in RemoveUser function. Thanks for Virtouse Lilienthal for pointing it out.
// 2010/11/29 - Tidied up a little and removed functions NewMenu and RemoveUser that are only called once
// 2014/04/28 - Clarified licence
//
// NOTE: This script is licenced using the Creative Commons Creative Commons Attribution-Share Alike 3.0 license
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

// Main Menu Details
string BACK = "<<";
string FOWARD = ">>";
list MENU_NAVIGATE_BUTTONS = [ " ", "Back", "Exit"];
float MENU_TIMEOUT_CHECK = 10.0;
integer MENU_TIMEOUT = 120;
integer MAX_TEXT = 510;

integer STRIDE_DESCRIPTION = 8;
integer STRIDE_ACTIVE = 4;
integer DEBUG = FALSE;

// ********************************************************************
// Variables
// ********************************************************************

list menusDescription;
list menusActive;

// ********************************************************************
// Functions - General
// ********************************************************************

debug(string debug)
{
if (DEBUG) llSay(DEBUG_CHANNEL,"DEBUG:"+llGetScriptName()+":"+debug+" : Free("+(string)llGetFreeMemory()+")");
}

integer string2Bool (string test)
{
if (test == "TRUE") return TRUE;
else return FALSE;
}

// ********************************************************************
// Functions - Menu Helpers
// ********************************************************************

integer NewChannel()
{ // generates unique channel number
integer channel;

do channel = -(llRound(llFrand(999999)) + 99999);
while (~llListFindList(menusDescription, [channel]));

return channel;
}

string CheckTitleLength(string title)
{
if (llStringLength(title) > MAX_TEXT) title = llGetSubString(title, 0, MAX_TEXT-1);

return title;
}

list FillMenu(list buttons)
{ //adds empty buttons until the list length is multiple of 3, to max of 12
integer i;
list listButtons;

for(i=0;i<llGetListLength(buttons);i++)
{
string name = llList2String(buttons,i);
if (llStringLength(name) > 24) name = llGetSubString(name, 0, 23);
listButtons = listButtons + [name];
}

while (llGetListLength(listButtons) != 3 && llGetListLength(listButtons) != 6 && llGetListLength(listButtons) != 9 && llGetListLength(listButtons) < 12)
{
listButtons = listButtons + [" "];
}

buttons = llList2List(listButtons, 9, 11);
buttons = buttons + llList2List(listButtons, 6, 8);
buttons = buttons + llList2List(listButtons, 3, 5);
buttons = buttons + llList2List(listButtons, 0, 2);

return buttons;
}

RemoveMenu(integer channel, integer echo)
{
integer index = llListFindList(menusDescription, [channel]);

if (index != -1)
{
key menuId = llList2Key(menusDescription, index+1);
string menuDetails = llList2String(menusDescription, index+2);
integer menuLink = llList2Integer(menusDescription, index+3);
menusDescription = llDeleteSubList(menusDescription, index, index + STRIDE_DESCRIPTION - 1);
RemoveListen(channel);

if (echo) llMessageLinked(menuLink, LINK_MENU_TIMEOUT, menuDetails, menuId);
}
}

RemoveListen(integer channel)
{
integer index = llListFindList(menusActive, [channel]);
if (index != -1)
{
llListenRemove(llList2Integer(menusActive, index + 1));
menusActive = llDeleteSubList(menusActive, index, index + STRIDE_ACTIVE - 1);
}
}

// ********************************************************************
// Functions - Menu Main
// ********************************************************************

DisplayMenu(key id, integer channel, integer page)
{
string menuTitle;
list menuSubTitles;
list menuButtonsAll;
list menuButtons;
list menuNavigateButtons;
list menuFixedButtons;

integer max = 12;

// Populate values
integer index = llListFindList(menusDescription, [channel]);
menuButtonsAll = llParseString2List(llList2String(menusDescription, index+6), ["~"], []);
if (llList2String(menusDescription, index+7) != "") menuFixedButtons = llParseString2List(llList2String(menusDescription, index+7), ["~"], []);

// Set up the menu buttons
if (llList2Integer(menusDescription, index+4)) menuNavigateButtons= MENU_NAVIGATE_BUTTONS;
else if (llGetListLength(menuButtonsAll) > (max-llGetListLength(menuFixedButtons))) menuNavigateButtons = [" ", " ", " "];

// FIXME: add sanity check for menu page

max = max - llGetListLength(menuFixedButtons) - llGetListLength(menuNavigateButtons);
integer start = page*max;
integer stop = (page+1)*max - 1;
menuButtons = FillMenu(menuFixedButtons + llList2List(menuButtonsAll, start, stop));

// Generate the title
list tempTitle = llParseString2List(llList2String(menusDescription, index+5), ["~"], []);
menuTitle = llList2String(tempTitle,0);
if (llGetListLength(tempTitle) > 1) menuSubTitles = llList2List(tempTitle, 1, -1);
if (llGetListLength(menuSubTitles) > 0)
{
integer i;
for(i=start;i<(stop+1);++i)
{
if (llList2String(menuSubTitles, i) != "") menuTitle += "\n"+llList2String(menuSubTitles, i);
}
}
menuTitle = CheckTitleLength(menuTitle);

// Add navigate buttons if necessary
if (page > 0) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [BACK], 0, 0);
if (llGetListLength(menuButtonsAll) > (page+1)*max) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [FOWARD], 2, 2);

// Set up listen and add the row details
integer menuHandle = llListen(channel, "", id, "");
menusActive = [channel, menuHandle, llGetUnixTime(), page] + menusActive;

llSetTimerEvent(MENU_TIMEOUT_CHECK);

// Display menu
llDialog(id, menuTitle, menuNavigateButtons + menuButtons, channel);
}

// ********************************************************************
// Event Handlers
// ********************************************************************

default
{
listen(integer channel, string name, key id, string message)
{
if (message == BACK)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)-1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == FOWARD)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)+1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == " ")
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3);
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else
{
integer index = llListFindList(menusDescription, [channel]);
llMessageLinked(llList2Integer(menusDescription, index+3), LINK_MENU_RETURN, llList2String(menusDescription, index+2)+"|"+message, id);
RemoveMenu(channel, FALSE);
}
}

link_message(integer senderNum, integer num, string message, key id)
{
if (num == LINK_MENU_DISPLAY)
{ // Setup New Menu
list temp = llParseString2List(message, ["|"], []);
integer channel = NewChannel();

if (llGetListLength(temp) > 2)
{
menusDescription = [channel, id, llList2String(temp, 0), senderNum, string2Bool(llList2String(temp, 1)), llList2String(temp, 2), llList2String(temp, 3), llList2String(temp, 4)] + menusDescription;

DisplayMenu(id, channel, 0);
}
else llSay (DEBUG_CHANNEL, "ERROR in "+llGetScriptName()+": Dialog Script. Incorrect menu format");
}
else if (num == LINK_MENU_CLOSE)
{ // Will remove all menus that have the user id.
integer index_id = llListFindList(menusDescription, [id]);

while (~index_id)
{
integer channel = llList2Integer(menusDescription, index_id-1);
RemoveMenu(channel, FALSE);

// Check for another menu by same user
index_id = llListFindList(menusDescription, [id]);
}
}
}

timer()
{ // Check through timers and close if necessary
integer i;
list toRemove;
integer currentTime = llGetUnixTime();
integer length = llGetListLength(menusActive);

for(i=0;i<length;i+=STRIDE_ACTIVE)
{
if (currentTime - llList2Integer(menusActive, i+2) > MENU_TIMEOUT) toRemove = [llList2Integer(menusActive, i)] + toRemove;
}

length = llGetListLength(toRemove);
if (length > 0)
{
for(i=0;i<length;i++)
{
RemoveMenu(llList2Integer(toRemove, i), TRUE);
}
}
}
}

</lsl>

==See also==
*[[ Script_Library | Script Library ]]
[[Category:LSL Library|Dialog Handler (MultiUser)]]

MultiUser Dialog Handler

2014-04-27T23:20:06Z

SimonT Quinnell: /* The Script */

==Introduction==

I found that i was constantly rewriting a pile of dialog handling functions in my scrips so i decided to write a single dialog handler script. It needed to have the following features;

* Support multiple simultaneous menus from different users, scripts and prims.
* Support fixed top buttons that will persist on lists.
* Support fixed bottom buttons with include Back and Exit buttons.
* Handle item lists > 12 and automatically insert << and >> buttons to scroll through the lists.
* Handle timeouts and communicate timeout back to calling script.
* Handles truncation of the buttons and text to stop errors in llDialog

==Using The Script==

===Calling a Simple Menu===
In the script that is calling the menu I use a function something like this.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "FALSE"; //Navigation buttons not displayed
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "TopLeft~Top~TopRight~Left~Center~Right~BottomLeft~Bottom~BottomRight"; // The buttons, each button separated by a '~'.

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|TopLeft|| Top|| TopRight
|-
|Left|| Center || Right
|-
|BottomLeft|| Bottom || BottomRight
|}

===Calling a Simple Menu with Auto-Navigation Buttons===
In this case we now add navigation buttons to the bottom of the script. Back and Exit buttons are added to the bottom and if necessary >> and << buttons. In the script that is calling the menu I use a function something like this.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "TRUE"; //The display of the bottom navigation buttons is set to TRUE
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

This will display a menu that looks something like this.

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|-
| || Back || Exit
|}

===Calling a Complex Menu===
In the following case we will have 10 buttons that are going to be displayed. Because we will also display the bottom 3 buttons this will be spanned across 2 menus. We will also include 2 fixed buttons that always display at the top of the menu, PLUS each button has a unique descriptor that is displayed. Here is the menu call.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"
string menuNavigate = "TRUE";
string menuText = "Main text displayed.~text1~text2~text3~text4~text5~text6~text7~text8~text9~text10";
string menuButtons = "B1~B2~B3~B4~B5~B6~B7~B8~B9~B10";
string menuFixedButtons = "FIXED1~FIXED2"

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons+"|"+menuFixedButtons, id);
}
</lsl>

This will display the following 2 menus

Menu1
Main text displayed.
item1
item2
item3
item4
item5
item6
item7

{| border="1"
|FIXED1 || FIXED2 || B1
|-
|B2 || B3 || B4
|-
|B5 || B6 || B7
|-
| || Back || >>
|}

Menu2 (on clicking the >> button)
Main text displayed.
item8
item9
item10

{| border="1"
|FIXED1 || FIXED2 || B8
|-
| B9 || B10 ||
|-
| << || Back || Exit
|}

===Parsing the returning Menu information===

Note that if the user clicks on the << or >> buttons the calling script WILL NOT see any response. The correct menu is displayed. The calling script only receives a response when one of the buttons or Back/Exit are clicked. Clicking on a space button will cause the menu to redisplay.

The script that expects the response back from the menu has the following

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

default
{
link_message(integer intSenderNum, integer num, string message, key id)
{
if (num == LINK_MENU_RETURN)
{
list returnMenu = llParseString2List(message, ["|"], []);
string menuDescriptor = llList2String(returnMenu,0); // The idenfifying descriptor. I sometimes use the name of the script plus menu and parent menu name

if (menuDescriptor == "mymenu")
{ // Is this a response to "mymenu" from the dialog script?
string item = llList2String(returnMenu,1); // The actual button pushed

// id == the key of the menu user.
// The button pressed in the menu is 'item', so now do something with it
}
}
else if (num == LINK_MENU_TIMEOUT)
{
if (message == "mymenu")
{
// We received a timeout (don't worry the listens are all dealt with) so you might want to IM the menu user.
}
}
}
}
</lsl>

==The Script==
<lsl>
// ********************************************************************
//
// Menu Display Script
//
// Menu command format
// string = menuidentifier | display navigate? TRUE/FALSE | menuMaintitle~subtitle1~subtitle2~subtitle3 | button1~button2~button3 {| fixedbutton1~fixedbutton2~fixedbutton3 optional}
// key = menuuser key
//
// Return is in the format
// "menuidentifier | item"
//
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]
// menusActive [menuchannel, menuhandle, time, page]
//
// by SimonT Quinnell
//
// CHANGES
// 2010/10/14 - Timeout message now gets sent to the prim that called the menu, not LINK_THIS. Also includes menuidentifier
// 2010/11/29 - Fixed Bug in RemoveUser function. Thanks for Virtouse Lilienthal for pointing it out.
// 2010/11/29 - Tidied up a little and removed functions NewMenu and RemoveUser that are only called once
// 2014/04/28 - Clarified licence
//
// NOTE: This script is licence using the Creative Commons Creative Commons Attribution-Share Alike 3.0 license
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

// Main Menu Details
string BACK = "<<";
string FOWARD = ">>";
list MENU_NAVIGATE_BUTTONS = [ " ", "Back", "Exit"];
float MENU_TIMEOUT_CHECK = 10.0;
integer MENU_TIMEOUT = 120;
integer MAX_TEXT = 510;

integer STRIDE_DESCRIPTION = 8;
integer STRIDE_ACTIVE = 4;
integer DEBUG = FALSE;

// ********************************************************************
// Variables
// ********************************************************************

list menusDescription;
list menusActive;

// ********************************************************************
// Functions - General
// ********************************************************************

debug(string debug)
{
if (DEBUG) llSay(DEBUG_CHANNEL,"DEBUG:"+llGetScriptName()+":"+debug+" : Free("+(string)llGetFreeMemory()+")");
}

integer string2Bool (string test)
{
if (test == "TRUE") return TRUE;
else return FALSE;
}

// ********************************************************************
// Functions - Menu Helpers
// ********************************************************************

integer NewChannel()
{ // generates unique channel number
integer channel;

do channel = -(llRound(llFrand(999999)) + 99999);
while (~llListFindList(menusDescription, [channel]));

return channel;
}

string CheckTitleLength(string title)
{
if (llStringLength(title) > MAX_TEXT) title = llGetSubString(title, 0, MAX_TEXT-1);

return title;
}

list FillMenu(list buttons)
{ //adds empty buttons until the list length is multiple of 3, to max of 12
integer i;
list listButtons;

for(i=0;i<llGetListLength(buttons);i++)
{
string name = llList2String(buttons,i);
if (llStringLength(name) > 24) name = llGetSubString(name, 0, 23);
listButtons = listButtons + [name];
}

while (llGetListLength(listButtons) != 3 && llGetListLength(listButtons) != 6 && llGetListLength(listButtons) != 9 && llGetListLength(listButtons) < 12)
{
listButtons = listButtons + [" "];
}

buttons = llList2List(listButtons, 9, 11);
buttons = buttons + llList2List(listButtons, 6, 8);
buttons = buttons + llList2List(listButtons, 3, 5);
buttons = buttons + llList2List(listButtons, 0, 2);

return buttons;
}

RemoveMenu(integer channel, integer echo)
{
integer index = llListFindList(menusDescription, [channel]);

if (index != -1)
{
key menuId = llList2Key(menusDescription, index+1);
string menuDetails = llList2String(menusDescription, index+2);
integer menuLink = llList2Integer(menusDescription, index+3);
menusDescription = llDeleteSubList(menusDescription, index, index + STRIDE_DESCRIPTION - 1);
RemoveListen(channel);

if (echo) llMessageLinked(menuLink, LINK_MENU_TIMEOUT, menuDetails, menuId);
}
}

RemoveListen(integer channel)
{
integer index = llListFindList(menusActive, [channel]);
if (index != -1)
{
llListenRemove(llList2Integer(menusActive, index + 1));
menusActive = llDeleteSubList(menusActive, index, index + STRIDE_ACTIVE - 1);
}
}

// ********************************************************************
// Functions - Menu Main
// ********************************************************************

DisplayMenu(key id, integer channel, integer page)
{
string menuTitle;
list menuSubTitles;
list menuButtonsAll;
list menuButtons;
list menuNavigateButtons;
list menuFixedButtons;

integer max = 12;

// Populate values
integer index = llListFindList(menusDescription, [channel]);
menuButtonsAll = llParseString2List(llList2String(menusDescription, index+6), ["~"], []);
if (llList2String(menusDescription, index+7) != "") menuFixedButtons = llParseString2List(llList2String(menusDescription, index+7), ["~"], []);

// Set up the menu buttons
if (llList2Integer(menusDescription, index+4)) menuNavigateButtons= MENU_NAVIGATE_BUTTONS;
else if (llGetListLength(menuButtonsAll) > (max-llGetListLength(menuFixedButtons))) menuNavigateButtons = [" ", " ", " "];

// FIXME: add sanity check for menu page

max = max - llGetListLength(menuFixedButtons) - llGetListLength(menuNavigateButtons);
integer start = page*max;
integer stop = (page+1)*max - 1;
menuButtons = FillMenu(menuFixedButtons + llList2List(menuButtonsAll, start, stop));

// Generate the title
list tempTitle = llParseString2List(llList2String(menusDescription, index+5), ["~"], []);
menuTitle = llList2String(tempTitle,0);
if (llGetListLength(tempTitle) > 1) menuSubTitles = llList2List(tempTitle, 1, -1);
if (llGetListLength(menuSubTitles) > 0)
{
integer i;
for(i=start;i<(stop+1);++i)
{
if (llList2String(menuSubTitles, i) != "") menuTitle += "\n"+llList2String(menuSubTitles, i);
}
}
menuTitle = CheckTitleLength(menuTitle);

// Add navigate buttons if necessary
if (page > 0) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [BACK], 0, 0);
if (llGetListLength(menuButtonsAll) > (page+1)*max) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [FOWARD], 2, 2);

// Set up listen and add the row details
integer menuHandle = llListen(channel, "", id, "");
menusActive = [channel, menuHandle, llGetUnixTime(), page] + menusActive;

llSetTimerEvent(MENU_TIMEOUT_CHECK);

// Display menu
llDialog(id, menuTitle, menuNavigateButtons + menuButtons, channel);
}

// ********************************************************************
// Event Handlers
// ********************************************************************

default
{
listen(integer channel, string name, key id, string message)
{
if (message == BACK)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)-1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == FOWARD)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)+1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == " ")
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3);
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else
{
integer index = llListFindList(menusDescription, [channel]);
llMessageLinked(llList2Integer(menusDescription, index+3), LINK_MENU_RETURN, llList2String(menusDescription, index+2)+"|"+message, id);
RemoveMenu(channel, FALSE);
}
}

link_message(integer senderNum, integer num, string message, key id)
{
if (num == LINK_MENU_DISPLAY)
{ // Setup New Menu
list temp = llParseString2List(message, ["|"], []);
integer channel = NewChannel();

if (llGetListLength(temp) > 2)
{
menusDescription = [channel, id, llList2String(temp, 0), senderNum, string2Bool(llList2String(temp, 1)), llList2String(temp, 2), llList2String(temp, 3), llList2String(temp, 4)] + menusDescription;

DisplayMenu(id, channel, 0);
}
else llSay (DEBUG_CHANNEL, "ERROR in "+llGetScriptName()+": Dialog Script. Incorrect menu format");
}
else if (num == LINK_MENU_CLOSE)
{ // Will remove all menus that have the user id.
integer index_id = llListFindList(menusDescription, [id]);

while (~index_id)
{
integer channel = llList2Integer(menusDescription, index_id-1);
RemoveMenu(channel, FALSE);

// Check for another menu by same user
index_id = llListFindList(menusDescription, [id]);
}
}
}

timer()
{ // Check through timers and close if necessary
integer i;
list toRemove;
integer currentTime = llGetUnixTime();
integer length = llGetListLength(menusActive);

for(i=0;i<length;i+=STRIDE_ACTIVE)
{
if (currentTime - llList2Integer(menusActive, i+2) > MENU_TIMEOUT) toRemove = [llList2Integer(menusActive, i)] + toRemove;
}

length = llGetListLength(toRemove);
if (length > 0)
{
for(i=0;i<length;i++)
{
RemoveMenu(llList2Integer(toRemove, i), TRUE);
}
}
}
}

</lsl>

==See also==
*[[ Script_Library | Script Library ]]
[[Category:LSL Library|Dialog Handler (MultiUser)]]

MultiUser Dialog Handler

2010-11-28T23:58:29Z

SimonT Quinnell: /* The Script */

==Introduction==

I found that i was constantly rewriting a pile of dialog handling functions in my scrips so i decided to write a single dialog handler script. It needed to have the following features;

* Support multiple simultaneous menus from different users, scripts and prims.
* Support fixed top buttons that will persist on lists.
* Support fixed bottom buttons with include Back and Exit buttons.
* Handle item lists > 12 and automatically insert << and >> buttons to scroll through the lists.
* Handle timeouts and communicate timeout back to calling script.
* Handles truncation of the buttons and text to stop errors in llDialog

==Using The Script==

===Calling a Simple Menu===
In the script that is calling the menu I use a function something like this.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "FALSE"; //Navigation buttons not displayed
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "TopLeft~Top~TopRight~Left~Center~Right~BottomLeft~Bottom~BottomRight"; // The buttons, each button separated by a '~'.

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|TopLeft|| Top|| TopRight
|-
|Left|| Center || Right
|-
|BottomLeft|| Bottom || BottomRight
|}

===Calling a Simple Menu with Auto-Navigation Buttons===
In this case we now add navigation buttons to the bottom of the script. Back and Exit buttons are added to the bottom and if necessary >> and << buttons. In the script that is calling the menu I use a function something like this.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "TRUE"; //The display of the bottom navigation buttons is set to TRUE
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

This will display a menu that looks something like this.

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|-
| || Back || Exit
|}

===Calling a Complex Menu===
In the following case we will have 10 buttons that are going to be displayed. Because we will also display the bottom 3 buttons this will be spanned across 2 menus. We will also include 2 fixed buttons that always display at the top of the menu, PLUS each button has a unique descriptor that is displayed. Here is the menu call.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"
string menuNavigate = "TRUE";
string menuText = "Main text displayed.~text1~text2~text3~text4~text5~text6~text7~text8~text9~text10";
string menuButtons = "B1~B2~B3~B4~B5~B6~B7~B8~B9~B10";
string menuFixedButtons = "FIXED1~FIXED2"

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons+"|"+menuFixedButtons, id);
}
</lsl>

This will display the following 2 menus

Menu1
Main text displayed.
item1
item2
item3
item4
item5
item6
item7

{| border="1"
|FIXED1 || FIXED2 || B1
|-
|B2 || B3 || B4
|-
|B5 || B6 || B7
|-
| || Back || >>
|}

Menu2 (on clicking the >> button)
Main text displayed.
item8
item9
item10

{| border="1"
|FIXED1 || FIXED2 || B8
|-
| B9 || B10 ||
|-
| << || Back || Exit
|}

===Parsing the returning Menu information===

Note that if the user clicks on the << or >> buttons the calling script WILL NOT see any response. The correct menu is displayed. The calling script only receives a response when one of the buttons or Back/Exit are clicked. Clicking on a space button will cause the menu to redisplay.

The script that expects the response back from the menu has the following

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

default
{
link_message(integer intSenderNum, integer num, string message, key id)
{
if (num == LINK_MENU_RETURN)
{
list returnMenu = llParseString2List(message, ["|"], []);
string menuDescriptor = llList2String(returnMenu,0); // The idenfifying descriptor. I sometimes use the name of the script plus menu and parent menu name

if (menuDescriptor == "mymenu")
{ // Is this a response to "mymenu" from the dialog script?
string item = llList2String(returnMenu,1); // The actual button pushed

// id == the key of the menu user.
// The button pressed in the menu is 'item', so now do something with it
}
}
else if (num == LINK_MENU_TIMEOUT)
{
if (message == "mymenu")
{
// We received a timeout (don't worry the listens are all dealt with) so you might want to IM the menu user.
}
}
}
}
</lsl>

==The Script==
<lsl>
// ********************************************************************
//
// Menu Display Script
//
// Menu command format
// string = menuidentifier | display navigate? TRUE/FALSE | menuMaintitle~subtitle1~subtitle2~subtitle3 | button1~button2~button3 {| fixedbutton1~fixedbutton2~fixedbutton3 optional}
// key = menuuser key
//
// Return is in the format
// "menuidentifier | item"
//
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]
// menusActive [menuchannel, menuhandle, time, page]
//
// by SimonT Quinnell
//
// CHANGES
// 2010/10/14 - Timeout message now gets sent to the prim that called the menu, not LINK_THIS. Also includes menuidentifier
// 2010/11/29 - Fixed Bug in RemoveUser function. Thanks for Virtouse Lilienthal for pointing it out.
// 2010/11/29 - Tidied up a little and removed functions NewMenu and RemoveUser that are only called once
//
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

// Main Menu Details
string BACK = "<<";
string FOWARD = ">>";
list MENU_NAVIGATE_BUTTONS = [ " ", "Back", "Exit"];
float MENU_TIMEOUT_CHECK = 10.0;
integer MENU_TIMEOUT = 120;
integer MAX_TEXT = 510;

integer STRIDE_DESCRIPTION = 8;
integer STRIDE_ACTIVE = 4;
integer DEBUG = FALSE;

// ********************************************************************
// Variables
// ********************************************************************

list menusDescription;
list menusActive;

// ********************************************************************
// Functions - General
// ********************************************************************

debug(string debug)
{
if (DEBUG) llSay(DEBUG_CHANNEL,"DEBUG:"+llGetScriptName()+":"+debug+" : Free("+(string)llGetFreeMemory()+")");
}

integer string2Bool (string test)
{
if (test == "TRUE") return TRUE;
else return FALSE;
}

// ********************************************************************
// Functions - Menu Helpers
// ********************************************************************

integer NewChannel()
{ // generates unique channel number
integer channel;

do channel = -(llRound(llFrand(999999)) + 99999);
while (~llListFindList(menusDescription, [channel]));

return channel;
}

string CheckTitleLength(string title)
{
if (llStringLength(title) > MAX_TEXT) title = llGetSubString(title, 0, MAX_TEXT-1);

return title;
}

list FillMenu(list buttons)
{ //adds empty buttons until the list length is multiple of 3, to max of 12
integer i;
list listButtons;

for(i=0;i<llGetListLength(buttons);i++)
{
string name = llList2String(buttons,i);
if (llStringLength(name) > 24) name = llGetSubString(name, 0, 23);
listButtons = listButtons + [name];
}

while (llGetListLength(listButtons) != 3 && llGetListLength(listButtons) != 6 && llGetListLength(listButtons) != 9 && llGetListLength(listButtons) < 12)
{
listButtons = listButtons + [" "];
}

buttons = llList2List(listButtons, 9, 11);
buttons = buttons + llList2List(listButtons, 6, 8);
buttons = buttons + llList2List(listButtons, 3, 5);
buttons = buttons + llList2List(listButtons, 0, 2);

return buttons;
}

RemoveMenu(integer channel, integer echo)
{
integer index = llListFindList(menusDescription, [channel]);

if (index != -1)
{
key menuId = llList2Key(menusDescription, index+1);
string menuDetails = llList2String(menusDescription, index+2);
integer menuLink = llList2Integer(menusDescription, index+3);
menusDescription = llDeleteSubList(menusDescription, index, index + STRIDE_DESCRIPTION - 1);
RemoveListen(channel);

if (echo) llMessageLinked(menuLink, LINK_MENU_TIMEOUT, menuDetails, menuId);
}
}

RemoveListen(integer channel)
{
integer index = llListFindList(menusActive, [channel]);
if (index != -1)
{
llListenRemove(llList2Integer(menusActive, index + 1));
menusActive = llDeleteSubList(menusActive, index, index + STRIDE_ACTIVE - 1);
}
}

// ********************************************************************
// Functions - Menu Main
// ********************************************************************

DisplayMenu(key id, integer channel, integer page)
{
string menuTitle;
list menuSubTitles;
list menuButtonsAll;
list menuButtons;
list menuNavigateButtons;
list menuFixedButtons;

integer max = 12;

// Populate values
integer index = llListFindList(menusDescription, [channel]);
menuButtonsAll = llParseString2List(llList2String(menusDescription, index+6), ["~"], []);
if (llList2String(menusDescription, index+7) != "") menuFixedButtons = llParseString2List(llList2String(menusDescription, index+7), ["~"], []);

// Set up the menu buttons
if (llList2Integer(menusDescription, index+4)) menuNavigateButtons= MENU_NAVIGATE_BUTTONS;
else if (llGetListLength(menuButtonsAll) > (max-llGetListLength(menuFixedButtons))) menuNavigateButtons = [" ", " ", " "];

// FIXME: add sanity check for menu page

max = max - llGetListLength(menuFixedButtons) - llGetListLength(menuNavigateButtons);
integer start = page*max;
integer stop = (page+1)*max - 1;
menuButtons = FillMenu(menuFixedButtons + llList2List(menuButtonsAll, start, stop));

// Generate the title
list tempTitle = llParseString2List(llList2String(menusDescription, index+5), ["~"], []);
menuTitle = llList2String(tempTitle,0);
if (llGetListLength(tempTitle) > 1) menuSubTitles = llList2List(tempTitle, 1, -1);
if (llGetListLength(menuSubTitles) > 0)
{
integer i;
for(i=start;i<(stop+1);++i)
{
if (llList2String(menuSubTitles, i) != "") menuTitle += "\n"+llList2String(menuSubTitles, i);
}
}
menuTitle = CheckTitleLength(menuTitle);

// Add navigate buttons if necessary
if (page > 0) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [BACK], 0, 0);
if (llGetListLength(menuButtonsAll) > (page+1)*max) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [FOWARD], 2, 2);

// Set up listen and add the row details
integer menuHandle = llListen(channel, "", id, "");
menusActive = [channel, menuHandle, llGetUnixTime(), page] + menusActive;

llSetTimerEvent(MENU_TIMEOUT_CHECK);

// Display menu
llDialog(id, menuTitle, menuNavigateButtons + menuButtons, channel);
}

// ********************************************************************
// Event Handlers
// ********************************************************************

default
{
listen(integer channel, string name, key id, string message)
{
if (message == BACK)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)-1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == FOWARD)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)+1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == " ")
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3);
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else
{
integer index = llListFindList(menusDescription, [channel]);
llMessageLinked(llList2Integer(menusDescription, index+3), LINK_MENU_RETURN, llList2String(menusDescription, index+2)+"|"+message, id);
RemoveMenu(channel, FALSE);
}
}

link_message(integer senderNum, integer num, string message, key id)
{
if (num == LINK_MENU_DISPLAY)
{ // Setup New Menu
list temp = llParseString2List(message, ["|"], []);
integer channel = NewChannel();

if (llGetListLength(temp) > 2)
{
menusDescription = [channel, id, llList2String(temp, 0), senderNum, string2Bool(llList2String(temp, 1)), llList2String(temp, 2), llList2String(temp, 3), llList2String(temp, 4)] + menusDescription;

DisplayMenu(id, channel, 0);
}
else llSay (DEBUG_CHANNEL, "ERROR in "+llGetScriptName()+": Dialog Script. Incorrect menu format");
}
else if (num == LINK_MENU_CLOSE)
{ // Will remove all menus that have the user id.
integer index_id = llListFindList(menusDescription, [id]);

while (~index_id)
{
integer channel = llList2Integer(menusDescription, index_id-1);
RemoveMenu(channel, FALSE);

// Check for another menu by same user
index_id = llListFindList(menusDescription, [id]);
}
}
}

timer()
{ // Check through timers and close if necessary
integer i;
list toRemove;
integer currentTime = llGetUnixTime();
integer length = llGetListLength(menusActive);

for(i=0;i<length;i+=STRIDE_ACTIVE)
{
if (currentTime - llList2Integer(menusActive, i+2) > MENU_TIMEOUT) toRemove = [llList2Integer(menusActive, i)] + toRemove;
}

length = llGetListLength(toRemove);
if (length > 0)
{
for(i=0;i<length;i++)
{
RemoveMenu(llList2Integer(toRemove, i), TRUE);
}
}
}
}

</lsl>

==See also==
*[[ Script_Library | Script Library ]]
[[Category:LSL Library|Dialog Handler (MultiUser)]]

MultiUser Dialog Handler

2010-11-28T23:07:35Z

SimonT Quinnell: /* The Script */

==Introduction==

I found that i was constantly rewriting a pile of dialog handling functions in my scrips so i decided to write a single dialog handler script. It needed to have the following features;

* Support multiple simultaneous menus from different users, scripts and prims.
* Support fixed top buttons that will persist on lists.
* Support fixed bottom buttons with include Back and Exit buttons.
* Handle item lists > 12 and automatically insert << and >> buttons to scroll through the lists.
* Handle timeouts and communicate timeout back to calling script.
* Handles truncation of the buttons and text to stop errors in llDialog

==Using The Script==

===Calling a Simple Menu===
In the script that is calling the menu I use a function something like this.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "FALSE"; //Navigation buttons not displayed
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "TopLeft~Top~TopRight~Left~Center~Right~BottomLeft~Bottom~BottomRight"; // The buttons, each button separated by a '~'.

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|TopLeft|| Top|| TopRight
|-
|Left|| Center || Right
|-
|BottomLeft|| Bottom || BottomRight
|}

===Calling a Simple Menu with Auto-Navigation Buttons===
In this case we now add navigation buttons to the bottom of the script. Back and Exit buttons are added to the bottom and if necessary >> and << buttons. In the script that is calling the menu I use a function something like this.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "TRUE"; //The display of the bottom navigation buttons is set to TRUE
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

This will display a menu that looks something like this.

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|-
| || Back || Exit
|}

===Calling a Complex Menu===
In the following case we will have 10 buttons that are going to be displayed. Because we will also display the bottom 3 buttons this will be spanned across 2 menus. We will also include 2 fixed buttons that always display at the top of the menu, PLUS each button has a unique descriptor that is displayed. Here is the menu call.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"
string menuNavigate = "TRUE";
string menuText = "Main text displayed.~text1~text2~text3~text4~text5~text6~text7~text8~text9~text10";
string menuButtons = "B1~B2~B3~B4~B5~B6~B7~B8~B9~B10";
string menuFixedButtons = "FIXED1~FIXED2"

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons+"|"+menuFixedButtons, id);
}
</lsl>

This will display the following 2 menus

Menu1
Main text displayed.
item1
item2
item3
item4
item5
item6
item7

{| border="1"
|FIXED1 || FIXED2 || B1
|-
|B2 || B3 || B4
|-
|B5 || B6 || B7
|-
| || Back || >>
|}

Menu2 (on clicking the >> button)
Main text displayed.
item8
item9
item10

{| border="1"
|FIXED1 || FIXED2 || B8
|-
| B9 || B10 ||
|-
| << || Back || Exit
|}

===Parsing the returning Menu information===

Note that if the user clicks on the << or >> buttons the calling script WILL NOT see any response. The correct menu is displayed. The calling script only receives a response when one of the buttons or Back/Exit are clicked. Clicking on a space button will cause the menu to redisplay.

The script that expects the response back from the menu has the following

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

default
{
link_message(integer intSenderNum, integer num, string message, key id)
{
if (num == LINK_MENU_RETURN)
{
list returnMenu = llParseString2List(message, ["|"], []);
string menuDescriptor = llList2String(returnMenu,0); // The idenfifying descriptor. I sometimes use the name of the script plus menu and parent menu name

if (menuDescriptor == "mymenu")
{ // Is this a response to "mymenu" from the dialog script?
string item = llList2String(returnMenu,1); // The actual button pushed

// id == the key of the menu user.
// The button pressed in the menu is 'item', so now do something with it
}
}
else if (num == LINK_MENU_TIMEOUT)
{
if (message == "mymenu")
{
// We received a timeout (don't worry the listens are all dealt with) so you might want to IM the menu user.
}
}
}
}
</lsl>

==The Script==
<lsl>
// ********************************************************************
//
// Menu Display Script
//
// Menu command format
// string = menuidentifier | display navigate? TRUE/FALSE | menuMaintitle~subtitle1~subtitle2~subtitle3 | button1~button2~button3 {| fixedbutton1~fixedbutton2~fixedbutton3 optional}
// key = menuuser key
//
// Return is in the format
// "menuidentifier | item"
//
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]
// menusActive [menuchannel, menuhandle, time, page]
//
// by SimonT Quinnell
//
// CHANGES
// 2010/10/14 - Timeout message now gets sent to the prim that called the menu, not LINK_THIS. Also includes menuidentifier
// 2010/11/29 - Fixed Bug in RemoveUser function. Thanks for Virtouse Lilienthal for pointing it out.
//
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

// Main Menu Details
string BACK = "<<";
string FOWARD = ">>";
list MENU_NAVIGATE_BUTTONS = [ " ", "Back", "Exit"];
float MENU_TIMEOUT_CHECK = 10.0;
integer MENU_TIMEOUT = 120;
integer MAX_TEXT = 510;

integer STRIDE_DESCRIPTION = 8;
integer STRIDE_ACTIVE = 4;
integer DEBUG = FALSE;

// ********************************************************************
// Variables
// ********************************************************************

list menusDescription;
list menusActive;

// ********************************************************************
// Functions - General
// ********************************************************************

debug(string debug)
{
if (DEBUG) llSay(DEBUG_CHANNEL,"DEBUG:"+llGetScriptName()+":"+debug+" : Free("+(string)llGetFreeMemory()+")");
}

integer string2Bool (string test)
{
if (test == "TRUE") return TRUE;
else return FALSE;
}

// ********************************************************************
// Functions - Menu Helpers
// ********************************************************************

integer NewChannel()
{ // generates unique channel number
integer channel;

do channel = -(llRound(llFrand(999999)) + 99999);
while (~llListFindList(menusDescription, [channel]));

return channel;
}

string CheckTitleLength(string title)
{
if (llStringLength(title) > MAX_TEXT) title = llGetSubString(title, 0, MAX_TEXT-1);

return title;
}

list FillMenu(list buttons)
{ //adds empty buttons until the list length is multiple of 3, to max of 12
integer i;
list listButtons;

for(i=0;i<llGetListLength(buttons);i++)
{
string name = llList2String(buttons,i);
if (llStringLength(name) > 24) name = llGetSubString(name, 0, 23);
listButtons = listButtons + [name];
}

while (llGetListLength(listButtons) != 3 && llGetListLength(listButtons) != 6 && llGetListLength(listButtons) != 9 && llGetListLength(listButtons) < 12)
{
listButtons = listButtons + [" "];
}

buttons = llList2List(listButtons, 9, 11);
buttons = buttons + llList2List(listButtons, 6, 8);
buttons = buttons + llList2List(listButtons, 3, 5);
buttons = buttons + llList2List(listButtons, 0, 2);

return buttons;
}

RemoveUser(key id)
{ // Will remove all menus that have the user id.
integer index_id = llListFindList(menusDescription, [id]);

while (~index_id)
{
integer channel = llList2Integer(menusDescription, index_id-1);
RemoveMenu(channel, FALSE);

// Check for another menu by same user
index_id = llListFindList(menusDescription, [id]);
}
}

RemoveMenu(integer channel, integer echo)
{
integer index = llListFindList(menusDescription, [channel]);

if (index != -1)
{
key menuId = llList2Key(menusDescription, index+1);
string menuDetails = llList2String(menusDescription, index+2);
integer menuLink = llList2Integer(menusDescription, index+3);
menusDescription = llDeleteSubList(menusDescription, index, index + STRIDE_DESCRIPTION - 1);
RemoveListen(channel);

if (echo) llMessageLinked(menuLink, LINK_MENU_TIMEOUT, menuDetails, menuId);
}
}

RemoveListen(integer channel)
{
integer index = llListFindList(menusActive, [channel]);
if (index != -1)
{
llListenRemove(llList2Integer(menusActive, index + 1));
menusActive = llDeleteSubList(menusActive, index, index + STRIDE_ACTIVE - 1);
}
}

// ********************************************************************
// Functions - Menu Main
// ********************************************************************

NewMenu(string message, integer senderNum, key id)
{ // Setup New Menu
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]

list temp = llParseString2List(message, ["|"], []);
integer channel = NewChannel();

if (llGetListLength(temp) > 2)
{
menusDescription = [channel, id, llList2String(temp, 0), senderNum, string2Bool(llList2String(temp, 1)), llList2String(temp, 2), llList2String(temp, 3), llList2String(temp, 4)] + menusDescription;

DisplayMenu(id, channel, 0);
}
else llOwnerSay ("ERROR: Dialog Script. Incorrect menu format");
}

DisplayMenu(key id, integer channel, integer page)
{
string menuTitle;
list menuSubTitles;
list menuButtonsAll;
list menuButtons;
list menuNavigateButtons;
list menuFixedButtons;

integer max = 12;

// Populate values
integer index = llListFindList(menusDescription, [channel]);
menuButtonsAll = llParseString2List(llList2String(menusDescription, index+6), ["~"], []);
if (llList2String(menusDescription, index+7) != "") menuFixedButtons = llParseString2List(llList2String(menusDescription, index+7), ["~"], []);

// Set up the menu buttons
if (llList2Integer(menusDescription, index+4)) menuNavigateButtons= MENU_NAVIGATE_BUTTONS;
else if (llGetListLength(menuButtonsAll) > (max-llGetListLength(menuFixedButtons))) menuNavigateButtons = [" ", " ", " "];

// FIXME: add sanity check for menu page

max = max - llGetListLength(menuFixedButtons) - llGetListLength(menuNavigateButtons);
integer start = page*max;
integer stop = (page+1)*max - 1;
menuButtons = FillMenu(menuFixedButtons + llList2List(menuButtonsAll, start, stop));

// Generate the title
list tempTitle = llParseString2List(llList2String(menusDescription, index+5), ["~"], []);
menuTitle = llList2String(tempTitle,0);
if (llGetListLength(tempTitle) > 1) menuSubTitles = llList2List(tempTitle, 1, -1);
if (llGetListLength(menuSubTitles) > 0)
{
integer i;
for(i=start;i<(stop+1);++i)
{
if (llList2String(menuSubTitles, i) != "") menuTitle += "\n"+llList2String(menuSubTitles, i);
}
}
menuTitle = CheckTitleLength(menuTitle);

// Add navigate buttons if necessary
if (page > 0) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [BACK], 0, 0);
if (llGetListLength(menuButtonsAll) > (page+1)*max) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [FOWARD], 2, 2);

// Set up listen and add the row details
integer menuHandle = llListen(channel, "", id, "");
menusActive = [channel, menuHandle, llGetUnixTime(), page] + menusActive;

llSetTimerEvent(MENU_TIMEOUT_CHECK);

// Display menu
llDialog(id, menuTitle, menuNavigateButtons + menuButtons, channel);
}

// ********************************************************************
// Event Handlers
// ********************************************************************

default
{
listen(integer channel, string name, key id, string message)
{
if (message == BACK)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)-1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == FOWARD)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)+1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == " ")
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3);
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else
{
integer index = llListFindList(menusDescription, [channel]);
llMessageLinked(llList2Integer(menusDescription, index+3), LINK_MENU_RETURN, llList2String(menusDescription, index+2)+"|"+message, id);
RemoveMenu(channel, FALSE);
}
}

link_message(integer senderNum, integer num, string message, key id)
{
if (num == LINK_MENU_DISPLAY) NewMenu(message, senderNum, id);
else if (num == LINK_MENU_CLOSE) RemoveUser(id);
}

timer()
{ // Check through timers and close if necessary
integer i;
list toRemove;
integer currentTime = llGetUnixTime();
integer length = llGetListLength(menusActive);

for(i=0;i<length;i+=STRIDE_ACTIVE)
{
if (currentTime - llList2Integer(menusActive, i+2) > MENU_TIMEOUT) toRemove = [llList2Integer(menusActive, i)] + toRemove;
}

length = llGetListLength(toRemove);
if (length > 0)
{
for(i=0;i<length;i++)
{
RemoveMenu(llList2Integer(toRemove, i), TRUE);
}
}
}
}

</lsl>

==See also==
*[[ Script_Library | Script Library ]]
[[Category:LSL Library|Dialog Handler (MultiUser)]]

MultiUser Dialog Handler

2010-11-28T23:04:36Z

SimonT Quinnell: /* The Script */

==Introduction==

I found that i was constantly rewriting a pile of dialog handling functions in my scrips so i decided to write a single dialog handler script. It needed to have the following features;

* Support multiple simultaneous menus from different users, scripts and prims.
* Support fixed top buttons that will persist on lists.
* Support fixed bottom buttons with include Back and Exit buttons.
* Handle item lists > 12 and automatically insert << and >> buttons to scroll through the lists.
* Handle timeouts and communicate timeout back to calling script.
* Handles truncation of the buttons and text to stop errors in llDialog

==Using The Script==

===Calling a Simple Menu===
In the script that is calling the menu I use a function something like this.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "FALSE"; //Navigation buttons not displayed
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "TopLeft~Top~TopRight~Left~Center~Right~BottomLeft~Bottom~BottomRight"; // The buttons, each button separated by a '~'.

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|TopLeft|| Top|| TopRight
|-
|Left|| Center || Right
|-
|BottomLeft|| Bottom || BottomRight
|}

===Calling a Simple Menu with Auto-Navigation Buttons===
In this case we now add navigation buttons to the bottom of the script. Back and Exit buttons are added to the bottom and if necessary >> and << buttons. In the script that is calling the menu I use a function something like this.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "TRUE"; //The display of the bottom navigation buttons is set to TRUE
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

This will display a menu that looks something like this.

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|-
| || Back || Exit
|}

===Calling a Complex Menu===
In the following case we will have 10 buttons that are going to be displayed. Because we will also display the bottom 3 buttons this will be spanned across 2 menus. We will also include 2 fixed buttons that always display at the top of the menu, PLUS each button has a unique descriptor that is displayed. Here is the menu call.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"
string menuNavigate = "TRUE";
string menuText = "Main text displayed.~text1~text2~text3~text4~text5~text6~text7~text8~text9~text10";
string menuButtons = "B1~B2~B3~B4~B5~B6~B7~B8~B9~B10";
string menuFixedButtons = "FIXED1~FIXED2"

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons+"|"+menuFixedButtons, id);
}
</lsl>

This will display the following 2 menus

Menu1
Main text displayed.
item1
item2
item3
item4
item5
item6
item7

{| border="1"
|FIXED1 || FIXED2 || B1
|-
|B2 || B3 || B4
|-
|B5 || B6 || B7
|-
| || Back || >>
|}

Menu2 (on clicking the >> button)
Main text displayed.
item8
item9
item10

{| border="1"
|FIXED1 || FIXED2 || B8
|-
| B9 || B10 ||
|-
| << || Back || Exit
|}

===Parsing the returning Menu information===

Note that if the user clicks on the << or >> buttons the calling script WILL NOT see any response. The correct menu is displayed. The calling script only receives a response when one of the buttons or Back/Exit are clicked. Clicking on a space button will cause the menu to redisplay.

The script that expects the response back from the menu has the following

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

default
{
link_message(integer intSenderNum, integer num, string message, key id)
{
if (num == LINK_MENU_RETURN)
{
list returnMenu = llParseString2List(message, ["|"], []);
string menuDescriptor = llList2String(returnMenu,0); // The idenfifying descriptor. I sometimes use the name of the script plus menu and parent menu name

if (menuDescriptor == "mymenu")
{ // Is this a response to "mymenu" from the dialog script?
string item = llList2String(returnMenu,1); // The actual button pushed

// id == the key of the menu user.
// The button pressed in the menu is 'item', so now do something with it
}
}
else if (num == LINK_MENU_TIMEOUT)
{
if (message == "mymenu")
{
// We received a timeout (don't worry the listens are all dealt with) so you might want to IM the menu user.
}
}
}
}
</lsl>

==The Script==
<lsl>
// ********************************************************************
//
// Menu Display Script
//
// Menu command format
// string = menuidentifier | display navigate? TRUE/FALSE | menuMaintitle~subtitle1~subtitle2~subtitle3 | button1~button2~button3 {| fixedbutton1~fixedbutton2~fixedbutton3 optional}
// key = menuuser key
//
// Return is in the format
// "menuidentifier | item"
//
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]
// menusActive [menuchannel, menuhandle, time, page]
//
// by SimonT Quinnell
//
// CHANGES
// 2010/10/14 - Timeout message now gets sent to the prim that called the menu, not LINK_THIS. Also includes menuidentifier
// 2010/11/29 - Fixed Bug in RemoveUser function. Thanks for Virtouse Lilienthal for pointing it out.
//
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

// Main Menu Details
string BACK = "<<";
string FOWARD = ">>";
list MENU_NAVIGATE_BUTTONS = [ " ", "Back", "Exit"];
float MENU_TIMEOUT_CHECK = 10.0;
integer MENU_TIMEOUT = 120;
integer MAX_TEXT = 510;

integer STRIDE_DESCRIPTION = 8;
integer STRIDE_ACTIVE = 4;
integer DEBUG = FALSE;

// ********************************************************************
// Variables
// ********************************************************************

list menusDescription;
list menusActive;

// ********************************************************************
// Functions - General
// ********************************************************************

debug(string debug)
{
if (DEBUG) llSay(DEBUG_CHANNEL,"DEBUG:"+llGetScriptName()+":"+debug+" : Free("+(string)llGetFreeMemory()+")");
}

integer string2Bool (string test)
{
if (test == "TRUE") return TRUE;
else return FALSE;
}

// ********************************************************************
// Functions - Menu Helpers
// ********************************************************************

integer NewChannel()
{ // generates unique channel number
integer channel;

do channel = -(llRound(llFrand(999999)) + 99999);
while (~llListFindList(menusDescription, [channel]));

return channel;
}

string CheckTitleLength(string title)
{
if (llStringLength(title) > MAX_TEXT) title = llGetSubString(title, 0, MAX_TEXT-1);

return title;
}

list FillMenu(list buttons)
{ //adds empty buttons until the list length is multiple of 3, to max of 12
integer i;
list listButtons;

for(i=0;i<llGetListLength(buttons);i++)
{
string name = llList2String(buttons,i);
if (llStringLength(name) > 24) name = llGetSubString(name, 0, 23);
listButtons = listButtons + [name];
}

while (llGetListLength(listButtons) != 3 && llGetListLength(listButtons) != 6 && llGetListLength(listButtons) != 9 && llGetListLength(listButtons) < 12)
{
listButtons = listButtons + [" "];
}

buttons = llList2List(listButtons, 9, 11);
buttons = buttons + llList2List(listButtons, 6, 8);
buttons = buttons + llList2List(listButtons, 3, 5);
buttons = buttons + llList2List(listButtons, 0, 2);

return buttons;
}

RemoveUser(key id)
{ // Will remove all menus that have the user id.
integer index_id = llListFindList(menusDescription, [id]);

while (~index_id)
{
integer channel = llList2Integer(menusDescription, index_id-1);
index_id = llListFindList(menusDescription, [id]);
RemoveMenu(channel, FALSE);
}
}

RemoveMenu(integer channel, integer echo)
{
integer index = llListFindList(menusDescription, [channel]);

if (index != -1)
{
key menuId = llList2Key(menusDescription, index+1);
string menuDetails = llList2String(menusDescription, index+2);
integer menuLink = llList2Integer(menusDescription, index+3);
menusDescription = llDeleteSubList(menusDescription, index, index + STRIDE_DESCRIPTION - 1);
RemoveListen(channel);

if (echo) llMessageLinked(menuLink, LINK_MENU_TIMEOUT, menuDetails, menuId);
}
}

RemoveListen(integer channel)
{
integer index = llListFindList(menusActive, [channel]);
if (index != -1)
{
llListenRemove(llList2Integer(menusActive, index + 1));
menusActive = llDeleteSubList(menusActive, index, index + STRIDE_ACTIVE - 1);
}
}

// ********************************************************************
// Functions - Menu Main
// ********************************************************************

NewMenu(string message, integer senderNum, key id)
{ // Setup New Menu
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]

list temp = llParseString2List(message, ["|"], []);
integer channel = NewChannel();

if (llGetListLength(temp) > 2)
{
menusDescription = [channel, id, llList2String(temp, 0), senderNum, string2Bool(llList2String(temp, 1)), llList2String(temp, 2), llList2String(temp, 3), llList2String(temp, 4)] + menusDescription;

DisplayMenu(id, channel, 0);
}
else llOwnerSay ("ERROR: Dialog Script. Incorrect menu format");
}

DisplayMenu(key id, integer channel, integer page)
{
string menuTitle;
list menuSubTitles;
list menuButtonsAll;
list menuButtons;
list menuNavigateButtons;
list menuFixedButtons;

integer max = 12;

// Populate values
integer index = llListFindList(menusDescription, [channel]);
menuButtonsAll = llParseString2List(llList2String(menusDescription, index+6), ["~"], []);
if (llList2String(menusDescription, index+7) != "") menuFixedButtons = llParseString2List(llList2String(menusDescription, index+7), ["~"], []);

// Set up the menu buttons
if (llList2Integer(menusDescription, index+4)) menuNavigateButtons= MENU_NAVIGATE_BUTTONS;
else if (llGetListLength(menuButtonsAll) > (max-llGetListLength(menuFixedButtons))) menuNavigateButtons = [" ", " ", " "];

// FIXME: add sanity check for menu page

max = max - llGetListLength(menuFixedButtons) - llGetListLength(menuNavigateButtons);
integer start = page*max;
integer stop = (page+1)*max - 1;
menuButtons = FillMenu(menuFixedButtons + llList2List(menuButtonsAll, start, stop));

// Generate the title
list tempTitle = llParseString2List(llList2String(menusDescription, index+5), ["~"], []);
menuTitle = llList2String(tempTitle,0);
if (llGetListLength(tempTitle) > 1) menuSubTitles = llList2List(tempTitle, 1, -1);
if (llGetListLength(menuSubTitles) > 0)
{
integer i;
for(i=start;i<(stop+1);++i)
{
if (llList2String(menuSubTitles, i) != "") menuTitle += "\n"+llList2String(menuSubTitles, i);
}
}
menuTitle = CheckTitleLength(menuTitle);

// Add navigate buttons if necessary
if (page > 0) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [BACK], 0, 0);
if (llGetListLength(menuButtonsAll) > (page+1)*max) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [FOWARD], 2, 2);

// Set up listen and add the row details
integer menuHandle = llListen(channel, "", id, "");
menusActive = [channel, menuHandle, llGetUnixTime(), page] + menusActive;

llSetTimerEvent(MENU_TIMEOUT_CHECK);

// Display menu
llDialog(id, menuTitle, menuNavigateButtons + menuButtons, channel);
}

// ********************************************************************
// Event Handlers
// ********************************************************************

default
{
listen(integer channel, string name, key id, string message)
{
if (message == BACK)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)-1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == FOWARD)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)+1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == " ")
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3);
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else
{
integer index = llListFindList(menusDescription, [channel]);
llMessageLinked(llList2Integer(menusDescription, index+3), LINK_MENU_RETURN, llList2String(menusDescription, index+2)+"|"+message, id);
RemoveMenu(channel, FALSE);
}
}

link_message(integer senderNum, integer num, string message, key id)
{
if (num == LINK_MENU_DISPLAY) NewMenu(message, senderNum, id);
else if (num == LINK_MENU_CLOSE) RemoveUser(id);
}

timer()
{ // Check through timers and close if necessary
integer i;
list toRemove;
integer currentTime = llGetUnixTime();
integer length = llGetListLength(menusActive);

for(i=0;i<length;i+=STRIDE_ACTIVE)
{
if (currentTime - llList2Integer(menusActive, i+2) > MENU_TIMEOUT) toRemove = [llList2Integer(menusActive, i)] + toRemove;
}

length = llGetListLength(toRemove);
if (length > 0)
{
for(i=0;i<length;i++)
{
RemoveMenu(llList2Integer(toRemove, i), TRUE);
}
}
}
}

</lsl>

==See also==
*[[ Script_Library | Script Library ]]
[[Category:LSL Library|Dialog Handler (MultiUser)]]

MultiUser Dialog Handler

2010-10-14T04:46:12Z

SimonT Quinnell:

==Introduction==

I found that i was constantly rewriting a pile of dialog handling functions in my scrips so i decided to write a single dialog handler script. It needed to have the following features;

* Support multiple simultaneous menus from different users, scripts and prims.
* Support fixed top buttons that will persist on lists.
* Support fixed bottom buttons with include Back and Exit buttons.
* Handle item lists > 12 and automatically insert << and >> buttons to scroll through the lists.
* Handle timeouts and communicate timeout back to calling script.
* Handles truncation of the buttons and text to stop errors in llDialog

==Using The Script==

===Calling a Simple Menu===
In the script that is calling the menu I use a function something like this.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "FALSE"; //Navigation buttons not displayed
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "TopLeft~Top~TopRight~Left~Center~Right~BottomLeft~Bottom~BottomRight"; // The buttons, each button separated by a '~'.

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|TopLeft|| Top|| TopRight
|-
|Left|| Center || Right
|-
|BottomLeft|| Bottom || BottomRight
|}

===Calling a Simple Menu with Auto-Navigation Buttons===
In this case we now add navigation buttons to the bottom of the script. Back and Exit buttons are added to the bottom and if necessary >> and << buttons. In the script that is calling the menu I use a function something like this.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "TRUE"; //The display of the bottom navigation buttons is set to TRUE
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

This will display a menu that looks something like this.

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|-
| || Back || Exit
|}

===Calling a Complex Menu===
In the following case we will have 10 buttons that are going to be displayed. Because we will also display the bottom 3 buttons this will be spanned across 2 menus. We will also include 2 fixed buttons that always display at the top of the menu, PLUS each button has a unique descriptor that is displayed. Here is the menu call.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"
string menuNavigate = "TRUE";
string menuText = "Main text displayed.~text1~text2~text3~text4~text5~text6~text7~text8~text9~text10";
string menuButtons = "B1~B2~B3~B4~B5~B6~B7~B8~B9~B10";
string menuFixedButtons = "FIXED1~FIXED2"

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons+"|"+menuFixedButtons, id);
}
</lsl>

This will display the following 2 menus

Menu1
Main text displayed.
item1
item2
item3
item4
item5
item6
item7

{| border="1"
|FIXED1 || FIXED2 || B1
|-
|B2 || B3 || B4
|-
|B5 || B6 || B7
|-
| || Back || >>
|}

Menu2 (on clicking the >> button)
Main text displayed.
item8
item9
item10

{| border="1"
|FIXED1 || FIXED2 || B8
|-
| B9 || B10 ||
|-
| << || Back || Exit
|}

===Parsing the returning Menu information===

Note that if the user clicks on the << or >> buttons the calling script WILL NOT see any response. The correct menu is displayed. The calling script only receives a response when one of the buttons or Back/Exit are clicked. Clicking on a space button will cause the menu to redisplay.

The script that expects the response back from the menu has the following

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

default
{
link_message(integer intSenderNum, integer num, string message, key id)
{
if (num == LINK_MENU_RETURN)
{
list returnMenu = llParseString2List(message, ["|"], []);
string menuDescriptor = llList2String(returnMenu,0); // The idenfifying descriptor. I sometimes use the name of the script plus menu and parent menu name

if (menuDescriptor == "mymenu")
{ // Is this a response to "mymenu" from the dialog script?
string item = llList2String(returnMenu,1); // The actual button pushed

// id == the key of the menu user.
// The button pressed in the menu is 'item', so now do something with it
}
}
else if (num == LINK_MENU_TIMEOUT)
{
if (message == "mymenu")
{
// We received a timeout (don't worry the listens are all dealt with) so you might want to IM the menu user.
}
}
}
}
</lsl>

==The Script==
<lsl>
// ********************************************************************
//
// Menu Display Script
//
// Menu command format
// string = menuidentifier | display navigate? TRUE/FALSE | menuMaintitle~subtitle1~subtitle2~subtitle3 | button1~button2~button3 {| fixedbutton1~fixedbutton2~fixedbutton3 optional}
// key = menuuser key
//
// Return is in the format
// "menuidentifier | item"
//
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]
// menusActive [menuchannel, menuhandle, time, page]
//
// by SimonT Quinnell
//
// CHANGES
// 2010/10/14 - Timeout message now gets sent to the prim that called the menu, not LINK_THIS. Also includes menuidentifier
//
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

// Main Menu Details
string BACK = "<<";
string FOWARD = ">>";
list MENU_NAVIGATE_BUTTONS = [ " ", "Back", "Exit"];
float MENU_TIMEOUT_CHECK = 10.0;
integer MENU_TIMEOUT = 120;
integer MAX_TEXT = 510;

integer STRIDE_DESCRIPTION = 8;
integer STRIDE_ACTIVE = 4;
integer DEBUG = FALSE;

// ********************************************************************
// Variables
// ********************************************************************

list menusDescription;
list menusActive;

// ********************************************************************
// Functions - General
// ********************************************************************

debug(string debug)
{
if (DEBUG) llSay(DEBUG_CHANNEL,"DEBUG:"+llGetScriptName()+":"+debug+" : Free("+(string)llGetFreeMemory()+")");
}

integer string2Bool (string test)
{
if (test == "TRUE") return TRUE;
else return FALSE;
}

// ********************************************************************
// Functions - Menu Helpers
// ********************************************************************

integer NewChannel()
{ // generates unique channel number
integer channel;

do channel = -(llRound(llFrand(999999)) + 99999);
while (~llListFindList(menusDescription, [channel]));

return channel;
}

string CheckTitleLength(string title)
{
if (llStringLength(title) > MAX_TEXT) title = llGetSubString(title, 0, MAX_TEXT-1);

return title;
}

list FillMenu(list buttons)
{ //adds empty buttons until the list length is multiple of 3, to max of 12
integer i;
list listButtons;

for(i=0;i<llGetListLength(buttons);i++)
{
string name = llList2String(buttons,i);
if (llStringLength(name) > 24) name = llGetSubString(name, 0, 23);
listButtons = listButtons + [name];
}

while (llGetListLength(listButtons) != 3 && llGetListLength(listButtons) != 6 && llGetListLength(listButtons) != 9 && llGetListLength(listButtons) < 12)
{
listButtons = listButtons + [" "];
}

buttons = llList2List(listButtons, 9, 11);
buttons = buttons + llList2List(listButtons, 6, 8);
buttons = buttons + llList2List(listButtons, 3, 5);
buttons = buttons + llList2List(listButtons, 0, 2);

return buttons;
}

RemoveUser(key id)
{
integer index_id = llListFindList(menusDescription, [id]);

while (~index_id)
{
integer channel = llList2Integer(menusDescription, index_id-1);
RemoveMenu(channel, FALSE);
}
}

RemoveMenu(integer channel, integer echo)
{
integer index = llListFindList(menusDescription, [channel]);

if (index != -1)
{
key menuId = llList2Key(menusDescription, index+1);
string menuDetails = llList2String(menusDescription, index+2);
integer menuLink = llList2Integer(menusDescription, index+3);
menusDescription = llDeleteSubList(menusDescription, index, index + STRIDE_DESCRIPTION - 1);
RemoveListen(channel);

if (echo) llMessageLinked(menuLink, LINK_MENU_TIMEOUT, menuDetails, menuId);
}
}

RemoveListen(integer channel)
{
integer index = llListFindList(menusActive, [channel]);
if (index != -1)
{
llListenRemove(llList2Integer(menusActive, index + 1));
menusActive = llDeleteSubList(menusActive, index, index + STRIDE_ACTIVE - 1);
}
}

// ********************************************************************
// Functions - Menu Main
// ********************************************************************

NewMenu(string message, integer senderNum, key id)
{ // Setup New Menu
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]

list temp = llParseString2List(message, ["|"], []);
integer channel = NewChannel();

if (llGetListLength(temp) > 2)
{
menusDescription = [channel, id, llList2String(temp, 0), senderNum, string2Bool(llList2String(temp, 1)), llList2String(temp, 2), llList2String(temp, 3), llList2String(temp, 4)] + menusDescription;

DisplayMenu(id, channel, 0);
}
else llOwnerSay ("ERROR: Dialog Script. Incorrect menu format");
}

DisplayMenu(key id, integer channel, integer page)
{
string menuTitle;
list menuSubTitles;
list menuButtonsAll;
list menuButtons;
list menuNavigateButtons;
list menuFixedButtons;

integer max = 12;

// Populate values
integer index = llListFindList(menusDescription, [channel]);
menuButtonsAll = llParseString2List(llList2String(menusDescription, index+6), ["~"], []);
if (llList2String(menusDescription, index+7) != "") menuFixedButtons = llParseString2List(llList2String(menusDescription, index+7), ["~"], []);

// Set up the menu buttons
if (llList2Integer(menusDescription, index+4)) menuNavigateButtons= MENU_NAVIGATE_BUTTONS;
else if (llGetListLength(menuButtonsAll) > (max-llGetListLength(menuFixedButtons))) menuNavigateButtons = [" ", " ", " "];

// FIXME: add sanity check for menu page

max = max - llGetListLength(menuFixedButtons) - llGetListLength(menuNavigateButtons);
integer start = page*max;
integer stop = (page+1)*max - 1;
menuButtons = FillMenu(menuFixedButtons + llList2List(menuButtonsAll, start, stop));

// Generate the title
list tempTitle = llParseString2List(llList2String(menusDescription, index+5), ["~"], []);
menuTitle = llList2String(tempTitle,0);
if (llGetListLength(tempTitle) > 1) menuSubTitles = llList2List(tempTitle, 1, -1);
if (llGetListLength(menuSubTitles) > 0)
{
integer i;
for(i=start;i<(stop+1);++i)
{
if (llList2String(menuSubTitles, i) != "") menuTitle += "\n"+llList2String(menuSubTitles, i);
}
}
menuTitle = CheckTitleLength(menuTitle);

// Add navigate buttons if necessary
if (page > 0) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [BACK], 0, 0);
if (llGetListLength(menuButtonsAll) > (page+1)*max) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [FOWARD], 2, 2);

// Set up listen and add the row details
integer menuHandle = llListen(channel, "", id, "");
menusActive = [channel, menuHandle, llGetUnixTime(), page] + menusActive;

llSetTimerEvent(MENU_TIMEOUT_CHECK);

// Display menu
llDialog(id, menuTitle, menuNavigateButtons + menuButtons, channel);
}

// ********************************************************************
// Event Handlers
// ********************************************************************

default
{
listen(integer channel, string name, key id, string message)
{
if (message == BACK)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)-1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == FOWARD)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)+1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == " ")
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3);
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else
{
integer index = llListFindList(menusDescription, [channel]);
llMessageLinked(llList2Integer(menusDescription, index+3), LINK_MENU_RETURN, llList2String(menusDescription, index+2)+"|"+message, id);
RemoveMenu(channel, FALSE);
}
}

link_message(integer senderNum, integer num, string message, key id)
{
if (num == LINK_MENU_DISPLAY) NewMenu(message, senderNum, id);
else if (num == LINK_MENU_CLOSE) RemoveUser(id);
}

timer()
{ // Check through timers and close if necessary
integer i;
list toRemove;
integer currentTime = llGetUnixTime();
integer length = llGetListLength(menusActive);

for(i=0;i<length;i+=STRIDE_ACTIVE)
{
if (currentTime - llList2Integer(menusActive, i+2) > MENU_TIMEOUT) toRemove = [llList2Integer(menusActive, i)] + toRemove;
}

length = llGetListLength(toRemove);
if (length > 0)
{
for(i=0;i<length;i++)
{
RemoveMenu(llList2Integer(toRemove, i), TRUE);
}
}
}
}

</lsl>

==See also==
*[[ Script_Library | Script Library ]]
[[Category:LSL Library|Dialog Handler (MultiUser)]]

Smooth Sliding Door

2010-10-14T04:44:26Z

SimonT Quinnell:

{{LSL Header}}
=Smooth Sliding Door Script=

==Introduction==
It really annoys me that there are so many bad looking doors out there that jerk around. While you can use llSetPos for a sliding door you have no control at what speed it moves. This sliding door script i created because i wanted to time my sliding door movements with the door sounds i had. It uses llMoveToTarget to move the door, with the door temporally turning phantom as it moves.

In laggy sims it will behave a little bit funky .. the door sometimes seeming to zoom off to the side before popping into the correct final position as the door becomes a physical object. However, even with that defect it still looks much better IMHO

==The Script==

<lsl>
// ********************************************************************
//
// Basic Physical Sliding Door Script
// by SimonT Quinnell
// 11/07/2009
//
// NOTE: If you are going to reposition the door, do it while the door is closed.
// Otherwise it will try and use the old close position as a reference point.
//
// Licensed under the "OpenCollar License"
// Ie. Licensed under the GPLv2, with the additional requirement that these scripts remain "full perms" in Second Life.
//
// Edit: Simplified the script to be just a basic move script .. removed the sound triggers (5/1/2010)
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Movement Constants
vector OFFSET = <-2.0, 0.0, 0.0>; // Directional offset for moving the door in x,y,z coordinates
float OPENTIME = 3.5; // Time taken to open door
float CLOSETIME = 3.5; // Time taken to close door

// ********************************************************************
// Variables
// ********************************************************************

vector vPosition;
rotation rRot;
float omega=0.0;
vector vTargetPos;
integer bOpen = FALSE;
integer bMoving = FALSE;

// ********************************************************************
// Functions
// ********************************************************************

MoveDoor()
{
if(!bOpen)
{ // Initial conditions
bOpen = TRUE;
rRot = llGetRot();
vPosition = llGetPos();

// Target Position
omega=OPENTIME/llVecDist(<0,0,0>,OFFSET);
vTargetPos = vPosition+OFFSET*rRot;

// Set the timer to cleanup position
llSetTimerEvent(OPENTIME);
}else
{
bOpen = FALSE;

// Target Position
omega=CLOSETIME/llVecDist(<0,0,0>,OFFSET);
vTargetPos = vPosition;

// Set the timer to cleanup position
llSetTimerEvent(CLOSETIME);
}

// Set Door Physical and move it
bMoving = TRUE;
llSetStatus(STATUS_PHANTOM, TRUE);
llSetStatus(STATUS_PHYSICS, TRUE);
llMoveToTarget(vTargetPos,omega);
}

default
{
state_entry()
{ // Initial conditions
rRot = llGetRot();
vPosition = llGetPos();
}

touch_start(integer num_detected)
{
MoveDoor();
}

timer()
{
// Clean up Position
bMoving = FALSE;
llSetTimerEvent(0.0);
llSetStatus(STATUS_PHYSICS, FALSE);
llSetStatus(STATUS_PHANTOM, FALSE);
llSetPrimitiveParams([ PRIM_POSITION, vTargetPos, PRIM_ROTATION, rRot ]);
}
}</lsl>

==See also==
*[[ Script_Library | Script Library ]]
[[Category:LSL Library|Smooth Sliding Door Script]]

Basic Notecard Reader

2010-10-14T04:42:57Z

SimonT Quinnell: /* Introduction */

{{LSL Header}}
=Basic Notecard Reader=

==Introduction==

Quite often i read in configuration settings from a notecard. I thought i should stick up the core part of my notecard reading script. It's not exactly rocket science but hoepfully it's useful.

==The Script==

<lsl>
// ********************************************************************
//
// Base Notecard reader
//
// by SimonT Quinnell
//
// NOTE. This treats lines starting with '#' in the notecard as a comment
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

string NOTECARD = "notecard";

// ********************************************************************
// Variables
// ********************************************************************

// internals for reading notecards
string strNotecard;
integer intLine1;
key keyConfigQueryhandle;
key keyConfigUUID;

default
{
state_entry()
{
if (llGetInventoryType(NOTECARD) == INVENTORY_NONE)
{
llSay(DEBUG_CHANNEL, "The notecard '"+NOTECARD+"' is missing!");
state main;
}
else
{
keyConfigQueryhandle = llGetNotecardLine(NOTECARD, intLine1 = 0);
keyConfigUUID = llGetInventoryKey(NOTECARD);
}
}

dataserver(key keyQueryId, string strData)
{
if (keyQueryId == keyConfigQueryhandle)
{
if (strData != EOF)
{
string strToken;
strData = llStringTrim(strData, STRING_TRIM_HEAD); // Trim Whitespace
if (llGetSubString (strData, 0, 0) != "#") // is it a comment?
{
// OK .. now we do somthing in here with our notecard
}
keyConfigQueryhandle = llGetNotecardLine(strNotecard, ++intLine1);
}
else
{
// Finished reasding the notecard
state main;
}
}
}
}

state main
{
state_entry()
{
//
}

changed(integer intChange)
{
if (intChange & CHANGED_INVENTORY)
{ // If the notecard has changed, then reload the notecard
if (keyConfigUUID != llGetInventoryKey(NOTECARD))
{
state default;
}
}

}
}
</lsl>

==See also==
*[[ Script_Library | Script Library ]]

Basic Notecard Reader

2010-10-14T04:41:25Z

SimonT Quinnell: /* The Script */

{{LSL Header}}
=Basic Notecard Reader=

==Introduction==

==The Script==

<lsl>
// ********************************************************************
//
// Base Notecard reader
//
// by SimonT Quinnell
//
// NOTE. This treats lines starting with '#' in the notecard as a comment
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

string NOTECARD = "notecard";

// ********************************************************************
// Variables
// ********************************************************************

// internals for reading notecards
string strNotecard;
integer intLine1;
key keyConfigQueryhandle;
key keyConfigUUID;

default
{
state_entry()
{
if (llGetInventoryType(NOTECARD) == INVENTORY_NONE)
{
llSay(DEBUG_CHANNEL, "The notecard '"+NOTECARD+"' is missing!");
state main;
}
else
{
keyConfigQueryhandle = llGetNotecardLine(NOTECARD, intLine1 = 0);
keyConfigUUID = llGetInventoryKey(NOTECARD);
}
}

dataserver(key keyQueryId, string strData)
{
if (keyQueryId == keyConfigQueryhandle)
{
if (strData != EOF)
{
string strToken;
strData = llStringTrim(strData, STRING_TRIM_HEAD); // Trim Whitespace
if (llGetSubString (strData, 0, 0) != "#") // is it a comment?
{
// OK .. now we do somthing in here with our notecard
}
keyConfigQueryhandle = llGetNotecardLine(strNotecard, ++intLine1);
}
else
{
// Finished reasding the notecard
state main;
}
}
}
}

state main
{
state_entry()
{
//
}

changed(integer intChange)
{
if (intChange & CHANGED_INVENTORY)
{ // If the notecard has changed, then reload the notecard
if (keyConfigUUID != llGetInventoryKey(NOTECARD))
{
state default;
}
}

}
}
</lsl>

==See also==
*[[ Script_Library | Script Library ]]

Smooth Sliding Door

2010-10-14T04:39:23Z

SimonT Quinnell:

Basic Notecard Reader

2010-10-14T04:39:14Z

SimonT Quinnell: Created page with '{{LSL Header}} =Basic Notecard Reader= ==Introduction== ==The Script== ==See also== * Script Library '

{{LSL Header}}
=Basic Notecard Reader=

==Introduction==

==The Script==

==See also==
*[[ Script_Library | Script Library ]]

User:SimonT Quinnell

2010-10-14T04:37:20Z

SimonT Quinnell:

A few random scripts that I have written and are free for anyone to use

* [http://wiki.secondlife.com/wiki/Basic_Notecard_Reader Notecard Reader]
* [http://wiki.secondlife.com/wiki/Smooth_Sliding_Door Smooth Sliding door script]
* [http://wiki.secondlife.com/wiki/MultiUser_Dialog_Handler Dialog Handler]

--[[User:SimonT Quinnell|SimonT Quinnell]] 02:39, 1 September 2010 (UTC)

MultiUser Dialog Handler

2010-10-14T04:30:43Z

SimonT Quinnell: /* The Script */

==Introduction==

I found that i was constantly rewriting a pile of dialog handling functions in my scrips so i decided to write a single dialog handler script. It needed to have the following features;

* Support multiple simultaneous menus from different users, scripts and prims.
* Support fixed top buttons that will persist on lists.
* Support fixed bottom buttons with include Back and Exit buttons.
* Handle item lists > 12 and automatically insert << and >> buttons to scroll through the lists.
* Handle timeouts and communicate timeout back to calling script.
* Handles truncation of the buttons and text to stop errors in llDialog

==Using The Script==

===Calling a Simple Menu===
In the script that is calling the menu I use a function something like this.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "FALSE"; //Navigation buttons not displayed
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "TopLeft~Top~TopRight~Left~Center~Right~BottomLeft~Bottom~BottomRight"; // The buttons, each button separated by a '~'.

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|TopLeft|| Top|| TopRight
|-
|Left|| Center || Right
|-
|BottomLeft|| Bottom || BottomRight
|}

===Calling a Simple Menu with Auto-Navigation Buttons===
In this case we now add navigation buttons to the bottom of the script. Back and Exit buttons are added to the bottom and if necessary >> and << buttons. In the script that is calling the menu I use a function something like this.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "TRUE"; //The display of the bottom navigation buttons is set to TRUE
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

This will display a menu that looks something like this.

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|-
| || Back || Exit
|}

===Calling a Complex Menu===
In the following case we will have 10 buttons that are going to be displayed. Because we will also display the bottom 3 buttons this will be spanned across 2 menus. We will also include 2 fixed buttons that always display at the top of the menu, PLUS each button has a unique descriptor that is displayed. Here is the menu call.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"
string menuNavigate = "TRUE";
string menuText = "Main text displayed.~text1~text2~text3~text4~text5~text6~text7~text8~text9~text10";
string menuButtons = "B1~B2~B3~B4~B5~B6~B7~B8~B9~B10";
string menuFixedButtons = "FIXED1~FIXED2"

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons+"|"+menuFixedButtons, id);
}
</lsl>

This will display the following 2 menus

Menu1
Main text displayed.
item1
item2
item3
item4
item5
item6
item7

{| border="1"
|FIXED1 || FIXED2 || B1
|-
|B2 || B3 || B4
|-
|B5 || B6 || B7
|-
| || Back || >>
|}

Menu2 (on clicking the >> button)
Main text displayed.
item8
item9
item10

{| border="1"
|FIXED1 || FIXED2 || B8
|-
| B9 || B10 ||
|-
| << || Back || Exit
|}

===Parsing the returning Menu information===

Note that if the user clicks on the << or >> buttons the calling script WILL NOT see any response. The correct menu is displayed. The calling script only receives a response when one of the buttons or Back/Exit are clicked. Clicking on a space button will cause the menu to redisplay.

The script that expects the response back from the menu has the following

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

default
{
link_message(integer intSenderNum, integer num, string message, key id)
{
if (num == LINK_MENU_RETURN)
{
list returnMenu = llParseString2List(message, ["|"], []);
string menuDescriptor = llList2String(returnMenu,0); // The idenfifying descriptor. I sometimes use the name of the script plus menu and parent menu name

if (menuDescriptor == "mymenu")
{ // Is this a response to "mymenu" from the dialog script?
string item = llList2String(returnMenu,1); // The actual button pushed

// id == the key of the menu user.
// The button pressed in the menu is 'item', so now do something with it
}
}
else if (num == LINK_MENU_TIMEOUT)
{
if (message == "mymenu")
{
// We received a timeout (don't worry the listens are all dealt with) so you might want to IM the menu user.
}
}
}
}
</lsl>

==The Script==
<lsl>
// ********************************************************************
//
// Menu Display Script
//
// Menu command format
// string = menuidentifier | display navigate? TRUE/FALSE | menuMaintitle~subtitle1~subtitle2~subtitle3 | button1~button2~button3 {| fixedbutton1~fixedbutton2~fixedbutton3 optional}
// key = menuuser key
//
// Return is in the format
// "menuidentifier | item"
//
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]
// menusActive [menuchannel, menuhandle, time, page]
//
// by SimonT Quinnell
//
// CHANGES
// 2010/10/14 - Timeout message now gets sent to the prim that called the menu, not LINK_THIS. Also includes menuidentifier
//
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

// Main Menu Details
string BACK = "<<";
string FOWARD = ">>";
list MENU_NAVIGATE_BUTTONS = [ " ", "Back", "Exit"];
float MENU_TIMEOUT_CHECK = 10.0;
integer MENU_TIMEOUT = 120;
integer MAX_TEXT = 510;

integer STRIDE_DESCRIPTION = 8;
integer STRIDE_ACTIVE = 4;
integer DEBUG = FALSE;

// ********************************************************************
// Variables
// ********************************************************************

list menusDescription;
list menusActive;

// ********************************************************************
// Functions - General
// ********************************************************************

debug(string debug)
{
if (DEBUG) llSay(DEBUG_CHANNEL,"DEBUG:"+llGetScriptName()+":"+debug+" : Free("+(string)llGetFreeMemory()+")");
}

integer string2Bool (string test)
{
if (test == "TRUE") return TRUE;
else return FALSE;
}

// ********************************************************************
// Functions - Menu Helpers
// ********************************************************************

integer NewChannel()
{ // generates unique channel number
integer channel;

do channel = -(llRound(llFrand(999999)) + 99999);
while (~llListFindList(menusDescription, [channel]));

return channel;
}

string CheckTitleLength(string title)
{
if (llStringLength(title) > MAX_TEXT) title = llGetSubString(title, 0, MAX_TEXT-1);

return title;
}

list FillMenu(list buttons)
{ //adds empty buttons until the list length is multiple of 3, to max of 12
integer i;
list listButtons;

for(i=0;i<llGetListLength(buttons);i++)
{
string name = llList2String(buttons,i);
if (llStringLength(name) > 24) name = llGetSubString(name, 0, 23);
listButtons = listButtons + [name];
}

while (llGetListLength(listButtons) != 3 && llGetListLength(listButtons) != 6 && llGetListLength(listButtons) != 9 && llGetListLength(listButtons) < 12)
{
listButtons = listButtons + [" "];
}

buttons = llList2List(listButtons, 9, 11);
buttons = buttons + llList2List(listButtons, 6, 8);
buttons = buttons + llList2List(listButtons, 3, 5);
buttons = buttons + llList2List(listButtons, 0, 2);

return buttons;
}

RemoveUser(key id)
{
integer index_id = llListFindList(menusDescription, [id]);

while (~index_id)
{
integer channel = llList2Integer(menusDescription, index_id-1);
RemoveMenu(channel, FALSE);
}
}

RemoveMenu(integer channel, integer echo)
{
integer index = llListFindList(menusDescription, [channel]);

if (index != -1)
{
key menuId = llList2Key(menusDescription, index+1);
string menuDetails = llList2String(menusDescription, index+2);
integer menuLink = llList2Integer(menusDescription, index+3);
menusDescription = llDeleteSubList(menusDescription, index, index + STRIDE_DESCRIPTION - 1);
RemoveListen(channel);

if (echo) llMessageLinked(menuLink, LINK_MENU_TIMEOUT, menuDetails, menuId);
}
}

RemoveListen(integer channel)
{
integer index = llListFindList(menusActive, [channel]);
if (index != -1)
{
llListenRemove(llList2Integer(menusActive, index + 1));
menusActive = llDeleteSubList(menusActive, index, index + STRIDE_ACTIVE - 1);
}
}

// ********************************************************************
// Functions - Menu Main
// ********************************************************************

NewMenu(string message, integer senderNum, key id)
{ // Setup New Menu
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]

list temp = llParseString2List(message, ["|"], []);
integer channel = NewChannel();

if (llGetListLength(temp) > 2)
{
menusDescription = [channel, id, llList2String(temp, 0), senderNum, string2Bool(llList2String(temp, 1)), llList2String(temp, 2), llList2String(temp, 3), llList2String(temp, 4)] + menusDescription;

DisplayMenu(id, channel, 0);
}
else llOwnerSay ("ERROR: Dialog Script. Incorrect menu format");
}

DisplayMenu(key id, integer channel, integer page)
{
string menuTitle;
list menuSubTitles;
list menuButtonsAll;
list menuButtons;
list menuNavigateButtons;
list menuFixedButtons;

integer max = 12;

// Populate values
integer index = llListFindList(menusDescription, [channel]);
menuButtonsAll = llParseString2List(llList2String(menusDescription, index+6), ["~"], []);
if (llList2String(menusDescription, index+7) != "") menuFixedButtons = llParseString2List(llList2String(menusDescription, index+7), ["~"], []);

// Set up the menu buttons
if (llList2Integer(menusDescription, index+4)) menuNavigateButtons= MENU_NAVIGATE_BUTTONS;
else if (llGetListLength(menuButtonsAll) > (max-llGetListLength(menuFixedButtons))) menuNavigateButtons = [" ", " ", " "];

// FIXME: add sanity check for menu page

max = max - llGetListLength(menuFixedButtons) - llGetListLength(menuNavigateButtons);
integer start = page*max;
integer stop = (page+1)*max - 1;
menuButtons = FillMenu(menuFixedButtons + llList2List(menuButtonsAll, start, stop));

// Generate the title
list tempTitle = llParseString2List(llList2String(menusDescription, index+5), ["~"], []);
menuTitle = llList2String(tempTitle,0);
if (llGetListLength(tempTitle) > 1) menuSubTitles = llList2List(tempTitle, 1, -1);
if (llGetListLength(menuSubTitles) > 0)
{
integer i;
for(i=start;i<(stop+1);++i)
{
if (llList2String(menuSubTitles, i) != "") menuTitle += "\n"+llList2String(menuSubTitles, i);
}
}
menuTitle = CheckTitleLength(menuTitle);

// Add navigate buttons if necessary
if (page > 0) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [BACK], 0, 0);
if (llGetListLength(menuButtonsAll) > (page+1)*max) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [FOWARD], 2, 2);

// Set up listen and add the row details
integer menuHandle = llListen(channel, "", id, "");
menusActive = [channel, menuHandle, llGetUnixTime(), page] + menusActive;

llSetTimerEvent(MENU_TIMEOUT_CHECK);

// Display menu
llDialog(id, menuTitle, menuNavigateButtons + menuButtons, channel);
}

// ********************************************************************
// Event Handlers
// ********************************************************************

default
{
listen(integer channel, string name, key id, string message)
{
if (message == BACK)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)-1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == FOWARD)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)+1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == " ")
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3);
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else
{
integer index = llListFindList(menusDescription, [channel]);
llMessageLinked(llList2Integer(menusDescription, index+3), LINK_MENU_RETURN, llList2String(menusDescription, index+2)+"|"+message, id);
RemoveMenu(channel, FALSE);
}
}

link_message(integer senderNum, integer num, string message, key id)
{
if (num == LINK_MENU_DISPLAY) NewMenu(message, senderNum, id);
else if (num == LINK_MENU_CLOSE) RemoveUser(id);
}

timer()
{ // Check through timers and close if necessary
integer i;
list toRemove;
integer currentTime = llGetUnixTime();
integer length = llGetListLength(menusActive);

for(i=0;i<length;i+=STRIDE_ACTIVE)
{
if (currentTime - llList2Integer(menusActive, i+2) > MENU_TIMEOUT) toRemove = [llList2Integer(menusActive, i)] + toRemove;
}

length = llGetListLength(toRemove);
if (length > 0)
{
for(i=0;i<length;i++)
{
RemoveMenu(llList2Integer(toRemove, i), TRUE);
}
}
}
}

</lsl>

==See also==
*[[ Script_Library | Script Library ]]

MultiUser Dialog Handler

2010-10-14T04:27:13Z

SimonT Quinnell: /* Parsing the returning Menu information */

==Introduction==

I found that i was constantly rewriting a pile of dialog handling functions in my scrips so i decided to write a single dialog handler script. It needed to have the following features;

* Support multiple simultaneous menus from different users, scripts and prims.
* Support fixed top buttons that will persist on lists.
* Support fixed bottom buttons with include Back and Exit buttons.
* Handle item lists > 12 and automatically insert << and >> buttons to scroll through the lists.
* Handle timeouts and communicate timeout back to calling script.
* Handles truncation of the buttons and text to stop errors in llDialog

==Using The Script==

===Calling a Simple Menu===
In the script that is calling the menu I use a function something like this.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "FALSE"; //Navigation buttons not displayed
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "TopLeft~Top~TopRight~Left~Center~Right~BottomLeft~Bottom~BottomRight"; // The buttons, each button separated by a '~'.

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|TopLeft|| Top|| TopRight
|-
|Left|| Center || Right
|-
|BottomLeft|| Bottom || BottomRight
|}

===Calling a Simple Menu with Auto-Navigation Buttons===
In this case we now add navigation buttons to the bottom of the script. Back and Exit buttons are added to the bottom and if necessary >> and << buttons. In the script that is calling the menu I use a function something like this.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "TRUE"; //The display of the bottom navigation buttons is set to TRUE
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

This will display a menu that looks something like this.

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|-
| || Back || Exit
|}

===Calling a Complex Menu===
In the following case we will have 10 buttons that are going to be displayed. Because we will also display the bottom 3 buttons this will be spanned across 2 menus. We will also include 2 fixed buttons that always display at the top of the menu, PLUS each button has a unique descriptor that is displayed. Here is the menu call.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"
string menuNavigate = "TRUE";
string menuText = "Main text displayed.~text1~text2~text3~text4~text5~text6~text7~text8~text9~text10";
string menuButtons = "B1~B2~B3~B4~B5~B6~B7~B8~B9~B10";
string menuFixedButtons = "FIXED1~FIXED2"

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons+"|"+menuFixedButtons, id);
}
</lsl>

This will display the following 2 menus

Menu1
Main text displayed.
item1
item2
item3
item4
item5
item6
item7

{| border="1"
|FIXED1 || FIXED2 || B1
|-
|B2 || B3 || B4
|-
|B5 || B6 || B7
|-
| || Back || >>
|}

Menu2 (on clicking the >> button)
Main text displayed.
item8
item9
item10

{| border="1"
|FIXED1 || FIXED2 || B8
|-
| B9 || B10 ||
|-
| << || Back || Exit
|}

===Parsing the returning Menu information===

Note that if the user clicks on the << or >> buttons the calling script WILL NOT see any response. The correct menu is displayed. The calling script only receives a response when one of the buttons or Back/Exit are clicked. Clicking on a space button will cause the menu to redisplay.

The script that expects the response back from the menu has the following

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

default
{
link_message(integer intSenderNum, integer num, string message, key id)
{
if (num == LINK_MENU_RETURN)
{
list returnMenu = llParseString2List(message, ["|"], []);
string menuDescriptor = llList2String(returnMenu,0); // The idenfifying descriptor. I sometimes use the name of the script plus menu and parent menu name

if (menuDescriptor == "mymenu")
{ // Is this a response to "mymenu" from the dialog script?
string item = llList2String(returnMenu,1); // The actual button pushed

// id == the key of the menu user.
// The button pressed in the menu is 'item', so now do something with it
}
}
else if (num == LINK_MENU_TIMEOUT)
{
if (message == "mymenu")
{
// We received a timeout (don't worry the listens are all dealt with) so you might want to IM the menu user.
}
}
}
}
</lsl>

==The Script==
<lsl>
// ********************************************************************
//
// Menu Display Script
//
// Menu command format
// string = menuidentifier | display navigate? TRUE/FALSE | menuMaintitle~subtitle1~subtitle2~subtitle3 | button1~button2~button3 {| fixedbutton1~fixedbutton2~fixedbutton3 optional}
// key = menuuser key
//
// Return is in the format
// "menuidentifier | item"
//
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]
// menusActive [menuchannel, menuhandle, time, page]
//
// by SimonT Quinnell
//
// CHANGES
// 2010/10/14 - Timeout message now gets sent to the prim that called the menu, not LINK_THIS. Also includes menuidentifier
//
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

// Main Menu Details
string BACK = "<<";
string FOWARD = ">>";
list MENU_NAVIGATE_BUTTONS = [ " ", "Back", "Exit"];
float MENU_TIMEOUT_CHECK = 10.0;
integer MENU_TIMEOUT = 120;
integer MAX_TEXT = 510;

integer STRIDE_DESCRIPTION = 8;
integer STRIDE_ACTIVE = 4;
integer DEBUG = FALSE;

// ********************************************************************
// Variables
// ********************************************************************

list menusDescription;
list menusActive;

// ********************************************************************
// Functions - General
// ********************************************************************

debug(string debug)
{
if (DEBUG) llWhisper(0,"DEBUG:"+llGetScriptName()+":"+debug+" : Free("+(string)llGetFreeMemory()+")");
}

integer string2Bool (string test)
{
if (test == "TRUE") return TRUE;
else return FALSE;
}

// ********************************************************************
// Functions - Menu Helpers
// ********************************************************************

integer NewChannel()
{ // generates unique channel number
integer channel;

do channel = -(llRound(llFrand(999999)) + 99999);
while (~llListFindList(menusDescription, [channel]));

return channel;
}

string CheckTitleLength(string title)
{
if (llStringLength(title) > MAX_TEXT) title = llGetSubString(title, 0, MAX_TEXT-1);

return title;
}

list FillMenu(list buttons)
{ //adds empty buttons until the list length is multiple of 3, to max of 12
integer i;
list listButtons;

for(i=0;i<llGetListLength(buttons);i++)
{
string name = llList2String(buttons,i);
if (llStringLength(name) > 24) name = llGetSubString(name, 0, 23);
listButtons = listButtons + [name];
}

while (llGetListLength(listButtons) != 3 && llGetListLength(listButtons) != 6 && llGetListLength(listButtons) != 9 && llGetListLength(listButtons) < 12)
{
listButtons = listButtons + [" "];
}

buttons = llList2List(listButtons, 9, 11);
buttons = buttons + llList2List(listButtons, 6, 8);
buttons = buttons + llList2List(listButtons, 3, 5);
buttons = buttons + llList2List(listButtons, 0, 2);

return buttons;
}

RemoveUser(key id)
{
integer index_id = llListFindList(menusDescription, [id]);

while (~index_id)
{
integer channel = llList2Integer(menusDescription, index_id-1);
RemoveMenu(channel, FALSE);
}
}

RemoveMenu(integer channel, integer echo)
{
integer index = llListFindList(menusDescription, [channel]);

if (index != -1)
{
key menuId = llList2Key(menusDescription, index+1);
string menuDetails = llList2String(menusDescription, index+2);
integer menuLink = llList2Integer(menusDescription, index+3);
menusDescription = llDeleteSubList(menusDescription, index, index + STRIDE_DESCRIPTION - 1);
RemoveListen(channel);

if (echo) llMessageLinked(menuLink, LINK_MENU_TIMEOUT, menuDetails, menuId);
}
}

RemoveListen(integer channel)
{
integer index = llListFindList(menusActive, [channel]);
if (index != -1)
{
llListenRemove(llList2Integer(menusActive, index + 1));
menusActive = llDeleteSubList(menusActive, index, index + STRIDE_ACTIVE - 1);
}
}

// ********************************************************************
// Functions - Menu Main
// ********************************************************************

NewMenu(string message, integer senderNum, key id)
{ // Setup New Menu
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]

list temp = llParseString2List(message, ["|"], []);
integer channel = NewChannel();

if (llGetListLength(temp) > 2)
{
menusDescription = [channel, id, llList2String(temp, 0), senderNum, string2Bool(llList2String(temp, 1)), llList2String(temp, 2), llList2String(temp, 3), llList2String(temp, 4)] + menusDescription;

DisplayMenu(id, channel, 0);
}
else llOwnerSay ("ERROR: Dialog Script. Incorrect menu format");
}

DisplayMenu(key id, integer channel, integer page)
{
string menuTitle;
list menuSubTitles;
list menuButtonsAll;
list menuButtons;
list menuNavigateButtons;
list menuFixedButtons;

integer max = 12;

// Populate values
integer index = llListFindList(menusDescription, [channel]);
menuButtonsAll = llParseString2List(llList2String(menusDescription, index+6), ["~"], []);
if (llList2String(menusDescription, index+7) != "") menuFixedButtons = llParseString2List(llList2String(menusDescription, index+7), ["~"], []);

// Set up the menu buttons
if (llList2Integer(menusDescription, index+4)) menuNavigateButtons= MENU_NAVIGATE_BUTTONS;
else if (llGetListLength(menuButtonsAll) > (max-llGetListLength(menuFixedButtons))) menuNavigateButtons = [" ", " ", " "];

// FIXME: add sanity check for menu page

max = max - llGetListLength(menuFixedButtons) - llGetListLength(menuNavigateButtons);
integer start = page*max;
integer stop = (page+1)*max - 1;
menuButtons = FillMenu(menuFixedButtons + llList2List(menuButtonsAll, start, stop));

// Generate the title
list tempTitle = llParseString2List(llList2String(menusDescription, index+5), ["~"], []);
menuTitle = llList2String(tempTitle,0);
if (llGetListLength(tempTitle) > 1) menuSubTitles = llList2List(tempTitle, 1, -1);
if (llGetListLength(menuSubTitles) > 0)
{
integer i;
for(i=start;i<(stop+1);++i)
{
if (llList2String(menuSubTitles, i) != "") menuTitle += "\n"+llList2String(menuSubTitles, i);
}
}
menuTitle = CheckTitleLength(menuTitle);

// Add navigate buttons if necessary
if (page > 0) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [BACK], 0, 0);
if (llGetListLength(menuButtonsAll) > (page+1)*max) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [FOWARD], 2, 2);

// Set up listen and add the row details
integer menuHandle = llListen(channel, "", id, "");
menusActive = [channel, menuHandle, llGetUnixTime(), page] + menusActive;

llSetTimerEvent(MENU_TIMEOUT_CHECK);

// Display menu
llDialog(id, menuTitle, menuNavigateButtons + menuButtons, channel);
}

// ********************************************************************
// Event Handlers
// ********************************************************************

default
{
listen(integer channel, string name, key id, string message)
{
if (message == BACK)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)-1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == FOWARD)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)+1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == " ")
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3);
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else
{
integer index = llListFindList(menusDescription, [channel]);
llMessageLinked(llList2Integer(menusDescription, index+3), LINK_MENU_RETURN, llList2String(menusDescription, index+2)+"|"+message, id);
RemoveMenu(channel, FALSE);
}
}

link_message(integer senderNum, integer num, string message, key id)
{
if (num == LINK_MENU_DISPLAY) NewMenu(message, senderNum, id);
else if (num == LINK_MENU_CLOSE) RemoveUser(id);
}

timer()
{ // Check through timers and close if necessary
integer i;
list toRemove;
integer currentTime = llGetUnixTime();
integer length = llGetListLength(menusActive);

for(i=0;i<length;i+=STRIDE_ACTIVE)
{
if (currentTime - llList2Integer(menusActive, i+2) > MENU_TIMEOUT) toRemove = [llList2Integer(menusActive, i)] + toRemove;
}

length = llGetListLength(toRemove);
if (length > 0)
{
for(i=0;i<length;i++)
{
RemoveMenu(llList2Integer(toRemove, i), TRUE);
}
}
}
}

</lsl>

==See also==
*[[ Script_Library | Script Library ]]

MultiUser Dialog Handler

2010-10-14T04:26:09Z

SimonT Quinnell: /* Calling a Simple Menu */

==Introduction==

I found that i was constantly rewriting a pile of dialog handling functions in my scrips so i decided to write a single dialog handler script. It needed to have the following features;

* Support multiple simultaneous menus from different users, scripts and prims.
* Support fixed top buttons that will persist on lists.
* Support fixed bottom buttons with include Back and Exit buttons.
* Handle item lists > 12 and automatically insert << and >> buttons to scroll through the lists.
* Handle timeouts and communicate timeout back to calling script.
* Handles truncation of the buttons and text to stop errors in llDialog

==Using The Script==

===Calling a Simple Menu===
In the script that is calling the menu I use a function something like this.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "FALSE"; //Navigation buttons not displayed
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "TopLeft~Top~TopRight~Left~Center~Right~BottomLeft~Bottom~BottomRight"; // The buttons, each button separated by a '~'.

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|TopLeft|| Top|| TopRight
|-
|Left|| Center || Right
|-
|BottomLeft|| Bottom || BottomRight
|}

===Calling a Simple Menu with Auto-Navigation Buttons===
In this case we now add navigation buttons to the bottom of the script. Back and Exit buttons are added to the bottom and if necessary >> and << buttons. In the script that is calling the menu I use a function something like this.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "TRUE"; //The display of the bottom navigation buttons is set to TRUE
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

This will display a menu that looks something like this.

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|-
| || Back || Exit
|}

===Calling a Complex Menu===
In the following case we will have 10 buttons that are going to be displayed. Because we will also display the bottom 3 buttons this will be spanned across 2 menus. We will also include 2 fixed buttons that always display at the top of the menu, PLUS each button has a unique descriptor that is displayed. Here is the menu call.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"
string menuNavigate = "TRUE";
string menuText = "Main text displayed.~text1~text2~text3~text4~text5~text6~text7~text8~text9~text10";
string menuButtons = "B1~B2~B3~B4~B5~B6~B7~B8~B9~B10";
string menuFixedButtons = "FIXED1~FIXED2"

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons+"|"+menuFixedButtons, id);
}
</lsl>

This will display the following 2 menus

Menu1
Main text displayed.
item1
item2
item3
item4
item5
item6
item7

{| border="1"
|FIXED1 || FIXED2 || B1
|-
|B2 || B3 || B4
|-
|B5 || B6 || B7
|-
| || Back || >>
|}

Menu2 (on clicking the >> button)
Main text displayed.
item8
item9
item10

{| border="1"
|FIXED1 || FIXED2 || B8
|-
| B9 || B10 ||
|-
| << || Back || Exit
|}

===Parsing the returning Menu information===

Note that if the user clicks on the << or >> buttons the calling script WILL NOT see any response. The correct menu is displayed. The calling script only receives a response when one of the buttons or Back/Exit are clicked. Clicking on a space button will cause the menu to redisplay.

The script that expects the response back from the menu has the following

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

default
{
link_message(integer intSenderNum, integer num, string message, key id)
{
if (num == LINK_MENU_RETURN)
{
list returnMenu = llParseString2List(message, ["|"], []);
string menuDescriptor = llList2String(returnMenu,0); // The idenfifying descriptor. I sometimes use the name of the script plus menu and parent menu name

if (menuDescriptor == "mymenu")
{ // Is this my menu that is sending this message?
string item = llList2String(returnMenu,1); // The actual button pushed

// id == the key of the menu user.
// The button pressed in the menu is 'item', so now do something with it
}
}
else if (num == LINK_MENU_TIMEOUT)
{
if (message == "mymenu")
{
// We received a timeout (don't worry the listens are all dealt with) so you might want to IM the menu user.
}
}
}
}
</lsl>

==The Script==
<lsl>
// ********************************************************************
//
// Menu Display Script
//
// Menu command format
// string = menuidentifier | display navigate? TRUE/FALSE | menuMaintitle~subtitle1~subtitle2~subtitle3 | button1~button2~button3 {| fixedbutton1~fixedbutton2~fixedbutton3 optional}
// key = menuuser key
//
// Return is in the format
// "menuidentifier | item"
//
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]
// menusActive [menuchannel, menuhandle, time, page]
//
// by SimonT Quinnell
//
// CHANGES
// 2010/10/14 - Timeout message now gets sent to the prim that called the menu, not LINK_THIS. Also includes menuidentifier
//
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

// Main Menu Details
string BACK = "<<";
string FOWARD = ">>";
list MENU_NAVIGATE_BUTTONS = [ " ", "Back", "Exit"];
float MENU_TIMEOUT_CHECK = 10.0;
integer MENU_TIMEOUT = 120;
integer MAX_TEXT = 510;

integer STRIDE_DESCRIPTION = 8;
integer STRIDE_ACTIVE = 4;
integer DEBUG = FALSE;

// ********************************************************************
// Variables
// ********************************************************************

list menusDescription;
list menusActive;

// ********************************************************************
// Functions - General
// ********************************************************************

debug(string debug)
{
if (DEBUG) llWhisper(0,"DEBUG:"+llGetScriptName()+":"+debug+" : Free("+(string)llGetFreeMemory()+")");
}

integer string2Bool (string test)
{
if (test == "TRUE") return TRUE;
else return FALSE;
}

// ********************************************************************
// Functions - Menu Helpers
// ********************************************************************

integer NewChannel()
{ // generates unique channel number
integer channel;

do channel = -(llRound(llFrand(999999)) + 99999);
while (~llListFindList(menusDescription, [channel]));

return channel;
}

string CheckTitleLength(string title)
{
if (llStringLength(title) > MAX_TEXT) title = llGetSubString(title, 0, MAX_TEXT-1);

return title;
}

list FillMenu(list buttons)
{ //adds empty buttons until the list length is multiple of 3, to max of 12
integer i;
list listButtons;

for(i=0;i<llGetListLength(buttons);i++)
{
string name = llList2String(buttons,i);
if (llStringLength(name) > 24) name = llGetSubString(name, 0, 23);
listButtons = listButtons + [name];
}

while (llGetListLength(listButtons) != 3 && llGetListLength(listButtons) != 6 && llGetListLength(listButtons) != 9 && llGetListLength(listButtons) < 12)
{
listButtons = listButtons + [" "];
}

buttons = llList2List(listButtons, 9, 11);
buttons = buttons + llList2List(listButtons, 6, 8);
buttons = buttons + llList2List(listButtons, 3, 5);
buttons = buttons + llList2List(listButtons, 0, 2);

return buttons;
}

RemoveUser(key id)
{
integer index_id = llListFindList(menusDescription, [id]);

while (~index_id)
{
integer channel = llList2Integer(menusDescription, index_id-1);
RemoveMenu(channel, FALSE);
}
}

RemoveMenu(integer channel, integer echo)
{
integer index = llListFindList(menusDescription, [channel]);

if (index != -1)
{
key menuId = llList2Key(menusDescription, index+1);
string menuDetails = llList2String(menusDescription, index+2);
integer menuLink = llList2Integer(menusDescription, index+3);
menusDescription = llDeleteSubList(menusDescription, index, index + STRIDE_DESCRIPTION - 1);
RemoveListen(channel);

if (echo) llMessageLinked(menuLink, LINK_MENU_TIMEOUT, menuDetails, menuId);
}
}

RemoveListen(integer channel)
{
integer index = llListFindList(menusActive, [channel]);
if (index != -1)
{
llListenRemove(llList2Integer(menusActive, index + 1));
menusActive = llDeleteSubList(menusActive, index, index + STRIDE_ACTIVE - 1);
}
}

// ********************************************************************
// Functions - Menu Main
// ********************************************************************

NewMenu(string message, integer senderNum, key id)
{ // Setup New Menu
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]

list temp = llParseString2List(message, ["|"], []);
integer channel = NewChannel();

if (llGetListLength(temp) > 2)
{
menusDescription = [channel, id, llList2String(temp, 0), senderNum, string2Bool(llList2String(temp, 1)), llList2String(temp, 2), llList2String(temp, 3), llList2String(temp, 4)] + menusDescription;

DisplayMenu(id, channel, 0);
}
else llOwnerSay ("ERROR: Dialog Script. Incorrect menu format");
}

DisplayMenu(key id, integer channel, integer page)
{
string menuTitle;
list menuSubTitles;
list menuButtonsAll;
list menuButtons;
list menuNavigateButtons;
list menuFixedButtons;

integer max = 12;

// Populate values
integer index = llListFindList(menusDescription, [channel]);
menuButtonsAll = llParseString2List(llList2String(menusDescription, index+6), ["~"], []);
if (llList2String(menusDescription, index+7) != "") menuFixedButtons = llParseString2List(llList2String(menusDescription, index+7), ["~"], []);

// Set up the menu buttons
if (llList2Integer(menusDescription, index+4)) menuNavigateButtons= MENU_NAVIGATE_BUTTONS;
else if (llGetListLength(menuButtonsAll) > (max-llGetListLength(menuFixedButtons))) menuNavigateButtons = [" ", " ", " "];

// FIXME: add sanity check for menu page

max = max - llGetListLength(menuFixedButtons) - llGetListLength(menuNavigateButtons);
integer start = page*max;
integer stop = (page+1)*max - 1;
menuButtons = FillMenu(menuFixedButtons + llList2List(menuButtonsAll, start, stop));

// Generate the title
list tempTitle = llParseString2List(llList2String(menusDescription, index+5), ["~"], []);
menuTitle = llList2String(tempTitle,0);
if (llGetListLength(tempTitle) > 1) menuSubTitles = llList2List(tempTitle, 1, -1);
if (llGetListLength(menuSubTitles) > 0)
{
integer i;
for(i=start;i<(stop+1);++i)
{
if (llList2String(menuSubTitles, i) != "") menuTitle += "\n"+llList2String(menuSubTitles, i);
}
}
menuTitle = CheckTitleLength(menuTitle);

// Add navigate buttons if necessary
if (page > 0) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [BACK], 0, 0);
if (llGetListLength(menuButtonsAll) > (page+1)*max) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [FOWARD], 2, 2);

// Set up listen and add the row details
integer menuHandle = llListen(channel, "", id, "");
menusActive = [channel, menuHandle, llGetUnixTime(), page] + menusActive;

llSetTimerEvent(MENU_TIMEOUT_CHECK);

// Display menu
llDialog(id, menuTitle, menuNavigateButtons + menuButtons, channel);
}

// ********************************************************************
// Event Handlers
// ********************************************************************

default
{
listen(integer channel, string name, key id, string message)
{
if (message == BACK)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)-1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == FOWARD)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)+1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == " ")
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3);
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else
{
integer index = llListFindList(menusDescription, [channel]);
llMessageLinked(llList2Integer(menusDescription, index+3), LINK_MENU_RETURN, llList2String(menusDescription, index+2)+"|"+message, id);
RemoveMenu(channel, FALSE);
}
}

link_message(integer senderNum, integer num, string message, key id)
{
if (num == LINK_MENU_DISPLAY) NewMenu(message, senderNum, id);
else if (num == LINK_MENU_CLOSE) RemoveUser(id);
}

timer()
{ // Check through timers and close if necessary
integer i;
list toRemove;
integer currentTime = llGetUnixTime();
integer length = llGetListLength(menusActive);

for(i=0;i<length;i+=STRIDE_ACTIVE)
{
if (currentTime - llList2Integer(menusActive, i+2) > MENU_TIMEOUT) toRemove = [llList2Integer(menusActive, i)] + toRemove;
}

length = llGetListLength(toRemove);
if (length > 0)
{
for(i=0;i<length;i++)
{
RemoveMenu(llList2Integer(toRemove, i), TRUE);
}
}
}
}

</lsl>

==See also==
*[[ Script_Library | Script Library ]]

MultiUser Dialog Handler

2010-10-14T04:25:35Z

SimonT Quinnell: /* Calling a Simple Menu with Auto-Navigation Buttons */

==Introduction==

I found that i was constantly rewriting a pile of dialog handling functions in my scrips so i decided to write a single dialog handler script. It needed to have the following features;

* Support multiple simultaneous menus from different users, scripts and prims.
* Support fixed top buttons that will persist on lists.
* Support fixed bottom buttons with include Back and Exit buttons.
* Handle item lists > 12 and automatically insert << and >> buttons to scroll through the lists.
* Handle timeouts and communicate timeout back to calling script.
* Handles truncation of the buttons and text to stop errors in llDialog

==Using The Script==

===Calling a Simple Menu===
In the script that is calling the menu I use a function something like this.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "FALSE"; //Navigation buttons not displayed
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "TopLeft~Top~TopRight~Left~Center~Right~BottomLeft~Bottom~BottomRight"; // The buttons, each button separated by a '~'.

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|TopLeft|| Top|| TopRight
|-
|Left|| Center || Right
|-
|BottomLeft|| Bottom || BottomRight
|}

===Calling a Simple Menu with Auto-Navigation Buttons===
In this case we now add navigation buttons to the bottom of the script. Back and Exit buttons are added to the bottom and if necessary >> and << buttons. In the script that is calling the menu I use a function something like this.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "TRUE"; //The display of the bottom navigation buttons is set to TRUE
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

This will display a menu that looks something like this.

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|-
| || Back || Exit
|}

===Calling a Complex Menu===
In the following case we will have 10 buttons that are going to be displayed. Because we will also display the bottom 3 buttons this will be spanned across 2 menus. We will also include 2 fixed buttons that always display at the top of the menu, PLUS each button has a unique descriptor that is displayed. Here is the menu call.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"
string menuNavigate = "TRUE";
string menuText = "Main text displayed.~text1~text2~text3~text4~text5~text6~text7~text8~text9~text10";
string menuButtons = "B1~B2~B3~B4~B5~B6~B7~B8~B9~B10";
string menuFixedButtons = "FIXED1~FIXED2"

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons+"|"+menuFixedButtons, id);
}
</lsl>

This will display the following 2 menus

Menu1
Main text displayed.
item1
item2
item3
item4
item5
item6
item7

{| border="1"
|FIXED1 || FIXED2 || B1
|-
|B2 || B3 || B4
|-
|B5 || B6 || B7
|-
| || Back || >>
|}

Menu2 (on clicking the >> button)
Main text displayed.
item8
item9
item10

{| border="1"
|FIXED1 || FIXED2 || B8
|-
| B9 || B10 ||
|-
| << || Back || Exit
|}

===Parsing the returning Menu information===

Note that if the user clicks on the << or >> buttons the calling script WILL NOT see any response. The correct menu is displayed. The calling script only receives a response when one of the buttons or Back/Exit are clicked. Clicking on a space button will cause the menu to redisplay.

The script that expects the response back from the menu has the following

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

default
{
link_message(integer intSenderNum, integer num, string message, key id)
{
if (num == LINK_MENU_RETURN)
{
list returnMenu = llParseString2List(message, ["|"], []);
string menuDescriptor = llList2String(returnMenu,0); // The idenfifying descriptor. I sometimes use the name of the script plus menu and parent menu name

if (menuDescriptor == "mymenu")
{ // Is this my menu that is sending this message?
string item = llList2String(returnMenu,1); // The actual button pushed

// id == the key of the menu user.
// The button pressed in the menu is 'item', so now do something with it
}
}
else if (num == LINK_MENU_TIMEOUT)
{
if (message == "mymenu")
{
// We received a timeout (don't worry the listens are all dealt with) so you might want to IM the menu user.
}
}
}
}
</lsl>

==The Script==
<lsl>
// ********************************************************************
//
// Menu Display Script
//
// Menu command format
// string = menuidentifier | display navigate? TRUE/FALSE | menuMaintitle~subtitle1~subtitle2~subtitle3 | button1~button2~button3 {| fixedbutton1~fixedbutton2~fixedbutton3 optional}
// key = menuuser key
//
// Return is in the format
// "menuidentifier | item"
//
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]
// menusActive [menuchannel, menuhandle, time, page]
//
// by SimonT Quinnell
//
// CHANGES
// 2010/10/14 - Timeout message now gets sent to the prim that called the menu, not LINK_THIS. Also includes menuidentifier
//
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

// Main Menu Details
string BACK = "<<";
string FOWARD = ">>";
list MENU_NAVIGATE_BUTTONS = [ " ", "Back", "Exit"];
float MENU_TIMEOUT_CHECK = 10.0;
integer MENU_TIMEOUT = 120;
integer MAX_TEXT = 510;

integer STRIDE_DESCRIPTION = 8;
integer STRIDE_ACTIVE = 4;
integer DEBUG = FALSE;

// ********************************************************************
// Variables
// ********************************************************************

list menusDescription;
list menusActive;

// ********************************************************************
// Functions - General
// ********************************************************************

debug(string debug)
{
if (DEBUG) llWhisper(0,"DEBUG:"+llGetScriptName()+":"+debug+" : Free("+(string)llGetFreeMemory()+")");
}

integer string2Bool (string test)
{
if (test == "TRUE") return TRUE;
else return FALSE;
}

// ********************************************************************
// Functions - Menu Helpers
// ********************************************************************

integer NewChannel()
{ // generates unique channel number
integer channel;

do channel = -(llRound(llFrand(999999)) + 99999);
while (~llListFindList(menusDescription, [channel]));

return channel;
}

string CheckTitleLength(string title)
{
if (llStringLength(title) > MAX_TEXT) title = llGetSubString(title, 0, MAX_TEXT-1);

return title;
}

list FillMenu(list buttons)
{ //adds empty buttons until the list length is multiple of 3, to max of 12
integer i;
list listButtons;

for(i=0;i<llGetListLength(buttons);i++)
{
string name = llList2String(buttons,i);
if (llStringLength(name) > 24) name = llGetSubString(name, 0, 23);
listButtons = listButtons + [name];
}

while (llGetListLength(listButtons) != 3 && llGetListLength(listButtons) != 6 && llGetListLength(listButtons) != 9 && llGetListLength(listButtons) < 12)
{
listButtons = listButtons + [" "];
}

buttons = llList2List(listButtons, 9, 11);
buttons = buttons + llList2List(listButtons, 6, 8);
buttons = buttons + llList2List(listButtons, 3, 5);
buttons = buttons + llList2List(listButtons, 0, 2);

return buttons;
}

RemoveUser(key id)
{
integer index_id = llListFindList(menusDescription, [id]);

while (~index_id)
{
integer channel = llList2Integer(menusDescription, index_id-1);
RemoveMenu(channel, FALSE);
}
}

RemoveMenu(integer channel, integer echo)
{
integer index = llListFindList(menusDescription, [channel]);

if (index != -1)
{
key menuId = llList2Key(menusDescription, index+1);
string menuDetails = llList2String(menusDescription, index+2);
integer menuLink = llList2Integer(menusDescription, index+3);
menusDescription = llDeleteSubList(menusDescription, index, index + STRIDE_DESCRIPTION - 1);
RemoveListen(channel);

if (echo) llMessageLinked(menuLink, LINK_MENU_TIMEOUT, menuDetails, menuId);
}
}

RemoveListen(integer channel)
{
integer index = llListFindList(menusActive, [channel]);
if (index != -1)
{
llListenRemove(llList2Integer(menusActive, index + 1));
menusActive = llDeleteSubList(menusActive, index, index + STRIDE_ACTIVE - 1);
}
}

// ********************************************************************
// Functions - Menu Main
// ********************************************************************

NewMenu(string message, integer senderNum, key id)
{ // Setup New Menu
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]

list temp = llParseString2List(message, ["|"], []);
integer channel = NewChannel();

if (llGetListLength(temp) > 2)
{
menusDescription = [channel, id, llList2String(temp, 0), senderNum, string2Bool(llList2String(temp, 1)), llList2String(temp, 2), llList2String(temp, 3), llList2String(temp, 4)] + menusDescription;

DisplayMenu(id, channel, 0);
}
else llOwnerSay ("ERROR: Dialog Script. Incorrect menu format");
}

DisplayMenu(key id, integer channel, integer page)
{
string menuTitle;
list menuSubTitles;
list menuButtonsAll;
list menuButtons;
list menuNavigateButtons;
list menuFixedButtons;

integer max = 12;

// Populate values
integer index = llListFindList(menusDescription, [channel]);
menuButtonsAll = llParseString2List(llList2String(menusDescription, index+6), ["~"], []);
if (llList2String(menusDescription, index+7) != "") menuFixedButtons = llParseString2List(llList2String(menusDescription, index+7), ["~"], []);

// Set up the menu buttons
if (llList2Integer(menusDescription, index+4)) menuNavigateButtons= MENU_NAVIGATE_BUTTONS;
else if (llGetListLength(menuButtonsAll) > (max-llGetListLength(menuFixedButtons))) menuNavigateButtons = [" ", " ", " "];

// FIXME: add sanity check for menu page

max = max - llGetListLength(menuFixedButtons) - llGetListLength(menuNavigateButtons);
integer start = page*max;
integer stop = (page+1)*max - 1;
menuButtons = FillMenu(menuFixedButtons + llList2List(menuButtonsAll, start, stop));

// Generate the title
list tempTitle = llParseString2List(llList2String(menusDescription, index+5), ["~"], []);
menuTitle = llList2String(tempTitle,0);
if (llGetListLength(tempTitle) > 1) menuSubTitles = llList2List(tempTitle, 1, -1);
if (llGetListLength(menuSubTitles) > 0)
{
integer i;
for(i=start;i<(stop+1);++i)
{
if (llList2String(menuSubTitles, i) != "") menuTitle += "\n"+llList2String(menuSubTitles, i);
}
}
menuTitle = CheckTitleLength(menuTitle);

// Add navigate buttons if necessary
if (page > 0) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [BACK], 0, 0);
if (llGetListLength(menuButtonsAll) > (page+1)*max) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [FOWARD], 2, 2);

// Set up listen and add the row details
integer menuHandle = llListen(channel, "", id, "");
menusActive = [channel, menuHandle, llGetUnixTime(), page] + menusActive;

llSetTimerEvent(MENU_TIMEOUT_CHECK);

// Display menu
llDialog(id, menuTitle, menuNavigateButtons + menuButtons, channel);
}

// ********************************************************************
// Event Handlers
// ********************************************************************

default
{
listen(integer channel, string name, key id, string message)
{
if (message == BACK)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)-1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == FOWARD)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)+1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == " ")
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3);
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else
{
integer index = llListFindList(menusDescription, [channel]);
llMessageLinked(llList2Integer(menusDescription, index+3), LINK_MENU_RETURN, llList2String(menusDescription, index+2)+"|"+message, id);
RemoveMenu(channel, FALSE);
}
}

link_message(integer senderNum, integer num, string message, key id)
{
if (num == LINK_MENU_DISPLAY) NewMenu(message, senderNum, id);
else if (num == LINK_MENU_CLOSE) RemoveUser(id);
}

timer()
{ // Check through timers and close if necessary
integer i;
list toRemove;
integer currentTime = llGetUnixTime();
integer length = llGetListLength(menusActive);

for(i=0;i<length;i+=STRIDE_ACTIVE)
{
if (currentTime - llList2Integer(menusActive, i+2) > MENU_TIMEOUT) toRemove = [llList2Integer(menusActive, i)] + toRemove;
}

length = llGetListLength(toRemove);
if (length > 0)
{
for(i=0;i<length;i++)
{
RemoveMenu(llList2Integer(toRemove, i), TRUE);
}
}
}
}

</lsl>

==See also==
*[[ Script_Library | Script Library ]]

MultiUser Dialog Handler

2010-10-14T04:25:03Z

SimonT Quinnell: /* Calling a Simple Menu with Auto-Navigation Buttons */

==Introduction==

I found that i was constantly rewriting a pile of dialog handling functions in my scrips so i decided to write a single dialog handler script. It needed to have the following features;

* Support multiple simultaneous menus from different users, scripts and prims.
* Support fixed top buttons that will persist on lists.
* Support fixed bottom buttons with include Back and Exit buttons.
* Handle item lists > 12 and automatically insert << and >> buttons to scroll through the lists.
* Handle timeouts and communicate timeout back to calling script.
* Handles truncation of the buttons and text to stop errors in llDialog

==Using The Script==

===Calling a Simple Menu===
In the script that is calling the menu I use a function something like this.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "FALSE"; //Navigation buttons not displayed
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "TopLeft~Top~TopRight~Left~Center~Right~BottomLeft~Bottom~BottomRight"; // The buttons, each button separated by a '~'.

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|TopLeft|| Top|| TopRight
|-
|Left|| Center || Right
|-
|BottomLeft|| Bottom || BottomRight
|}

===Calling a Simple Menu with Auto-Navigation Buttons===
In this case we now add navigation buttons to the bottom of the script. Back and Exit buttons are added to the bootom and if necessary >> and << buttons. In the script that is calling the menu I use a function something like this.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "TRUE"; //The display of the bottom navigation buttons is set to TRUE
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

This will display a menu that looks something like this.

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|-
| || Back || Exit
|}

===Calling a Complex Menu===
In the following case we will have 10 buttons that are going to be displayed. Because we will also display the bottom 3 buttons this will be spanned across 2 menus. We will also include 2 fixed buttons that always display at the top of the menu, PLUS each button has a unique descriptor that is displayed. Here is the menu call.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"
string menuNavigate = "TRUE";
string menuText = "Main text displayed.~text1~text2~text3~text4~text5~text6~text7~text8~text9~text10";
string menuButtons = "B1~B2~B3~B4~B5~B6~B7~B8~B9~B10";
string menuFixedButtons = "FIXED1~FIXED2"

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons+"|"+menuFixedButtons, id);
}
</lsl>

This will display the following 2 menus

Menu1
Main text displayed.
item1
item2
item3
item4
item5
item6
item7

{| border="1"
|FIXED1 || FIXED2 || B1
|-
|B2 || B3 || B4
|-
|B5 || B6 || B7
|-
| || Back || >>
|}

Menu2 (on clicking the >> button)
Main text displayed.
item8
item9
item10

{| border="1"
|FIXED1 || FIXED2 || B8
|-
| B9 || B10 ||
|-
| << || Back || Exit
|}

===Parsing the returning Menu information===

Note that if the user clicks on the << or >> buttons the calling script WILL NOT see any response. The correct menu is displayed. The calling script only receives a response when one of the buttons or Back/Exit are clicked. Clicking on a space button will cause the menu to redisplay.

The script that expects the response back from the menu has the following

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

default
{
link_message(integer intSenderNum, integer num, string message, key id)
{
if (num == LINK_MENU_RETURN)
{
list returnMenu = llParseString2List(message, ["|"], []);
string menuDescriptor = llList2String(returnMenu,0); // The idenfifying descriptor. I sometimes use the name of the script plus menu and parent menu name

if (menuDescriptor == "mymenu")
{ // Is this my menu that is sending this message?
string item = llList2String(returnMenu,1); // The actual button pushed

// id == the key of the menu user.
// The button pressed in the menu is 'item', so now do something with it
}
}
else if (num == LINK_MENU_TIMEOUT)
{
if (message == "mymenu")
{
// We received a timeout (don't worry the listens are all dealt with) so you might want to IM the menu user.
}
}
}
}
</lsl>

==The Script==
<lsl>
// ********************************************************************
//
// Menu Display Script
//
// Menu command format
// string = menuidentifier | display navigate? TRUE/FALSE | menuMaintitle~subtitle1~subtitle2~subtitle3 | button1~button2~button3 {| fixedbutton1~fixedbutton2~fixedbutton3 optional}
// key = menuuser key
//
// Return is in the format
// "menuidentifier | item"
//
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]
// menusActive [menuchannel, menuhandle, time, page]
//
// by SimonT Quinnell
//
// CHANGES
// 2010/10/14 - Timeout message now gets sent to the prim that called the menu, not LINK_THIS. Also includes menuidentifier
//
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

// Main Menu Details
string BACK = "<<";
string FOWARD = ">>";
list MENU_NAVIGATE_BUTTONS = [ " ", "Back", "Exit"];
float MENU_TIMEOUT_CHECK = 10.0;
integer MENU_TIMEOUT = 120;
integer MAX_TEXT = 510;

integer STRIDE_DESCRIPTION = 8;
integer STRIDE_ACTIVE = 4;
integer DEBUG = FALSE;

// ********************************************************************
// Variables
// ********************************************************************

list menusDescription;
list menusActive;

// ********************************************************************
// Functions - General
// ********************************************************************

debug(string debug)
{
if (DEBUG) llWhisper(0,"DEBUG:"+llGetScriptName()+":"+debug+" : Free("+(string)llGetFreeMemory()+")");
}

integer string2Bool (string test)
{
if (test == "TRUE") return TRUE;
else return FALSE;
}

// ********************************************************************
// Functions - Menu Helpers
// ********************************************************************

integer NewChannel()
{ // generates unique channel number
integer channel;

do channel = -(llRound(llFrand(999999)) + 99999);
while (~llListFindList(menusDescription, [channel]));

return channel;
}

string CheckTitleLength(string title)
{
if (llStringLength(title) > MAX_TEXT) title = llGetSubString(title, 0, MAX_TEXT-1);

return title;
}

list FillMenu(list buttons)
{ //adds empty buttons until the list length is multiple of 3, to max of 12
integer i;
list listButtons;

for(i=0;i<llGetListLength(buttons);i++)
{
string name = llList2String(buttons,i);
if (llStringLength(name) > 24) name = llGetSubString(name, 0, 23);
listButtons = listButtons + [name];
}

while (llGetListLength(listButtons) != 3 && llGetListLength(listButtons) != 6 && llGetListLength(listButtons) != 9 && llGetListLength(listButtons) < 12)
{
listButtons = listButtons + [" "];
}

buttons = llList2List(listButtons, 9, 11);
buttons = buttons + llList2List(listButtons, 6, 8);
buttons = buttons + llList2List(listButtons, 3, 5);
buttons = buttons + llList2List(listButtons, 0, 2);

return buttons;
}

RemoveUser(key id)
{
integer index_id = llListFindList(menusDescription, [id]);

while (~index_id)
{
integer channel = llList2Integer(menusDescription, index_id-1);
RemoveMenu(channel, FALSE);
}
}

RemoveMenu(integer channel, integer echo)
{
integer index = llListFindList(menusDescription, [channel]);

if (index != -1)
{
key menuId = llList2Key(menusDescription, index+1);
string menuDetails = llList2String(menusDescription, index+2);
integer menuLink = llList2Integer(menusDescription, index+3);
menusDescription = llDeleteSubList(menusDescription, index, index + STRIDE_DESCRIPTION - 1);
RemoveListen(channel);

if (echo) llMessageLinked(menuLink, LINK_MENU_TIMEOUT, menuDetails, menuId);
}
}

RemoveListen(integer channel)
{
integer index = llListFindList(menusActive, [channel]);
if (index != -1)
{
llListenRemove(llList2Integer(menusActive, index + 1));
menusActive = llDeleteSubList(menusActive, index, index + STRIDE_ACTIVE - 1);
}
}

// ********************************************************************
// Functions - Menu Main
// ********************************************************************

NewMenu(string message, integer senderNum, key id)
{ // Setup New Menu
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]

list temp = llParseString2List(message, ["|"], []);
integer channel = NewChannel();

if (llGetListLength(temp) > 2)
{
menusDescription = [channel, id, llList2String(temp, 0), senderNum, string2Bool(llList2String(temp, 1)), llList2String(temp, 2), llList2String(temp, 3), llList2String(temp, 4)] + menusDescription;

DisplayMenu(id, channel, 0);
}
else llOwnerSay ("ERROR: Dialog Script. Incorrect menu format");
}

DisplayMenu(key id, integer channel, integer page)
{
string menuTitle;
list menuSubTitles;
list menuButtonsAll;
list menuButtons;
list menuNavigateButtons;
list menuFixedButtons;

integer max = 12;

// Populate values
integer index = llListFindList(menusDescription, [channel]);
menuButtonsAll = llParseString2List(llList2String(menusDescription, index+6), ["~"], []);
if (llList2String(menusDescription, index+7) != "") menuFixedButtons = llParseString2List(llList2String(menusDescription, index+7), ["~"], []);

// Set up the menu buttons
if (llList2Integer(menusDescription, index+4)) menuNavigateButtons= MENU_NAVIGATE_BUTTONS;
else if (llGetListLength(menuButtonsAll) > (max-llGetListLength(menuFixedButtons))) menuNavigateButtons = [" ", " ", " "];

// FIXME: add sanity check for menu page

max = max - llGetListLength(menuFixedButtons) - llGetListLength(menuNavigateButtons);
integer start = page*max;
integer stop = (page+1)*max - 1;
menuButtons = FillMenu(menuFixedButtons + llList2List(menuButtonsAll, start, stop));

// Generate the title
list tempTitle = llParseString2List(llList2String(menusDescription, index+5), ["~"], []);
menuTitle = llList2String(tempTitle,0);
if (llGetListLength(tempTitle) > 1) menuSubTitles = llList2List(tempTitle, 1, -1);
if (llGetListLength(menuSubTitles) > 0)
{
integer i;
for(i=start;i<(stop+1);++i)
{
if (llList2String(menuSubTitles, i) != "") menuTitle += "\n"+llList2String(menuSubTitles, i);
}
}
menuTitle = CheckTitleLength(menuTitle);

// Add navigate buttons if necessary
if (page > 0) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [BACK], 0, 0);
if (llGetListLength(menuButtonsAll) > (page+1)*max) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [FOWARD], 2, 2);

// Set up listen and add the row details
integer menuHandle = llListen(channel, "", id, "");
menusActive = [channel, menuHandle, llGetUnixTime(), page] + menusActive;

llSetTimerEvent(MENU_TIMEOUT_CHECK);

// Display menu
llDialog(id, menuTitle, menuNavigateButtons + menuButtons, channel);
}

// ********************************************************************
// Event Handlers
// ********************************************************************

default
{
listen(integer channel, string name, key id, string message)
{
if (message == BACK)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)-1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == FOWARD)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)+1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == " ")
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3);
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else
{
integer index = llListFindList(menusDescription, [channel]);
llMessageLinked(llList2Integer(menusDescription, index+3), LINK_MENU_RETURN, llList2String(menusDescription, index+2)+"|"+message, id);
RemoveMenu(channel, FALSE);
}
}

link_message(integer senderNum, integer num, string message, key id)
{
if (num == LINK_MENU_DISPLAY) NewMenu(message, senderNum, id);
else if (num == LINK_MENU_CLOSE) RemoveUser(id);
}

timer()
{ // Check through timers and close if necessary
integer i;
list toRemove;
integer currentTime = llGetUnixTime();
integer length = llGetListLength(menusActive);

for(i=0;i<length;i+=STRIDE_ACTIVE)
{
if (currentTime - llList2Integer(menusActive, i+2) > MENU_TIMEOUT) toRemove = [llList2Integer(menusActive, i)] + toRemove;
}

length = llGetListLength(toRemove);
if (length > 0)
{
for(i=0;i<length;i++)
{
RemoveMenu(llList2Integer(toRemove, i), TRUE);
}
}
}
}

</lsl>

==See also==
*[[ Script_Library | Script Library ]]

MultiUser Dialog Handler

2010-10-14T04:24:46Z

SimonT Quinnell: /* Calling a Complex Menu */

==Introduction==

I found that i was constantly rewriting a pile of dialog handling functions in my scrips so i decided to write a single dialog handler script. It needed to have the following features;

* Support multiple simultaneous menus from different users, scripts and prims.
* Support fixed top buttons that will persist on lists.
* Support fixed bottom buttons with include Back and Exit buttons.
* Handle item lists > 12 and automatically insert << and >> buttons to scroll through the lists.
* Handle timeouts and communicate timeout back to calling script.
* Handles truncation of the buttons and text to stop errors in llDialog

==Using The Script==

===Calling a Simple Menu===
In the script that is calling the menu I use a function something like this.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "FALSE"; //Navigation buttons not displayed
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "TopLeft~Top~TopRight~Left~Center~Right~BottomLeft~Bottom~BottomRight"; // The buttons, each button separated by a '~'.

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|TopLeft|| Top|| TopRight
|-
|Left|| Center || Right
|-
|BottomLeft|| Bottom || BottomRight
|}

===Calling a Simple Menu with Auto-Navigation Buttons===
In this case we now add navigation buttons to the bottom of the script. Back and Exit buttons are added to the bootom and if necessary >> and << buttons. In the script that is calling the menu I use a function something like this.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "TRUE"; //The display of the bottom navigation buttons is set to TRUE
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

This will display a menu that looks something like this.

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|-
| || Back || Exit
|}

===Calling a Complex Menu===
In the following case we will have 10 buttons that are going to be displayed. Because we will also display the bottom 3 buttons this will be spanned across 2 menus. We will also include 2 fixed buttons that always display at the top of the menu, PLUS each button has a unique descriptor that is displayed. Here is the menu call.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"
string menuNavigate = "TRUE";
string menuText = "Main text displayed.~text1~text2~text3~text4~text5~text6~text7~text8~text9~text10";
string menuButtons = "B1~B2~B3~B4~B5~B6~B7~B8~B9~B10";
string menuFixedButtons = "FIXED1~FIXED2"

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons+"|"+menuFixedButtons, id);
}
</lsl>

This will display the following 2 menus

Menu1
Main text displayed.
item1
item2
item3
item4
item5
item6
item7

{| border="1"
|FIXED1 || FIXED2 || B1
|-
|B2 || B3 || B4
|-
|B5 || B6 || B7
|-
| || Back || >>
|}

Menu2 (on clicking the >> button)
Main text displayed.
item8
item9
item10

{| border="1"
|FIXED1 || FIXED2 || B8
|-
| B9 || B10 ||
|-
| << || Back || Exit
|}

===Parsing the returning Menu information===

Note that if the user clicks on the << or >> buttons the calling script WILL NOT see any response. The correct menu is displayed. The calling script only receives a response when one of the buttons or Back/Exit are clicked. Clicking on a space button will cause the menu to redisplay.

The script that expects the response back from the menu has the following

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

default
{
link_message(integer intSenderNum, integer num, string message, key id)
{
if (num == LINK_MENU_RETURN)
{
list returnMenu = llParseString2List(message, ["|"], []);
string menuDescriptor = llList2String(returnMenu,0); // The idenfifying descriptor. I sometimes use the name of the script plus menu and parent menu name

if (menuDescriptor == "mymenu")
{ // Is this my menu that is sending this message?
string item = llList2String(returnMenu,1); // The actual button pushed

// id == the key of the menu user.
// The button pressed in the menu is 'item', so now do something with it
}
}
else if (num == LINK_MENU_TIMEOUT)
{
if (message == "mymenu")
{
// We received a timeout (don't worry the listens are all dealt with) so you might want to IM the menu user.
}
}
}
}
</lsl>

==The Script==
<lsl>
// ********************************************************************
//
// Menu Display Script
//
// Menu command format
// string = menuidentifier | display navigate? TRUE/FALSE | menuMaintitle~subtitle1~subtitle2~subtitle3 | button1~button2~button3 {| fixedbutton1~fixedbutton2~fixedbutton3 optional}
// key = menuuser key
//
// Return is in the format
// "menuidentifier | item"
//
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]
// menusActive [menuchannel, menuhandle, time, page]
//
// by SimonT Quinnell
//
// CHANGES
// 2010/10/14 - Timeout message now gets sent to the prim that called the menu, not LINK_THIS. Also includes menuidentifier
//
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

// Main Menu Details
string BACK = "<<";
string FOWARD = ">>";
list MENU_NAVIGATE_BUTTONS = [ " ", "Back", "Exit"];
float MENU_TIMEOUT_CHECK = 10.0;
integer MENU_TIMEOUT = 120;
integer MAX_TEXT = 510;

integer STRIDE_DESCRIPTION = 8;
integer STRIDE_ACTIVE = 4;
integer DEBUG = FALSE;

// ********************************************************************
// Variables
// ********************************************************************

list menusDescription;
list menusActive;

// ********************************************************************
// Functions - General
// ********************************************************************

debug(string debug)
{
if (DEBUG) llWhisper(0,"DEBUG:"+llGetScriptName()+":"+debug+" : Free("+(string)llGetFreeMemory()+")");
}

integer string2Bool (string test)
{
if (test == "TRUE") return TRUE;
else return FALSE;
}

// ********************************************************************
// Functions - Menu Helpers
// ********************************************************************

integer NewChannel()
{ // generates unique channel number
integer channel;

do channel = -(llRound(llFrand(999999)) + 99999);
while (~llListFindList(menusDescription, [channel]));

return channel;
}

string CheckTitleLength(string title)
{
if (llStringLength(title) > MAX_TEXT) title = llGetSubString(title, 0, MAX_TEXT-1);

return title;
}

list FillMenu(list buttons)
{ //adds empty buttons until the list length is multiple of 3, to max of 12
integer i;
list listButtons;

for(i=0;i<llGetListLength(buttons);i++)
{
string name = llList2String(buttons,i);
if (llStringLength(name) > 24) name = llGetSubString(name, 0, 23);
listButtons = listButtons + [name];
}

while (llGetListLength(listButtons) != 3 && llGetListLength(listButtons) != 6 && llGetListLength(listButtons) != 9 && llGetListLength(listButtons) < 12)
{
listButtons = listButtons + [" "];
}

buttons = llList2List(listButtons, 9, 11);
buttons = buttons + llList2List(listButtons, 6, 8);
buttons = buttons + llList2List(listButtons, 3, 5);
buttons = buttons + llList2List(listButtons, 0, 2);

return buttons;
}

RemoveUser(key id)
{
integer index_id = llListFindList(menusDescription, [id]);

while (~index_id)
{
integer channel = llList2Integer(menusDescription, index_id-1);
RemoveMenu(channel, FALSE);
}
}

RemoveMenu(integer channel, integer echo)
{
integer index = llListFindList(menusDescription, [channel]);

if (index != -1)
{
key menuId = llList2Key(menusDescription, index+1);
string menuDetails = llList2String(menusDescription, index+2);
integer menuLink = llList2Integer(menusDescription, index+3);
menusDescription = llDeleteSubList(menusDescription, index, index + STRIDE_DESCRIPTION - 1);
RemoveListen(channel);

if (echo) llMessageLinked(menuLink, LINK_MENU_TIMEOUT, menuDetails, menuId);
}
}

RemoveListen(integer channel)
{
integer index = llListFindList(menusActive, [channel]);
if (index != -1)
{
llListenRemove(llList2Integer(menusActive, index + 1));
menusActive = llDeleteSubList(menusActive, index, index + STRIDE_ACTIVE - 1);
}
}

// ********************************************************************
// Functions - Menu Main
// ********************************************************************

NewMenu(string message, integer senderNum, key id)
{ // Setup New Menu
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]

list temp = llParseString2List(message, ["|"], []);
integer channel = NewChannel();

if (llGetListLength(temp) > 2)
{
menusDescription = [channel, id, llList2String(temp, 0), senderNum, string2Bool(llList2String(temp, 1)), llList2String(temp, 2), llList2String(temp, 3), llList2String(temp, 4)] + menusDescription;

DisplayMenu(id, channel, 0);
}
else llOwnerSay ("ERROR: Dialog Script. Incorrect menu format");
}

DisplayMenu(key id, integer channel, integer page)
{
string menuTitle;
list menuSubTitles;
list menuButtonsAll;
list menuButtons;
list menuNavigateButtons;
list menuFixedButtons;

integer max = 12;

// Populate values
integer index = llListFindList(menusDescription, [channel]);
menuButtonsAll = llParseString2List(llList2String(menusDescription, index+6), ["~"], []);
if (llList2String(menusDescription, index+7) != "") menuFixedButtons = llParseString2List(llList2String(menusDescription, index+7), ["~"], []);

// Set up the menu buttons
if (llList2Integer(menusDescription, index+4)) menuNavigateButtons= MENU_NAVIGATE_BUTTONS;
else if (llGetListLength(menuButtonsAll) > (max-llGetListLength(menuFixedButtons))) menuNavigateButtons = [" ", " ", " "];

// FIXME: add sanity check for menu page

max = max - llGetListLength(menuFixedButtons) - llGetListLength(menuNavigateButtons);
integer start = page*max;
integer stop = (page+1)*max - 1;
menuButtons = FillMenu(menuFixedButtons + llList2List(menuButtonsAll, start, stop));

// Generate the title
list tempTitle = llParseString2List(llList2String(menusDescription, index+5), ["~"], []);
menuTitle = llList2String(tempTitle,0);
if (llGetListLength(tempTitle) > 1) menuSubTitles = llList2List(tempTitle, 1, -1);
if (llGetListLength(menuSubTitles) > 0)
{
integer i;
for(i=start;i<(stop+1);++i)
{
if (llList2String(menuSubTitles, i) != "") menuTitle += "\n"+llList2String(menuSubTitles, i);
}
}
menuTitle = CheckTitleLength(menuTitle);

// Add navigate buttons if necessary
if (page > 0) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [BACK], 0, 0);
if (llGetListLength(menuButtonsAll) > (page+1)*max) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [FOWARD], 2, 2);

// Set up listen and add the row details
integer menuHandle = llListen(channel, "", id, "");
menusActive = [channel, menuHandle, llGetUnixTime(), page] + menusActive;

llSetTimerEvent(MENU_TIMEOUT_CHECK);

// Display menu
llDialog(id, menuTitle, menuNavigateButtons + menuButtons, channel);
}

// ********************************************************************
// Event Handlers
// ********************************************************************

default
{
listen(integer channel, string name, key id, string message)
{
if (message == BACK)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)-1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == FOWARD)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)+1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == " ")
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3);
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else
{
integer index = llListFindList(menusDescription, [channel]);
llMessageLinked(llList2Integer(menusDescription, index+3), LINK_MENU_RETURN, llList2String(menusDescription, index+2)+"|"+message, id);
RemoveMenu(channel, FALSE);
}
}

link_message(integer senderNum, integer num, string message, key id)
{
if (num == LINK_MENU_DISPLAY) NewMenu(message, senderNum, id);
else if (num == LINK_MENU_CLOSE) RemoveUser(id);
}

timer()
{ // Check through timers and close if necessary
integer i;
list toRemove;
integer currentTime = llGetUnixTime();
integer length = llGetListLength(menusActive);

for(i=0;i<length;i+=STRIDE_ACTIVE)
{
if (currentTime - llList2Integer(menusActive, i+2) > MENU_TIMEOUT) toRemove = [llList2Integer(menusActive, i)] + toRemove;
}

length = llGetListLength(toRemove);
if (length > 0)
{
for(i=0;i<length;i++)
{
RemoveMenu(llList2Integer(toRemove, i), TRUE);
}
}
}
}

</lsl>

==See also==
*[[ Script_Library | Script Library ]]

MultiUser Dialog Handler

2010-10-14T04:24:30Z

SimonT Quinnell: /* Parsing the returning Menu information */

==Introduction==

I found that i was constantly rewriting a pile of dialog handling functions in my scrips so i decided to write a single dialog handler script. It needed to have the following features;

* Support multiple simultaneous menus from different users, scripts and prims.
* Support fixed top buttons that will persist on lists.
* Support fixed bottom buttons with include Back and Exit buttons.
* Handle item lists > 12 and automatically insert << and >> buttons to scroll through the lists.
* Handle timeouts and communicate timeout back to calling script.
* Handles truncation of the buttons and text to stop errors in llDialog

==Using The Script==

===Calling a Simple Menu===
In the script that is calling the menu I use a function something like this.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "FALSE"; //Navigation buttons not displayed
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "TopLeft~Top~TopRight~Left~Center~Right~BottomLeft~Bottom~BottomRight"; // The buttons, each button separated by a '~'.

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|TopLeft|| Top|| TopRight
|-
|Left|| Center || Right
|-
|BottomLeft|| Bottom || BottomRight
|}

===Calling a Simple Menu with Auto-Navigation Buttons===
In this case we now add navigation buttons to the bottom of the script. Back and Exit buttons are added to the bootom and if necessary >> and << buttons. In the script that is calling the menu I use a function something like this.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "TRUE"; //The display of the bottom navigation buttons is set to TRUE
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

This will display a menu that looks something like this.

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|-
| || Back || Exit
|}

===Calling a Complex Menu===
In the following case we will have 10 buttons that are going to be displayed. Because we will also display the bottom 3 buttons this will be spanned across 2 menus. We will also include 2 fixed buttons that always display at the top of the menu, PLUS each button has a unique descriptor that is displayed. Here is the menu call.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"
string menuNavigate = "TRUE";
string menuText = "Main text displayed.~text1~text2~text3~text4~text5~text6~text7~text8~text9~text10";
string menuButtons = "B1~B2~B3~B4~B5~B6~B7~B8~B9~B10";
string menuFixedButtons = "FIXED1~FIXED2"

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons+"|"+menuFixedButtons, id);
}
</lsl>

This will display the following 2 menus

Menu1
Main text displayed.
item1
item2
item3
item4
item5
item6
item7

{| border="1"
|FIXED1 || FIXED2 || B1
|-
|B2 || B3 || B4
|-
|B5 || B6 || B7
|-
| || Back || >>
|}

Menu2 (on clicking the >> button)
Main text displayed.
item8
item9
item10

{| border="1"
|FIXED1 || FIXED2 || B8
|-
| B9 || B10 ||
|-
| << || Back || Exit
|}

===Parsing the returning Menu information===

Note that if the user clicks on the << or >> buttons the calling script WILL NOT see any response. The correct menu is displayed. The calling script only receives a response when one of the buttons or Back/Exit are clicked. Clicking on a space button will cause the menu to redisplay.

The script that expects the response back from the menu has the following

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

default
{
link_message(integer intSenderNum, integer num, string message, key id)
{
if (num == LINK_MENU_RETURN)
{
list returnMenu = llParseString2List(message, ["|"], []);
string menuDescriptor = llList2String(returnMenu,0); // The idenfifying descriptor. I sometimes use the name of the script plus menu and parent menu name

if (menuDescriptor == "mymenu")
{ // Is this my menu that is sending this message?
string item = llList2String(returnMenu,1); // The actual button pushed

// id == the key of the menu user.
// The button pressed in the menu is 'item', so now do something with it
}
}
else if (num == LINK_MENU_TIMEOUT)
{
if (message == "mymenu")
{
// We received a timeout (don't worry the listens are all dealt with) so you might want to IM the menu user.
}
}
}
}
</lsl>

==The Script==
<lsl>
// ********************************************************************
//
// Menu Display Script
//
// Menu command format
// string = menuidentifier | display navigate? TRUE/FALSE | menuMaintitle~subtitle1~subtitle2~subtitle3 | button1~button2~button3 {| fixedbutton1~fixedbutton2~fixedbutton3 optional}
// key = menuuser key
//
// Return is in the format
// "menuidentifier | item"
//
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]
// menusActive [menuchannel, menuhandle, time, page]
//
// by SimonT Quinnell
//
// CHANGES
// 2010/10/14 - Timeout message now gets sent to the prim that called the menu, not LINK_THIS. Also includes menuidentifier
//
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

// Main Menu Details
string BACK = "<<";
string FOWARD = ">>";
list MENU_NAVIGATE_BUTTONS = [ " ", "Back", "Exit"];
float MENU_TIMEOUT_CHECK = 10.0;
integer MENU_TIMEOUT = 120;
integer MAX_TEXT = 510;

integer STRIDE_DESCRIPTION = 8;
integer STRIDE_ACTIVE = 4;
integer DEBUG = FALSE;

// ********************************************************************
// Variables
// ********************************************************************

list menusDescription;
list menusActive;

// ********************************************************************
// Functions - General
// ********************************************************************

debug(string debug)
{
if (DEBUG) llWhisper(0,"DEBUG:"+llGetScriptName()+":"+debug+" : Free("+(string)llGetFreeMemory()+")");
}

integer string2Bool (string test)
{
if (test == "TRUE") return TRUE;
else return FALSE;
}

// ********************************************************************
// Functions - Menu Helpers
// ********************************************************************

integer NewChannel()
{ // generates unique channel number
integer channel;

do channel = -(llRound(llFrand(999999)) + 99999);
while (~llListFindList(menusDescription, [channel]));

return channel;
}

string CheckTitleLength(string title)
{
if (llStringLength(title) > MAX_TEXT) title = llGetSubString(title, 0, MAX_TEXT-1);

return title;
}

list FillMenu(list buttons)
{ //adds empty buttons until the list length is multiple of 3, to max of 12
integer i;
list listButtons;

for(i=0;i<llGetListLength(buttons);i++)
{
string name = llList2String(buttons,i);
if (llStringLength(name) > 24) name = llGetSubString(name, 0, 23);
listButtons = listButtons + [name];
}

while (llGetListLength(listButtons) != 3 && llGetListLength(listButtons) != 6 && llGetListLength(listButtons) != 9 && llGetListLength(listButtons) < 12)
{
listButtons = listButtons + [" "];
}

buttons = llList2List(listButtons, 9, 11);
buttons = buttons + llList2List(listButtons, 6, 8);
buttons = buttons + llList2List(listButtons, 3, 5);
buttons = buttons + llList2List(listButtons, 0, 2);

return buttons;
}

RemoveUser(key id)
{
integer index_id = llListFindList(menusDescription, [id]);

while (~index_id)
{
integer channel = llList2Integer(menusDescription, index_id-1);
RemoveMenu(channel, FALSE);
}
}

RemoveMenu(integer channel, integer echo)
{
integer index = llListFindList(menusDescription, [channel]);

if (index != -1)
{
key menuId = llList2Key(menusDescription, index+1);
string menuDetails = llList2String(menusDescription, index+2);
integer menuLink = llList2Integer(menusDescription, index+3);
menusDescription = llDeleteSubList(menusDescription, index, index + STRIDE_DESCRIPTION - 1);
RemoveListen(channel);

if (echo) llMessageLinked(menuLink, LINK_MENU_TIMEOUT, menuDetails, menuId);
}
}

RemoveListen(integer channel)
{
integer index = llListFindList(menusActive, [channel]);
if (index != -1)
{
llListenRemove(llList2Integer(menusActive, index + 1));
menusActive = llDeleteSubList(menusActive, index, index + STRIDE_ACTIVE - 1);
}
}

// ********************************************************************
// Functions - Menu Main
// ********************************************************************

NewMenu(string message, integer senderNum, key id)
{ // Setup New Menu
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]

list temp = llParseString2List(message, ["|"], []);
integer channel = NewChannel();

if (llGetListLength(temp) > 2)
{
menusDescription = [channel, id, llList2String(temp, 0), senderNum, string2Bool(llList2String(temp, 1)), llList2String(temp, 2), llList2String(temp, 3), llList2String(temp, 4)] + menusDescription;

DisplayMenu(id, channel, 0);
}
else llOwnerSay ("ERROR: Dialog Script. Incorrect menu format");
}

DisplayMenu(key id, integer channel, integer page)
{
string menuTitle;
list menuSubTitles;
list menuButtonsAll;
list menuButtons;
list menuNavigateButtons;
list menuFixedButtons;

integer max = 12;

// Populate values
integer index = llListFindList(menusDescription, [channel]);
menuButtonsAll = llParseString2List(llList2String(menusDescription, index+6), ["~"], []);
if (llList2String(menusDescription, index+7) != "") menuFixedButtons = llParseString2List(llList2String(menusDescription, index+7), ["~"], []);

// Set up the menu buttons
if (llList2Integer(menusDescription, index+4)) menuNavigateButtons= MENU_NAVIGATE_BUTTONS;
else if (llGetListLength(menuButtonsAll) > (max-llGetListLength(menuFixedButtons))) menuNavigateButtons = [" ", " ", " "];

// FIXME: add sanity check for menu page

max = max - llGetListLength(menuFixedButtons) - llGetListLength(menuNavigateButtons);
integer start = page*max;
integer stop = (page+1)*max - 1;
menuButtons = FillMenu(menuFixedButtons + llList2List(menuButtonsAll, start, stop));

// Generate the title
list tempTitle = llParseString2List(llList2String(menusDescription, index+5), ["~"], []);
menuTitle = llList2String(tempTitle,0);
if (llGetListLength(tempTitle) > 1) menuSubTitles = llList2List(tempTitle, 1, -1);
if (llGetListLength(menuSubTitles) > 0)
{
integer i;
for(i=start;i<(stop+1);++i)
{
if (llList2String(menuSubTitles, i) != "") menuTitle += "\n"+llList2String(menuSubTitles, i);
}
}
menuTitle = CheckTitleLength(menuTitle);

// Add navigate buttons if necessary
if (page > 0) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [BACK], 0, 0);
if (llGetListLength(menuButtonsAll) > (page+1)*max) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [FOWARD], 2, 2);

// Set up listen and add the row details
integer menuHandle = llListen(channel, "", id, "");
menusActive = [channel, menuHandle, llGetUnixTime(), page] + menusActive;

llSetTimerEvent(MENU_TIMEOUT_CHECK);

// Display menu
llDialog(id, menuTitle, menuNavigateButtons + menuButtons, channel);
}

// ********************************************************************
// Event Handlers
// ********************************************************************

default
{
listen(integer channel, string name, key id, string message)
{
if (message == BACK)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)-1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == FOWARD)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)+1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == " ")
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3);
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else
{
integer index = llListFindList(menusDescription, [channel]);
llMessageLinked(llList2Integer(menusDescription, index+3), LINK_MENU_RETURN, llList2String(menusDescription, index+2)+"|"+message, id);
RemoveMenu(channel, FALSE);
}
}

link_message(integer senderNum, integer num, string message, key id)
{
if (num == LINK_MENU_DISPLAY) NewMenu(message, senderNum, id);
else if (num == LINK_MENU_CLOSE) RemoveUser(id);
}

timer()
{ // Check through timers and close if necessary
integer i;
list toRemove;
integer currentTime = llGetUnixTime();
integer length = llGetListLength(menusActive);

for(i=0;i<length;i+=STRIDE_ACTIVE)
{
if (currentTime - llList2Integer(menusActive, i+2) > MENU_TIMEOUT) toRemove = [llList2Integer(menusActive, i)] + toRemove;
}

length = llGetListLength(toRemove);
if (length > 0)
{
for(i=0;i<length;i++)
{
RemoveMenu(llList2Integer(toRemove, i), TRUE);
}
}
}
}

</lsl>

==See also==
*[[ Script_Library | Script Library ]]

MultiUser Dialog Handler

2010-10-14T04:23:15Z

SimonT Quinnell: /* Parsing the returning Menu information */

==Introduction==

I found that i was constantly rewriting a pile of dialog handling functions in my scrips so i decided to write a single dialog handler script. It needed to have the following features;

* Support multiple simultaneous menus from different users, scripts and prims.
* Support fixed top buttons that will persist on lists.
* Support fixed bottom buttons with include Back and Exit buttons.
* Handle item lists > 12 and automatically insert << and >> buttons to scroll through the lists.
* Handle timeouts and communicate timeout back to calling script.
* Handles truncation of the buttons and text to stop errors in llDialog

==Using The Script==

===Calling a Simple Menu===
In the script that is calling the menu I use a function something like this.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "FALSE"; //Navigation buttons not displayed
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "TopLeft~Top~TopRight~Left~Center~Right~BottomLeft~Bottom~BottomRight"; // The buttons, each button separated by a '~'.

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|TopLeft|| Top|| TopRight
|-
|Left|| Center || Right
|-
|BottomLeft|| Bottom || BottomRight
|}

===Calling a Simple Menu with Auto-Navigation Buttons===
In this case we now add navigation buttons to the bottom of the script. Back and Exit buttons are added to the bootom and if necessary >> and << buttons. In the script that is calling the menu I use a function something like this.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "TRUE"; //The display of the bottom navigation buttons is set to TRUE
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

This will display a menu that looks something like this.

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|-
| || Back || Exit
|}

===Calling a Complex Menu===
In the following case we will have 10 buttons that are going to be displayed. Because we will also display the bottom 3 buttons this will be spanned across 2 menus. We will also include 2 fixed buttons that always display at the top of the menu, PLUS each button has a unique descriptor that is displayed. Here is the menu call.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"
string menuNavigate = "TRUE";
string menuText = "Main text displayed.~text1~text2~text3~text4~text5~text6~text7~text8~text9~text10";
string menuButtons = "B1~B2~B3~B4~B5~B6~B7~B8~B9~B10";
string menuFixedButtons = "FIXED1~FIXED2"

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons+"|"+menuFixedButtons, id);
}
</lsl>

This will display the following 2 menus

Menu1
Main text displayed.
item1
item2
item3
item4
item5
item6
item7

{| border="1"
|FIXED1 || FIXED2 || B1
|-
|B2 || B3 || B4
|-
|B5 || B6 || B7
|-
| || Back || >>
|}

Menu2 (on clicking the >> button)
Main text displayed.
item8
item9
item10

{| border="1"
|FIXED1 || FIXED2 || B8
|-
| B9 || B10 ||
|-
| << || Back || Exit
|}

===Parsing the returning Menu information===

Note that if the user clicks on the << or >> buttons the calling script WILL NOT see any response. The correct menu is displayed. The calling script only receives a response when one of the buttons or Back/Exit are clicked. Clicking on a space button will cause the menu to redisplay.

The script that expects the response back from the menu has the following

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

default
{
link_message(integer intSenderNum, integer num, string message, key id)
{
if (num == LINK_MENU_RETURN)
{
list returnMenu = llParseString2List(message, ["|"], []);
string menuDescriptor = llList2String(returnMenu,0); // The idenfifying descriptor. I sometimes use the name of the script plus menu and parent menu name

if (menuDescriptor == "mymenu")
{ // Is this my menu that is sending this message?
string item = llList2String(returnMenu,1); // The actual button pushed

// id == the key of the menu user.
// The button pressed in the menu is 'item', so now do something with it
}
}
else if (num == LINK_MENU_TIMEOUT)
{
if (message == "mymenu")
{
// We received a timeout (don't worry the listens are all dealt with) so you might want to IM the menu user.
}
}
}
}
</lsl>

==The Script==
<lsl>
// ********************************************************************
//
// Menu Display Script
//
// Menu command format
// string = menuidentifier | display navigate? TRUE/FALSE | menuMaintitle~subtitle1~subtitle2~subtitle3 | button1~button2~button3 {| fixedbutton1~fixedbutton2~fixedbutton3 optional}
// key = menuuser key
//
// Return is in the format
// "menuidentifier | item"
//
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]
// menusActive [menuchannel, menuhandle, time, page]
//
// by SimonT Quinnell
//
// CHANGES
// 2010/10/14 - Timeout message now gets sent to the prim that called the menu, not LINK_THIS. Also includes menuidentifier
//
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

// Main Menu Details
string BACK = "<<";
string FOWARD = ">>";
list MENU_NAVIGATE_BUTTONS = [ " ", "Back", "Exit"];
float MENU_TIMEOUT_CHECK = 10.0;
integer MENU_TIMEOUT = 120;
integer MAX_TEXT = 510;

integer STRIDE_DESCRIPTION = 8;
integer STRIDE_ACTIVE = 4;
integer DEBUG = FALSE;

// ********************************************************************
// Variables
// ********************************************************************

list menusDescription;
list menusActive;

// ********************************************************************
// Functions - General
// ********************************************************************

debug(string debug)
{
if (DEBUG) llWhisper(0,"DEBUG:"+llGetScriptName()+":"+debug+" : Free("+(string)llGetFreeMemory()+")");
}

integer string2Bool (string test)
{
if (test == "TRUE") return TRUE;
else return FALSE;
}

// ********************************************************************
// Functions - Menu Helpers
// ********************************************************************

integer NewChannel()
{ // generates unique channel number
integer channel;

do channel = -(llRound(llFrand(999999)) + 99999);
while (~llListFindList(menusDescription, [channel]));

return channel;
}

string CheckTitleLength(string title)
{
if (llStringLength(title) > MAX_TEXT) title = llGetSubString(title, 0, MAX_TEXT-1);

return title;
}

list FillMenu(list buttons)
{ //adds empty buttons until the list length is multiple of 3, to max of 12
integer i;
list listButtons;

for(i=0;i<llGetListLength(buttons);i++)
{
string name = llList2String(buttons,i);
if (llStringLength(name) > 24) name = llGetSubString(name, 0, 23);
listButtons = listButtons + [name];
}

while (llGetListLength(listButtons) != 3 && llGetListLength(listButtons) != 6 && llGetListLength(listButtons) != 9 && llGetListLength(listButtons) < 12)
{
listButtons = listButtons + [" "];
}

buttons = llList2List(listButtons, 9, 11);
buttons = buttons + llList2List(listButtons, 6, 8);
buttons = buttons + llList2List(listButtons, 3, 5);
buttons = buttons + llList2List(listButtons, 0, 2);

return buttons;
}

RemoveUser(key id)
{
integer index_id = llListFindList(menusDescription, [id]);

while (~index_id)
{
integer channel = llList2Integer(menusDescription, index_id-1);
RemoveMenu(channel, FALSE);
}
}

RemoveMenu(integer channel, integer echo)
{
integer index = llListFindList(menusDescription, [channel]);

if (index != -1)
{
key menuId = llList2Key(menusDescription, index+1);
string menuDetails = llList2String(menusDescription, index+2);
integer menuLink = llList2Integer(menusDescription, index+3);
menusDescription = llDeleteSubList(menusDescription, index, index + STRIDE_DESCRIPTION - 1);
RemoveListen(channel);

if (echo) llMessageLinked(menuLink, LINK_MENU_TIMEOUT, menuDetails, menuId);
}
}

RemoveListen(integer channel)
{
integer index = llListFindList(menusActive, [channel]);
if (index != -1)
{
llListenRemove(llList2Integer(menusActive, index + 1));
menusActive = llDeleteSubList(menusActive, index, index + STRIDE_ACTIVE - 1);
}
}

// ********************************************************************
// Functions - Menu Main
// ********************************************************************

NewMenu(string message, integer senderNum, key id)
{ // Setup New Menu
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]

list temp = llParseString2List(message, ["|"], []);
integer channel = NewChannel();

if (llGetListLength(temp) > 2)
{
menusDescription = [channel, id, llList2String(temp, 0), senderNum, string2Bool(llList2String(temp, 1)), llList2String(temp, 2), llList2String(temp, 3), llList2String(temp, 4)] + menusDescription;

DisplayMenu(id, channel, 0);
}
else llOwnerSay ("ERROR: Dialog Script. Incorrect menu format");
}

DisplayMenu(key id, integer channel, integer page)
{
string menuTitle;
list menuSubTitles;
list menuButtonsAll;
list menuButtons;
list menuNavigateButtons;
list menuFixedButtons;

integer max = 12;

// Populate values
integer index = llListFindList(menusDescription, [channel]);
menuButtonsAll = llParseString2List(llList2String(menusDescription, index+6), ["~"], []);
if (llList2String(menusDescription, index+7) != "") menuFixedButtons = llParseString2List(llList2String(menusDescription, index+7), ["~"], []);

// Set up the menu buttons
if (llList2Integer(menusDescription, index+4)) menuNavigateButtons= MENU_NAVIGATE_BUTTONS;
else if (llGetListLength(menuButtonsAll) > (max-llGetListLength(menuFixedButtons))) menuNavigateButtons = [" ", " ", " "];

// FIXME: add sanity check for menu page

max = max - llGetListLength(menuFixedButtons) - llGetListLength(menuNavigateButtons);
integer start = page*max;
integer stop = (page+1)*max - 1;
menuButtons = FillMenu(menuFixedButtons + llList2List(menuButtonsAll, start, stop));

// Generate the title
list tempTitle = llParseString2List(llList2String(menusDescription, index+5), ["~"], []);
menuTitle = llList2String(tempTitle,0);
if (llGetListLength(tempTitle) > 1) menuSubTitles = llList2List(tempTitle, 1, -1);
if (llGetListLength(menuSubTitles) > 0)
{
integer i;
for(i=start;i<(stop+1);++i)
{
if (llList2String(menuSubTitles, i) != "") menuTitle += "\n"+llList2String(menuSubTitles, i);
}
}
menuTitle = CheckTitleLength(menuTitle);

// Add navigate buttons if necessary
if (page > 0) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [BACK], 0, 0);
if (llGetListLength(menuButtonsAll) > (page+1)*max) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [FOWARD], 2, 2);

// Set up listen and add the row details
integer menuHandle = llListen(channel, "", id, "");
menusActive = [channel, menuHandle, llGetUnixTime(), page] + menusActive;

llSetTimerEvent(MENU_TIMEOUT_CHECK);

// Display menu
llDialog(id, menuTitle, menuNavigateButtons + menuButtons, channel);
}

// ********************************************************************
// Event Handlers
// ********************************************************************

default
{
listen(integer channel, string name, key id, string message)
{
if (message == BACK)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)-1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == FOWARD)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)+1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == " ")
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3);
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else
{
integer index = llListFindList(menusDescription, [channel]);
llMessageLinked(llList2Integer(menusDescription, index+3), LINK_MENU_RETURN, llList2String(menusDescription, index+2)+"|"+message, id);
RemoveMenu(channel, FALSE);
}
}

link_message(integer senderNum, integer num, string message, key id)
{
if (num == LINK_MENU_DISPLAY) NewMenu(message, senderNum, id);
else if (num == LINK_MENU_CLOSE) RemoveUser(id);
}

timer()
{ // Check through timers and close if necessary
integer i;
list toRemove;
integer currentTime = llGetUnixTime();
integer length = llGetListLength(menusActive);

for(i=0;i<length;i+=STRIDE_ACTIVE)
{
if (currentTime - llList2Integer(menusActive, i+2) > MENU_TIMEOUT) toRemove = [llList2Integer(menusActive, i)] + toRemove;
}

length = llGetListLength(toRemove);
if (length > 0)
{
for(i=0;i<length;i++)
{
RemoveMenu(llList2Integer(toRemove, i), TRUE);
}
}
}
}

</lsl>

==See also==
*[[ Script_Library | Script Library ]]

MultiUser Dialog Handler

2010-10-14T04:21:11Z

SimonT Quinnell: /* Calling a Complex Menu */

==Introduction==

I found that i was constantly rewriting a pile of dialog handling functions in my scrips so i decided to write a single dialog handler script. It needed to have the following features;

* Support multiple simultaneous menus from different users, scripts and prims.
* Support fixed top buttons that will persist on lists.
* Support fixed bottom buttons with include Back and Exit buttons.
* Handle item lists > 12 and automatically insert << and >> buttons to scroll through the lists.
* Handle timeouts and communicate timeout back to calling script.
* Handles truncation of the buttons and text to stop errors in llDialog

==Using The Script==

===Calling a Simple Menu===
In the script that is calling the menu I use a function something like this.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "FALSE"; //Navigation buttons not displayed
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "TopLeft~Top~TopRight~Left~Center~Right~BottomLeft~Bottom~BottomRight"; // The buttons, each button separated by a '~'.

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|TopLeft|| Top|| TopRight
|-
|Left|| Center || Right
|-
|BottomLeft|| Bottom || BottomRight
|}

===Calling a Simple Menu with Auto-Navigation Buttons===
In this case we now add navigation buttons to the bottom of the script. Back and Exit buttons are added to the bootom and if necessary >> and << buttons. In the script that is calling the menu I use a function something like this.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "TRUE"; //The display of the bottom navigation buttons is set to TRUE
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

This will display a menu that looks something like this.

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|-
| || Back || Exit
|}

===Calling a Complex Menu===
In the following case we will have 10 buttons that are going to be displayed. Because we will also display the bottom 3 buttons this will be spanned across 2 menus. We will also include 2 fixed buttons that always display at the top of the menu, PLUS each button has a unique descriptor that is displayed. Here is the menu call.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"
string menuNavigate = "TRUE";
string menuText = "Main text displayed.~text1~text2~text3~text4~text5~text6~text7~text8~text9~text10";
string menuButtons = "B1~B2~B3~B4~B5~B6~B7~B8~B9~B10";
string menuFixedButtons = "FIXED1~FIXED2"

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons+"|"+menuFixedButtons, id);
}
</lsl>

This will display the following 2 menus

Menu1
Main text displayed.
item1
item2
item3
item4
item5
item6
item7

{| border="1"
|FIXED1 || FIXED2 || B1
|-
|B2 || B3 || B4
|-
|B5 || B6 || B7
|-
| || Back || >>
|}

Menu2 (on clicking the >> button)
Main text displayed.
item8
item9
item10

{| border="1"
|FIXED1 || FIXED2 || B8
|-
| B9 || B10 ||
|-
| << || Back || Exit
|}

===Parsing the returning Menu information===

Note that if the user clicks on the << or >> buttons the calling script WILL NOT see any response. The correct menu is displayed. The calling script only receives a response when one of the buttons or Back/Exit are clicked. Clicking on a space button will cause the menu to redisplay.

The script that expects the response back from the menu has the following

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

default
{
link_message(integer intSenderNum, integer num, string message, key id)
{
if (num == LINK_MENU_RETURN)
{
list returnMenu = llParseString2List(message, ["|"], []);
string menuDescriptor = llList2String(returnMenu,0); // The idenfifying descriptor. I sometimes use the name of the script plus menu and parent menu name

if (menuDescriptor == "mymenu")
{ // Is this my menu that is sending this message?
string item = llList2String(returnMenu,1); // The actual button pushed

// id == the key of the menu user.
// The button pressed in the menu is 'item', so now do something with it
}
}
else if (num == LINK_MENU_TIMEOUT)
{
// We received a timeout (don't worry the listens are all dealt with) so you might want to IM the menu user.
}
}
}
</lsl>

==The Script==
<lsl>
// ********************************************************************
//
// Menu Display Script
//
// Menu command format
// string = menuidentifier | display navigate? TRUE/FALSE | menuMaintitle~subtitle1~subtitle2~subtitle3 | button1~button2~button3 {| fixedbutton1~fixedbutton2~fixedbutton3 optional}
// key = menuuser key
//
// Return is in the format
// "menuidentifier | item"
//
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]
// menusActive [menuchannel, menuhandle, time, page]
//
// by SimonT Quinnell
//
// CHANGES
// 2010/10/14 - Timeout message now gets sent to the prim that called the menu, not LINK_THIS. Also includes menuidentifier
//
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

// Main Menu Details
string BACK = "<<";
string FOWARD = ">>";
list MENU_NAVIGATE_BUTTONS = [ " ", "Back", "Exit"];
float MENU_TIMEOUT_CHECK = 10.0;
integer MENU_TIMEOUT = 120;
integer MAX_TEXT = 510;

integer STRIDE_DESCRIPTION = 8;
integer STRIDE_ACTIVE = 4;
integer DEBUG = FALSE;

// ********************************************************************
// Variables
// ********************************************************************

list menusDescription;
list menusActive;

// ********************************************************************
// Functions - General
// ********************************************************************

debug(string debug)
{
if (DEBUG) llWhisper(0,"DEBUG:"+llGetScriptName()+":"+debug+" : Free("+(string)llGetFreeMemory()+")");
}

integer string2Bool (string test)
{
if (test == "TRUE") return TRUE;
else return FALSE;
}

// ********************************************************************
// Functions - Menu Helpers
// ********************************************************************

integer NewChannel()
{ // generates unique channel number
integer channel;

do channel = -(llRound(llFrand(999999)) + 99999);
while (~llListFindList(menusDescription, [channel]));

return channel;
}

string CheckTitleLength(string title)
{
if (llStringLength(title) > MAX_TEXT) title = llGetSubString(title, 0, MAX_TEXT-1);

return title;
}

list FillMenu(list buttons)
{ //adds empty buttons until the list length is multiple of 3, to max of 12
integer i;
list listButtons;

for(i=0;i<llGetListLength(buttons);i++)
{
string name = llList2String(buttons,i);
if (llStringLength(name) > 24) name = llGetSubString(name, 0, 23);
listButtons = listButtons + [name];
}

while (llGetListLength(listButtons) != 3 && llGetListLength(listButtons) != 6 && llGetListLength(listButtons) != 9 && llGetListLength(listButtons) < 12)
{
listButtons = listButtons + [" "];
}

buttons = llList2List(listButtons, 9, 11);
buttons = buttons + llList2List(listButtons, 6, 8);
buttons = buttons + llList2List(listButtons, 3, 5);
buttons = buttons + llList2List(listButtons, 0, 2);

return buttons;
}

RemoveUser(key id)
{
integer index_id = llListFindList(menusDescription, [id]);

while (~index_id)
{
integer channel = llList2Integer(menusDescription, index_id-1);
RemoveMenu(channel, FALSE);
}
}

RemoveMenu(integer channel, integer echo)
{
integer index = llListFindList(menusDescription, [channel]);

if (index != -1)
{
key menuId = llList2Key(menusDescription, index+1);
string menuDetails = llList2String(menusDescription, index+2);
integer menuLink = llList2Integer(menusDescription, index+3);
menusDescription = llDeleteSubList(menusDescription, index, index + STRIDE_DESCRIPTION - 1);
RemoveListen(channel);

if (echo) llMessageLinked(menuLink, LINK_MENU_TIMEOUT, menuDetails, menuId);
}
}

RemoveListen(integer channel)
{
integer index = llListFindList(menusActive, [channel]);
if (index != -1)
{
llListenRemove(llList2Integer(menusActive, index + 1));
menusActive = llDeleteSubList(menusActive, index, index + STRIDE_ACTIVE - 1);
}
}

// ********************************************************************
// Functions - Menu Main
// ********************************************************************

NewMenu(string message, integer senderNum, key id)
{ // Setup New Menu
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]

list temp = llParseString2List(message, ["|"], []);
integer channel = NewChannel();

if (llGetListLength(temp) > 2)
{
menusDescription = [channel, id, llList2String(temp, 0), senderNum, string2Bool(llList2String(temp, 1)), llList2String(temp, 2), llList2String(temp, 3), llList2String(temp, 4)] + menusDescription;

DisplayMenu(id, channel, 0);
}
else llOwnerSay ("ERROR: Dialog Script. Incorrect menu format");
}

DisplayMenu(key id, integer channel, integer page)
{
string menuTitle;
list menuSubTitles;
list menuButtonsAll;
list menuButtons;
list menuNavigateButtons;
list menuFixedButtons;

integer max = 12;

// Populate values
integer index = llListFindList(menusDescription, [channel]);
menuButtonsAll = llParseString2List(llList2String(menusDescription, index+6), ["~"], []);
if (llList2String(menusDescription, index+7) != "") menuFixedButtons = llParseString2List(llList2String(menusDescription, index+7), ["~"], []);

// Set up the menu buttons
if (llList2Integer(menusDescription, index+4)) menuNavigateButtons= MENU_NAVIGATE_BUTTONS;
else if (llGetListLength(menuButtonsAll) > (max-llGetListLength(menuFixedButtons))) menuNavigateButtons = [" ", " ", " "];

// FIXME: add sanity check for menu page

max = max - llGetListLength(menuFixedButtons) - llGetListLength(menuNavigateButtons);
integer start = page*max;
integer stop = (page+1)*max - 1;
menuButtons = FillMenu(menuFixedButtons + llList2List(menuButtonsAll, start, stop));

// Generate the title
list tempTitle = llParseString2List(llList2String(menusDescription, index+5), ["~"], []);
menuTitle = llList2String(tempTitle,0);
if (llGetListLength(tempTitle) > 1) menuSubTitles = llList2List(tempTitle, 1, -1);
if (llGetListLength(menuSubTitles) > 0)
{
integer i;
for(i=start;i<(stop+1);++i)
{
if (llList2String(menuSubTitles, i) != "") menuTitle += "\n"+llList2String(menuSubTitles, i);
}
}
menuTitle = CheckTitleLength(menuTitle);

// Add navigate buttons if necessary
if (page > 0) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [BACK], 0, 0);
if (llGetListLength(menuButtonsAll) > (page+1)*max) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [FOWARD], 2, 2);

// Set up listen and add the row details
integer menuHandle = llListen(channel, "", id, "");
menusActive = [channel, menuHandle, llGetUnixTime(), page] + menusActive;

llSetTimerEvent(MENU_TIMEOUT_CHECK);

// Display menu
llDialog(id, menuTitle, menuNavigateButtons + menuButtons, channel);
}

// ********************************************************************
// Event Handlers
// ********************************************************************

default
{
listen(integer channel, string name, key id, string message)
{
if (message == BACK)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)-1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == FOWARD)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)+1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == " ")
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3);
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else
{
integer index = llListFindList(menusDescription, [channel]);
llMessageLinked(llList2Integer(menusDescription, index+3), LINK_MENU_RETURN, llList2String(menusDescription, index+2)+"|"+message, id);
RemoveMenu(channel, FALSE);
}
}

link_message(integer senderNum, integer num, string message, key id)
{
if (num == LINK_MENU_DISPLAY) NewMenu(message, senderNum, id);
else if (num == LINK_MENU_CLOSE) RemoveUser(id);
}

timer()
{ // Check through timers and close if necessary
integer i;
list toRemove;
integer currentTime = llGetUnixTime();
integer length = llGetListLength(menusActive);

for(i=0;i<length;i+=STRIDE_ACTIVE)
{
if (currentTime - llList2Integer(menusActive, i+2) > MENU_TIMEOUT) toRemove = [llList2Integer(menusActive, i)] + toRemove;
}

length = llGetListLength(toRemove);
if (length > 0)
{
for(i=0;i<length;i++)
{
RemoveMenu(llList2Integer(toRemove, i), TRUE);
}
}
}
}

</lsl>

==See also==
*[[ Script_Library | Script Library ]]

MultiUser Dialog Handler

2010-10-14T04:19:43Z

SimonT Quinnell: /* Calling a Simple Menu with Auto-Navigation Buttons */

==Introduction==

I found that i was constantly rewriting a pile of dialog handling functions in my scrips so i decided to write a single dialog handler script. It needed to have the following features;

* Support multiple simultaneous menus from different users, scripts and prims.
* Support fixed top buttons that will persist on lists.
* Support fixed bottom buttons with include Back and Exit buttons.
* Handle item lists > 12 and automatically insert << and >> buttons to scroll through the lists.
* Handle timeouts and communicate timeout back to calling script.
* Handles truncation of the buttons and text to stop errors in llDialog

==Using The Script==

===Calling a Simple Menu===
In the script that is calling the menu I use a function something like this.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "FALSE"; //Navigation buttons not displayed
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "TopLeft~Top~TopRight~Left~Center~Right~BottomLeft~Bottom~BottomRight"; // The buttons, each button separated by a '~'.

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|TopLeft|| Top|| TopRight
|-
|Left|| Center || Right
|-
|BottomLeft|| Bottom || BottomRight
|}

===Calling a Simple Menu with Auto-Navigation Buttons===
In this case we now add navigation buttons to the bottom of the script. Back and Exit buttons are added to the bootom and if necessary >> and << buttons. In the script that is calling the menu I use a function something like this.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "TRUE"; //The display of the bottom navigation buttons is set to TRUE
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

This will display a menu that looks something like this.

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|-
| || Back || Exit
|}

===Calling a Complex Menu===
The above case is a simple menu. The script can also do more complex menus.

In the following case we will have 10 buttons that are going to be displayed. Because we will also display the bottom 3 buttons this will be spanned across 2 menus. We will also include 2 fixed buttons that always display at the top of the menu, PLUS each button has a unique descriptor that is displayed.

This will display the following 2 menus

Menu1
Main text displayed.
item1
item2
item3
item4
item5
item6
item7

{| border="1"
|FIXED1 || FIXED2 || B1
|-
|B2 || B3 || B4
|-
|B5 || B6 || B7
|-
| || Back || >>
|}

Menu2 (on clicking the >> button)
Main text displayed.
item8
item9
item10

{| border="1"
|FIXED1 || FIXED2 || B8
|-
| B9 || B10 ||
|-
| << || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"
string menuNavigate = "TRUE";
string menuText = "Main text displayed.~text1~text2~text3~text4~text5~text6~text7~text8~text9~text10";
string menuButtons = "B1~B2~B3~B4~B5~B6~B7~B8~B9~B10";
string menuFixedButtons = "FIXED1~FIXED2"

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons+"|"+menuFixedButtons, id);
}
</lsl>

===Parsing the returning Menu information===

Note that if the user clicks on the << or >> buttons the calling script WILL NOT see any response. The correct menu is displayed. The calling script only receives a response when one of the buttons or Back/Exit are clicked. Clicking on a space button will cause the menu to redisplay.

The script that expects the response back from the menu has the following

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

default
{
link_message(integer intSenderNum, integer num, string message, key id)
{
if (num == LINK_MENU_RETURN)
{
list returnMenu = llParseString2List(message, ["|"], []);
string menuDescriptor = llList2String(returnMenu,0); // The idenfifying descriptor. I sometimes use the name of the script plus menu and parent menu name

if (menuDescriptor == "mymenu")
{ // Is this my menu that is sending this message?
string item = llList2String(returnMenu,1); // The actual button pushed

// id == the key of the menu user.
// The button pressed in the menu is 'item', so now do something with it
}
}
else if (num == LINK_MENU_TIMEOUT)
{
// We received a timeout (don't worry the listens are all dealt with) so you might want to IM the menu user.
}
}
}
</lsl>

==The Script==
<lsl>
// ********************************************************************
//
// Menu Display Script
//
// Menu command format
// string = menuidentifier | display navigate? TRUE/FALSE | menuMaintitle~subtitle1~subtitle2~subtitle3 | button1~button2~button3 {| fixedbutton1~fixedbutton2~fixedbutton3 optional}
// key = menuuser key
//
// Return is in the format
// "menuidentifier | item"
//
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]
// menusActive [menuchannel, menuhandle, time, page]
//
// by SimonT Quinnell
//
// CHANGES
// 2010/10/14 - Timeout message now gets sent to the prim that called the menu, not LINK_THIS. Also includes menuidentifier
//
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

// Main Menu Details
string BACK = "<<";
string FOWARD = ">>";
list MENU_NAVIGATE_BUTTONS = [ " ", "Back", "Exit"];
float MENU_TIMEOUT_CHECK = 10.0;
integer MENU_TIMEOUT = 120;
integer MAX_TEXT = 510;

integer STRIDE_DESCRIPTION = 8;
integer STRIDE_ACTIVE = 4;
integer DEBUG = FALSE;

// ********************************************************************
// Variables
// ********************************************************************

list menusDescription;
list menusActive;

// ********************************************************************
// Functions - General
// ********************************************************************

debug(string debug)
{
if (DEBUG) llWhisper(0,"DEBUG:"+llGetScriptName()+":"+debug+" : Free("+(string)llGetFreeMemory()+")");
}

integer string2Bool (string test)
{
if (test == "TRUE") return TRUE;
else return FALSE;
}

// ********************************************************************
// Functions - Menu Helpers
// ********************************************************************

integer NewChannel()
{ // generates unique channel number
integer channel;

do channel = -(llRound(llFrand(999999)) + 99999);
while (~llListFindList(menusDescription, [channel]));

return channel;
}

string CheckTitleLength(string title)
{
if (llStringLength(title) > MAX_TEXT) title = llGetSubString(title, 0, MAX_TEXT-1);

return title;
}

list FillMenu(list buttons)
{ //adds empty buttons until the list length is multiple of 3, to max of 12
integer i;
list listButtons;

for(i=0;i<llGetListLength(buttons);i++)
{
string name = llList2String(buttons,i);
if (llStringLength(name) > 24) name = llGetSubString(name, 0, 23);
listButtons = listButtons + [name];
}

while (llGetListLength(listButtons) != 3 && llGetListLength(listButtons) != 6 && llGetListLength(listButtons) != 9 && llGetListLength(listButtons) < 12)
{
listButtons = listButtons + [" "];
}

buttons = llList2List(listButtons, 9, 11);
buttons = buttons + llList2List(listButtons, 6, 8);
buttons = buttons + llList2List(listButtons, 3, 5);
buttons = buttons + llList2List(listButtons, 0, 2);

return buttons;
}

RemoveUser(key id)
{
integer index_id = llListFindList(menusDescription, [id]);

while (~index_id)
{
integer channel = llList2Integer(menusDescription, index_id-1);
RemoveMenu(channel, FALSE);
}
}

RemoveMenu(integer channel, integer echo)
{
integer index = llListFindList(menusDescription, [channel]);

if (index != -1)
{
key menuId = llList2Key(menusDescription, index+1);
string menuDetails = llList2String(menusDescription, index+2);
integer menuLink = llList2Integer(menusDescription, index+3);
menusDescription = llDeleteSubList(menusDescription, index, index + STRIDE_DESCRIPTION - 1);
RemoveListen(channel);

if (echo) llMessageLinked(menuLink, LINK_MENU_TIMEOUT, menuDetails, menuId);
}
}

RemoveListen(integer channel)
{
integer index = llListFindList(menusActive, [channel]);
if (index != -1)
{
llListenRemove(llList2Integer(menusActive, index + 1));
menusActive = llDeleteSubList(menusActive, index, index + STRIDE_ACTIVE - 1);
}
}

// ********************************************************************
// Functions - Menu Main
// ********************************************************************

NewMenu(string message, integer senderNum, key id)
{ // Setup New Menu
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]

list temp = llParseString2List(message, ["|"], []);
integer channel = NewChannel();

if (llGetListLength(temp) > 2)
{
menusDescription = [channel, id, llList2String(temp, 0), senderNum, string2Bool(llList2String(temp, 1)), llList2String(temp, 2), llList2String(temp, 3), llList2String(temp, 4)] + menusDescription;

DisplayMenu(id, channel, 0);
}
else llOwnerSay ("ERROR: Dialog Script. Incorrect menu format");
}

DisplayMenu(key id, integer channel, integer page)
{
string menuTitle;
list menuSubTitles;
list menuButtonsAll;
list menuButtons;
list menuNavigateButtons;
list menuFixedButtons;

integer max = 12;

// Populate values
integer index = llListFindList(menusDescription, [channel]);
menuButtonsAll = llParseString2List(llList2String(menusDescription, index+6), ["~"], []);
if (llList2String(menusDescription, index+7) != "") menuFixedButtons = llParseString2List(llList2String(menusDescription, index+7), ["~"], []);

// Set up the menu buttons
if (llList2Integer(menusDescription, index+4)) menuNavigateButtons= MENU_NAVIGATE_BUTTONS;
else if (llGetListLength(menuButtonsAll) > (max-llGetListLength(menuFixedButtons))) menuNavigateButtons = [" ", " ", " "];

// FIXME: add sanity check for menu page

max = max - llGetListLength(menuFixedButtons) - llGetListLength(menuNavigateButtons);
integer start = page*max;
integer stop = (page+1)*max - 1;
menuButtons = FillMenu(menuFixedButtons + llList2List(menuButtonsAll, start, stop));

// Generate the title
list tempTitle = llParseString2List(llList2String(menusDescription, index+5), ["~"], []);
menuTitle = llList2String(tempTitle,0);
if (llGetListLength(tempTitle) > 1) menuSubTitles = llList2List(tempTitle, 1, -1);
if (llGetListLength(menuSubTitles) > 0)
{
integer i;
for(i=start;i<(stop+1);++i)
{
if (llList2String(menuSubTitles, i) != "") menuTitle += "\n"+llList2String(menuSubTitles, i);
}
}
menuTitle = CheckTitleLength(menuTitle);

// Add navigate buttons if necessary
if (page > 0) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [BACK], 0, 0);
if (llGetListLength(menuButtonsAll) > (page+1)*max) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [FOWARD], 2, 2);

// Set up listen and add the row details
integer menuHandle = llListen(channel, "", id, "");
menusActive = [channel, menuHandle, llGetUnixTime(), page] + menusActive;

llSetTimerEvent(MENU_TIMEOUT_CHECK);

// Display menu
llDialog(id, menuTitle, menuNavigateButtons + menuButtons, channel);
}

// ********************************************************************
// Event Handlers
// ********************************************************************

default
{
listen(integer channel, string name, key id, string message)
{
if (message == BACK)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)-1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == FOWARD)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)+1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == " ")
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3);
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else
{
integer index = llListFindList(menusDescription, [channel]);
llMessageLinked(llList2Integer(menusDescription, index+3), LINK_MENU_RETURN, llList2String(menusDescription, index+2)+"|"+message, id);
RemoveMenu(channel, FALSE);
}
}

link_message(integer senderNum, integer num, string message, key id)
{
if (num == LINK_MENU_DISPLAY) NewMenu(message, senderNum, id);
else if (num == LINK_MENU_CLOSE) RemoveUser(id);
}

timer()
{ // Check through timers and close if necessary
integer i;
list toRemove;
integer currentTime = llGetUnixTime();
integer length = llGetListLength(menusActive);

for(i=0;i<length;i+=STRIDE_ACTIVE)
{
if (currentTime - llList2Integer(menusActive, i+2) > MENU_TIMEOUT) toRemove = [llList2Integer(menusActive, i)] + toRemove;
}

length = llGetListLength(toRemove);
if (length > 0)
{
for(i=0;i<length;i++)
{
RemoveMenu(llList2Integer(toRemove, i), TRUE);
}
}
}
}

</lsl>

==See also==
*[[ Script_Library | Script Library ]]

MultiUser Dialog Handler

2010-10-14T04:18:10Z

SimonT Quinnell: /* Calling a Simple Menu */

==Introduction==

I found that i was constantly rewriting a pile of dialog handling functions in my scrips so i decided to write a single dialog handler script. It needed to have the following features;

* Support multiple simultaneous menus from different users, scripts and prims.
* Support fixed top buttons that will persist on lists.
* Support fixed bottom buttons with include Back and Exit buttons.
* Handle item lists > 12 and automatically insert << and >> buttons to scroll through the lists.
* Handle timeouts and communicate timeout back to calling script.
* Handles truncation of the buttons and text to stop errors in llDialog

==Using The Script==

===Calling a Simple Menu===
In the script that is calling the menu I use a function something like this.

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "FALSE"; //Navigation buttons not displayed
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "TopLeft~Top~TopRight~Left~Center~Right~BottomLeft~Bottom~BottomRight"; // The buttons, each button separated by a '~'.

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|TopLeft|| Top|| TopRight
|-
|Left|| Center || Right
|-
|BottomLeft|| Bottom || BottomRight
|}

===Calling a Simple Menu with Auto-Navigation Buttons===
In the script that is calling the menu I use a function something like this. This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|-
| || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "TRUE"; //The display of the bottom navigation buttons is set to TRUE
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

===Calling a Complex Menu===
The above case is a simple menu. The script can also do more complex menus.

In the following case we will have 10 buttons that are going to be displayed. Because we will also display the bottom 3 buttons this will be spanned across 2 menus. We will also include 2 fixed buttons that always display at the top of the menu, PLUS each button has a unique descriptor that is displayed.

This will display the following 2 menus

Menu1
Main text displayed.
item1
item2
item3
item4
item5
item6
item7

{| border="1"
|FIXED1 || FIXED2 || B1
|-
|B2 || B3 || B4
|-
|B5 || B6 || B7
|-
| || Back || >>
|}

Menu2 (on clicking the >> button)
Main text displayed.
item8
item9
item10

{| border="1"
|FIXED1 || FIXED2 || B8
|-
| B9 || B10 ||
|-
| << || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"
string menuNavigate = "TRUE";
string menuText = "Main text displayed.~text1~text2~text3~text4~text5~text6~text7~text8~text9~text10";
string menuButtons = "B1~B2~B3~B4~B5~B6~B7~B8~B9~B10";
string menuFixedButtons = "FIXED1~FIXED2"

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons+"|"+menuFixedButtons, id);
}
</lsl>

===Parsing the returning Menu information===

Note that if the user clicks on the << or >> buttons the calling script WILL NOT see any response. The correct menu is displayed. The calling script only receives a response when one of the buttons or Back/Exit are clicked. Clicking on a space button will cause the menu to redisplay.

The script that expects the response back from the menu has the following

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

default
{
link_message(integer intSenderNum, integer num, string message, key id)
{
if (num == LINK_MENU_RETURN)
{
list returnMenu = llParseString2List(message, ["|"], []);
string menuDescriptor = llList2String(returnMenu,0); // The idenfifying descriptor. I sometimes use the name of the script plus menu and parent menu name

if (menuDescriptor == "mymenu")
{ // Is this my menu that is sending this message?
string item = llList2String(returnMenu,1); // The actual button pushed

// id == the key of the menu user.
// The button pressed in the menu is 'item', so now do something with it
}
}
else if (num == LINK_MENU_TIMEOUT)
{
// We received a timeout (don't worry the listens are all dealt with) so you might want to IM the menu user.
}
}
}
</lsl>

==The Script==
<lsl>
// ********************************************************************
//
// Menu Display Script
//
// Menu command format
// string = menuidentifier | display navigate? TRUE/FALSE | menuMaintitle~subtitle1~subtitle2~subtitle3 | button1~button2~button3 {| fixedbutton1~fixedbutton2~fixedbutton3 optional}
// key = menuuser key
//
// Return is in the format
// "menuidentifier | item"
//
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]
// menusActive [menuchannel, menuhandle, time, page]
//
// by SimonT Quinnell
//
// CHANGES
// 2010/10/14 - Timeout message now gets sent to the prim that called the menu, not LINK_THIS. Also includes menuidentifier
//
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

// Main Menu Details
string BACK = "<<";
string FOWARD = ">>";
list MENU_NAVIGATE_BUTTONS = [ " ", "Back", "Exit"];
float MENU_TIMEOUT_CHECK = 10.0;
integer MENU_TIMEOUT = 120;
integer MAX_TEXT = 510;

integer STRIDE_DESCRIPTION = 8;
integer STRIDE_ACTIVE = 4;
integer DEBUG = FALSE;

// ********************************************************************
// Variables
// ********************************************************************

list menusDescription;
list menusActive;

// ********************************************************************
// Functions - General
// ********************************************************************

debug(string debug)
{
if (DEBUG) llWhisper(0,"DEBUG:"+llGetScriptName()+":"+debug+" : Free("+(string)llGetFreeMemory()+")");
}

integer string2Bool (string test)
{
if (test == "TRUE") return TRUE;
else return FALSE;
}

// ********************************************************************
// Functions - Menu Helpers
// ********************************************************************

integer NewChannel()
{ // generates unique channel number
integer channel;

do channel = -(llRound(llFrand(999999)) + 99999);
while (~llListFindList(menusDescription, [channel]));

return channel;
}

string CheckTitleLength(string title)
{
if (llStringLength(title) > MAX_TEXT) title = llGetSubString(title, 0, MAX_TEXT-1);

return title;
}

list FillMenu(list buttons)
{ //adds empty buttons until the list length is multiple of 3, to max of 12
integer i;
list listButtons;

for(i=0;i<llGetListLength(buttons);i++)
{
string name = llList2String(buttons,i);
if (llStringLength(name) > 24) name = llGetSubString(name, 0, 23);
listButtons = listButtons + [name];
}

while (llGetListLength(listButtons) != 3 && llGetListLength(listButtons) != 6 && llGetListLength(listButtons) != 9 && llGetListLength(listButtons) < 12)
{
listButtons = listButtons + [" "];
}

buttons = llList2List(listButtons, 9, 11);
buttons = buttons + llList2List(listButtons, 6, 8);
buttons = buttons + llList2List(listButtons, 3, 5);
buttons = buttons + llList2List(listButtons, 0, 2);

return buttons;
}

RemoveUser(key id)
{
integer index_id = llListFindList(menusDescription, [id]);

while (~index_id)
{
integer channel = llList2Integer(menusDescription, index_id-1);
RemoveMenu(channel, FALSE);
}
}

RemoveMenu(integer channel, integer echo)
{
integer index = llListFindList(menusDescription, [channel]);

if (index != -1)
{
key menuId = llList2Key(menusDescription, index+1);
string menuDetails = llList2String(menusDescription, index+2);
integer menuLink = llList2Integer(menusDescription, index+3);
menusDescription = llDeleteSubList(menusDescription, index, index + STRIDE_DESCRIPTION - 1);
RemoveListen(channel);

if (echo) llMessageLinked(menuLink, LINK_MENU_TIMEOUT, menuDetails, menuId);
}
}

RemoveListen(integer channel)
{
integer index = llListFindList(menusActive, [channel]);
if (index != -1)
{
llListenRemove(llList2Integer(menusActive, index + 1));
menusActive = llDeleteSubList(menusActive, index, index + STRIDE_ACTIVE - 1);
}
}

// ********************************************************************
// Functions - Menu Main
// ********************************************************************

NewMenu(string message, integer senderNum, key id)
{ // Setup New Menu
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]

list temp = llParseString2List(message, ["|"], []);
integer channel = NewChannel();

if (llGetListLength(temp) > 2)
{
menusDescription = [channel, id, llList2String(temp, 0), senderNum, string2Bool(llList2String(temp, 1)), llList2String(temp, 2), llList2String(temp, 3), llList2String(temp, 4)] + menusDescription;

DisplayMenu(id, channel, 0);
}
else llOwnerSay ("ERROR: Dialog Script. Incorrect menu format");
}

DisplayMenu(key id, integer channel, integer page)
{
string menuTitle;
list menuSubTitles;
list menuButtonsAll;
list menuButtons;
list menuNavigateButtons;
list menuFixedButtons;

integer max = 12;

// Populate values
integer index = llListFindList(menusDescription, [channel]);
menuButtonsAll = llParseString2List(llList2String(menusDescription, index+6), ["~"], []);
if (llList2String(menusDescription, index+7) != "") menuFixedButtons = llParseString2List(llList2String(menusDescription, index+7), ["~"], []);

// Set up the menu buttons
if (llList2Integer(menusDescription, index+4)) menuNavigateButtons= MENU_NAVIGATE_BUTTONS;
else if (llGetListLength(menuButtonsAll) > (max-llGetListLength(menuFixedButtons))) menuNavigateButtons = [" ", " ", " "];

// FIXME: add sanity check for menu page

max = max - llGetListLength(menuFixedButtons) - llGetListLength(menuNavigateButtons);
integer start = page*max;
integer stop = (page+1)*max - 1;
menuButtons = FillMenu(menuFixedButtons + llList2List(menuButtonsAll, start, stop));

// Generate the title
list tempTitle = llParseString2List(llList2String(menusDescription, index+5), ["~"], []);
menuTitle = llList2String(tempTitle,0);
if (llGetListLength(tempTitle) > 1) menuSubTitles = llList2List(tempTitle, 1, -1);
if (llGetListLength(menuSubTitles) > 0)
{
integer i;
for(i=start;i<(stop+1);++i)
{
if (llList2String(menuSubTitles, i) != "") menuTitle += "\n"+llList2String(menuSubTitles, i);
}
}
menuTitle = CheckTitleLength(menuTitle);

// Add navigate buttons if necessary
if (page > 0) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [BACK], 0, 0);
if (llGetListLength(menuButtonsAll) > (page+1)*max) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [FOWARD], 2, 2);

// Set up listen and add the row details
integer menuHandle = llListen(channel, "", id, "");
menusActive = [channel, menuHandle, llGetUnixTime(), page] + menusActive;

llSetTimerEvent(MENU_TIMEOUT_CHECK);

// Display menu
llDialog(id, menuTitle, menuNavigateButtons + menuButtons, channel);
}

// ********************************************************************
// Event Handlers
// ********************************************************************

default
{
listen(integer channel, string name, key id, string message)
{
if (message == BACK)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)-1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == FOWARD)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)+1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == " ")
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3);
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else
{
integer index = llListFindList(menusDescription, [channel]);
llMessageLinked(llList2Integer(menusDescription, index+3), LINK_MENU_RETURN, llList2String(menusDescription, index+2)+"|"+message, id);
RemoveMenu(channel, FALSE);
}
}

link_message(integer senderNum, integer num, string message, key id)
{
if (num == LINK_MENU_DISPLAY) NewMenu(message, senderNum, id);
else if (num == LINK_MENU_CLOSE) RemoveUser(id);
}

timer()
{ // Check through timers and close if necessary
integer i;
list toRemove;
integer currentTime = llGetUnixTime();
integer length = llGetListLength(menusActive);

for(i=0;i<length;i+=STRIDE_ACTIVE)
{
if (currentTime - llList2Integer(menusActive, i+2) > MENU_TIMEOUT) toRemove = [llList2Integer(menusActive, i)] + toRemove;
}

length = llGetListLength(toRemove);
if (length > 0)
{
for(i=0;i<length;i++)
{
RemoveMenu(llList2Integer(toRemove, i), TRUE);
}
}
}
}

</lsl>

==See also==
*[[ Script_Library | Script Library ]]

MultiUser Dialog Handler

2010-10-14T04:13:57Z

SimonT Quinnell:

==Introduction==

I found that i was constantly rewriting a pile of dialog handling functions in my scrips so i decided to write a single dialog handler script. It needed to have the following features;

* Support multiple simultaneous menus from different users, scripts and prims.
* Support fixed top buttons that will persist on lists.
* Support fixed bottom buttons with include Back and Exit buttons.
* Handle item lists > 12 and automatically insert << and >> buttons to scroll through the lists.
* Handle timeouts and communicate timeout back to calling script.
* Handles truncation of the buttons and text to stop errors in llDialog

==Using The Script==

===Calling a Simple Menu===
In the script that is calling the menu I use a function something like this. This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|TopLeft|| Top|| TopRight
|-
|Left|| Center || Right
|-
|BottomLeft|| Bottom || BottomRight
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "FALSE"; //Navigation buttons not displayed
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "TopLeft~Top~TopRight~Left~Center~Right~BottomLeft~Bottom~BottomRight"; // The buttons, each button separated by a '~'.

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

===Calling a Simple Menu with Auto-Navigation Buttons===
In the script that is calling the menu I use a function something like this. This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|-
| || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "TRUE"; //The display of the bottom navigation buttons is set to TRUE
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

===Calling a Complex Menu===
The above case is a simple menu. The script can also do more complex menus.

In the following case we will have 10 buttons that are going to be displayed. Because we will also display the bottom 3 buttons this will be spanned across 2 menus. We will also include 2 fixed buttons that always display at the top of the menu, PLUS each button has a unique descriptor that is displayed.

This will display the following 2 menus

Menu1
Main text displayed.
item1
item2
item3
item4
item5
item6
item7

{| border="1"
|FIXED1 || FIXED2 || B1
|-
|B2 || B3 || B4
|-
|B5 || B6 || B7
|-
| || Back || >>
|}

Menu2 (on clicking the >> button)
Main text displayed.
item8
item9
item10

{| border="1"
|FIXED1 || FIXED2 || B8
|-
| B9 || B10 ||
|-
| << || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"
string menuNavigate = "TRUE";
string menuText = "Main text displayed.~text1~text2~text3~text4~text5~text6~text7~text8~text9~text10";
string menuButtons = "B1~B2~B3~B4~B5~B6~B7~B8~B9~B10";
string menuFixedButtons = "FIXED1~FIXED2"

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons+"|"+menuFixedButtons, id);
}
</lsl>

===Parsing the returning Menu information===

Note that if the user clicks on the << or >> buttons the calling script WILL NOT see any response. The correct menu is displayed. The calling script only receives a response when one of the buttons or Back/Exit are clicked. Clicking on a space button will cause the menu to redisplay.

The script that expects the response back from the menu has the following

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

default
{
link_message(integer intSenderNum, integer num, string message, key id)
{
if (num == LINK_MENU_RETURN)
{
list returnMenu = llParseString2List(message, ["|"], []);
string menuDescriptor = llList2String(returnMenu,0); // The idenfifying descriptor. I sometimes use the name of the script plus menu and parent menu name

if (menuDescriptor == "mymenu")
{ // Is this my menu that is sending this message?
string item = llList2String(returnMenu,1); // The actual button pushed

// id == the key of the menu user.
// The button pressed in the menu is 'item', so now do something with it
}
}
else if (num == LINK_MENU_TIMEOUT)
{
// We received a timeout (don't worry the listens are all dealt with) so you might want to IM the menu user.
}
}
}
</lsl>

==The Script==
<lsl>
// ********************************************************************
//
// Menu Display Script
//
// Menu command format
// string = menuidentifier | display navigate? TRUE/FALSE | menuMaintitle~subtitle1~subtitle2~subtitle3 | button1~button2~button3 {| fixedbutton1~fixedbutton2~fixedbutton3 optional}
// key = menuuser key
//
// Return is in the format
// "menuidentifier | item"
//
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]
// menusActive [menuchannel, menuhandle, time, page]
//
// by SimonT Quinnell
//
// CHANGES
// 2010/10/14 - Timeout message now gets sent to the prim that called the menu, not LINK_THIS. Also includes menuidentifier
//
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

// Main Menu Details
string BACK = "<<";
string FOWARD = ">>";
list MENU_NAVIGATE_BUTTONS = [ " ", "Back", "Exit"];
float MENU_TIMEOUT_CHECK = 10.0;
integer MENU_TIMEOUT = 120;
integer MAX_TEXT = 510;

integer STRIDE_DESCRIPTION = 8;
integer STRIDE_ACTIVE = 4;
integer DEBUG = FALSE;

// ********************************************************************
// Variables
// ********************************************************************

list menusDescription;
list menusActive;

// ********************************************************************
// Functions - General
// ********************************************************************

debug(string debug)
{
if (DEBUG) llWhisper(0,"DEBUG:"+llGetScriptName()+":"+debug+" : Free("+(string)llGetFreeMemory()+")");
}

integer string2Bool (string test)
{
if (test == "TRUE") return TRUE;
else return FALSE;
}

// ********************************************************************
// Functions - Menu Helpers
// ********************************************************************

integer NewChannel()
{ // generates unique channel number
integer channel;

do channel = -(llRound(llFrand(999999)) + 99999);
while (~llListFindList(menusDescription, [channel]));

return channel;
}

string CheckTitleLength(string title)
{
if (llStringLength(title) > MAX_TEXT) title = llGetSubString(title, 0, MAX_TEXT-1);

return title;
}

list FillMenu(list buttons)
{ //adds empty buttons until the list length is multiple of 3, to max of 12
integer i;
list listButtons;

for(i=0;i<llGetListLength(buttons);i++)
{
string name = llList2String(buttons,i);
if (llStringLength(name) > 24) name = llGetSubString(name, 0, 23);
listButtons = listButtons + [name];
}

while (llGetListLength(listButtons) != 3 && llGetListLength(listButtons) != 6 && llGetListLength(listButtons) != 9 && llGetListLength(listButtons) < 12)
{
listButtons = listButtons + [" "];
}

buttons = llList2List(listButtons, 9, 11);
buttons = buttons + llList2List(listButtons, 6, 8);
buttons = buttons + llList2List(listButtons, 3, 5);
buttons = buttons + llList2List(listButtons, 0, 2);

return buttons;
}

RemoveUser(key id)
{
integer index_id = llListFindList(menusDescription, [id]);

while (~index_id)
{
integer channel = llList2Integer(menusDescription, index_id-1);
RemoveMenu(channel, FALSE);
}
}

RemoveMenu(integer channel, integer echo)
{
integer index = llListFindList(menusDescription, [channel]);

if (index != -1)
{
key menuId = llList2Key(menusDescription, index+1);
string menuDetails = llList2String(menusDescription, index+2);
integer menuLink = llList2Integer(menusDescription, index+3);
menusDescription = llDeleteSubList(menusDescription, index, index + STRIDE_DESCRIPTION - 1);
RemoveListen(channel);

if (echo) llMessageLinked(menuLink, LINK_MENU_TIMEOUT, menuDetails, menuId);
}
}

RemoveListen(integer channel)
{
integer index = llListFindList(menusActive, [channel]);
if (index != -1)
{
llListenRemove(llList2Integer(menusActive, index + 1));
menusActive = llDeleteSubList(menusActive, index, index + STRIDE_ACTIVE - 1);
}
}

// ********************************************************************
// Functions - Menu Main
// ********************************************************************

NewMenu(string message, integer senderNum, key id)
{ // Setup New Menu
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]

list temp = llParseString2List(message, ["|"], []);
integer channel = NewChannel();

if (llGetListLength(temp) > 2)
{
menusDescription = [channel, id, llList2String(temp, 0), senderNum, string2Bool(llList2String(temp, 1)), llList2String(temp, 2), llList2String(temp, 3), llList2String(temp, 4)] + menusDescription;

DisplayMenu(id, channel, 0);
}
else llOwnerSay ("ERROR: Dialog Script. Incorrect menu format");
}

DisplayMenu(key id, integer channel, integer page)
{
string menuTitle;
list menuSubTitles;
list menuButtonsAll;
list menuButtons;
list menuNavigateButtons;
list menuFixedButtons;

integer max = 12;

// Populate values
integer index = llListFindList(menusDescription, [channel]);
menuButtonsAll = llParseString2List(llList2String(menusDescription, index+6), ["~"], []);
if (llList2String(menusDescription, index+7) != "") menuFixedButtons = llParseString2List(llList2String(menusDescription, index+7), ["~"], []);

// Set up the menu buttons
if (llList2Integer(menusDescription, index+4)) menuNavigateButtons= MENU_NAVIGATE_BUTTONS;
else if (llGetListLength(menuButtonsAll) > (max-llGetListLength(menuFixedButtons))) menuNavigateButtons = [" ", " ", " "];

// FIXME: add sanity check for menu page

max = max - llGetListLength(menuFixedButtons) - llGetListLength(menuNavigateButtons);
integer start = page*max;
integer stop = (page+1)*max - 1;
menuButtons = FillMenu(menuFixedButtons + llList2List(menuButtonsAll, start, stop));

// Generate the title
list tempTitle = llParseString2List(llList2String(menusDescription, index+5), ["~"], []);
menuTitle = llList2String(tempTitle,0);
if (llGetListLength(tempTitle) > 1) menuSubTitles = llList2List(tempTitle, 1, -1);
if (llGetListLength(menuSubTitles) > 0)
{
integer i;
for(i=start;i<(stop+1);++i)
{
if (llList2String(menuSubTitles, i) != "") menuTitle += "\n"+llList2String(menuSubTitles, i);
}
}
menuTitle = CheckTitleLength(menuTitle);

// Add navigate buttons if necessary
if (page > 0) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [BACK], 0, 0);
if (llGetListLength(menuButtonsAll) > (page+1)*max) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [FOWARD], 2, 2);

// Set up listen and add the row details
integer menuHandle = llListen(channel, "", id, "");
menusActive = [channel, menuHandle, llGetUnixTime(), page] + menusActive;

llSetTimerEvent(MENU_TIMEOUT_CHECK);

// Display menu
llDialog(id, menuTitle, menuNavigateButtons + menuButtons, channel);
}

// ********************************************************************
// Event Handlers
// ********************************************************************

default
{
listen(integer channel, string name, key id, string message)
{
if (message == BACK)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)-1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == FOWARD)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)+1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == " ")
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3);
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else
{
integer index = llListFindList(menusDescription, [channel]);
llMessageLinked(llList2Integer(menusDescription, index+3), LINK_MENU_RETURN, llList2String(menusDescription, index+2)+"|"+message, id);
RemoveMenu(channel, FALSE);
}
}

link_message(integer senderNum, integer num, string message, key id)
{
if (num == LINK_MENU_DISPLAY) NewMenu(message, senderNum, id);
else if (num == LINK_MENU_CLOSE) RemoveUser(id);
}

timer()
{ // Check through timers and close if necessary
integer i;
list toRemove;
integer currentTime = llGetUnixTime();
integer length = llGetListLength(menusActive);

for(i=0;i<length;i+=STRIDE_ACTIVE)
{
if (currentTime - llList2Integer(menusActive, i+2) > MENU_TIMEOUT) toRemove = [llList2Integer(menusActive, i)] + toRemove;
}

length = llGetListLength(toRemove);
if (length > 0)
{
for(i=0;i<length;i++)
{
RemoveMenu(llList2Integer(toRemove, i), TRUE);
}
}
}
}

</lsl>

==See also==
*[[ Script_Library | Script Library ]]

MultiUser Dialog Handler

2010-10-14T04:10:50Z

SimonT Quinnell:

==Introduction==

I found that i was constantly rewriting a pile of dialog handling functions in my scrips so i decided to write a single dialog handler script. It needed to have the following features;

* Support multiple simultaneous menus from different users, scripts and prims.
* Support fixed top buttons that will persist on lists.
* Support fixed bottom buttons with include Back and Exit buttons.
* Handle item lists > 12 and automatically insert << and >> buttons to scroll through the lists.
* Handle timeouts and communicate timeout back to calling script.
* Handles truncation of the buttons and text to stop errors in llDialog

==Using The Script==

===Calling a Simple Menu===
In the script that is calling the menu I use a function something like this. This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "FALSE"; //Navigation buttons not displayed
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

===Calling a Simple Menu with Auto-Navigation Buttons===
In the script that is calling the menu I use a function something like this. This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|-
| || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "TRUE"; //The display of the bottom navigation buttons is set to TRUE
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

===Calling a Complex Menu===
The above case is a simple menu. The script can also do more complex menus.

In the following case we will have 10 buttons that are going to be displayed. Because we will also display the bottom 3 buttons this will be spanned across 2 menus. We will also include 2 fixed buttons that always display at the top of the menu, PLUS each button has a unique descriptor that is displayed.

This will display the following 2 menus

Menu1
Main text displayed.
item1
item2
item3
item4
item5
item6
item7

{| border="1"
|FIXED1 || FIXED2 || B1
|-
|B2 || B3 || B4
|-
|B5 || B6 || B7
|-
| || Back || >>
|}

Menu2 (on clicking the >> button)
Main text displayed.
item8
item9
item10

{| border="1"
|FIXED1 || FIXED2 || B8
|-
| B9 || B10 ||
|-
| << || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"
string menuNavigate = "TRUE";
string menuText = "Main text displayed.~text1~text2~text3~text4~text5~text6~text7~text8~text9~text10";
string menuButtons = "B1~B2~B3~B4~B5~B6~B7~B8~B9~B10";
string menuFixedButtons = "FIXED1~FIXED2"

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons+"|"+menuFixedButtons, id);
}
</lsl>

===Parsing the returning Menu information===

Note that if the user clicks on the << or >> buttons the calling script WILL NOT see any response. The correct menu is displayed. The calling script only receives a response when one of the buttons or Back/Exit are clicked. Clicking on a space button will cause the menu to redisplay.

The script that expects the response back from the menu has the following

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

default
{
link_message(integer intSenderNum, integer num, string message, key id)
{
if (num == LINK_MENU_RETURN)
{
list returnMenu = llParseString2List(message, ["|"], []);
string menuDescriptor = llList2String(returnMenu,0); // The idenfifying descriptor. I sometimes use the name of the script plus menu and parent menu name

if (menuDescriptor == "mymenu")
{ // Is this my menu that is sending this message?
string item = llList2String(returnMenu,1); // The actual button pushed

// id == the key of the menu user.
// The button pressed in the menu is 'item', so now do something with it
}
}
else if (num == LINK_MENU_TIMEOUT)
{
// We received a timeout (don't worry the listens are all dealt with) so you might want to IM the menu user.
}
}
}
</lsl>

==The Script==
<lsl>
// ********************************************************************
//
// Menu Display Script
//
// Menu command format
// string = menuidentifier | display navigate? TRUE/FALSE | menuMaintitle~subtitle1~subtitle2~subtitle3 | button1~button2~button3 {| fixedbutton1~fixedbutton2~fixedbutton3 optional}
// key = menuuser key
//
// Return is in the format
// "menuidentifier | item"
//
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]
// menusActive [menuchannel, menuhandle, time, page]
//
// by SimonT Quinnell
//
// CHANGES
// 2010/10/14 - Timeout message now gets sent to the prim that called the menu, not LINK_THIS. Also includes menuidentifier
//
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

// Main Menu Details
string BACK = "<<";
string FOWARD = ">>";
list MENU_NAVIGATE_BUTTONS = [ " ", "Back", "Exit"];
float MENU_TIMEOUT_CHECK = 10.0;
integer MENU_TIMEOUT = 120;
integer MAX_TEXT = 510;

integer STRIDE_DESCRIPTION = 8;
integer STRIDE_ACTIVE = 4;
integer DEBUG = FALSE;

// ********************************************************************
// Variables
// ********************************************************************

list menusDescription;
list menusActive;

// ********************************************************************
// Functions - General
// ********************************************************************

debug(string debug)
{
if (DEBUG) llWhisper(0,"DEBUG:"+llGetScriptName()+":"+debug+" : Free("+(string)llGetFreeMemory()+")");
}

integer string2Bool (string test)
{
if (test == "TRUE") return TRUE;
else return FALSE;
}

// ********************************************************************
// Functions - Menu Helpers
// ********************************************************************

integer NewChannel()
{ // generates unique channel number
integer channel;

do channel = -(llRound(llFrand(999999)) + 99999);
while (~llListFindList(menusDescription, [channel]));

return channel;
}

string CheckTitleLength(string title)
{
if (llStringLength(title) > MAX_TEXT) title = llGetSubString(title, 0, MAX_TEXT-1);

return title;
}

list FillMenu(list buttons)
{ //adds empty buttons until the list length is multiple of 3, to max of 12
integer i;
list listButtons;

for(i=0;i<llGetListLength(buttons);i++)
{
string name = llList2String(buttons,i);
if (llStringLength(name) > 24) name = llGetSubString(name, 0, 23);
listButtons = listButtons + [name];
}

while (llGetListLength(listButtons) != 3 && llGetListLength(listButtons) != 6 && llGetListLength(listButtons) != 9 && llGetListLength(listButtons) < 12)
{
listButtons = listButtons + [" "];
}

buttons = llList2List(listButtons, 9, 11);
buttons = buttons + llList2List(listButtons, 6, 8);
buttons = buttons + llList2List(listButtons, 3, 5);
buttons = buttons + llList2List(listButtons, 0, 2);

return buttons;
}

RemoveUser(key id)
{
integer index_id = llListFindList(menusDescription, [id]);

while (~index_id)
{
integer channel = llList2Integer(menusDescription, index_id-1);
RemoveMenu(channel, FALSE);
}
}

RemoveMenu(integer channel, integer echo)
{
integer index = llListFindList(menusDescription, [channel]);

if (index != -1)
{
key menuId = llList2Key(menusDescription, index+1);
string menuDetails = llList2String(menusDescription, index+2);
integer menuLink = llList2Integer(menusDescription, index+3);
menusDescription = llDeleteSubList(menusDescription, index, index + STRIDE_DESCRIPTION - 1);
RemoveListen(channel);

if (echo) llMessageLinked(menuLink, LINK_MENU_TIMEOUT, menuDetails, menuId);
}
}

RemoveListen(integer channel)
{
integer index = llListFindList(menusActive, [channel]);
if (index != -1)
{
llListenRemove(llList2Integer(menusActive, index + 1));
menusActive = llDeleteSubList(menusActive, index, index + STRIDE_ACTIVE - 1);
}
}

// ********************************************************************
// Functions - Menu Main
// ********************************************************************

NewMenu(string message, integer senderNum, key id)
{ // Setup New Menu
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]

list temp = llParseString2List(message, ["|"], []);
integer channel = NewChannel();

if (llGetListLength(temp) > 2)
{
menusDescription = [channel, id, llList2String(temp, 0), senderNum, string2Bool(llList2String(temp, 1)), llList2String(temp, 2), llList2String(temp, 3), llList2String(temp, 4)] + menusDescription;

DisplayMenu(id, channel, 0);
}
else llOwnerSay ("ERROR: Dialog Script. Incorrect menu format");
}

DisplayMenu(key id, integer channel, integer page)
{
string menuTitle;
list menuSubTitles;
list menuButtonsAll;
list menuButtons;
list menuNavigateButtons;
list menuFixedButtons;

integer max = 12;

// Populate values
integer index = llListFindList(menusDescription, [channel]);
menuButtonsAll = llParseString2List(llList2String(menusDescription, index+6), ["~"], []);
if (llList2String(menusDescription, index+7) != "") menuFixedButtons = llParseString2List(llList2String(menusDescription, index+7), ["~"], []);

// Set up the menu buttons
if (llList2Integer(menusDescription, index+4)) menuNavigateButtons= MENU_NAVIGATE_BUTTONS;
else if (llGetListLength(menuButtonsAll) > (max-llGetListLength(menuFixedButtons))) menuNavigateButtons = [" ", " ", " "];

// FIXME: add sanity check for menu page

max = max - llGetListLength(menuFixedButtons) - llGetListLength(menuNavigateButtons);
integer start = page*max;
integer stop = (page+1)*max - 1;
menuButtons = FillMenu(menuFixedButtons + llList2List(menuButtonsAll, start, stop));

// Generate the title
list tempTitle = llParseString2List(llList2String(menusDescription, index+5), ["~"], []);
menuTitle = llList2String(tempTitle,0);
if (llGetListLength(tempTitle) > 1) menuSubTitles = llList2List(tempTitle, 1, -1);
if (llGetListLength(menuSubTitles) > 0)
{
integer i;
for(i=start;i<(stop+1);++i)
{
if (llList2String(menuSubTitles, i) != "") menuTitle += "\n"+llList2String(menuSubTitles, i);
}
}
menuTitle = CheckTitleLength(menuTitle);

// Add navigate buttons if necessary
if (page > 0) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [BACK], 0, 0);
if (llGetListLength(menuButtonsAll) > (page+1)*max) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [FOWARD], 2, 2);

// Set up listen and add the row details
integer menuHandle = llListen(channel, "", id, "");
menusActive = [channel, menuHandle, llGetUnixTime(), page] + menusActive;

llSetTimerEvent(MENU_TIMEOUT_CHECK);

// Display menu
llDialog(id, menuTitle, menuNavigateButtons + menuButtons, channel);
}

// ********************************************************************
// Event Handlers
// ********************************************************************

default
{
listen(integer channel, string name, key id, string message)
{
if (message == BACK)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)-1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == FOWARD)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)+1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == " ")
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3);
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else
{
integer index = llListFindList(menusDescription, [channel]);
llMessageLinked(llList2Integer(menusDescription, index+3), LINK_MENU_RETURN, llList2String(menusDescription, index+2)+"|"+message, id);
RemoveMenu(channel, FALSE);
}
}

link_message(integer senderNum, integer num, string message, key id)
{
if (num == LINK_MENU_DISPLAY) NewMenu(message, senderNum, id);
else if (num == LINK_MENU_CLOSE) RemoveUser(id);
}

timer()
{ // Check through timers and close if necessary
integer i;
list toRemove;
integer currentTime = llGetUnixTime();
integer length = llGetListLength(menusActive);

for(i=0;i<length;i+=STRIDE_ACTIVE)
{
if (currentTime - llList2Integer(menusActive, i+2) > MENU_TIMEOUT) toRemove = [llList2Integer(menusActive, i)] + toRemove;
}

length = llGetListLength(toRemove);
if (length > 0)
{
for(i=0;i<length;i++)
{
RemoveMenu(llList2Integer(toRemove, i), TRUE);
}
}
}
}

</lsl>

==See also==
*[[ Script_Library | Script Library ]]

MultiUser Dialog Handler

2010-10-14T04:09:01Z

SimonT Quinnell:

==Introduction==

I found that i was constantly rewriting a pile of dialog handling functions in my scrips so i decided to write a single dialog handler script. It needed to have the following features;

* Support multiple simultaneous menus from different users, scripts and prims.
* Support fixed top buttons that will persist on lists.
* Support fixed bottom buttons with include Back and Exit buttons.
* Handle item lists > 12 and automatically insert << and >> buttons to scroll through the lists.
* Handle timeouts and communicate timeout back to calling script.
* Handles truncation of the buttons and text to stop errors in llDialog

==Using The Script==

===Calling a Simple Menu with Auto-Navigation Buttons===
In the script that is calling the menu I use a function something like this. This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|-
| || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "TRUE"; //The display of the bottom navigation buttons is set to TRUE
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

===Calling a Complex Menu===
The above case is a simple menu. The script can also do more complex menus.

In the following case we will have 10 buttons that are going to be displayed. Because we will also display the bottom 3 buttons this will be spanned across 2 menus. We will also include 2 fixed buttons that always display at the top of the menu, PLUS each button has a unique descriptor that is displayed.

This will display the following 2 menus

Menu1
Main text displayed.
item1
item2
item3
item4
item5
item6
item7

{| border="1"
|FIXED1 || FIXED2 || B1
|-
|B2 || B3 || B4
|-
|B5 || B6 || B7
|-
| || Back || >>
|}

Menu2 (on clicking the >> button)
Main text displayed.
item8
item9
item10

{| border="1"
|FIXED1 || FIXED2 || B8
|-
| B9 || B10 ||
|-
| << || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"
string menuNavigate = "TRUE";
string menuText = "Main text displayed.~text1~text2~text3~text4~text5~text6~text7~text8~text9~text10";
string menuButtons = "B1~B2~B3~B4~B5~B6~B7~B8~B9~B10";
string menuFixedButtons = "FIXED1~FIXED2"

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons+"|"+menuFixedButtons, id);
}
</lsl>

===Parsing the returning Menu information===

Note that if the user clicks on the << or >> buttons the calling script WILL NOT see any response. The correct menu is displayed. The calling script only receives a response when one of the buttons or Back/Exit are clicked. Clicking on a space button will cause the menu to redisplay.

The script that expects the response back from the menu has the following

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

default
{
link_message(integer intSenderNum, integer num, string message, key id)
{
if (num == LINK_MENU_RETURN)
{
list returnMenu = llParseString2List(message, ["|"], []);
string menuDescriptor = llList2String(returnMenu,0); // The idenfifying descriptor. I sometimes use the name of the script plus menu and parent menu name

if (menuDescriptor == "mymenu")
{ // Is this my menu that is sending this message?
string item = llList2String(returnMenu,1); // The actual button pushed

// id == the key of the menu user.
// The button pressed in the menu is 'item', so now do something with it
}
}
else if (num == LINK_MENU_TIMEOUT)
{
// We received a timeout (don't worry the listens are all dealt with) so you might want to IM the menu user.
}
}
}
</lsl>

==The Script==
<lsl>
// ********************************************************************
//
// Menu Display Script
//
// Menu command format
// string = menuidentifier | display navigate? TRUE/FALSE | menuMaintitle~subtitle1~subtitle2~subtitle3 | button1~button2~button3 {| fixedbutton1~fixedbutton2~fixedbutton3 optional}
// key = menuuser key
//
// Return is in the format
// "menuidentifier | item"
//
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]
// menusActive [menuchannel, menuhandle, time, page]
//
// by SimonT Quinnell
//
// CHANGES
// 2010/10/14 - Timeout message now gets sent to the prim that called the menu, not LINK_THIS. Also includes menuidentifier
//
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

// Main Menu Details
string BACK = "<<";
string FOWARD = ">>";
list MENU_NAVIGATE_BUTTONS = [ " ", "Back", "Exit"];
float MENU_TIMEOUT_CHECK = 10.0;
integer MENU_TIMEOUT = 120;
integer MAX_TEXT = 510;

integer STRIDE_DESCRIPTION = 8;
integer STRIDE_ACTIVE = 4;
integer DEBUG = FALSE;

// ********************************************************************
// Variables
// ********************************************************************

list menusDescription;
list menusActive;

// ********************************************************************
// Functions - General
// ********************************************************************

debug(string debug)
{
if (DEBUG) llWhisper(0,"DEBUG:"+llGetScriptName()+":"+debug+" : Free("+(string)llGetFreeMemory()+")");
}

integer string2Bool (string test)
{
if (test == "TRUE") return TRUE;
else return FALSE;
}

// ********************************************************************
// Functions - Menu Helpers
// ********************************************************************

integer NewChannel()
{ // generates unique channel number
integer channel;

do channel = -(llRound(llFrand(999999)) + 99999);
while (~llListFindList(menusDescription, [channel]));

return channel;
}

string CheckTitleLength(string title)
{
if (llStringLength(title) > MAX_TEXT) title = llGetSubString(title, 0, MAX_TEXT-1);

return title;
}

list FillMenu(list buttons)
{ //adds empty buttons until the list length is multiple of 3, to max of 12
integer i;
list listButtons;

for(i=0;i<llGetListLength(buttons);i++)
{
string name = llList2String(buttons,i);
if (llStringLength(name) > 24) name = llGetSubString(name, 0, 23);
listButtons = listButtons + [name];
}

while (llGetListLength(listButtons) != 3 && llGetListLength(listButtons) != 6 && llGetListLength(listButtons) != 9 && llGetListLength(listButtons) < 12)
{
listButtons = listButtons + [" "];
}

buttons = llList2List(listButtons, 9, 11);
buttons = buttons + llList2List(listButtons, 6, 8);
buttons = buttons + llList2List(listButtons, 3, 5);
buttons = buttons + llList2List(listButtons, 0, 2);

return buttons;
}

RemoveUser(key id)
{
integer index_id = llListFindList(menusDescription, [id]);

while (~index_id)
{
integer channel = llList2Integer(menusDescription, index_id-1);
RemoveMenu(channel, FALSE);
}
}

RemoveMenu(integer channel, integer echo)
{
integer index = llListFindList(menusDescription, [channel]);

if (index != -1)
{
key menuId = llList2Key(menusDescription, index+1);
string menuDetails = llList2String(menusDescription, index+2);
integer menuLink = llList2Integer(menusDescription, index+3);
menusDescription = llDeleteSubList(menusDescription, index, index + STRIDE_DESCRIPTION - 1);
RemoveListen(channel);

if (echo) llMessageLinked(menuLink, LINK_MENU_TIMEOUT, menuDetails, menuId);
}
}

RemoveListen(integer channel)
{
integer index = llListFindList(menusActive, [channel]);
if (index != -1)
{
llListenRemove(llList2Integer(menusActive, index + 1));
menusActive = llDeleteSubList(menusActive, index, index + STRIDE_ACTIVE - 1);
}
}

// ********************************************************************
// Functions - Menu Main
// ********************************************************************

NewMenu(string message, integer senderNum, key id)
{ // Setup New Menu
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]

list temp = llParseString2List(message, ["|"], []);
integer channel = NewChannel();

if (llGetListLength(temp) > 2)
{
menusDescription = [channel, id, llList2String(temp, 0), senderNum, string2Bool(llList2String(temp, 1)), llList2String(temp, 2), llList2String(temp, 3), llList2String(temp, 4)] + menusDescription;

DisplayMenu(id, channel, 0);
}
else llOwnerSay ("ERROR: Dialog Script. Incorrect menu format");
}

DisplayMenu(key id, integer channel, integer page)
{
string menuTitle;
list menuSubTitles;
list menuButtonsAll;
list menuButtons;
list menuNavigateButtons;
list menuFixedButtons;

integer max = 12;

// Populate values
integer index = llListFindList(menusDescription, [channel]);
menuButtonsAll = llParseString2List(llList2String(menusDescription, index+6), ["~"], []);
if (llList2String(menusDescription, index+7) != "") menuFixedButtons = llParseString2List(llList2String(menusDescription, index+7), ["~"], []);

// Set up the menu buttons
if (llList2Integer(menusDescription, index+4)) menuNavigateButtons= MENU_NAVIGATE_BUTTONS;
else if (llGetListLength(menuButtonsAll) > (max-llGetListLength(menuFixedButtons))) menuNavigateButtons = [" ", " ", " "];

// FIXME: add sanity check for menu page

max = max - llGetListLength(menuFixedButtons) - llGetListLength(menuNavigateButtons);
integer start = page*max;
integer stop = (page+1)*max - 1;
menuButtons = FillMenu(menuFixedButtons + llList2List(menuButtonsAll, start, stop));

// Generate the title
list tempTitle = llParseString2List(llList2String(menusDescription, index+5), ["~"], []);
menuTitle = llList2String(tempTitle,0);
if (llGetListLength(tempTitle) > 1) menuSubTitles = llList2List(tempTitle, 1, -1);
if (llGetListLength(menuSubTitles) > 0)
{
integer i;
for(i=start;i<(stop+1);++i)
{
if (llList2String(menuSubTitles, i) != "") menuTitle += "\n"+llList2String(menuSubTitles, i);
}
}
menuTitle = CheckTitleLength(menuTitle);

// Add navigate buttons if necessary
if (page > 0) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [BACK], 0, 0);
if (llGetListLength(menuButtonsAll) > (page+1)*max) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [FOWARD], 2, 2);

// Set up listen and add the row details
integer menuHandle = llListen(channel, "", id, "");
menusActive = [channel, menuHandle, llGetUnixTime(), page] + menusActive;

llSetTimerEvent(MENU_TIMEOUT_CHECK);

// Display menu
llDialog(id, menuTitle, menuNavigateButtons + menuButtons, channel);
}

// ********************************************************************
// Event Handlers
// ********************************************************************

default
{
listen(integer channel, string name, key id, string message)
{
if (message == BACK)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)-1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == FOWARD)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)+1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == " ")
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3);
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else
{
integer index = llListFindList(menusDescription, [channel]);
llMessageLinked(llList2Integer(menusDescription, index+3), LINK_MENU_RETURN, llList2String(menusDescription, index+2)+"|"+message, id);
RemoveMenu(channel, FALSE);
}
}

link_message(integer senderNum, integer num, string message, key id)
{
if (num == LINK_MENU_DISPLAY) NewMenu(message, senderNum, id);
else if (num == LINK_MENU_CLOSE) RemoveUser(id);
}

timer()
{ // Check through timers and close if necessary
integer i;
list toRemove;
integer currentTime = llGetUnixTime();
integer length = llGetListLength(menusActive);

for(i=0;i<length;i+=STRIDE_ACTIVE)
{
if (currentTime - llList2Integer(menusActive, i+2) > MENU_TIMEOUT) toRemove = [llList2Integer(menusActive, i)] + toRemove;
}

length = llGetListLength(toRemove);
if (length > 0)
{
for(i=0;i<length;i++)
{
RemoveMenu(llList2Integer(toRemove, i), TRUE);
}
}
}
}

</lsl>

==See also==
*[[ Script_Library | Script Library ]]

MultiUser Dialog Handler

2010-10-14T04:06:22Z

SimonT Quinnell: /* The Script */

==Introduction==

I found that i was constantly rewriting a pile of dialog handling functions in my scrips so i decided to write a single dialog handler script. It needed to have the following features;

* Support multiple simultaneous menus from different users, scripts and prims.
* Support fixed top buttons that will persist on lists.
* Support fixed bottom buttons with include Back and Exit buttons.
* Handle item lists > 12 and automatically insert << and >> buttons to scroll through the lists.
* Handle timeouts and communicate timeout back to calling script.
* Handles truncation of the buttons and text to stop errors in llDialog

==Using The Script==

===Calling a Simple Menu===
In the script that is calling the menu I use a function something like this. This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|-
| || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "TRUE"; //The display of the bottom navigation buttons is set to TRUE
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

===Calling a Complex Menu===
The above case is a simple menu. The script can also do more complex menus.

In the following case we will have 10 buttons that are going to be displayed. Because we will also display the bottom 3 buttons this will be spanned across 2 menus. We will also include 2 fixed buttons that always display at the top of the menu, PLUS each button has a unique descriptor that is displayed.

This will display the following 2 menus

Menu1
Main text displayed.
item1
item2
item3
item4
item5
item6
item7

{| border="1"
|FIXED1 || FIXED2 || B1
|-
|B2 || B3 || B4
|-
|B5 || B6 || B7
|-
| || Back || >>
|}

Menu2 (on clicking the >> button)
Main text displayed.
item8
item9
item10

{| border="1"
|FIXED1 || FIXED2 || B8
|-
| B9 || B10 ||
|-
| << || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"
string menuNavigate = "TRUE";
string menuText = "Main text displayed.~text1~text2~text3~text4~text5~text6~text7~text8~text9~text10";
string menuButtons = "B1~B2~B3~B4~B5~B6~B7~B8~B9~B10";
string menuFixedButtons = "FIXED1~FIXED2"

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons+"|"+menuFixedButtons, id);
}
</lsl>

===Parsing the returning Menu information===

Note that if the user clicks on the << or >> buttons the calling script WILL NOT see any response. The correct menu is displayed. The calling script only receives a response when one of the buttons or Back/Exit are clicked. Clicking on a space button will cause the menu to redisplay.

The script that expects the response back from the menu has the following

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

default
{
link_message(integer intSenderNum, integer num, string message, key id)
{
if (num == LINK_MENU_RETURN)
{
list returnMenu = llParseString2List(message, ["|"], []);
string menuDescriptor = llList2String(returnMenu,0); // The idenfifying descriptor. I sometimes use the name of the script plus menu and parent menu name

if (menuDescriptor == "mymenu")
{ // Is this my menu that is sending this message?
string item = llList2String(returnMenu,1); // The actual button pushed

// id == the key of the menu user.
// The button pressed in the menu is 'item', so now do something with it
}
}
else if (num == LINK_MENU_TIMEOUT)
{
// We received a timeout (don't worry the listens are all dealt with) so you might want to IM the menu user.
}
}
}
</lsl>

==The Script==
<lsl>
// ********************************************************************
//
// Menu Display Script
//
// Menu command format
// string = menuidentifier | display navigate? TRUE/FALSE | menuMaintitle~subtitle1~subtitle2~subtitle3 | button1~button2~button3 {| fixedbutton1~fixedbutton2~fixedbutton3 optional}
// key = menuuser key
//
// Return is in the format
// "menuidentifier | item"
//
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]
// menusActive [menuchannel, menuhandle, time, page]
//
// by SimonT Quinnell
//
// CHANGES
// 2010/10/14 - Timeout message now gets sent to the prim that called the menu, not LINK_THIS. Also includes menuidentifier
//
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

// Main Menu Details
string BACK = "<<";
string FOWARD = ">>";
list MENU_NAVIGATE_BUTTONS = [ " ", "Back", "Exit"];
float MENU_TIMEOUT_CHECK = 10.0;
integer MENU_TIMEOUT = 120;
integer MAX_TEXT = 510;

integer STRIDE_DESCRIPTION = 8;
integer STRIDE_ACTIVE = 4;
integer DEBUG = FALSE;

// ********************************************************************
// Variables
// ********************************************************************

list menusDescription;
list menusActive;

// ********************************************************************
// Functions - General
// ********************************************************************

debug(string debug)
{
if (DEBUG) llWhisper(0,"DEBUG:"+llGetScriptName()+":"+debug+" : Free("+(string)llGetFreeMemory()+")");
}

integer string2Bool (string test)
{
if (test == "TRUE") return TRUE;
else return FALSE;
}

// ********************************************************************
// Functions - Menu Helpers
// ********************************************************************

integer NewChannel()
{ // generates unique channel number
integer channel;

do channel = -(llRound(llFrand(999999)) + 99999);
while (~llListFindList(menusDescription, [channel]));

return channel;
}

string CheckTitleLength(string title)
{
if (llStringLength(title) > MAX_TEXT) title = llGetSubString(title, 0, MAX_TEXT-1);

return title;
}

list FillMenu(list buttons)
{ //adds empty buttons until the list length is multiple of 3, to max of 12
integer i;
list listButtons;

for(i=0;i<llGetListLength(buttons);i++)
{
string name = llList2String(buttons,i);
if (llStringLength(name) > 24) name = llGetSubString(name, 0, 23);
listButtons = listButtons + [name];
}

while (llGetListLength(listButtons) != 3 && llGetListLength(listButtons) != 6 && llGetListLength(listButtons) != 9 && llGetListLength(listButtons) < 12)
{
listButtons = listButtons + [" "];
}

buttons = llList2List(listButtons, 9, 11);
buttons = buttons + llList2List(listButtons, 6, 8);
buttons = buttons + llList2List(listButtons, 3, 5);
buttons = buttons + llList2List(listButtons, 0, 2);

return buttons;
}

RemoveUser(key id)
{
integer index_id = llListFindList(menusDescription, [id]);

while (~index_id)
{
integer channel = llList2Integer(menusDescription, index_id-1);
RemoveMenu(channel, FALSE);
}
}

RemoveMenu(integer channel, integer echo)
{
integer index = llListFindList(menusDescription, [channel]);

if (index != -1)
{
key menuId = llList2Key(menusDescription, index+1);
string menuDetails = llList2String(menusDescription, index+2);
integer menuLink = llList2Integer(menusDescription, index+3);
menusDescription = llDeleteSubList(menusDescription, index, index + STRIDE_DESCRIPTION - 1);
RemoveListen(channel);

if (echo) llMessageLinked(menuLink, LINK_MENU_TIMEOUT, menuDetails, menuId);
}
}

RemoveListen(integer channel)
{
integer index = llListFindList(menusActive, [channel]);
if (index != -1)
{
llListenRemove(llList2Integer(menusActive, index + 1));
menusActive = llDeleteSubList(menusActive, index, index + STRIDE_ACTIVE - 1);
}
}

// ********************************************************************
// Functions - Menu Main
// ********************************************************************

NewMenu(string message, integer senderNum, key id)
{ // Setup New Menu
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]

list temp = llParseString2List(message, ["|"], []);
integer channel = NewChannel();

if (llGetListLength(temp) > 2)
{
menusDescription = [channel, id, llList2String(temp, 0), senderNum, string2Bool(llList2String(temp, 1)), llList2String(temp, 2), llList2String(temp, 3), llList2String(temp, 4)] + menusDescription;

DisplayMenu(id, channel, 0);
}
else llOwnerSay ("ERROR: Dialog Script. Incorrect menu format");
}

DisplayMenu(key id, integer channel, integer page)
{
string menuTitle;
list menuSubTitles;
list menuButtonsAll;
list menuButtons;
list menuNavigateButtons;
list menuFixedButtons;

integer max = 12;

// Populate values
integer index = llListFindList(menusDescription, [channel]);
menuButtonsAll = llParseString2List(llList2String(menusDescription, index+6), ["~"], []);
if (llList2String(menusDescription, index+7) != "") menuFixedButtons = llParseString2List(llList2String(menusDescription, index+7), ["~"], []);

// Set up the menu buttons
if (llList2Integer(menusDescription, index+4)) menuNavigateButtons= MENU_NAVIGATE_BUTTONS;
else if (llGetListLength(menuButtonsAll) > (max-llGetListLength(menuFixedButtons))) menuNavigateButtons = [" ", " ", " "];

// FIXME: add sanity check for menu page

max = max - llGetListLength(menuFixedButtons) - llGetListLength(menuNavigateButtons);
integer start = page*max;
integer stop = (page+1)*max - 1;
menuButtons = FillMenu(menuFixedButtons + llList2List(menuButtonsAll, start, stop));

// Generate the title
list tempTitle = llParseString2List(llList2String(menusDescription, index+5), ["~"], []);
menuTitle = llList2String(tempTitle,0);
if (llGetListLength(tempTitle) > 1) menuSubTitles = llList2List(tempTitle, 1, -1);
if (llGetListLength(menuSubTitles) > 0)
{
integer i;
for(i=start;i<(stop+1);++i)
{
if (llList2String(menuSubTitles, i) != "") menuTitle += "\n"+llList2String(menuSubTitles, i);
}
}
menuTitle = CheckTitleLength(menuTitle);

// Add navigate buttons if necessary
if (page > 0) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [BACK], 0, 0);
if (llGetListLength(menuButtonsAll) > (page+1)*max) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [FOWARD], 2, 2);

// Set up listen and add the row details
integer menuHandle = llListen(channel, "", id, "");
menusActive = [channel, menuHandle, llGetUnixTime(), page] + menusActive;

llSetTimerEvent(MENU_TIMEOUT_CHECK);

// Display menu
llDialog(id, menuTitle, menuNavigateButtons + menuButtons, channel);
}

// ********************************************************************
// Event Handlers
// ********************************************************************

default
{
listen(integer channel, string name, key id, string message)
{
if (message == BACK)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)-1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == FOWARD)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)+1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == " ")
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3);
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else
{
integer index = llListFindList(menusDescription, [channel]);
llMessageLinked(llList2Integer(menusDescription, index+3), LINK_MENU_RETURN, llList2String(menusDescription, index+2)+"|"+message, id);
RemoveMenu(channel, FALSE);
}
}

link_message(integer senderNum, integer num, string message, key id)
{
if (num == LINK_MENU_DISPLAY) NewMenu(message, senderNum, id);
else if (num == LINK_MENU_CLOSE) RemoveUser(id);
}

timer()
{ // Check through timers and close if necessary
integer i;
list toRemove;
integer currentTime = llGetUnixTime();
integer length = llGetListLength(menusActive);

for(i=0;i<length;i+=STRIDE_ACTIVE)
{
if (currentTime - llList2Integer(menusActive, i+2) > MENU_TIMEOUT) toRemove = [llList2Integer(menusActive, i)] + toRemove;
}

length = llGetListLength(toRemove);
if (length > 0)
{
for(i=0;i<length;i++)
{
RemoveMenu(llList2Integer(toRemove, i), TRUE);
}
}
}
}

</lsl>

==See also==
*[[ Script_Library | Script Library ]]

MultiUser Dialog Handler

2010-10-14T04:04:26Z

SimonT Quinnell: /* The Script */

==Introduction==

I found that i was constantly rewriting a pile of dialog handling functions in my scrips so i decided to write a single dialog handler script. It needed to have the following features;

* Support multiple simultaneous menus from different users, scripts and prims.
* Support fixed top buttons that will persist on lists.
* Support fixed bottom buttons with include Back and Exit buttons.
* Handle item lists > 12 and automatically insert << and >> buttons to scroll through the lists.
* Handle timeouts and communicate timeout back to calling script.
* Handles truncation of the buttons and text to stop errors in llDialog

==Using The Script==

===Calling a Simple Menu===
In the script that is calling the menu I use a function something like this. This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|-
| || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "TRUE"; //The display of the bottom navigation buttons is set to TRUE
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

===Calling a Complex Menu===
The above case is a simple menu. The script can also do more complex menus.

In the following case we will have 10 buttons that are going to be displayed. Because we will also display the bottom 3 buttons this will be spanned across 2 menus. We will also include 2 fixed buttons that always display at the top of the menu, PLUS each button has a unique descriptor that is displayed.

This will display the following 2 menus

Menu1
Main text displayed.
item1
item2
item3
item4
item5
item6
item7

{| border="1"
|FIXED1 || FIXED2 || B1
|-
|B2 || B3 || B4
|-
|B5 || B6 || B7
|-
| || Back || >>
|}

Menu2 (on clicking the >> button)
Main text displayed.
item8
item9
item10

{| border="1"
|FIXED1 || FIXED2 || B8
|-
| B9 || B10 ||
|-
| << || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"
string menuNavigate = "TRUE";
string menuText = "Main text displayed.~text1~text2~text3~text4~text5~text6~text7~text8~text9~text10";
string menuButtons = "B1~B2~B3~B4~B5~B6~B7~B8~B9~B10";
string menuFixedButtons = "FIXED1~FIXED2"

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons+"|"+menuFixedButtons, id);
}
</lsl>

===Parsing the returning Menu information===

Note that if the user clicks on the << or >> buttons the calling script WILL NOT see any response. The correct menu is displayed. The calling script only receives a response when one of the buttons or Back/Exit are clicked. Clicking on a space button will cause the menu to redisplay.

The script that expects the response back from the menu has the following

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

default
{
link_message(integer intSenderNum, integer num, string message, key id)
{
if (num == LINK_MENU_RETURN)
{
list returnMenu = llParseString2List(message, ["|"], []);
string menuDescriptor = llList2String(returnMenu,0); // The idenfifying descriptor. I sometimes use the name of the script plus menu and parent menu name

if (menuDescriptor == "mymenu")
{ // Is this my menu that is sending this message?
string item = llList2String(returnMenu,1); // The actual button pushed

// id == the key of the menu user.
// The button pressed in the menu is 'item', so now do something with it
}
}
else if (num == LINK_MENU_TIMEOUT)
{
// We received a timeout (don't worry the listens are all dealt with) so you might want to IM the menu user.
}
}
}
</lsl>

==The Script==
<lsl>
// ********************************************************************
//
// Menu Display Script
//
// Menu command format
// string = menuidentifier | display navigate? TRUE/FALSE | menuMaintitle~subtitle1~subtitle2~subtitle3 | button1~button2~button3 {| fixedbutton1~fixedbutton2~fixedbutton3 optional}
// key = menuuser key
//
// Return is in the format
// "menuidentifier | item"
//
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]
// menusActive [menuchannel, menuhandle, time, page]
//
// by SimonT Quinnell
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

// Main Menu Details
string BACK = "<<";
string FOWARD = ">>";
list MENU_NAVIGATE_BUTTONS = [ " ", "Back", "Exit"];
float MENU_TIMEOUT_CHECK = 10.0;
integer MENU_TIMEOUT = 120;
integer MAX_TEXT = 510;

integer STRIDE_DESCRIPTION = 8;
integer STRIDE_ACTIVE = 4;
integer DEBUG = FALSE;

// ********************************************************************
// Variables
// ********************************************************************

list menusDescription;
list menusActive;

// ********************************************************************
// Functions - General
// ********************************************************************

debug(string debug)
{
if (DEBUG) llWhisper(0,"DEBUG:"+llGetScriptName()+":"+debug+" : Free("+(string)llGetFreeMemory()+")");
}

integer string2Bool (string test)
{
if (test == "TRUE") return TRUE;
else return FALSE;
}

// ********************************************************************
// Functions - Menu Helpers
// ********************************************************************

integer NewChannel()
{ // generates unique channel number
integer channel;

do channel = -(llRound(llFrand(999999)) + 99999);
while (~llListFindList(menusDescription, [channel]));

return channel;
}

string CheckTitleLength(string title)
{
if (llStringLength(title) > MAX_TEXT) title = llGetSubString(title, 0, MAX_TEXT-1);

return title;
}

list FillMenu(list buttons)
{ //adds empty buttons until the list length is multiple of 3, to max of 12
integer i;
list listButtons;

for(i=0;i<llGetListLength(buttons);i++)
{
string name = llList2String(buttons,i);
if (llStringLength(name) > 24) name = llGetSubString(name, 0, 23);
listButtons = listButtons + [name];
}

while (llGetListLength(listButtons) != 3 && llGetListLength(listButtons) != 6 && llGetListLength(listButtons) != 9 && llGetListLength(listButtons) < 12)
{
listButtons = listButtons + [" "];
}

buttons = llList2List(listButtons, 9, 11);
buttons = buttons + llList2List(listButtons, 6, 8);
buttons = buttons + llList2List(listButtons, 3, 5);
buttons = buttons + llList2List(listButtons, 0, 2);

return buttons;
}

RemoveUser(key id)
{
integer index_id = llListFindList(menusDescription, [id]);

while (~index_id)
{
integer channel = llList2Integer(menusDescription, index_id-1);
RemoveMenu(channel, FALSE);
}
}

RemoveMenu(integer channel, integer echo)
{
integer index = llListFindList(menusDescription, [channel]);

if (index != -1)
{
key menuId = llList2Key(menusDescription, index+1);
string menuDetails = llList2String(menusDescription, index+2);
integer menuLink = llList2Integer(menusDescription, index+3);
menusDescription = llDeleteSubList(menusDescription, index, index + STRIDE_DESCRIPTION - 1);
RemoveListen(channel);

if (echo) llMessageLinked(menuLink, LINK_MENU_TIMEOUT, menuDetails, menuId);
}
}

RemoveListen(integer channel)
{
integer index = llListFindList(menusActive, [channel]);
if (index != -1)
{
llListenRemove(llList2Integer(menusActive, index + 1));
menusActive = llDeleteSubList(menusActive, index, index + STRIDE_ACTIVE - 1);
}
}

// ********************************************************************
// Functions - Menu Main
// ********************************************************************

NewMenu(string message, integer senderNum, key id)
{ // Setup New Menu
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]

list temp = llParseString2List(message, ["|"], []);
integer channel = NewChannel();

if (llGetListLength(temp) > 2)
{
menusDescription = [channel, id, llList2String(temp, 0), senderNum, string2Bool(llList2String(temp, 1)), llList2String(temp, 2), llList2String(temp, 3), llList2String(temp, 4)] + menusDescription;

DisplayMenu(id, channel, 0);
}
else llOwnerSay ("ERROR: Dialog Script. Incorrect menu format");
}

DisplayMenu(key id, integer channel, integer page)
{
string menuTitle;
list menuSubTitles;
list menuButtonsAll;
list menuButtons;
list menuNavigateButtons;
list menuFixedButtons;

integer max = 12;

// Populate values
integer index = llListFindList(menusDescription, [channel]);
menuButtonsAll = llParseString2List(llList2String(menusDescription, index+6), ["~"], []);
if (llList2String(menusDescription, index+7) != "") menuFixedButtons = llParseString2List(llList2String(menusDescription, index+7), ["~"], []);

// Set up the menu buttons
if (llList2Integer(menusDescription, index+4)) menuNavigateButtons= MENU_NAVIGATE_BUTTONS;
else if (llGetListLength(menuButtonsAll) > (max-llGetListLength(menuFixedButtons))) menuNavigateButtons = [" ", " ", " "];

// FIXME: add sanity check for menu page

max = max - llGetListLength(menuFixedButtons) - llGetListLength(menuNavigateButtons);
integer start = page*max;
integer stop = (page+1)*max - 1;
menuButtons = FillMenu(menuFixedButtons + llList2List(menuButtonsAll, start, stop));

// Generate the title
list tempTitle = llParseString2List(llList2String(menusDescription, index+5), ["~"], []);
menuTitle = llList2String(tempTitle,0);
if (llGetListLength(tempTitle) > 1) menuSubTitles = llList2List(tempTitle, 1, -1);
if (llGetListLength(menuSubTitles) > 0)
{
integer i;
for(i=start;i<(stop+1);++i)
{
if (llList2String(menuSubTitles, i) != "") menuTitle += "\n"+llList2String(menuSubTitles, i);
}
}
menuTitle = CheckTitleLength(menuTitle);

// Add navigate buttons if necessary
if (page > 0) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [BACK], 0, 0);
if (llGetListLength(menuButtonsAll) > (page+1)*max) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [FOWARD], 2, 2);

// Set up listen and add the row details
integer menuHandle = llListen(channel, "", id, "");
menusActive = [channel, menuHandle, llGetUnixTime(), page] + menusActive;

llSetTimerEvent(MENU_TIMEOUT_CHECK);

// Display menu
llDialog(id, menuTitle, menuNavigateButtons + menuButtons, channel);
}

// ********************************************************************
// Event Handlers
// ********************************************************************

default
{
listen(integer channel, string name, key id, string message)
{
if (message == BACK)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)-1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == FOWARD)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)+1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == " ")
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3);
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else
{
integer index = llListFindList(menusDescription, [channel]);
llMessageLinked(llList2Integer(menusDescription, index+3), LINK_MENU_RETURN, llList2String(menusDescription, index+2)+"|"+message, id);
RemoveMenu(channel, FALSE);
}
}

link_message(integer senderNum, integer num, string message, key id)
{
if (num == LINK_MENU_DISPLAY) NewMenu(message, senderNum, id);
else if (num == LINK_MENU_CLOSE) RemoveUser(id);
}

timer()
{ // Check through timers and close if necessary
integer i;
list toRemove;
integer currentTime = llGetUnixTime();
integer length = llGetListLength(menusActive);

for(i=0;i<length;i+=STRIDE_ACTIVE)
{
if (currentTime - llList2Integer(menusActive, i+2) > MENU_TIMEOUT) toRemove = [llList2Integer(menusActive, i)] + toRemove;
}

length = llGetListLength(toRemove);
if (length > 0)
{
for(i=0;i<length;i++)
{
RemoveMenu(llList2Integer(toRemove, i), TRUE);
}
}
}
}

</lsl>

==See also==
*[[ Script_Library | Script Library ]]

MultiUser Dialog Handler

2010-10-14T02:41:05Z

SimonT Quinnell: /* Introduction */

==Introduction==

I found that i was constantly rewriting a pile of dialog handling functions in my scrips so i decided to write a single dialog handler script. It needed to have the following features;

* Support multiple simultaneous menus from different users, scripts and prims.
* Support fixed top buttons that will persist on lists.
* Support fixed bottom buttons with include Back and Exit buttons.
* Handle item lists > 12 and automatically insert << and >> buttons to scroll through the lists.
* Handle timeouts and communicate timeout back to calling script.
* Handles truncation of the buttons and text to stop errors in llDialog

==Using The Script==

===Calling a Simple Menu===
In the script that is calling the menu I use a function something like this. This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|-
| || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "TRUE"; //The display of the bottom navigation buttons is set to TRUE
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

===Calling a Complex Menu===
The above case is a simple menu. The script can also do more complex menus.

In the following case we will have 10 buttons that are going to be displayed. Because we will also display the bottom 3 buttons this will be spanned across 2 menus. We will also include 2 fixed buttons that always display at the top of the menu, PLUS each button has a unique descriptor that is displayed.

This will display the following 2 menus

Menu1
Main text displayed.
item1
item2
item3
item4
item5
item6
item7

{| border="1"
|FIXED1 || FIXED2 || B1
|-
|B2 || B3 || B4
|-
|B5 || B6 || B7
|-
| || Back || >>
|}

Menu2 (on clicking the >> button)
Main text displayed.
item8
item9
item10

{| border="1"
|FIXED1 || FIXED2 || B8
|-
| B9 || B10 ||
|-
| << || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"
string menuNavigate = "TRUE";
string menuText = "Main text displayed.~text1~text2~text3~text4~text5~text6~text7~text8~text9~text10";
string menuButtons = "B1~B2~B3~B4~B5~B6~B7~B8~B9~B10";
string menuFixedButtons = "FIXED1~FIXED2"

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons+"|"+menuFixedButtons, id);
}
</lsl>

===Parsing the returning Menu information===

Note that if the user clicks on the << or >> buttons the calling script WILL NOT see any response. The correct menu is displayed. The calling script only receives a response when one of the buttons or Back/Exit are clicked. Clicking on a space button will cause the menu to redisplay.

The script that expects the response back from the menu has the following

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

default
{
link_message(integer intSenderNum, integer num, string message, key id)
{
if (num == LINK_MENU_RETURN)
{
list returnMenu = llParseString2List(message, ["|"], []);
string menuDescriptor = llList2String(returnMenu,0); // The idenfifying descriptor. I sometimes use the name of the script plus menu and parent menu name

if (menuDescriptor == "mymenu")
{ // Is this my menu that is sending this message?
string item = llList2String(returnMenu,1); // The actual button pushed

// id == the key of the menu user.
// The button pressed in the menu is 'item', so now do something with it
}
}
else if (num == LINK_MENU_TIMEOUT)
{
// We received a timeout (don't worry the listens are all dealt with) so you might want to IM the menu user.
}
}
}
</lsl>

==The Script==
<lsl>
// ********************************************************************
//
// Menu Display Script
//
// Menu command format
// string = menuidentifier | display navigate? TRUE/FALSE | menuMaintitle~subtitle1~subtitle2~subtitle3 | button1~button2~button3 {| fixedbutton1~fixedbutton2~fixedbutton3 optional}
// key = menuuser key
//
// Return is in the format
// "menuidentifier | item"
//
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]
// menusActive [menuchannel, menuhandle, time, page]
//
// by SimonT Quinnell
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

// Main Menu Details
string BACK = "<<";
string FOWARD = ">>";
list MENU_NAVIGATE_BUTTONS = [ " ", "Back", "Exit"];
float MENU_TIMEOUT_CHECK = 10.0;
integer MENU_TIMEOUT = 120;
integer MAX_TEXT = 510;

integer STRIDE_DESCRIPTION = 8;
integer STRIDE_ACTIVE = 4;
integer DEBUG = FALSE;

// ********************************************************************
// Variables
// ********************************************************************

list menusDescription;
list menusActive;

// ********************************************************************
// Functions - General
// ********************************************************************

debug(string debug)
{
if (DEBUG) llWhisper(0,"DEBUG:"+llGetScriptName()+":"+debug+" : Free("+(string)llGetFreeMemory()+")");
}

integer string2Bool (string test)
{
if (test == "TRUE") return TRUE;
else return FALSE;
}

// ********************************************************************
// Functions - Menu Helpers
// ********************************************************************

integer NewChannel()
{ // generates unique channel number
integer channel;

do channel = -(llRound(llFrand(999999)) + 99999);
while (~llListFindList(menusDescription, [channel]));

return channel;
}

string CheckTitleLength(string title)
{
if (llStringLength(title) > MAX_TEXT) title = llGetSubString(title, 0, MAX_TEXT-1);

return title;
}

list FillMenu(list buttons)
{ //adds empty buttons until the list length is multiple of 3, to max of 12
integer i;
list listButtons;

for(i=0;i<llGetListLength(buttons);i++)
{
string name = llList2String(buttons,i);
if (llStringLength(name) > 24) name = llGetSubString(name, 0, 23);
listButtons = listButtons + [name];
}

while (llGetListLength(listButtons) != 3 && llGetListLength(listButtons) != 6 && llGetListLength(listButtons) != 9 && llGetListLength(listButtons) < 12)
{
listButtons = listButtons + [" "];
}

buttons = llList2List(listButtons, 9, 11);
buttons = buttons + llList2List(listButtons, 6, 8);
buttons = buttons + llList2List(listButtons, 3, 5);
buttons = buttons + llList2List(listButtons, 0, 2);

return buttons;
}

RemoveUser(key id)
{
integer index_id = llListFindList(menusDescription, [id]);

while (~index_id)
{
integer channel = llList2Integer(menusDescription, index_id-1);
RemoveMenu(channel, FALSE);
}
}

RemoveMenu(integer channel, integer echo)
{
integer index = llListFindList(menusDescription, [channel]);

if (index != -1)
{
key id = llList2Key(menusDescription, index+1);
menusDescription = llDeleteSubList(menusDescription, index, index + STRIDE_DESCRIPTION -1);
RemoveListen(channel);

if (echo) llMessageLinked(LINK_THIS, LINK_MENU_TIMEOUT, "Timeout", id);
}
}

RemoveListen(integer channel)
{
integer index = llListFindList(menusActive, [channel]);
if (index != -1)
{
llListenRemove(llList2Integer(menusActive, index + 1));
menusActive = llDeleteSubList(menusActive, index, index + STRIDE_ACTIVE - 1);
}
}

// ********************************************************************
// Functions - Menu Main
// ********************************************************************

NewMenu(string message, integer senderNum, key id)
{ // Setup New Menu
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]

list temp = llParseString2List(message, ["|"], []);
integer channel = NewChannel();

if (llGetListLength(temp) > 2)
{
menusDescription = [channel, id, llList2String(temp, 0), senderNum, string2Bool(llList2String(temp, 1)), llList2String(temp, 2), llList2String(temp, 3), llList2String(temp, 4)] + menusDescription;

DisplayMenu(id, channel, 0);
}
else llOwnerSay ("ERROR: Dialog Script. Incorrect menu format");
}

DisplayMenu(key id, integer channel, integer page)
{
string menuTitle;
list menuSubTitles;
list menuButtonsAll;
list menuButtons;
list menuNavigateButtons;
list menuFixedButtons;

integer max = 12;

// Populate values
integer index = llListFindList(menusDescription, [channel]);
menuButtonsAll = llParseString2List(llList2String(menusDescription, index+6), ["~"], []);
if (llList2String(menusDescription, index+7) != "") menuFixedButtons = llParseString2List(llList2String(menusDescription, index+7), ["~"], []);

// Set up the menu buttons
if (llList2Integer(menusDescription, index+4)) menuNavigateButtons= MENU_NAVIGATE_BUTTONS;
else if (llGetListLength(menuButtonsAll) > (max-llGetListLength(menuFixedButtons))) menuNavigateButtons = [" ", " ", " "];

// FIXME: add sanity check for menu page

max = max - llGetListLength(menuFixedButtons) - llGetListLength(menuNavigateButtons);
integer start = page*max;
integer stop = (page+1)*max - 1;
menuButtons = FillMenu(menuFixedButtons + llList2List(menuButtonsAll, start, stop));

// Generate the title
list tempTitle = llParseString2List(llList2String(menusDescription, index+5), ["~"], []);
menuTitle = llList2String(tempTitle,0);
if (llGetListLength(tempTitle) > 1) menuSubTitles = llList2List(tempTitle, 1, -1);
if (llGetListLength(menuSubTitles) > 0)
{
integer i;
for(i=start;i<(stop+1);++i)
{
if (llList2String(menuSubTitles, i) != "") menuTitle += "\n"+llList2String(menuSubTitles, i);
}
}
menuTitle = CheckTitleLength(menuTitle);

// Add navigate buttons if necessary
if (page > 0) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [BACK], 0, 0);
if (llGetListLength(menuButtonsAll) > (page+1)*max) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [FOWARD], 2, 2);

// Set up listen and add the row details
integer menuHandle = llListen(channel, "", id, "");
menusActive = [channel, menuHandle, llGetUnixTime(), page] + menusActive;

llSetTimerEvent(MENU_TIMEOUT_CHECK);

// Display menu
llDialog(id, menuTitle, menuNavigateButtons + menuButtons, channel);
}

// ********************************************************************
// Event Handlers
// ********************************************************************

default
{
listen(integer channel, string name, key id, string message)
{
if (message == BACK)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)-1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == FOWARD)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)+1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == " ")
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3);
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else
{
integer index = llListFindList(menusDescription, [channel]);
llMessageLinked(llList2Integer(menusDescription, index+3), LINK_MENU_RETURN, llList2String(menusDescription, index+2)+"|"+message, id);
RemoveMenu(channel, FALSE);
}
}

link_message(integer senderNum, integer num, string message, key id)
{
if (num == LINK_MENU_DISPLAY) NewMenu(message, senderNum, id);
else if (num == LINK_MENU_CLOSE) RemoveUser(id);
}

timer()
{ // Check through timers and close if necessary
integer i;
list toRemove;
integer currentTime = llGetUnixTime();
integer length = llGetListLength(menusActive);

for(i=0;i<length;i+=STRIDE_ACTIVE)
{
if (currentTime - llList2Integer(menusActive, i+2) > MENU_TIMEOUT) toRemove = [llList2Integer(menusActive, i)] + toRemove;
}

length = llGetListLength(toRemove);
if (length > 0)
{
for(i=0;i<length;i++)
{
RemoveMenu(llList2Integer(toRemove, i), TRUE);
}
}
}
}

</lsl>

==See also==
*[[ Script_Library | Script Library ]]

MultiUser Dialog Handler

2010-10-14T02:38:02Z

SimonT Quinnell: /* Calling a Simple Menu */

==Introduction==

I found that i was constantly rewriting a pile of dialog handling functions in my scrips so i decided to write a single dialog handler script. It needed to have the following features;

* Support multiple simultaneous menus from different users.
* Support fixed top buttons that will persist on lists.
* Support fixed bottom buttons with include Back and Exit buttons.
* Handle item lists > 12 and automatically insert << and >> buttons to scroll through the lists.
* Handle timeouts and communicate timeout back to calling script.
* Handles truncation of the buttons and text to stop errors in llDialog

==Using The Script==

===Calling a Simple Menu===
In the script that is calling the menu I use a function something like this. This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|-
| || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script. I often include the script name plus menu name.
string menuNavigate = "TRUE"; //The display of the bottom navigation buttons is set to TRUE
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

===Calling a Complex Menu===
The above case is a simple menu. The script can also do more complex menus.

In the following case we will have 10 buttons that are going to be displayed. Because we will also display the bottom 3 buttons this will be spanned across 2 menus. We will also include 2 fixed buttons that always display at the top of the menu, PLUS each button has a unique descriptor that is displayed.

This will display the following 2 menus

Menu1
Main text displayed.
item1
item2
item3
item4
item5
item6
item7

{| border="1"
|FIXED1 || FIXED2 || B1
|-
|B2 || B3 || B4
|-
|B5 || B6 || B7
|-
| || Back || >>
|}

Menu2 (on clicking the >> button)
Main text displayed.
item8
item9
item10

{| border="1"
|FIXED1 || FIXED2 || B8
|-
| B9 || B10 ||
|-
| << || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"
string menuNavigate = "TRUE";
string menuText = "Main text displayed.~text1~text2~text3~text4~text5~text6~text7~text8~text9~text10";
string menuButtons = "B1~B2~B3~B4~B5~B6~B7~B8~B9~B10";
string menuFixedButtons = "FIXED1~FIXED2"

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons+"|"+menuFixedButtons, id);
}
</lsl>

===Parsing the returning Menu information===

Note that if the user clicks on the << or >> buttons the calling script WILL NOT see any response. The correct menu is displayed. The calling script only receives a response when one of the buttons or Back/Exit are clicked. Clicking on a space button will cause the menu to redisplay.

The script that expects the response back from the menu has the following

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

default
{
link_message(integer intSenderNum, integer num, string message, key id)
{
if (num == LINK_MENU_RETURN)
{
list returnMenu = llParseString2List(message, ["|"], []);
string menuDescriptor = llList2String(returnMenu,0); // The idenfifying descriptor. I sometimes use the name of the script plus menu and parent menu name

if (menuDescriptor == "mymenu")
{ // Is this my menu that is sending this message?
string item = llList2String(returnMenu,1); // The actual button pushed

// id == the key of the menu user.
// The button pressed in the menu is 'item', so now do something with it
}
}
else if (num == LINK_MENU_TIMEOUT)
{
// We received a timeout (don't worry the listens are all dealt with) so you might want to IM the menu user.
}
}
}
</lsl>

==The Script==
<lsl>
// ********************************************************************
//
// Menu Display Script
//
// Menu command format
// string = menuidentifier | display navigate? TRUE/FALSE | menuMaintitle~subtitle1~subtitle2~subtitle3 | button1~button2~button3 {| fixedbutton1~fixedbutton2~fixedbutton3 optional}
// key = menuuser key
//
// Return is in the format
// "menuidentifier | item"
//
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]
// menusActive [menuchannel, menuhandle, time, page]
//
// by SimonT Quinnell
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

// Main Menu Details
string BACK = "<<";
string FOWARD = ">>";
list MENU_NAVIGATE_BUTTONS = [ " ", "Back", "Exit"];
float MENU_TIMEOUT_CHECK = 10.0;
integer MENU_TIMEOUT = 120;
integer MAX_TEXT = 510;

integer STRIDE_DESCRIPTION = 8;
integer STRIDE_ACTIVE = 4;
integer DEBUG = FALSE;

// ********************************************************************
// Variables
// ********************************************************************

list menusDescription;
list menusActive;

// ********************************************************************
// Functions - General
// ********************************************************************

debug(string debug)
{
if (DEBUG) llWhisper(0,"DEBUG:"+llGetScriptName()+":"+debug+" : Free("+(string)llGetFreeMemory()+")");
}

integer string2Bool (string test)
{
if (test == "TRUE") return TRUE;
else return FALSE;
}

// ********************************************************************
// Functions - Menu Helpers
// ********************************************************************

integer NewChannel()
{ // generates unique channel number
integer channel;

do channel = -(llRound(llFrand(999999)) + 99999);
while (~llListFindList(menusDescription, [channel]));

return channel;
}

string CheckTitleLength(string title)
{
if (llStringLength(title) > MAX_TEXT) title = llGetSubString(title, 0, MAX_TEXT-1);

return title;
}

list FillMenu(list buttons)
{ //adds empty buttons until the list length is multiple of 3, to max of 12
integer i;
list listButtons;

for(i=0;i<llGetListLength(buttons);i++)
{
string name = llList2String(buttons,i);
if (llStringLength(name) > 24) name = llGetSubString(name, 0, 23);
listButtons = listButtons + [name];
}

while (llGetListLength(listButtons) != 3 && llGetListLength(listButtons) != 6 && llGetListLength(listButtons) != 9 && llGetListLength(listButtons) < 12)
{
listButtons = listButtons + [" "];
}

buttons = llList2List(listButtons, 9, 11);
buttons = buttons + llList2List(listButtons, 6, 8);
buttons = buttons + llList2List(listButtons, 3, 5);
buttons = buttons + llList2List(listButtons, 0, 2);

return buttons;
}

RemoveUser(key id)
{
integer index_id = llListFindList(menusDescription, [id]);

while (~index_id)
{
integer channel = llList2Integer(menusDescription, index_id-1);
RemoveMenu(channel, FALSE);
}
}

RemoveMenu(integer channel, integer echo)
{
integer index = llListFindList(menusDescription, [channel]);

if (index != -1)
{
key id = llList2Key(menusDescription, index+1);
menusDescription = llDeleteSubList(menusDescription, index, index + STRIDE_DESCRIPTION -1);
RemoveListen(channel);

if (echo) llMessageLinked(LINK_THIS, LINK_MENU_TIMEOUT, "Timeout", id);
}
}

RemoveListen(integer channel)
{
integer index = llListFindList(menusActive, [channel]);
if (index != -1)
{
llListenRemove(llList2Integer(menusActive, index + 1));
menusActive = llDeleteSubList(menusActive, index, index + STRIDE_ACTIVE - 1);
}
}

// ********************************************************************
// Functions - Menu Main
// ********************************************************************

NewMenu(string message, integer senderNum, key id)
{ // Setup New Menu
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]

list temp = llParseString2List(message, ["|"], []);
integer channel = NewChannel();

if (llGetListLength(temp) > 2)
{
menusDescription = [channel, id, llList2String(temp, 0), senderNum, string2Bool(llList2String(temp, 1)), llList2String(temp, 2), llList2String(temp, 3), llList2String(temp, 4)] + menusDescription;

DisplayMenu(id, channel, 0);
}
else llOwnerSay ("ERROR: Dialog Script. Incorrect menu format");
}

DisplayMenu(key id, integer channel, integer page)
{
string menuTitle;
list menuSubTitles;
list menuButtonsAll;
list menuButtons;
list menuNavigateButtons;
list menuFixedButtons;

integer max = 12;

// Populate values
integer index = llListFindList(menusDescription, [channel]);
menuButtonsAll = llParseString2List(llList2String(menusDescription, index+6), ["~"], []);
if (llList2String(menusDescription, index+7) != "") menuFixedButtons = llParseString2List(llList2String(menusDescription, index+7), ["~"], []);

// Set up the menu buttons
if (llList2Integer(menusDescription, index+4)) menuNavigateButtons= MENU_NAVIGATE_BUTTONS;
else if (llGetListLength(menuButtonsAll) > (max-llGetListLength(menuFixedButtons))) menuNavigateButtons = [" ", " ", " "];

// FIXME: add sanity check for menu page

max = max - llGetListLength(menuFixedButtons) - llGetListLength(menuNavigateButtons);
integer start = page*max;
integer stop = (page+1)*max - 1;
menuButtons = FillMenu(menuFixedButtons + llList2List(menuButtonsAll, start, stop));

// Generate the title
list tempTitle = llParseString2List(llList2String(menusDescription, index+5), ["~"], []);
menuTitle = llList2String(tempTitle,0);
if (llGetListLength(tempTitle) > 1) menuSubTitles = llList2List(tempTitle, 1, -1);
if (llGetListLength(menuSubTitles) > 0)
{
integer i;
for(i=start;i<(stop+1);++i)
{
if (llList2String(menuSubTitles, i) != "") menuTitle += "\n"+llList2String(menuSubTitles, i);
}
}
menuTitle = CheckTitleLength(menuTitle);

// Add navigate buttons if necessary
if (page > 0) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [BACK], 0, 0);
if (llGetListLength(menuButtonsAll) > (page+1)*max) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [FOWARD], 2, 2);

// Set up listen and add the row details
integer menuHandle = llListen(channel, "", id, "");
menusActive = [channel, menuHandle, llGetUnixTime(), page] + menusActive;

llSetTimerEvent(MENU_TIMEOUT_CHECK);

// Display menu
llDialog(id, menuTitle, menuNavigateButtons + menuButtons, channel);
}

// ********************************************************************
// Event Handlers
// ********************************************************************

default
{
listen(integer channel, string name, key id, string message)
{
if (message == BACK)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)-1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == FOWARD)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)+1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == " ")
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3);
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else
{
integer index = llListFindList(menusDescription, [channel]);
llMessageLinked(llList2Integer(menusDescription, index+3), LINK_MENU_RETURN, llList2String(menusDescription, index+2)+"|"+message, id);
RemoveMenu(channel, FALSE);
}
}

link_message(integer senderNum, integer num, string message, key id)
{
if (num == LINK_MENU_DISPLAY) NewMenu(message, senderNum, id);
else if (num == LINK_MENU_CLOSE) RemoveUser(id);
}

timer()
{ // Check through timers and close if necessary
integer i;
list toRemove;
integer currentTime = llGetUnixTime();
integer length = llGetListLength(menusActive);

for(i=0;i<length;i+=STRIDE_ACTIVE)
{
if (currentTime - llList2Integer(menusActive, i+2) > MENU_TIMEOUT) toRemove = [llList2Integer(menusActive, i)] + toRemove;
}

length = llGetListLength(toRemove);
if (length > 0)
{
for(i=0;i<length;i++)
{
RemoveMenu(llList2Integer(toRemove, i), TRUE);
}
}
}
}

</lsl>

==See also==
*[[ Script_Library | Script Library ]]

MultiUser Dialog Handler

2010-10-14T02:33:48Z

SimonT Quinnell: /* The Script */

==Introduction==

I found that i was constantly rewriting a pile of dialog handling functions in my scrips so i decided to write a single dialog handler script. It needed to have the following features;

* Support multiple simultaneous menus from different users.
* Support fixed top buttons that will persist on lists.
* Support fixed bottom buttons with include Back and Exit buttons.
* Handle item lists > 12 and automatically insert << and >> buttons to scroll through the lists.
* Handle timeouts and communicate timeout back to calling script.
* Handles truncation of the buttons and text to stop errors in llDialog

==Using The Script==

===Calling a Simple Menu===
In the script that is calling the menu I use a function something like this. This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|-
| || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script.
string menuNavigate = "TRUE"; //The display of the bottom navigation buttons is set to TRUE
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

===Calling a Complex Menu===
The above case is a simple menu. The script can also do more complex menus.

In the following case we will have 10 buttons that are going to be displayed. Because we will also display the bottom 3 buttons this will be spanned across 2 menus. We will also include 2 fixed buttons that always display at the top of the menu, PLUS each button has a unique descriptor that is displayed.

This will display the following 2 menus

Menu1
Main text displayed.
item1
item2
item3
item4
item5
item6
item7

{| border="1"
|FIXED1 || FIXED2 || B1
|-
|B2 || B3 || B4
|-
|B5 || B6 || B7
|-
| || Back || >>
|}

Menu2 (on clicking the >> button)
Main text displayed.
item8
item9
item10

{| border="1"
|FIXED1 || FIXED2 || B8
|-
| B9 || B10 ||
|-
| << || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"
string menuNavigate = "TRUE";
string menuText = "Main text displayed.~text1~text2~text3~text4~text5~text6~text7~text8~text9~text10";
string menuButtons = "B1~B2~B3~B4~B5~B6~B7~B8~B9~B10";
string menuFixedButtons = "FIXED1~FIXED2"

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons+"|"+menuFixedButtons, id);
}
</lsl>

===Parsing the returning Menu information===

Note that if the user clicks on the << or >> buttons the calling script WILL NOT see any response. The correct menu is displayed. The calling script only receives a response when one of the buttons or Back/Exit are clicked. Clicking on a space button will cause the menu to redisplay.

The script that expects the response back from the menu has the following

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

default
{
link_message(integer intSenderNum, integer num, string message, key id)
{
if (num == LINK_MENU_RETURN)
{
list returnMenu = llParseString2List(message, ["|"], []);
string menuDescriptor = llList2String(returnMenu,0); // The idenfifying descriptor. I sometimes use the name of the script plus menu and parent menu name

if (menuDescriptor == "mymenu")
{ // Is this my menu that is sending this message?
string item = llList2String(returnMenu,1); // The actual button pushed

// id == the key of the menu user.
// The button pressed in the menu is 'item', so now do something with it
}
}
else if (num == LINK_MENU_TIMEOUT)
{
// We received a timeout (don't worry the listens are all dealt with) so you might want to IM the menu user.
}
}
}
</lsl>

==The Script==
<lsl>
// ********************************************************************
//
// Menu Display Script
//
// Menu command format
// string = menuidentifier | display navigate? TRUE/FALSE | menuMaintitle~subtitle1~subtitle2~subtitle3 | button1~button2~button3 {| fixedbutton1~fixedbutton2~fixedbutton3 optional}
// key = menuuser key
//
// Return is in the format
// "menuidentifier | item"
//
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]
// menusActive [menuchannel, menuhandle, time, page]
//
// by SimonT Quinnell
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

// Main Menu Details
string BACK = "<<";
string FOWARD = ">>";
list MENU_NAVIGATE_BUTTONS = [ " ", "Back", "Exit"];
float MENU_TIMEOUT_CHECK = 10.0;
integer MENU_TIMEOUT = 120;
integer MAX_TEXT = 510;

integer STRIDE_DESCRIPTION = 8;
integer STRIDE_ACTIVE = 4;
integer DEBUG = FALSE;

// ********************************************************************
// Variables
// ********************************************************************

list menusDescription;
list menusActive;

// ********************************************************************
// Functions - General
// ********************************************************************

debug(string debug)
{
if (DEBUG) llWhisper(0,"DEBUG:"+llGetScriptName()+":"+debug+" : Free("+(string)llGetFreeMemory()+")");
}

integer string2Bool (string test)
{
if (test == "TRUE") return TRUE;
else return FALSE;
}

// ********************************************************************
// Functions - Menu Helpers
// ********************************************************************

integer NewChannel()
{ // generates unique channel number
integer channel;

do channel = -(llRound(llFrand(999999)) + 99999);
while (~llListFindList(menusDescription, [channel]));

return channel;
}

string CheckTitleLength(string title)
{
if (llStringLength(title) > MAX_TEXT) title = llGetSubString(title, 0, MAX_TEXT-1);

return title;
}

list FillMenu(list buttons)
{ //adds empty buttons until the list length is multiple of 3, to max of 12
integer i;
list listButtons;

for(i=0;i<llGetListLength(buttons);i++)
{
string name = llList2String(buttons,i);
if (llStringLength(name) > 24) name = llGetSubString(name, 0, 23);
listButtons = listButtons + [name];
}

while (llGetListLength(listButtons) != 3 && llGetListLength(listButtons) != 6 && llGetListLength(listButtons) != 9 && llGetListLength(listButtons) < 12)
{
listButtons = listButtons + [" "];
}

buttons = llList2List(listButtons, 9, 11);
buttons = buttons + llList2List(listButtons, 6, 8);
buttons = buttons + llList2List(listButtons, 3, 5);
buttons = buttons + llList2List(listButtons, 0, 2);

return buttons;
}

RemoveUser(key id)
{
integer index_id = llListFindList(menusDescription, [id]);

while (~index_id)
{
integer channel = llList2Integer(menusDescription, index_id-1);
RemoveMenu(channel, FALSE);
}
}

RemoveMenu(integer channel, integer echo)
{
integer index = llListFindList(menusDescription, [channel]);

if (index != -1)
{
key id = llList2Key(menusDescription, index+1);
menusDescription = llDeleteSubList(menusDescription, index, index + STRIDE_DESCRIPTION -1);
RemoveListen(channel);

if (echo) llMessageLinked(LINK_THIS, LINK_MENU_TIMEOUT, "Timeout", id);
}
}

RemoveListen(integer channel)
{
integer index = llListFindList(menusActive, [channel]);
if (index != -1)
{
llListenRemove(llList2Integer(menusActive, index + 1));
menusActive = llDeleteSubList(menusActive, index, index + STRIDE_ACTIVE - 1);
}
}

// ********************************************************************
// Functions - Menu Main
// ********************************************************************

NewMenu(string message, integer senderNum, key id)
{ // Setup New Menu
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]

list temp = llParseString2List(message, ["|"], []);
integer channel = NewChannel();

if (llGetListLength(temp) > 2)
{
menusDescription = [channel, id, llList2String(temp, 0), senderNum, string2Bool(llList2String(temp, 1)), llList2String(temp, 2), llList2String(temp, 3), llList2String(temp, 4)] + menusDescription;

DisplayMenu(id, channel, 0);
}
else llOwnerSay ("ERROR: Dialog Script. Incorrect menu format");
}

DisplayMenu(key id, integer channel, integer page)
{
string menuTitle;
list menuSubTitles;
list menuButtonsAll;
list menuButtons;
list menuNavigateButtons;
list menuFixedButtons;

integer max = 12;

// Populate values
integer index = llListFindList(menusDescription, [channel]);
menuButtonsAll = llParseString2List(llList2String(menusDescription, index+6), ["~"], []);
if (llList2String(menusDescription, index+7) != "") menuFixedButtons = llParseString2List(llList2String(menusDescription, index+7), ["~"], []);

// Set up the menu buttons
if (llList2Integer(menusDescription, index+4)) menuNavigateButtons= MENU_NAVIGATE_BUTTONS;
else if (llGetListLength(menuButtonsAll) > (max-llGetListLength(menuFixedButtons))) menuNavigateButtons = [" ", " ", " "];

// FIXME: add sanity check for menu page

max = max - llGetListLength(menuFixedButtons) - llGetListLength(menuNavigateButtons);
integer start = page*max;
integer stop = (page+1)*max - 1;
menuButtons = FillMenu(menuFixedButtons + llList2List(menuButtonsAll, start, stop));

// Generate the title
list tempTitle = llParseString2List(llList2String(menusDescription, index+5), ["~"], []);
menuTitle = llList2String(tempTitle,0);
if (llGetListLength(tempTitle) > 1) menuSubTitles = llList2List(tempTitle, 1, -1);
if (llGetListLength(menuSubTitles) > 0)
{
integer i;
for(i=start;i<(stop+1);++i)
{
if (llList2String(menuSubTitles, i) != "") menuTitle += "\n"+llList2String(menuSubTitles, i);
}
}
menuTitle = CheckTitleLength(menuTitle);

// Add navigate buttons if necessary
if (page > 0) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [BACK], 0, 0);
if (llGetListLength(menuButtonsAll) > (page+1)*max) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [FOWARD], 2, 2);

// Set up listen and add the row details
integer menuHandle = llListen(channel, "", id, "");
menusActive = [channel, menuHandle, llGetUnixTime(), page] + menusActive;

llSetTimerEvent(MENU_TIMEOUT_CHECK);

// Display menu
llDialog(id, menuTitle, menuNavigateButtons + menuButtons, channel);
}

// ********************************************************************
// Event Handlers
// ********************************************************************

default
{
listen(integer channel, string name, key id, string message)
{
if (message == BACK)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)-1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == FOWARD)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)+1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == " ")
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3);
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else
{
integer index = llListFindList(menusDescription, [channel]);
llMessageLinked(llList2Integer(menusDescription, index+3), LINK_MENU_RETURN, llList2String(menusDescription, index+2)+"|"+message, id);
RemoveMenu(channel, FALSE);
}
}

link_message(integer senderNum, integer num, string message, key id)
{
if (num == LINK_MENU_DISPLAY) NewMenu(message, senderNum, id);
else if (num == LINK_MENU_CLOSE) RemoveUser(id);
}

timer()
{ // Check through timers and close if necessary
integer i;
list toRemove;
integer currentTime = llGetUnixTime();
integer length = llGetListLength(menusActive);

for(i=0;i<length;i+=STRIDE_ACTIVE)
{
if (currentTime - llList2Integer(menusActive, i+2) > MENU_TIMEOUT) toRemove = [llList2Integer(menusActive, i)] + toRemove;
}

length = llGetListLength(toRemove);
if (length > 0)
{
for(i=0;i<length;i++)
{
RemoveMenu(llList2Integer(toRemove, i), TRUE);
}
}
}
}

</lsl>

==See also==
*[[ Script_Library | Script Library ]]

MultiUser Dialog Handler

2010-10-14T02:31:35Z

SimonT Quinnell: /* Calling a Complex Menu */

==Introduction==

I found that i was constantly rewriting a pile of dialog handling functions in my scrips so i decided to write a single dialog handler script. It needed to have the following features;

* Support multiple simultaneous menus from different users.
* Support fixed top buttons that will persist on lists.
* Support fixed bottom buttons with include Back and Exit buttons.
* Handle item lists > 12 and automatically insert << and >> buttons to scroll through the lists.
* Handle timeouts and communicate timeout back to calling script.
* Handles truncation of the buttons and text to stop errors in llDialog

==Using The Script==

===Calling a Simple Menu===
In the script that is calling the menu I use a function something like this. This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|-
| || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script.
string menuNavigate = "TRUE"; //The display of the bottom navigation buttons is set to TRUE
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

===Calling a Complex Menu===
The above case is a simple menu. The script can also do more complex menus.

In the following case we will have 10 buttons that are going to be displayed. Because we will also display the bottom 3 buttons this will be spanned across 2 menus. We will also include 2 fixed buttons that always display at the top of the menu, PLUS each button has a unique descriptor that is displayed.

This will display the following 2 menus

Menu1
Main text displayed.
item1
item2
item3
item4
item5
item6
item7

{| border="1"
|FIXED1 || FIXED2 || B1
|-
|B2 || B3 || B4
|-
|B5 || B6 || B7
|-
| || Back || >>
|}

Menu2 (on clicking the >> button)
Main text displayed.
item8
item9
item10

{| border="1"
|FIXED1 || FIXED2 || B8
|-
| B9 || B10 ||
|-
| << || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"
string menuNavigate = "TRUE";
string menuText = "Main text displayed.~text1~text2~text3~text4~text5~text6~text7~text8~text9~text10";
string menuButtons = "B1~B2~B3~B4~B5~B6~B7~B8~B9~B10";
string menuFixedButtons = "FIXED1~FIXED2"

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons+"|"+menuFixedButtons, id);
}
</lsl>

===Parsing the returning Menu information===

Note that if the user clicks on the << or >> buttons the calling script WILL NOT see any response. The correct menu is displayed. The calling script only receives a response when one of the buttons or Back/Exit are clicked. Clicking on a space button will cause the menu to redisplay.

The script that expects the response back from the menu has the following

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

default
{
link_message(integer intSenderNum, integer num, string message, key id)
{
if (num == LINK_MENU_RETURN)
{
list returnMenu = llParseString2List(message, ["|"], []);
string menuDescriptor = llList2String(returnMenu,0); // The idenfifying descriptor. I sometimes use the name of the script plus menu and parent menu name

if (menuDescriptor == "mymenu")
{ // Is this my menu that is sending this message?
string item = llList2String(returnMenu,1); // The actual button pushed

// id == the key of the menu user.
// The button pressed in the menu is 'item', so now do something with it
}
}
else if (num == LINK_MENU_TIMEOUT)
{
// We received a timeout (don't worry the listens are all dealt with) so you might want to IM the menu user.
}
}
}
</lsl>

==The Script==
<lsl>
// ********************************************************************
//
// Menu Display Script
//
// Menu command format
// string = menuname ~ menuparent | display navigate? TRUE/FALSE | menuMaintitle~subtitle1~subtitle2~subtitle3 | button1~button2~button3 {| fixedbutton1~fixedbutton2~fixedbutton3 optional}
// key = menuuser key
//
//
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]
// menusActive [menuchannel, menuhandle, time, page]
//
// by SimonT Quinnell
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

// Main Menu Details
string BACK = "<<";
string FOWARD = ">>";
list MENU_NAVIGATE_BUTTONS = [ " ", "Back", "Exit"];
float MENU_TIMEOUT_CHECK = 10.0;
integer MENU_TIMEOUT = 120;
integer MAX_TEXT = 510;

integer STRIDE_DESCRIPTION = 8;
integer STRIDE_ACTIVE = 4;
integer DEBUG = FALSE;

// ********************************************************************
// Variables
// ********************************************************************

list menusDescription;
list menusActive;

// ********************************************************************
// Functions - General
// ********************************************************************

debug(string debug)
{
if (DEBUG) llWhisper(0,"DEBUG:"+llGetScriptName()+":"+debug+" : Free("+(string)llGetFreeMemory()+")");
}

integer string2Bool (string test)
{
if (test == "TRUE") return TRUE;
else return FALSE;
}

// ********************************************************************
// Functions - Menu Helpers
// ********************************************************************

integer NewChannel()
{ // generates unique channel number
integer channel;

do channel = -(llRound(llFrand(999999)) + 99999);
while (~llListFindList(menusDescription, [channel]));

return channel;
}

string CheckTitleLength(string title)
{
if (llStringLength(title) > MAX_TEXT) title = llGetSubString(title, 0, MAX_TEXT-1);

return title;
}

list FillMenu(list buttons)
{ //adds empty buttons until the list length is multiple of 3, to max of 12
integer i;
list listButtons;

for(i=0;i<llGetListLength(buttons);i++)
{
string name = llList2String(buttons,i);
if (llStringLength(name) > 24) name = llGetSubString(name, 0, 23);
listButtons = listButtons + [name];
}

while (llGetListLength(listButtons) != 3 && llGetListLength(listButtons) != 6 && llGetListLength(listButtons) != 9 && llGetListLength(listButtons) < 12)
{
listButtons = listButtons + [" "];
}

buttons = llList2List(listButtons, 9, 11);
buttons = buttons + llList2List(listButtons, 6, 8);
buttons = buttons + llList2List(listButtons, 3, 5);
buttons = buttons + llList2List(listButtons, 0, 2);

return buttons;
}

RemoveUser(key id)
{
integer index_id = llListFindList(menusDescription, [id]);

while (~index_id)
{
integer channel = llList2Integer(menusDescription, index_id-1);
RemoveMenu(channel, FALSE);
}
}

RemoveMenu(integer channel, integer echo)
{
integer index = llListFindList(menusDescription, [channel]);

if (index != -1)
{
key id = llList2Key(menusDescription, index+1);
menusDescription = llDeleteSubList(menusDescription, index, index + STRIDE_DESCRIPTION -1);
RemoveListen(channel);

if (echo) llMessageLinked(LINK_THIS, LINK_MENU_TIMEOUT, "Timeout", id);
}
}

RemoveListen(integer channel)
{
integer index = llListFindList(menusActive, [channel]);
if (index != -1)
{
llListenRemove(llList2Integer(menusActive, index + 1));
menusActive = llDeleteSubList(menusActive, index, index + STRIDE_ACTIVE - 1);
}
}

// ********************************************************************
// Functions - Menu Main
// ********************************************************************

NewMenu(string message, integer senderNum, key id)
{ // Setup New Menu
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]

list temp = llParseString2List(message, ["|"], []);
integer channel = NewChannel();

if (llGetListLength(temp) > 2)
{
menusDescription = [channel, id, llList2String(temp, 0), senderNum, string2Bool(llList2String(temp, 1)), llList2String(temp, 2), llList2String(temp, 3), llList2String(temp, 4)] + menusDescription;

DisplayMenu(id, channel, 0);
}
else llOwnerSay ("ERROR: Dialog Script. Incorrect menu format");
}

DisplayMenu(key id, integer channel, integer page)
{
string menuTitle;
list menuSubTitles;
list menuButtonsAll;
list menuButtons;
list menuNavigateButtons;
list menuFixedButtons;

integer max = 12;

// Populate values
integer index = llListFindList(menusDescription, [channel]);
menuButtonsAll = llParseString2List(llList2String(menusDescription, index+6), ["~"], []);
if (llList2String(menusDescription, index+7) != "") menuFixedButtons = llParseString2List(llList2String(menusDescription, index+7), ["~"], []);

// Set up the menu buttons
if (llList2Integer(menusDescription, index+4)) menuNavigateButtons= MENU_NAVIGATE_BUTTONS;
else if (llGetListLength(menuButtonsAll) > (max-llGetListLength(menuFixedButtons))) menuNavigateButtons = [" ", " ", " "];

// FIXME: add sanity check for menu page

max = max - llGetListLength(menuFixedButtons) - llGetListLength(menuNavigateButtons);
integer start = page*max;
integer stop = (page+1)*max - 1;
menuButtons = FillMenu(menuFixedButtons + llList2List(menuButtonsAll, start, stop));

// Generate the title
list tempTitle = llParseString2List(llList2String(menusDescription, index+5), ["~"], []);
menuTitle = llList2String(tempTitle,0);
if (llGetListLength(tempTitle) > 1) menuSubTitles = llList2List(tempTitle, 1, -1);
if (llGetListLength(menuSubTitles) > 0)
{
integer i;
for(i=start;i<(stop+1);++i)
{
if (llList2String(menuSubTitles, i) != "") menuTitle += "\n"+llList2String(menuSubTitles, i);
}
}
menuTitle = CheckTitleLength(menuTitle);

// Add navigate buttons if necessary
if (page > 0) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [BACK], 0, 0);
if (llGetListLength(menuButtonsAll) > (page+1)*max) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [FOWARD], 2, 2);

// Set up listen and add the row details
integer menuHandle = llListen(channel, "", id, "");
menusActive = [channel, menuHandle, llGetUnixTime(), page] + menusActive;

llSetTimerEvent(MENU_TIMEOUT_CHECK);

// Display menu
llDialog(id, menuTitle, menuNavigateButtons + menuButtons, channel);
}

// ********************************************************************
// Event Handlers
// ********************************************************************

default
{
listen(integer channel, string name, key id, string message)
{
if (message == BACK)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)-1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == FOWARD)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)+1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == " ")
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3);
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else
{
integer index = llListFindList(menusDescription, [channel]);
llMessageLinked(llList2Integer(menusDescription, index+3), LINK_MENU_RETURN, llList2String(menusDescription, index+2)+"|"+message, id);
RemoveMenu(channel, FALSE);
}
}

link_message(integer senderNum, integer num, string message, key id)
{
if (num == LINK_MENU_DISPLAY) NewMenu(message, senderNum, id);
else if (num == LINK_MENU_CLOSE) RemoveUser(id);
}

timer()
{ // Check through timers and close if necessary
integer i;
list toRemove;
integer currentTime = llGetUnixTime();
integer length = llGetListLength(menusActive);

for(i=0;i<length;i+=STRIDE_ACTIVE)
{
if (currentTime - llList2Integer(menusActive, i+2) > MENU_TIMEOUT) toRemove = [llList2Integer(menusActive, i)] + toRemove;
}

length = llGetListLength(toRemove);
if (length > 0)
{
for(i=0;i<length;i++)
{
RemoveMenu(llList2Integer(toRemove, i), TRUE);
}
}
}
}

</lsl>

==See also==
*[[ Script_Library | Script Library ]]

MultiUser Dialog Handler

2010-10-14T02:30:37Z

SimonT Quinnell: /* Calling a Simple Menu */

==Introduction==

I found that i was constantly rewriting a pile of dialog handling functions in my scrips so i decided to write a single dialog handler script. It needed to have the following features;

* Support multiple simultaneous menus from different users.
* Support fixed top buttons that will persist on lists.
* Support fixed bottom buttons with include Back and Exit buttons.
* Handle item lists > 12 and automatically insert << and >> buttons to scroll through the lists.
* Handle timeouts and communicate timeout back to calling script.
* Handles truncation of the buttons and text to stop errors in llDialog

==Using The Script==

===Calling a Simple Menu===
In the script that is calling the menu I use a function something like this. This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|-
| || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu"; //An identifier to show what menu called the script.
string menuNavigate = "TRUE"; //The display of the bottom navigation buttons is set to TRUE
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuNavigate+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

===Calling a Complex Menu===
The above case is a simple menu. The script can also do more complex menus.

In the following case we will have 10 buttons that are going to be displayed. Because we will also display the bottom 3 buttons this will be spanned across 2 menus. We will also include 2 fixed buttons that always display at the top of the menu, PLUS each button has a unique descriptor that is displayed.

This will display the following 2 menus

Menu1
Main text displayed.
item1
item2
item3
item4
item5
item6
item7

{| border="1"
|FIXED1 || FIXED2 || B1
|-
|B2 || B3 || B4
|-
|B5 || B6 || B7
|-
| || Back || >>
|}

Menu2 (on clicking the >> button)
Main text displayed.
item8
item9
item10

{| border="1"
|FIXED1 || FIXED2 || B8
|-
| B9 || B10 ||
|-
| << || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu|TRUE";
string menuText = "Main text displayed.~text1~text2~text3~text4~text5~text6~text7~text8~text9~text10";
string menuButtons = "B1~B2~B3~B4~B5~B6~B7~B8~B9~B10";
string menuFixedButtons = "FIXED1~FIXED2"

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuText+"|"+ menuButtons+"|"+menuFixedButtons, id);
}
</lsl>

===Parsing the returning Menu information===

Note that if the user clicks on the << or >> buttons the calling script WILL NOT see any response. The correct menu is displayed. The calling script only receives a response when one of the buttons or Back/Exit are clicked. Clicking on a space button will cause the menu to redisplay.

The script that expects the response back from the menu has the following

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

default
{
link_message(integer intSenderNum, integer num, string message, key id)
{
if (num == LINK_MENU_RETURN)
{
list returnMenu = llParseString2List(message, ["|"], []);
string menuDescriptor = llList2String(returnMenu,0); // The idenfifying descriptor. I sometimes use the name of the script plus menu and parent menu name

if (menuDescriptor == "mymenu")
{ // Is this my menu that is sending this message?
string item = llList2String(returnMenu,1); // The actual button pushed

// id == the key of the menu user.
// The button pressed in the menu is 'item', so now do something with it
}
}
else if (num == LINK_MENU_TIMEOUT)
{
// We received a timeout (don't worry the listens are all dealt with) so you might want to IM the menu user.
}
}
}
</lsl>

==The Script==
<lsl>
// ********************************************************************
//
// Menu Display Script
//
// Menu command format
// string = menuname ~ menuparent | display navigate? TRUE/FALSE | menuMaintitle~subtitle1~subtitle2~subtitle3 | button1~button2~button3 {| fixedbutton1~fixedbutton2~fixedbutton3 optional}
// key = menuuser key
//
//
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]
// menusActive [menuchannel, menuhandle, time, page]
//
// by SimonT Quinnell
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

// Main Menu Details
string BACK = "<<";
string FOWARD = ">>";
list MENU_NAVIGATE_BUTTONS = [ " ", "Back", "Exit"];
float MENU_TIMEOUT_CHECK = 10.0;
integer MENU_TIMEOUT = 120;
integer MAX_TEXT = 510;

integer STRIDE_DESCRIPTION = 8;
integer STRIDE_ACTIVE = 4;
integer DEBUG = FALSE;

// ********************************************************************
// Variables
// ********************************************************************

list menusDescription;
list menusActive;

// ********************************************************************
// Functions - General
// ********************************************************************

debug(string debug)
{
if (DEBUG) llWhisper(0,"DEBUG:"+llGetScriptName()+":"+debug+" : Free("+(string)llGetFreeMemory()+")");
}

integer string2Bool (string test)
{
if (test == "TRUE") return TRUE;
else return FALSE;
}

// ********************************************************************
// Functions - Menu Helpers
// ********************************************************************

integer NewChannel()
{ // generates unique channel number
integer channel;

do channel = -(llRound(llFrand(999999)) + 99999);
while (~llListFindList(menusDescription, [channel]));

return channel;
}

string CheckTitleLength(string title)
{
if (llStringLength(title) > MAX_TEXT) title = llGetSubString(title, 0, MAX_TEXT-1);

return title;
}

list FillMenu(list buttons)
{ //adds empty buttons until the list length is multiple of 3, to max of 12
integer i;
list listButtons;

for(i=0;i<llGetListLength(buttons);i++)
{
string name = llList2String(buttons,i);
if (llStringLength(name) > 24) name = llGetSubString(name, 0, 23);
listButtons = listButtons + [name];
}

while (llGetListLength(listButtons) != 3 && llGetListLength(listButtons) != 6 && llGetListLength(listButtons) != 9 && llGetListLength(listButtons) < 12)
{
listButtons = listButtons + [" "];
}

buttons = llList2List(listButtons, 9, 11);
buttons = buttons + llList2List(listButtons, 6, 8);
buttons = buttons + llList2List(listButtons, 3, 5);
buttons = buttons + llList2List(listButtons, 0, 2);

return buttons;
}

RemoveUser(key id)
{
integer index_id = llListFindList(menusDescription, [id]);

while (~index_id)
{
integer channel = llList2Integer(menusDescription, index_id-1);
RemoveMenu(channel, FALSE);
}
}

RemoveMenu(integer channel, integer echo)
{
integer index = llListFindList(menusDescription, [channel]);

if (index != -1)
{
key id = llList2Key(menusDescription, index+1);
menusDescription = llDeleteSubList(menusDescription, index, index + STRIDE_DESCRIPTION -1);
RemoveListen(channel);

if (echo) llMessageLinked(LINK_THIS, LINK_MENU_TIMEOUT, "Timeout", id);
}
}

RemoveListen(integer channel)
{
integer index = llListFindList(menusActive, [channel]);
if (index != -1)
{
llListenRemove(llList2Integer(menusActive, index + 1));
menusActive = llDeleteSubList(menusActive, index, index + STRIDE_ACTIVE - 1);
}
}

// ********************************************************************
// Functions - Menu Main
// ********************************************************************

NewMenu(string message, integer senderNum, key id)
{ // Setup New Menu
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]

list temp = llParseString2List(message, ["|"], []);
integer channel = NewChannel();

if (llGetListLength(temp) > 2)
{
menusDescription = [channel, id, llList2String(temp, 0), senderNum, string2Bool(llList2String(temp, 1)), llList2String(temp, 2), llList2String(temp, 3), llList2String(temp, 4)] + menusDescription;

DisplayMenu(id, channel, 0);
}
else llOwnerSay ("ERROR: Dialog Script. Incorrect menu format");
}

DisplayMenu(key id, integer channel, integer page)
{
string menuTitle;
list menuSubTitles;
list menuButtonsAll;
list menuButtons;
list menuNavigateButtons;
list menuFixedButtons;

integer max = 12;

// Populate values
integer index = llListFindList(menusDescription, [channel]);
menuButtonsAll = llParseString2List(llList2String(menusDescription, index+6), ["~"], []);
if (llList2String(menusDescription, index+7) != "") menuFixedButtons = llParseString2List(llList2String(menusDescription, index+7), ["~"], []);

// Set up the menu buttons
if (llList2Integer(menusDescription, index+4)) menuNavigateButtons= MENU_NAVIGATE_BUTTONS;
else if (llGetListLength(menuButtonsAll) > (max-llGetListLength(menuFixedButtons))) menuNavigateButtons = [" ", " ", " "];

// FIXME: add sanity check for menu page

max = max - llGetListLength(menuFixedButtons) - llGetListLength(menuNavigateButtons);
integer start = page*max;
integer stop = (page+1)*max - 1;
menuButtons = FillMenu(menuFixedButtons + llList2List(menuButtonsAll, start, stop));

// Generate the title
list tempTitle = llParseString2List(llList2String(menusDescription, index+5), ["~"], []);
menuTitle = llList2String(tempTitle,0);
if (llGetListLength(tempTitle) > 1) menuSubTitles = llList2List(tempTitle, 1, -1);
if (llGetListLength(menuSubTitles) > 0)
{
integer i;
for(i=start;i<(stop+1);++i)
{
if (llList2String(menuSubTitles, i) != "") menuTitle += "\n"+llList2String(menuSubTitles, i);
}
}
menuTitle = CheckTitleLength(menuTitle);

// Add navigate buttons if necessary
if (page > 0) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [BACK], 0, 0);
if (llGetListLength(menuButtonsAll) > (page+1)*max) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [FOWARD], 2, 2);

// Set up listen and add the row details
integer menuHandle = llListen(channel, "", id, "");
menusActive = [channel, menuHandle, llGetUnixTime(), page] + menusActive;

llSetTimerEvent(MENU_TIMEOUT_CHECK);

// Display menu
llDialog(id, menuTitle, menuNavigateButtons + menuButtons, channel);
}

// ********************************************************************
// Event Handlers
// ********************************************************************

default
{
listen(integer channel, string name, key id, string message)
{
if (message == BACK)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)-1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == FOWARD)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)+1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == " ")
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3);
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else
{
integer index = llListFindList(menusDescription, [channel]);
llMessageLinked(llList2Integer(menusDescription, index+3), LINK_MENU_RETURN, llList2String(menusDescription, index+2)+"|"+message, id);
RemoveMenu(channel, FALSE);
}
}

link_message(integer senderNum, integer num, string message, key id)
{
if (num == LINK_MENU_DISPLAY) NewMenu(message, senderNum, id);
else if (num == LINK_MENU_CLOSE) RemoveUser(id);
}

timer()
{ // Check through timers and close if necessary
integer i;
list toRemove;
integer currentTime = llGetUnixTime();
integer length = llGetListLength(menusActive);

for(i=0;i<length;i+=STRIDE_ACTIVE)
{
if (currentTime - llList2Integer(menusActive, i+2) > MENU_TIMEOUT) toRemove = [llList2Integer(menusActive, i)] + toRemove;
}

length = llGetListLength(toRemove);
if (length > 0)
{
for(i=0;i<length;i++)
{
RemoveMenu(llList2Integer(toRemove, i), TRUE);
}
}
}
}

</lsl>

==See also==
*[[ Script_Library | Script Library ]]

MultiUser Dialog Handler

2010-10-14T02:29:06Z

SimonT Quinnell: /* Calling a Simple Menu */

==Introduction==

I found that i was constantly rewriting a pile of dialog handling functions in my scrips so i decided to write a single dialog handler script. It needed to have the following features;

* Support multiple simultaneous menus from different users.
* Support fixed top buttons that will persist on lists.
* Support fixed bottom buttons with include Back and Exit buttons.
* Handle item lists > 12 and automatically insert << and >> buttons to scroll through the lists.
* Handle timeouts and communicate timeout back to calling script.
* Handles truncation of the buttons and text to stop errors in llDialog

==Using The Script==

===Calling a Simple Menu===
In the script that is calling the menu I use a function something like this. This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|-
| || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu|TRUE"; //An identifier to show what menu called the script. The display of the bottom navigation buttons is set to TRUE
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

===Calling a Complex Menu===
The above case is a simple menu. The script can also do more complex menus.

In the following case we will have 10 buttons that are going to be displayed. Because we will also display the bottom 3 buttons this will be spanned across 2 menus. We will also include 2 fixed buttons that always display at the top of the menu, PLUS each button has a unique descriptor that is displayed.

This will display the following 2 menus

Menu1
Main text displayed.
item1
item2
item3
item4
item5
item6
item7

{| border="1"
|FIXED1 || FIXED2 || B1
|-
|B2 || B3 || B4
|-
|B5 || B6 || B7
|-
| || Back || >>
|}

Menu2 (on clicking the >> button)
Main text displayed.
item8
item9
item10

{| border="1"
|FIXED1 || FIXED2 || B8
|-
| B9 || B10 ||
|-
| << || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu|TRUE";
string menuText = "Main text displayed.~text1~text2~text3~text4~text5~text6~text7~text8~text9~text10";
string menuButtons = "B1~B2~B3~B4~B5~B6~B7~B8~B9~B10";
string menuFixedButtons = "FIXED1~FIXED2"

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuText+"|"+ menuButtons+"|"+menuFixedButtons, id);
}
</lsl>

===Parsing the returning Menu information===

Note that if the user clicks on the << or >> buttons the calling script WILL NOT see any response. The correct menu is displayed. The calling script only receives a response when one of the buttons or Back/Exit are clicked. Clicking on a space button will cause the menu to redisplay.

The script that expects the response back from the menu has the following

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

default
{
link_message(integer intSenderNum, integer num, string message, key id)
{
if (num == LINK_MENU_RETURN)
{
list returnMenu = llParseString2List(message, ["|"], []);
string menuDescriptor = llList2String(returnMenu,0); // The idenfifying descriptor. I sometimes use the name of the script plus menu and parent menu name

if (menuDescriptor == "mymenu")
{ // Is this my menu that is sending this message?
string item = llList2String(returnMenu,1); // The actual button pushed

// id == the key of the menu user.
// The button pressed in the menu is 'item', so now do something with it
}
}
else if (num == LINK_MENU_TIMEOUT)
{
// We received a timeout (don't worry the listens are all dealt with) so you might want to IM the menu user.
}
}
}
</lsl>

==The Script==
<lsl>
// ********************************************************************
//
// Menu Display Script
//
// Menu command format
// string = menuname ~ menuparent | display navigate? TRUE/FALSE | menuMaintitle~subtitle1~subtitle2~subtitle3 | button1~button2~button3 {| fixedbutton1~fixedbutton2~fixedbutton3 optional}
// key = menuuser key
//
//
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]
// menusActive [menuchannel, menuhandle, time, page]
//
// by SimonT Quinnell
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

// Main Menu Details
string BACK = "<<";
string FOWARD = ">>";
list MENU_NAVIGATE_BUTTONS = [ " ", "Back", "Exit"];
float MENU_TIMEOUT_CHECK = 10.0;
integer MENU_TIMEOUT = 120;
integer MAX_TEXT = 510;

integer STRIDE_DESCRIPTION = 8;
integer STRIDE_ACTIVE = 4;
integer DEBUG = FALSE;

// ********************************************************************
// Variables
// ********************************************************************

list menusDescription;
list menusActive;

// ********************************************************************
// Functions - General
// ********************************************************************

debug(string debug)
{
if (DEBUG) llWhisper(0,"DEBUG:"+llGetScriptName()+":"+debug+" : Free("+(string)llGetFreeMemory()+")");
}

integer string2Bool (string test)
{
if (test == "TRUE") return TRUE;
else return FALSE;
}

// ********************************************************************
// Functions - Menu Helpers
// ********************************************************************

integer NewChannel()
{ // generates unique channel number
integer channel;

do channel = -(llRound(llFrand(999999)) + 99999);
while (~llListFindList(menusDescription, [channel]));

return channel;
}

string CheckTitleLength(string title)
{
if (llStringLength(title) > MAX_TEXT) title = llGetSubString(title, 0, MAX_TEXT-1);

return title;
}

list FillMenu(list buttons)
{ //adds empty buttons until the list length is multiple of 3, to max of 12
integer i;
list listButtons;

for(i=0;i<llGetListLength(buttons);i++)
{
string name = llList2String(buttons,i);
if (llStringLength(name) > 24) name = llGetSubString(name, 0, 23);
listButtons = listButtons + [name];
}

while (llGetListLength(listButtons) != 3 && llGetListLength(listButtons) != 6 && llGetListLength(listButtons) != 9 && llGetListLength(listButtons) < 12)
{
listButtons = listButtons + [" "];
}

buttons = llList2List(listButtons, 9, 11);
buttons = buttons + llList2List(listButtons, 6, 8);
buttons = buttons + llList2List(listButtons, 3, 5);
buttons = buttons + llList2List(listButtons, 0, 2);

return buttons;
}

RemoveUser(key id)
{
integer index_id = llListFindList(menusDescription, [id]);

while (~index_id)
{
integer channel = llList2Integer(menusDescription, index_id-1);
RemoveMenu(channel, FALSE);
}
}

RemoveMenu(integer channel, integer echo)
{
integer index = llListFindList(menusDescription, [channel]);

if (index != -1)
{
key id = llList2Key(menusDescription, index+1);
menusDescription = llDeleteSubList(menusDescription, index, index + STRIDE_DESCRIPTION -1);
RemoveListen(channel);

if (echo) llMessageLinked(LINK_THIS, LINK_MENU_TIMEOUT, "Timeout", id);
}
}

RemoveListen(integer channel)
{
integer index = llListFindList(menusActive, [channel]);
if (index != -1)
{
llListenRemove(llList2Integer(menusActive, index + 1));
menusActive = llDeleteSubList(menusActive, index, index + STRIDE_ACTIVE - 1);
}
}

// ********************************************************************
// Functions - Menu Main
// ********************************************************************

NewMenu(string message, integer senderNum, key id)
{ // Setup New Menu
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]

list temp = llParseString2List(message, ["|"], []);
integer channel = NewChannel();

if (llGetListLength(temp) > 2)
{
menusDescription = [channel, id, llList2String(temp, 0), senderNum, string2Bool(llList2String(temp, 1)), llList2String(temp, 2), llList2String(temp, 3), llList2String(temp, 4)] + menusDescription;

DisplayMenu(id, channel, 0);
}
else llOwnerSay ("ERROR: Dialog Script. Incorrect menu format");
}

DisplayMenu(key id, integer channel, integer page)
{
string menuTitle;
list menuSubTitles;
list menuButtonsAll;
list menuButtons;
list menuNavigateButtons;
list menuFixedButtons;

integer max = 12;

// Populate values
integer index = llListFindList(menusDescription, [channel]);
menuButtonsAll = llParseString2List(llList2String(menusDescription, index+6), ["~"], []);
if (llList2String(menusDescription, index+7) != "") menuFixedButtons = llParseString2List(llList2String(menusDescription, index+7), ["~"], []);

// Set up the menu buttons
if (llList2Integer(menusDescription, index+4)) menuNavigateButtons= MENU_NAVIGATE_BUTTONS;
else if (llGetListLength(menuButtonsAll) > (max-llGetListLength(menuFixedButtons))) menuNavigateButtons = [" ", " ", " "];

// FIXME: add sanity check for menu page

max = max - llGetListLength(menuFixedButtons) - llGetListLength(menuNavigateButtons);
integer start = page*max;
integer stop = (page+1)*max - 1;
menuButtons = FillMenu(menuFixedButtons + llList2List(menuButtonsAll, start, stop));

// Generate the title
list tempTitle = llParseString2List(llList2String(menusDescription, index+5), ["~"], []);
menuTitle = llList2String(tempTitle,0);
if (llGetListLength(tempTitle) > 1) menuSubTitles = llList2List(tempTitle, 1, -1);
if (llGetListLength(menuSubTitles) > 0)
{
integer i;
for(i=start;i<(stop+1);++i)
{
if (llList2String(menuSubTitles, i) != "") menuTitle += "\n"+llList2String(menuSubTitles, i);
}
}
menuTitle = CheckTitleLength(menuTitle);

// Add navigate buttons if necessary
if (page > 0) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [BACK], 0, 0);
if (llGetListLength(menuButtonsAll) > (page+1)*max) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [FOWARD], 2, 2);

// Set up listen and add the row details
integer menuHandle = llListen(channel, "", id, "");
menusActive = [channel, menuHandle, llGetUnixTime(), page] + menusActive;

llSetTimerEvent(MENU_TIMEOUT_CHECK);

// Display menu
llDialog(id, menuTitle, menuNavigateButtons + menuButtons, channel);
}

// ********************************************************************
// Event Handlers
// ********************************************************************

default
{
listen(integer channel, string name, key id, string message)
{
if (message == BACK)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)-1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == FOWARD)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)+1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == " ")
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3);
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else
{
integer index = llListFindList(menusDescription, [channel]);
llMessageLinked(llList2Integer(menusDescription, index+3), LINK_MENU_RETURN, llList2String(menusDescription, index+2)+"|"+message, id);
RemoveMenu(channel, FALSE);
}
}

link_message(integer senderNum, integer num, string message, key id)
{
if (num == LINK_MENU_DISPLAY) NewMenu(message, senderNum, id);
else if (num == LINK_MENU_CLOSE) RemoveUser(id);
}

timer()
{ // Check through timers and close if necessary
integer i;
list toRemove;
integer currentTime = llGetUnixTime();
integer length = llGetListLength(menusActive);

for(i=0;i<length;i+=STRIDE_ACTIVE)
{
if (currentTime - llList2Integer(menusActive, i+2) > MENU_TIMEOUT) toRemove = [llList2Integer(menusActive, i)] + toRemove;
}

length = llGetListLength(toRemove);
if (length > 0)
{
for(i=0;i<length;i++)
{
RemoveMenu(llList2Integer(toRemove, i), TRUE);
}
}
}
}

</lsl>

==See also==
*[[ Script_Library | Script Library ]]

MultiUser Dialog Handler

2010-10-14T02:28:44Z

SimonT Quinnell: /* Calling a Complex Menu */

==Introduction==

I found that i was constantly rewriting a pile of dialog handling functions in my scrips so i decided to write a single dialog handler script. It needed to have the following features;

* Support multiple simultaneous menus from different users.
* Support fixed top buttons that will persist on lists.
* Support fixed bottom buttons with include Back and Exit buttons.
* Handle item lists > 12 and automatically insert << and >> buttons to scroll through the lists.
* Handle timeouts and communicate timeout back to calling script.
* Handles truncation of the buttons and text to stop errors in llDialog

==Using The Script==

===Calling a Simple Menu===
In the script that is calling the menu I use a function something like this. This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|-
| || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "menudescriptor|TRUE"; //An identifier to show what menu called the script. The display of the bottom navigation buttons is set to TRUE
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

===Calling a Complex Menu===
The above case is a simple menu. The script can also do more complex menus.

In the following case we will have 10 buttons that are going to be displayed. Because we will also display the bottom 3 buttons this will be spanned across 2 menus. We will also include 2 fixed buttons that always display at the top of the menu, PLUS each button has a unique descriptor that is displayed.

This will display the following 2 menus

Menu1
Main text displayed.
item1
item2
item3
item4
item5
item6
item7

{| border="1"
|FIXED1 || FIXED2 || B1
|-
|B2 || B3 || B4
|-
|B5 || B6 || B7
|-
| || Back || >>
|}

Menu2 (on clicking the >> button)
Main text displayed.
item8
item9
item10

{| border="1"
|FIXED1 || FIXED2 || B8
|-
| B9 || B10 ||
|-
| << || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenu|TRUE";
string menuText = "Main text displayed.~text1~text2~text3~text4~text5~text6~text7~text8~text9~text10";
string menuButtons = "B1~B2~B3~B4~B5~B6~B7~B8~B9~B10";
string menuFixedButtons = "FIXED1~FIXED2"

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuText+"|"+ menuButtons+"|"+menuFixedButtons, id);
}
</lsl>

===Parsing the returning Menu information===

Note that if the user clicks on the << or >> buttons the calling script WILL NOT see any response. The correct menu is displayed. The calling script only receives a response when one of the buttons or Back/Exit are clicked. Clicking on a space button will cause the menu to redisplay.

The script that expects the response back from the menu has the following

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

default
{
link_message(integer intSenderNum, integer num, string message, key id)
{
if (num == LINK_MENU_RETURN)
{
list returnMenu = llParseString2List(message, ["|"], []);
string menuDescriptor = llList2String(returnMenu,0); // The idenfifying descriptor. I sometimes use the name of the script plus menu and parent menu name

if (menuDescriptor == "mymenu")
{ // Is this my menu that is sending this message?
string item = llList2String(returnMenu,1); // The actual button pushed

// id == the key of the menu user.
// The button pressed in the menu is 'item', so now do something with it
}
}
else if (num == LINK_MENU_TIMEOUT)
{
// We received a timeout (don't worry the listens are all dealt with) so you might want to IM the menu user.
}
}
}
</lsl>

==The Script==
<lsl>
// ********************************************************************
//
// Menu Display Script
//
// Menu command format
// string = menuname ~ menuparent | display navigate? TRUE/FALSE | menuMaintitle~subtitle1~subtitle2~subtitle3 | button1~button2~button3 {| fixedbutton1~fixedbutton2~fixedbutton3 optional}
// key = menuuser key
//
//
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]
// menusActive [menuchannel, menuhandle, time, page]
//
// by SimonT Quinnell
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

// Main Menu Details
string BACK = "<<";
string FOWARD = ">>";
list MENU_NAVIGATE_BUTTONS = [ " ", "Back", "Exit"];
float MENU_TIMEOUT_CHECK = 10.0;
integer MENU_TIMEOUT = 120;
integer MAX_TEXT = 510;

integer STRIDE_DESCRIPTION = 8;
integer STRIDE_ACTIVE = 4;
integer DEBUG = FALSE;

// ********************************************************************
// Variables
// ********************************************************************

list menusDescription;
list menusActive;

// ********************************************************************
// Functions - General
// ********************************************************************

debug(string debug)
{
if (DEBUG) llWhisper(0,"DEBUG:"+llGetScriptName()+":"+debug+" : Free("+(string)llGetFreeMemory()+")");
}

integer string2Bool (string test)
{
if (test == "TRUE") return TRUE;
else return FALSE;
}

// ********************************************************************
// Functions - Menu Helpers
// ********************************************************************

integer NewChannel()
{ // generates unique channel number
integer channel;

do channel = -(llRound(llFrand(999999)) + 99999);
while (~llListFindList(menusDescription, [channel]));

return channel;
}

string CheckTitleLength(string title)
{
if (llStringLength(title) > MAX_TEXT) title = llGetSubString(title, 0, MAX_TEXT-1);

return title;
}

list FillMenu(list buttons)
{ //adds empty buttons until the list length is multiple of 3, to max of 12
integer i;
list listButtons;

for(i=0;i<llGetListLength(buttons);i++)
{
string name = llList2String(buttons,i);
if (llStringLength(name) > 24) name = llGetSubString(name, 0, 23);
listButtons = listButtons + [name];
}

while (llGetListLength(listButtons) != 3 && llGetListLength(listButtons) != 6 && llGetListLength(listButtons) != 9 && llGetListLength(listButtons) < 12)
{
listButtons = listButtons + [" "];
}

buttons = llList2List(listButtons, 9, 11);
buttons = buttons + llList2List(listButtons, 6, 8);
buttons = buttons + llList2List(listButtons, 3, 5);
buttons = buttons + llList2List(listButtons, 0, 2);

return buttons;
}

RemoveUser(key id)
{
integer index_id = llListFindList(menusDescription, [id]);

while (~index_id)
{
integer channel = llList2Integer(menusDescription, index_id-1);
RemoveMenu(channel, FALSE);
}
}

RemoveMenu(integer channel, integer echo)
{
integer index = llListFindList(menusDescription, [channel]);

if (index != -1)
{
key id = llList2Key(menusDescription, index+1);
menusDescription = llDeleteSubList(menusDescription, index, index + STRIDE_DESCRIPTION -1);
RemoveListen(channel);

if (echo) llMessageLinked(LINK_THIS, LINK_MENU_TIMEOUT, "Timeout", id);
}
}

RemoveListen(integer channel)
{
integer index = llListFindList(menusActive, [channel]);
if (index != -1)
{
llListenRemove(llList2Integer(menusActive, index + 1));
menusActive = llDeleteSubList(menusActive, index, index + STRIDE_ACTIVE - 1);
}
}

// ********************************************************************
// Functions - Menu Main
// ********************************************************************

NewMenu(string message, integer senderNum, key id)
{ // Setup New Menu
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]

list temp = llParseString2List(message, ["|"], []);
integer channel = NewChannel();

if (llGetListLength(temp) > 2)
{
menusDescription = [channel, id, llList2String(temp, 0), senderNum, string2Bool(llList2String(temp, 1)), llList2String(temp, 2), llList2String(temp, 3), llList2String(temp, 4)] + menusDescription;

DisplayMenu(id, channel, 0);
}
else llOwnerSay ("ERROR: Dialog Script. Incorrect menu format");
}

DisplayMenu(key id, integer channel, integer page)
{
string menuTitle;
list menuSubTitles;
list menuButtonsAll;
list menuButtons;
list menuNavigateButtons;
list menuFixedButtons;

integer max = 12;

// Populate values
integer index = llListFindList(menusDescription, [channel]);
menuButtonsAll = llParseString2List(llList2String(menusDescription, index+6), ["~"], []);
if (llList2String(menusDescription, index+7) != "") menuFixedButtons = llParseString2List(llList2String(menusDescription, index+7), ["~"], []);

// Set up the menu buttons
if (llList2Integer(menusDescription, index+4)) menuNavigateButtons= MENU_NAVIGATE_BUTTONS;
else if (llGetListLength(menuButtonsAll) > (max-llGetListLength(menuFixedButtons))) menuNavigateButtons = [" ", " ", " "];

// FIXME: add sanity check for menu page

max = max - llGetListLength(menuFixedButtons) - llGetListLength(menuNavigateButtons);
integer start = page*max;
integer stop = (page+1)*max - 1;
menuButtons = FillMenu(menuFixedButtons + llList2List(menuButtonsAll, start, stop));

// Generate the title
list tempTitle = llParseString2List(llList2String(menusDescription, index+5), ["~"], []);
menuTitle = llList2String(tempTitle,0);
if (llGetListLength(tempTitle) > 1) menuSubTitles = llList2List(tempTitle, 1, -1);
if (llGetListLength(menuSubTitles) > 0)
{
integer i;
for(i=start;i<(stop+1);++i)
{
if (llList2String(menuSubTitles, i) != "") menuTitle += "\n"+llList2String(menuSubTitles, i);
}
}
menuTitle = CheckTitleLength(menuTitle);

// Add navigate buttons if necessary
if (page > 0) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [BACK], 0, 0);
if (llGetListLength(menuButtonsAll) > (page+1)*max) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [FOWARD], 2, 2);

// Set up listen and add the row details
integer menuHandle = llListen(channel, "", id, "");
menusActive = [channel, menuHandle, llGetUnixTime(), page] + menusActive;

llSetTimerEvent(MENU_TIMEOUT_CHECK);

// Display menu
llDialog(id, menuTitle, menuNavigateButtons + menuButtons, channel);
}

// ********************************************************************
// Event Handlers
// ********************************************************************

default
{
listen(integer channel, string name, key id, string message)
{
if (message == BACK)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)-1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == FOWARD)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)+1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == " ")
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3);
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else
{
integer index = llListFindList(menusDescription, [channel]);
llMessageLinked(llList2Integer(menusDescription, index+3), LINK_MENU_RETURN, llList2String(menusDescription, index+2)+"|"+message, id);
RemoveMenu(channel, FALSE);
}
}

link_message(integer senderNum, integer num, string message, key id)
{
if (num == LINK_MENU_DISPLAY) NewMenu(message, senderNum, id);
else if (num == LINK_MENU_CLOSE) RemoveUser(id);
}

timer()
{ // Check through timers and close if necessary
integer i;
list toRemove;
integer currentTime = llGetUnixTime();
integer length = llGetListLength(menusActive);

for(i=0;i<length;i+=STRIDE_ACTIVE)
{
if (currentTime - llList2Integer(menusActive, i+2) > MENU_TIMEOUT) toRemove = [llList2Integer(menusActive, i)] + toRemove;
}

length = llGetListLength(toRemove);
if (length > 0)
{
for(i=0;i<length;i++)
{
RemoveMenu(llList2Integer(toRemove, i), TRUE);
}
}
}
}

</lsl>

==See also==
*[[ Script_Library | Script Library ]]

MultiUser Dialog Handler

2010-10-14T02:28:25Z

SimonT Quinnell: /* Calling a Complex Menu */

==Introduction==

I found that i was constantly rewriting a pile of dialog handling functions in my scrips so i decided to write a single dialog handler script. It needed to have the following features;

* Support multiple simultaneous menus from different users.
* Support fixed top buttons that will persist on lists.
* Support fixed bottom buttons with include Back and Exit buttons.
* Handle item lists > 12 and automatically insert << and >> buttons to scroll through the lists.
* Handle timeouts and communicate timeout back to calling script.
* Handles truncation of the buttons and text to stop errors in llDialog

==Using The Script==

===Calling a Simple Menu===
In the script that is calling the menu I use a function something like this. This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|-
| || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "menudescriptor|TRUE"; //An identifier to show what menu called the script. The display of the bottom navigation buttons is set to TRUE
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

===Calling a Complex Menu===
The above case is a simple menu. The script can also do more complex menus.

In the following case we will have 10 buttons that are going to be displayed. Because we will also display the bottom 3 buttons this will be spanned across 2 menus. We will also include 2 fixed buttons that always display at the top of the menu, PLUS each button has a unique descriptor that is displayed.

This will display the following 2 menus

Menu1
Main text displayed.
item1
item2
item3
item4
item5
item6
item7

{| border="1"
|FIXED1 || FIXED2 || B1
|-
|B2 || B3 || B4
|-
|B5 || B6 || B7
|-
| || Back || >>
|}

Menu2 (on clicking the >> button)
Main text displayed.
item8
item9
item10

{| border="1"
|FIXED1 || FIXED2 || B8
|-
| B9 || B10 ||
|-
| << || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "menutext|TRUE";
string menuText = "Main text displayed.~text1~text2~text3~text4~text5~text6~text7~text8~text9~text10";
string menuButtons = "B1~B2~B3~B4~B5~B6~B7~B8~B9~B10";
string menuFixedButtons = "FIXED1~FIXED2"

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuText+"|"+ menuButtons+"|"+menuFixedButtons, id);
}
</lsl>

===Parsing the returning Menu information===

Note that if the user clicks on the << or >> buttons the calling script WILL NOT see any response. The correct menu is displayed. The calling script only receives a response when one of the buttons or Back/Exit are clicked. Clicking on a space button will cause the menu to redisplay.

The script that expects the response back from the menu has the following

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

default
{
link_message(integer intSenderNum, integer num, string message, key id)
{
if (num == LINK_MENU_RETURN)
{
list returnMenu = llParseString2List(message, ["|"], []);
string menuDescriptor = llList2String(returnMenu,0); // The idenfifying descriptor. I sometimes use the name of the script plus menu and parent menu name

if (menuDescriptor == "mymenu")
{ // Is this my menu that is sending this message?
string item = llList2String(returnMenu,1); // The actual button pushed

// id == the key of the menu user.
// The button pressed in the menu is 'item', so now do something with it
}
}
else if (num == LINK_MENU_TIMEOUT)
{
// We received a timeout (don't worry the listens are all dealt with) so you might want to IM the menu user.
}
}
}
</lsl>

==The Script==
<lsl>
// ********************************************************************
//
// Menu Display Script
//
// Menu command format
// string = menuname ~ menuparent | display navigate? TRUE/FALSE | menuMaintitle~subtitle1~subtitle2~subtitle3 | button1~button2~button3 {| fixedbutton1~fixedbutton2~fixedbutton3 optional}
// key = menuuser key
//
//
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]
// menusActive [menuchannel, menuhandle, time, page]
//
// by SimonT Quinnell
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

// Main Menu Details
string BACK = "<<";
string FOWARD = ">>";
list MENU_NAVIGATE_BUTTONS = [ " ", "Back", "Exit"];
float MENU_TIMEOUT_CHECK = 10.0;
integer MENU_TIMEOUT = 120;
integer MAX_TEXT = 510;

integer STRIDE_DESCRIPTION = 8;
integer STRIDE_ACTIVE = 4;
integer DEBUG = FALSE;

// ********************************************************************
// Variables
// ********************************************************************

list menusDescription;
list menusActive;

// ********************************************************************
// Functions - General
// ********************************************************************

debug(string debug)
{
if (DEBUG) llWhisper(0,"DEBUG:"+llGetScriptName()+":"+debug+" : Free("+(string)llGetFreeMemory()+")");
}

integer string2Bool (string test)
{
if (test == "TRUE") return TRUE;
else return FALSE;
}

// ********************************************************************
// Functions - Menu Helpers
// ********************************************************************

integer NewChannel()
{ // generates unique channel number
integer channel;

do channel = -(llRound(llFrand(999999)) + 99999);
while (~llListFindList(menusDescription, [channel]));

return channel;
}

string CheckTitleLength(string title)
{
if (llStringLength(title) > MAX_TEXT) title = llGetSubString(title, 0, MAX_TEXT-1);

return title;
}

list FillMenu(list buttons)
{ //adds empty buttons until the list length is multiple of 3, to max of 12
integer i;
list listButtons;

for(i=0;i<llGetListLength(buttons);i++)
{
string name = llList2String(buttons,i);
if (llStringLength(name) > 24) name = llGetSubString(name, 0, 23);
listButtons = listButtons + [name];
}

while (llGetListLength(listButtons) != 3 && llGetListLength(listButtons) != 6 && llGetListLength(listButtons) != 9 && llGetListLength(listButtons) < 12)
{
listButtons = listButtons + [" "];
}

buttons = llList2List(listButtons, 9, 11);
buttons = buttons + llList2List(listButtons, 6, 8);
buttons = buttons + llList2List(listButtons, 3, 5);
buttons = buttons + llList2List(listButtons, 0, 2);

return buttons;
}

RemoveUser(key id)
{
integer index_id = llListFindList(menusDescription, [id]);

while (~index_id)
{
integer channel = llList2Integer(menusDescription, index_id-1);
RemoveMenu(channel, FALSE);
}
}

RemoveMenu(integer channel, integer echo)
{
integer index = llListFindList(menusDescription, [channel]);

if (index != -1)
{
key id = llList2Key(menusDescription, index+1);
menusDescription = llDeleteSubList(menusDescription, index, index + STRIDE_DESCRIPTION -1);
RemoveListen(channel);

if (echo) llMessageLinked(LINK_THIS, LINK_MENU_TIMEOUT, "Timeout", id);
}
}

RemoveListen(integer channel)
{
integer index = llListFindList(menusActive, [channel]);
if (index != -1)
{
llListenRemove(llList2Integer(menusActive, index + 1));
menusActive = llDeleteSubList(menusActive, index, index + STRIDE_ACTIVE - 1);
}
}

// ********************************************************************
// Functions - Menu Main
// ********************************************************************

NewMenu(string message, integer senderNum, key id)
{ // Setup New Menu
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]

list temp = llParseString2List(message, ["|"], []);
integer channel = NewChannel();

if (llGetListLength(temp) > 2)
{
menusDescription = [channel, id, llList2String(temp, 0), senderNum, string2Bool(llList2String(temp, 1)), llList2String(temp, 2), llList2String(temp, 3), llList2String(temp, 4)] + menusDescription;

DisplayMenu(id, channel, 0);
}
else llOwnerSay ("ERROR: Dialog Script. Incorrect menu format");
}

DisplayMenu(key id, integer channel, integer page)
{
string menuTitle;
list menuSubTitles;
list menuButtonsAll;
list menuButtons;
list menuNavigateButtons;
list menuFixedButtons;

integer max = 12;

// Populate values
integer index = llListFindList(menusDescription, [channel]);
menuButtonsAll = llParseString2List(llList2String(menusDescription, index+6), ["~"], []);
if (llList2String(menusDescription, index+7) != "") menuFixedButtons = llParseString2List(llList2String(menusDescription, index+7), ["~"], []);

// Set up the menu buttons
if (llList2Integer(menusDescription, index+4)) menuNavigateButtons= MENU_NAVIGATE_BUTTONS;
else if (llGetListLength(menuButtonsAll) > (max-llGetListLength(menuFixedButtons))) menuNavigateButtons = [" ", " ", " "];

// FIXME: add sanity check for menu page

max = max - llGetListLength(menuFixedButtons) - llGetListLength(menuNavigateButtons);
integer start = page*max;
integer stop = (page+1)*max - 1;
menuButtons = FillMenu(menuFixedButtons + llList2List(menuButtonsAll, start, stop));

// Generate the title
list tempTitle = llParseString2List(llList2String(menusDescription, index+5), ["~"], []);
menuTitle = llList2String(tempTitle,0);
if (llGetListLength(tempTitle) > 1) menuSubTitles = llList2List(tempTitle, 1, -1);
if (llGetListLength(menuSubTitles) > 0)
{
integer i;
for(i=start;i<(stop+1);++i)
{
if (llList2String(menuSubTitles, i) != "") menuTitle += "\n"+llList2String(menuSubTitles, i);
}
}
menuTitle = CheckTitleLength(menuTitle);

// Add navigate buttons if necessary
if (page > 0) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [BACK], 0, 0);
if (llGetListLength(menuButtonsAll) > (page+1)*max) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [FOWARD], 2, 2);

// Set up listen and add the row details
integer menuHandle = llListen(channel, "", id, "");
menusActive = [channel, menuHandle, llGetUnixTime(), page] + menusActive;

llSetTimerEvent(MENU_TIMEOUT_CHECK);

// Display menu
llDialog(id, menuTitle, menuNavigateButtons + menuButtons, channel);
}

// ********************************************************************
// Event Handlers
// ********************************************************************

default
{
listen(integer channel, string name, key id, string message)
{
if (message == BACK)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)-1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == FOWARD)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)+1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == " ")
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3);
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else
{
integer index = llListFindList(menusDescription, [channel]);
llMessageLinked(llList2Integer(menusDescription, index+3), LINK_MENU_RETURN, llList2String(menusDescription, index+2)+"|"+message, id);
RemoveMenu(channel, FALSE);
}
}

link_message(integer senderNum, integer num, string message, key id)
{
if (num == LINK_MENU_DISPLAY) NewMenu(message, senderNum, id);
else if (num == LINK_MENU_CLOSE) RemoveUser(id);
}

timer()
{ // Check through timers and close if necessary
integer i;
list toRemove;
integer currentTime = llGetUnixTime();
integer length = llGetListLength(menusActive);

for(i=0;i<length;i+=STRIDE_ACTIVE)
{
if (currentTime - llList2Integer(menusActive, i+2) > MENU_TIMEOUT) toRemove = [llList2Integer(menusActive, i)] + toRemove;
}

length = llGetListLength(toRemove);
if (length > 0)
{
for(i=0;i<length;i++)
{
RemoveMenu(llList2Integer(toRemove, i), TRUE);
}
}
}
}

</lsl>

==See also==
*[[ Script_Library | Script Library ]]

MultiUser Dialog Handler

2010-10-14T02:27:54Z

SimonT Quinnell: Undo revision 1062072 by SimonT Quinnell (Talk)

==Introduction==

I found that i was constantly rewriting a pile of dialog handling functions in my scrips so i decided to write a single dialog handler script. It needed to have the following features;

* Support multiple simultaneous menus from different users.
* Support fixed top buttons that will persist on lists.
* Support fixed bottom buttons with include Back and Exit buttons.
* Handle item lists > 12 and automatically insert << and >> buttons to scroll through the lists.
* Handle timeouts and communicate timeout back to calling script.
* Handles truncation of the buttons and text to stop errors in llDialog

==Using The Script==

===Calling a Simple Menu===
In the script that is calling the menu I use a function something like this. This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|-
| || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "menudescriptor|TRUE"; //An identifier to show what menu called the script. The display of the bottom navigation buttons is set to TRUE
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

===Calling a Complex Menu===
The above case is a simple menu. The script can also do more complex menus.

In the following case we will have 10 buttons that are going to be displayed. Because we will also display the bottom 3 buttons this will be spanned across 2 menus. We will also include 2 fixed buttons that always display at the top of the menu, PLUS each button has a unique descriptor that is displayed.

This will display the following 2 menus

Menu1
Main text displayed.
item1
item2
item3
item4
item5
item6
item7

{| border="1"
|FIXED1 || FIXED2 || B1
|-
|B2 || B3 || B4
|-
|B5 || B6 || B7
|-
| || Back || >>
|}

Menu2 (on clicking the >> button)
Main text displayed.
item8
item9
item10

{| border="1"
|FIXED1 || FIXED2 || B8
|-
| B9 || B10 ||
|-
| << || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "menudescriptor|TRUE";
string menuText = "Main text displayed.~text1~text2~text3~text4~text5~text6~text7~text8~text9~text10";
string menuButtons = "B1~B2~B3~B4~B5~B6~B7~B8~B9~B10";
string menuFixedButtons = "FIXED1~FIXED2"

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuText+"|"+ menuButtons+"|"+menuFixedButtons, id);
}
</lsl>

===Parsing the returning Menu information===

Note that if the user clicks on the << or >> buttons the calling script WILL NOT see any response. The correct menu is displayed. The calling script only receives a response when one of the buttons or Back/Exit are clicked. Clicking on a space button will cause the menu to redisplay.

The script that expects the response back from the menu has the following

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

default
{
link_message(integer intSenderNum, integer num, string message, key id)
{
if (num == LINK_MENU_RETURN)
{
list returnMenu = llParseString2List(message, ["|"], []);
string menuDescriptor = llList2String(returnMenu,0); // The idenfifying descriptor. I sometimes use the name of the script plus menu and parent menu name

if (menuDescriptor == "mymenu")
{ // Is this my menu that is sending this message?
string item = llList2String(returnMenu,1); // The actual button pushed

// id == the key of the menu user.
// The button pressed in the menu is 'item', so now do something with it
}
}
else if (num == LINK_MENU_TIMEOUT)
{
// We received a timeout (don't worry the listens are all dealt with) so you might want to IM the menu user.
}
}
}
</lsl>

==The Script==
<lsl>
// ********************************************************************
//
// Menu Display Script
//
// Menu command format
// string = menuname ~ menuparent | display navigate? TRUE/FALSE | menuMaintitle~subtitle1~subtitle2~subtitle3 | button1~button2~button3 {| fixedbutton1~fixedbutton2~fixedbutton3 optional}
// key = menuuser key
//
//
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]
// menusActive [menuchannel, menuhandle, time, page]
//
// by SimonT Quinnell
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

// Main Menu Details
string BACK = "<<";
string FOWARD = ">>";
list MENU_NAVIGATE_BUTTONS = [ " ", "Back", "Exit"];
float MENU_TIMEOUT_CHECK = 10.0;
integer MENU_TIMEOUT = 120;
integer MAX_TEXT = 510;

integer STRIDE_DESCRIPTION = 8;
integer STRIDE_ACTIVE = 4;
integer DEBUG = FALSE;

// ********************************************************************
// Variables
// ********************************************************************

list menusDescription;
list menusActive;

// ********************************************************************
// Functions - General
// ********************************************************************

debug(string debug)
{
if (DEBUG) llWhisper(0,"DEBUG:"+llGetScriptName()+":"+debug+" : Free("+(string)llGetFreeMemory()+")");
}

integer string2Bool (string test)
{
if (test == "TRUE") return TRUE;
else return FALSE;
}

// ********************************************************************
// Functions - Menu Helpers
// ********************************************************************

integer NewChannel()
{ // generates unique channel number
integer channel;

do channel = -(llRound(llFrand(999999)) + 99999);
while (~llListFindList(menusDescription, [channel]));

return channel;
}

string CheckTitleLength(string title)
{
if (llStringLength(title) > MAX_TEXT) title = llGetSubString(title, 0, MAX_TEXT-1);

return title;
}

list FillMenu(list buttons)
{ //adds empty buttons until the list length is multiple of 3, to max of 12
integer i;
list listButtons;

for(i=0;i<llGetListLength(buttons);i++)
{
string name = llList2String(buttons,i);
if (llStringLength(name) > 24) name = llGetSubString(name, 0, 23);
listButtons = listButtons + [name];
}

while (llGetListLength(listButtons) != 3 && llGetListLength(listButtons) != 6 && llGetListLength(listButtons) != 9 && llGetListLength(listButtons) < 12)
{
listButtons = listButtons + [" "];
}

buttons = llList2List(listButtons, 9, 11);
buttons = buttons + llList2List(listButtons, 6, 8);
buttons = buttons + llList2List(listButtons, 3, 5);
buttons = buttons + llList2List(listButtons, 0, 2);

return buttons;
}

RemoveUser(key id)
{
integer index_id = llListFindList(menusDescription, [id]);

while (~index_id)
{
integer channel = llList2Integer(menusDescription, index_id-1);
RemoveMenu(channel, FALSE);
}
}

RemoveMenu(integer channel, integer echo)
{
integer index = llListFindList(menusDescription, [channel]);

if (index != -1)
{
key id = llList2Key(menusDescription, index+1);
menusDescription = llDeleteSubList(menusDescription, index, index + STRIDE_DESCRIPTION -1);
RemoveListen(channel);

if (echo) llMessageLinked(LINK_THIS, LINK_MENU_TIMEOUT, "Timeout", id);
}
}

RemoveListen(integer channel)
{
integer index = llListFindList(menusActive, [channel]);
if (index != -1)
{
llListenRemove(llList2Integer(menusActive, index + 1));
menusActive = llDeleteSubList(menusActive, index, index + STRIDE_ACTIVE - 1);
}
}

// ********************************************************************
// Functions - Menu Main
// ********************************************************************

NewMenu(string message, integer senderNum, key id)
{ // Setup New Menu
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]

list temp = llParseString2List(message, ["|"], []);
integer channel = NewChannel();

if (llGetListLength(temp) > 2)
{
menusDescription = [channel, id, llList2String(temp, 0), senderNum, string2Bool(llList2String(temp, 1)), llList2String(temp, 2), llList2String(temp, 3), llList2String(temp, 4)] + menusDescription;

DisplayMenu(id, channel, 0);
}
else llOwnerSay ("ERROR: Dialog Script. Incorrect menu format");
}

DisplayMenu(key id, integer channel, integer page)
{
string menuTitle;
list menuSubTitles;
list menuButtonsAll;
list menuButtons;
list menuNavigateButtons;
list menuFixedButtons;

integer max = 12;

// Populate values
integer index = llListFindList(menusDescription, [channel]);
menuButtonsAll = llParseString2List(llList2String(menusDescription, index+6), ["~"], []);
if (llList2String(menusDescription, index+7) != "") menuFixedButtons = llParseString2List(llList2String(menusDescription, index+7), ["~"], []);

// Set up the menu buttons
if (llList2Integer(menusDescription, index+4)) menuNavigateButtons= MENU_NAVIGATE_BUTTONS;
else if (llGetListLength(menuButtonsAll) > (max-llGetListLength(menuFixedButtons))) menuNavigateButtons = [" ", " ", " "];

// FIXME: add sanity check for menu page

max = max - llGetListLength(menuFixedButtons) - llGetListLength(menuNavigateButtons);
integer start = page*max;
integer stop = (page+1)*max - 1;
menuButtons = FillMenu(menuFixedButtons + llList2List(menuButtonsAll, start, stop));

// Generate the title
list tempTitle = llParseString2List(llList2String(menusDescription, index+5), ["~"], []);
menuTitle = llList2String(tempTitle,0);
if (llGetListLength(tempTitle) > 1) menuSubTitles = llList2List(tempTitle, 1, -1);
if (llGetListLength(menuSubTitles) > 0)
{
integer i;
for(i=start;i<(stop+1);++i)
{
if (llList2String(menuSubTitles, i) != "") menuTitle += "\n"+llList2String(menuSubTitles, i);
}
}
menuTitle = CheckTitleLength(menuTitle);

// Add navigate buttons if necessary
if (page > 0) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [BACK], 0, 0);
if (llGetListLength(menuButtonsAll) > (page+1)*max) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [FOWARD], 2, 2);

// Set up listen and add the row details
integer menuHandle = llListen(channel, "", id, "");
menusActive = [channel, menuHandle, llGetUnixTime(), page] + menusActive;

llSetTimerEvent(MENU_TIMEOUT_CHECK);

// Display menu
llDialog(id, menuTitle, menuNavigateButtons + menuButtons, channel);
}

// ********************************************************************
// Event Handlers
// ********************************************************************

default
{
listen(integer channel, string name, key id, string message)
{
if (message == BACK)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)-1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == FOWARD)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)+1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == " ")
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3);
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else
{
integer index = llListFindList(menusDescription, [channel]);
llMessageLinked(llList2Integer(menusDescription, index+3), LINK_MENU_RETURN, llList2String(menusDescription, index+2)+"|"+message, id);
RemoveMenu(channel, FALSE);
}
}

link_message(integer senderNum, integer num, string message, key id)
{
if (num == LINK_MENU_DISPLAY) NewMenu(message, senderNum, id);
else if (num == LINK_MENU_CLOSE) RemoveUser(id);
}

timer()
{ // Check through timers and close if necessary
integer i;
list toRemove;
integer currentTime = llGetUnixTime();
integer length = llGetListLength(menusActive);

for(i=0;i<length;i+=STRIDE_ACTIVE)
{
if (currentTime - llList2Integer(menusActive, i+2) > MENU_TIMEOUT) toRemove = [llList2Integer(menusActive, i)] + toRemove;
}

length = llGetListLength(toRemove);
if (length > 0)
{
for(i=0;i<length;i++)
{
RemoveMenu(llList2Integer(toRemove, i), TRUE);
}
}
}
}

</lsl>

==See also==
*[[ Script_Library | Script Library ]]

MultiUser Dialog Handler

2010-10-14T02:27:05Z

SimonT Quinnell: /* Calling a Complex Menu */

==Introduction==

I found that i was constantly rewriting a pile of dialog handling functions in my scrips so i decided to write a single dialog handler script. It needed to have the following features;

* Support multiple simultaneous menus from different users.
* Support fixed top buttons that will persist on lists.
* Support fixed bottom buttons with include Back and Exit buttons.
* Handle item lists > 12 and automatically insert << and >> buttons to scroll through the lists.
* Handle timeouts and communicate timeout back to calling script.
* Handles truncation of the buttons and text to stop errors in llDialog

==Using The Script==

===Calling a Simple Menu===
In the script that is calling the menu I use a function something like this. This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|-
| || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "menudescriptor|TRUE"; //An identifier to show what menu called the script. The display of the bottom navigation buttons is set to TRUE
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

===Calling a Complex Menu===
The above case is a simple menu. The script can also do more complex menus.

In the following case we will have 10 buttons that are going to be displayed. Because we will also display the bottom 3 buttons this will be spanned across 2 menus. We will also include 2 fixed buttons that always display at the top of the menu, PLUS each button has a unique descriptor that is displayed.

This will display the following 2 menus

Menu1
Main text displayed.
item1
item2
item3
item4
item5
item6
item7

{| border="1"
|FIXED1 || FIXED2 || B1
|-
|B2 || B3 || B4
|-
|B5 || B6 || B7
|-
| || Back || >>
|}

Menu2 (on clicking the >> button)
Main text displayed.
item8
item9
item10

{| border="1"
|FIXED1 || FIXED2 || B8
|-
| B9 || B10 ||
|-
| << || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "mymenuext displayed.~text1~text2~text3~text4~text5~text6~text7~text8~text9~text10";
string menuButtons = "B1~B2~B3~B4~B5~B6~B7~B8~B9~B10";
string menuFixedButtons = "FIXED1~FIXED2"

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuText+"|"+ menuButtons+"|"+menuFixedButtons, id);
}
</lsl>

===Parsing the returning Menu information===

Note that if the user clicks on the << or >> buttons the calling script WILL NOT see any response. The correct menu is displayed. The calling script only receives a response when one of the buttons or Back/Exit are clicked. Clicking on a space button will cause the menu to redisplay.

The script that expects the response back from the menu has the following

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

default
{
link_message(integer intSenderNum, integer num, string message, key id)
{
if (num == LINK_MENU_RETURN)
{
list returnMenu = llParseString2List(message, ["|"], []);
string menuDescriptor = llList2String(returnMenu,0); // The idenfifying descriptor. I sometimes use the name of the script plus menu and parent menu name

if (menuDescriptor == "mymenu")
{ // Is this my menu that is sending this message?
string item = llList2String(returnMenu,1); // The actual button pushed

// id == the key of the menu user.
// The button pressed in the menu is 'item', so now do something with it
}
}
else if (num == LINK_MENU_TIMEOUT)
{
// We received a timeout (don't worry the listens are all dealt with) so you might want to IM the menu user.
}
}
}
</lsl>

==The Script==
<lsl>
// ********************************************************************
//
// Menu Display Script
//
// Menu command format
// string = menuname ~ menuparent | display navigate? TRUE/FALSE | menuMaintitle~subtitle1~subtitle2~subtitle3 | button1~button2~button3 {| fixedbutton1~fixedbutton2~fixedbutton3 optional}
// key = menuuser key
//
//
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]
// menusActive [menuchannel, menuhandle, time, page]
//
// by SimonT Quinnell
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

// Main Menu Details
string BACK = "<<";
string FOWARD = ">>";
list MENU_NAVIGATE_BUTTONS = [ " ", "Back", "Exit"];
float MENU_TIMEOUT_CHECK = 10.0;
integer MENU_TIMEOUT = 120;
integer MAX_TEXT = 510;

integer STRIDE_DESCRIPTION = 8;
integer STRIDE_ACTIVE = 4;
integer DEBUG = FALSE;

// ********************************************************************
// Variables
// ********************************************************************

list menusDescription;
list menusActive;

// ********************************************************************
// Functions - General
// ********************************************************************

debug(string debug)
{
if (DEBUG) llWhisper(0,"DEBUG:"+llGetScriptName()+":"+debug+" : Free("+(string)llGetFreeMemory()+")");
}

integer string2Bool (string test)
{
if (test == "TRUE") return TRUE;
else return FALSE;
}

// ********************************************************************
// Functions - Menu Helpers
// ********************************************************************

integer NewChannel()
{ // generates unique channel number
integer channel;

do channel = -(llRound(llFrand(999999)) + 99999);
while (~llListFindList(menusDescription, [channel]));

return channel;
}

string CheckTitleLength(string title)
{
if (llStringLength(title) > MAX_TEXT) title = llGetSubString(title, 0, MAX_TEXT-1);

return title;
}

list FillMenu(list buttons)
{ //adds empty buttons until the list length is multiple of 3, to max of 12
integer i;
list listButtons;

for(i=0;i<llGetListLength(buttons);i++)
{
string name = llList2String(buttons,i);
if (llStringLength(name) > 24) name = llGetSubString(name, 0, 23);
listButtons = listButtons + [name];
}

while (llGetListLength(listButtons) != 3 && llGetListLength(listButtons) != 6 && llGetListLength(listButtons) != 9 && llGetListLength(listButtons) < 12)
{
listButtons = listButtons + [" "];
}

buttons = llList2List(listButtons, 9, 11);
buttons = buttons + llList2List(listButtons, 6, 8);
buttons = buttons + llList2List(listButtons, 3, 5);
buttons = buttons + llList2List(listButtons, 0, 2);

return buttons;
}

RemoveUser(key id)
{
integer index_id = llListFindList(menusDescription, [id]);

while (~index_id)
{
integer channel = llList2Integer(menusDescription, index_id-1);
RemoveMenu(channel, FALSE);
}
}

RemoveMenu(integer channel, integer echo)
{
integer index = llListFindList(menusDescription, [channel]);

if (index != -1)
{
key id = llList2Key(menusDescription, index+1);
menusDescription = llDeleteSubList(menusDescription, index, index + STRIDE_DESCRIPTION -1);
RemoveListen(channel);

if (echo) llMessageLinked(LINK_THIS, LINK_MENU_TIMEOUT, "Timeout", id);
}
}

RemoveListen(integer channel)
{
integer index = llListFindList(menusActive, [channel]);
if (index != -1)
{
llListenRemove(llList2Integer(menusActive, index + 1));
menusActive = llDeleteSubList(menusActive, index, index + STRIDE_ACTIVE - 1);
}
}

// ********************************************************************
// Functions - Menu Main
// ********************************************************************

NewMenu(string message, integer senderNum, key id)
{ // Setup New Menu
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]

list temp = llParseString2List(message, ["|"], []);
integer channel = NewChannel();

if (llGetListLength(temp) > 2)
{
menusDescription = [channel, id, llList2String(temp, 0), senderNum, string2Bool(llList2String(temp, 1)), llList2String(temp, 2), llList2String(temp, 3), llList2String(temp, 4)] + menusDescription;

DisplayMenu(id, channel, 0);
}
else llOwnerSay ("ERROR: Dialog Script. Incorrect menu format");
}

DisplayMenu(key id, integer channel, integer page)
{
string menuTitle;
list menuSubTitles;
list menuButtonsAll;
list menuButtons;
list menuNavigateButtons;
list menuFixedButtons;

integer max = 12;

// Populate values
integer index = llListFindList(menusDescription, [channel]);
menuButtonsAll = llParseString2List(llList2String(menusDescription, index+6), ["~"], []);
if (llList2String(menusDescription, index+7) != "") menuFixedButtons = llParseString2List(llList2String(menusDescription, index+7), ["~"], []);

// Set up the menu buttons
if (llList2Integer(menusDescription, index+4)) menuNavigateButtons= MENU_NAVIGATE_BUTTONS;
else if (llGetListLength(menuButtonsAll) > (max-llGetListLength(menuFixedButtons))) menuNavigateButtons = [" ", " ", " "];

// FIXME: add sanity check for menu page

max = max - llGetListLength(menuFixedButtons) - llGetListLength(menuNavigateButtons);
integer start = page*max;
integer stop = (page+1)*max - 1;
menuButtons = FillMenu(menuFixedButtons + llList2List(menuButtonsAll, start, stop));

// Generate the title
list tempTitle = llParseString2List(llList2String(menusDescription, index+5), ["~"], []);
menuTitle = llList2String(tempTitle,0);
if (llGetListLength(tempTitle) > 1) menuSubTitles = llList2List(tempTitle, 1, -1);
if (llGetListLength(menuSubTitles) > 0)
{
integer i;
for(i=start;i<(stop+1);++i)
{
if (llList2String(menuSubTitles, i) != "") menuTitle += "\n"+llList2String(menuSubTitles, i);
}
}
menuTitle = CheckTitleLength(menuTitle);

// Add navigate buttons if necessary
if (page > 0) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [BACK], 0, 0);
if (llGetListLength(menuButtonsAll) > (page+1)*max) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [FOWARD], 2, 2);

// Set up listen and add the row details
integer menuHandle = llListen(channel, "", id, "");
menusActive = [channel, menuHandle, llGetUnixTime(), page] + menusActive;

llSetTimerEvent(MENU_TIMEOUT_CHECK);

// Display menu
llDialog(id, menuTitle, menuNavigateButtons + menuButtons, channel);
}

// ********************************************************************
// Event Handlers
// ********************************************************************

default
{
listen(integer channel, string name, key id, string message)
{
if (message == BACK)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)-1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == FOWARD)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)+1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == " ")
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3);
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else
{
integer index = llListFindList(menusDescription, [channel]);
llMessageLinked(llList2Integer(menusDescription, index+3), LINK_MENU_RETURN, llList2String(menusDescription, index+2)+"|"+message, id);
RemoveMenu(channel, FALSE);
}
}

link_message(integer senderNum, integer num, string message, key id)
{
if (num == LINK_MENU_DISPLAY) NewMenu(message, senderNum, id);
else if (num == LINK_MENU_CLOSE) RemoveUser(id);
}

timer()
{ // Check through timers and close if necessary
integer i;
list toRemove;
integer currentTime = llGetUnixTime();
integer length = llGetListLength(menusActive);

for(i=0;i<length;i+=STRIDE_ACTIVE)
{
if (currentTime - llList2Integer(menusActive, i+2) > MENU_TIMEOUT) toRemove = [llList2Integer(menusActive, i)] + toRemove;
}

length = llGetListLength(toRemove);
if (length > 0)
{
for(i=0;i<length;i++)
{
RemoveMenu(llList2Integer(toRemove, i), TRUE);
}
}
}
}

</lsl>

==See also==
*[[ Script_Library | Script Library ]]

MultiUser Dialog Handler

2010-10-14T02:26:33Z

SimonT Quinnell: /* Parsing the returning Menu information */

==Introduction==

I found that i was constantly rewriting a pile of dialog handling functions in my scrips so i decided to write a single dialog handler script. It needed to have the following features;

* Support multiple simultaneous menus from different users.
* Support fixed top buttons that will persist on lists.
* Support fixed bottom buttons with include Back and Exit buttons.
* Handle item lists > 12 and automatically insert << and >> buttons to scroll through the lists.
* Handle timeouts and communicate timeout back to calling script.
* Handles truncation of the buttons and text to stop errors in llDialog

==Using The Script==

===Calling a Simple Menu===
In the script that is calling the menu I use a function something like this. This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|-
| || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "menudescriptor|TRUE"; //An identifier to show what menu called the script. The display of the bottom navigation buttons is set to TRUE
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

===Calling a Complex Menu===
The above case is a simple menu. The script can also do more complex menus.

In the following case we will have 10 buttons that are going to be displayed. Because we will also display the bottom 3 buttons this will be spanned across 2 menus. We will also include 2 fixed buttons that always display at the top of the menu, PLUS each button has a unique descriptor that is displayed.

This will display the following 2 menus

Menu1
Main text displayed.
item1
item2
item3
item4
item5
item6
item7

{| border="1"
|FIXED1 || FIXED2 || B1
|-
|B2 || B3 || B4
|-
|B5 || B6 || B7
|-
| || Back || >>
|}

Menu2 (on clicking the >> button)
Main text displayed.
item8
item9
item10

{| border="1"
|FIXED1 || FIXED2 || B8
|-
| B9 || B10 ||
|-
| << || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "menudescriptor|TRUE";
string menuText = "Main text displayed.~text1~text2~text3~text4~text5~text6~text7~text8~text9~text10";
string menuButtons = "B1~B2~B3~B4~B5~B6~B7~B8~B9~B10";
string menuFixedButtons = "FIXED1~FIXED2"

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuText+"|"+ menuButtons+"|"+menuFixedButtons, id);
}
</lsl>

===Parsing the returning Menu information===

Note that if the user clicks on the << or >> buttons the calling script WILL NOT see any response. The correct menu is displayed. The calling script only receives a response when one of the buttons or Back/Exit are clicked. Clicking on a space button will cause the menu to redisplay.

The script that expects the response back from the menu has the following

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

default
{
link_message(integer intSenderNum, integer num, string message, key id)
{
if (num == LINK_MENU_RETURN)
{
list returnMenu = llParseString2List(message, ["|"], []);
string menuDescriptor = llList2String(returnMenu,0); // The idenfifying descriptor. I sometimes use the name of the script plus menu and parent menu name

if (menuDescriptor == "mymenu")
{ // Is this my menu that is sending this message?
string item = llList2String(returnMenu,1); // The actual button pushed

// id == the key of the menu user.
// The button pressed in the menu is 'item', so now do something with it
}
}
else if (num == LINK_MENU_TIMEOUT)
{
// We received a timeout (don't worry the listens are all dealt with) so you might want to IM the menu user.
}
}
}
</lsl>

==The Script==
<lsl>
// ********************************************************************
//
// Menu Display Script
//
// Menu command format
// string = menuname ~ menuparent | display navigate? TRUE/FALSE | menuMaintitle~subtitle1~subtitle2~subtitle3 | button1~button2~button3 {| fixedbutton1~fixedbutton2~fixedbutton3 optional}
// key = menuuser key
//
//
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]
// menusActive [menuchannel, menuhandle, time, page]
//
// by SimonT Quinnell
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

// Main Menu Details
string BACK = "<<";
string FOWARD = ">>";
list MENU_NAVIGATE_BUTTONS = [ " ", "Back", "Exit"];
float MENU_TIMEOUT_CHECK = 10.0;
integer MENU_TIMEOUT = 120;
integer MAX_TEXT = 510;

integer STRIDE_DESCRIPTION = 8;
integer STRIDE_ACTIVE = 4;
integer DEBUG = FALSE;

// ********************************************************************
// Variables
// ********************************************************************

list menusDescription;
list menusActive;

// ********************************************************************
// Functions - General
// ********************************************************************

debug(string debug)
{
if (DEBUG) llWhisper(0,"DEBUG:"+llGetScriptName()+":"+debug+" : Free("+(string)llGetFreeMemory()+")");
}

integer string2Bool (string test)
{
if (test == "TRUE") return TRUE;
else return FALSE;
}

// ********************************************************************
// Functions - Menu Helpers
// ********************************************************************

integer NewChannel()
{ // generates unique channel number
integer channel;

do channel = -(llRound(llFrand(999999)) + 99999);
while (~llListFindList(menusDescription, [channel]));

return channel;
}

string CheckTitleLength(string title)
{
if (llStringLength(title) > MAX_TEXT) title = llGetSubString(title, 0, MAX_TEXT-1);

return title;
}

list FillMenu(list buttons)
{ //adds empty buttons until the list length is multiple of 3, to max of 12
integer i;
list listButtons;

for(i=0;i<llGetListLength(buttons);i++)
{
string name = llList2String(buttons,i);
if (llStringLength(name) > 24) name = llGetSubString(name, 0, 23);
listButtons = listButtons + [name];
}

while (llGetListLength(listButtons) != 3 && llGetListLength(listButtons) != 6 && llGetListLength(listButtons) != 9 && llGetListLength(listButtons) < 12)
{
listButtons = listButtons + [" "];
}

buttons = llList2List(listButtons, 9, 11);
buttons = buttons + llList2List(listButtons, 6, 8);
buttons = buttons + llList2List(listButtons, 3, 5);
buttons = buttons + llList2List(listButtons, 0, 2);

return buttons;
}

RemoveUser(key id)
{
integer index_id = llListFindList(menusDescription, [id]);

while (~index_id)
{
integer channel = llList2Integer(menusDescription, index_id-1);
RemoveMenu(channel, FALSE);
}
}

RemoveMenu(integer channel, integer echo)
{
integer index = llListFindList(menusDescription, [channel]);

if (index != -1)
{
key id = llList2Key(menusDescription, index+1);
menusDescription = llDeleteSubList(menusDescription, index, index + STRIDE_DESCRIPTION -1);
RemoveListen(channel);

if (echo) llMessageLinked(LINK_THIS, LINK_MENU_TIMEOUT, "Timeout", id);
}
}

RemoveListen(integer channel)
{
integer index = llListFindList(menusActive, [channel]);
if (index != -1)
{
llListenRemove(llList2Integer(menusActive, index + 1));
menusActive = llDeleteSubList(menusActive, index, index + STRIDE_ACTIVE - 1);
}
}

// ********************************************************************
// Functions - Menu Main
// ********************************************************************

NewMenu(string message, integer senderNum, key id)
{ // Setup New Menu
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]

list temp = llParseString2List(message, ["|"], []);
integer channel = NewChannel();

if (llGetListLength(temp) > 2)
{
menusDescription = [channel, id, llList2String(temp, 0), senderNum, string2Bool(llList2String(temp, 1)), llList2String(temp, 2), llList2String(temp, 3), llList2String(temp, 4)] + menusDescription;

DisplayMenu(id, channel, 0);
}
else llOwnerSay ("ERROR: Dialog Script. Incorrect menu format");
}

DisplayMenu(key id, integer channel, integer page)
{
string menuTitle;
list menuSubTitles;
list menuButtonsAll;
list menuButtons;
list menuNavigateButtons;
list menuFixedButtons;

integer max = 12;

// Populate values
integer index = llListFindList(menusDescription, [channel]);
menuButtonsAll = llParseString2List(llList2String(menusDescription, index+6), ["~"], []);
if (llList2String(menusDescription, index+7) != "") menuFixedButtons = llParseString2List(llList2String(menusDescription, index+7), ["~"], []);

// Set up the menu buttons
if (llList2Integer(menusDescription, index+4)) menuNavigateButtons= MENU_NAVIGATE_BUTTONS;
else if (llGetListLength(menuButtonsAll) > (max-llGetListLength(menuFixedButtons))) menuNavigateButtons = [" ", " ", " "];

// FIXME: add sanity check for menu page

max = max - llGetListLength(menuFixedButtons) - llGetListLength(menuNavigateButtons);
integer start = page*max;
integer stop = (page+1)*max - 1;
menuButtons = FillMenu(menuFixedButtons + llList2List(menuButtonsAll, start, stop));

// Generate the title
list tempTitle = llParseString2List(llList2String(menusDescription, index+5), ["~"], []);
menuTitle = llList2String(tempTitle,0);
if (llGetListLength(tempTitle) > 1) menuSubTitles = llList2List(tempTitle, 1, -1);
if (llGetListLength(menuSubTitles) > 0)
{
integer i;
for(i=start;i<(stop+1);++i)
{
if (llList2String(menuSubTitles, i) != "") menuTitle += "\n"+llList2String(menuSubTitles, i);
}
}
menuTitle = CheckTitleLength(menuTitle);

// Add navigate buttons if necessary
if (page > 0) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [BACK], 0, 0);
if (llGetListLength(menuButtonsAll) > (page+1)*max) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [FOWARD], 2, 2);

// Set up listen and add the row details
integer menuHandle = llListen(channel, "", id, "");
menusActive = [channel, menuHandle, llGetUnixTime(), page] + menusActive;

llSetTimerEvent(MENU_TIMEOUT_CHECK);

// Display menu
llDialog(id, menuTitle, menuNavigateButtons + menuButtons, channel);
}

// ********************************************************************
// Event Handlers
// ********************************************************************

default
{
listen(integer channel, string name, key id, string message)
{
if (message == BACK)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)-1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == FOWARD)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)+1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == " ")
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3);
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else
{
integer index = llListFindList(menusDescription, [channel]);
llMessageLinked(llList2Integer(menusDescription, index+3), LINK_MENU_RETURN, llList2String(menusDescription, index+2)+"|"+message, id);
RemoveMenu(channel, FALSE);
}
}

link_message(integer senderNum, integer num, string message, key id)
{
if (num == LINK_MENU_DISPLAY) NewMenu(message, senderNum, id);
else if (num == LINK_MENU_CLOSE) RemoveUser(id);
}

timer()
{ // Check through timers and close if necessary
integer i;
list toRemove;
integer currentTime = llGetUnixTime();
integer length = llGetListLength(menusActive);

for(i=0;i<length;i+=STRIDE_ACTIVE)
{
if (currentTime - llList2Integer(menusActive, i+2) > MENU_TIMEOUT) toRemove = [llList2Integer(menusActive, i)] + toRemove;
}

length = llGetListLength(toRemove);
if (length > 0)
{
for(i=0;i<length;i++)
{
RemoveMenu(llList2Integer(toRemove, i), TRUE);
}
}
}
}

</lsl>

==See also==
*[[ Script_Library | Script Library ]]

MultiUser Dialog Handler

2010-10-14T02:23:32Z

SimonT Quinnell: /* Calling a Simple Menu */

==Introduction==

I found that i was constantly rewriting a pile of dialog handling functions in my scrips so i decided to write a single dialog handler script. It needed to have the following features;

* Support multiple simultaneous menus from different users.
* Support fixed top buttons that will persist on lists.
* Support fixed bottom buttons with include Back and Exit buttons.
* Handle item lists > 12 and automatically insert << and >> buttons to scroll through the lists.
* Handle timeouts and communicate timeout back to calling script.
* Handles truncation of the buttons and text to stop errors in llDialog

==Using The Script==

===Calling a Simple Menu===
In the script that is calling the menu I use a function something like this. This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|-
| || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "menudescriptor|TRUE"; //An identifier to show what menu called the script. The display of the bottom navigation buttons is set to TRUE
string menuText = "This is the menu text that will be displayed."; // The text will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

===Calling a Complex Menu===
The above case is a simple menu. The script can also do more complex menus.

In the following case we will have 10 buttons that are going to be displayed. Because we will also display the bottom 3 buttons this will be spanned across 2 menus. We will also include 2 fixed buttons that always display at the top of the menu, PLUS each button has a unique descriptor that is displayed.

This will display the following 2 menus

Menu1
Main text displayed.
item1
item2
item3
item4
item5
item6
item7

{| border="1"
|FIXED1 || FIXED2 || B1
|-
|B2 || B3 || B4
|-
|B5 || B6 || B7
|-
| || Back || >>
|}

Menu2 (on clicking the >> button)
Main text displayed.
item8
item9
item10

{| border="1"
|FIXED1 || FIXED2 || B8
|-
| B9 || B10 ||
|-
| << || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "menudescriptor|TRUE";
string menuText = "Main text displayed.~text1~text2~text3~text4~text5~text6~text7~text8~text9~text10";
string menuButtons = "B1~B2~B3~B4~B5~B6~B7~B8~B9~B10";
string menuFixedButtons = "FIXED1~FIXED2"

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuText+"|"+ menuButtons+"|"+menuFixedButtons, id);
}
</lsl>

===Parsing the returning Menu information===

Note that if the user clicks on the << or >> buttons the calling script WILL NOT see any response. The correct menu is displayed. The calling script only receives a response when one of the buttons or Back/Exit are clicked. Clicking on a space button will cause the menu to redisplay.

The script that expects the response back from the menu has the following

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

default
{
link_message(integer intSenderNum, integer num, string message, key id)
{
if (num == LINK_MENU_RETURN)
{
list returnMenu = llParseString2List(message, ["|"], []);

string menuDescriptor = llList2String(returnMenu,0); // The idenfifying descriptor. I sometimes use the name of the script plus menu and parent menu name
string item = llList2String(returnMenu,1); // The actual button pushed

// id == the key of the menu user.
// The button pressed in the menu is 'item', so now do something with it
}
else if (num == LINK_MENU_TIMEOUT)
{
// We received a timeout (don't worry the listens are all dealt with) so you might want to IM the menu user.
}
}
}
</lsl>

==The Script==
<lsl>
// ********************************************************************
//
// Menu Display Script
//
// Menu command format
// string = menuname ~ menuparent | display navigate? TRUE/FALSE | menuMaintitle~subtitle1~subtitle2~subtitle3 | button1~button2~button3 {| fixedbutton1~fixedbutton2~fixedbutton3 optional}
// key = menuuser key
//
//
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]
// menusActive [menuchannel, menuhandle, time, page]
//
// by SimonT Quinnell
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

// Main Menu Details
string BACK = "<<";
string FOWARD = ">>";
list MENU_NAVIGATE_BUTTONS = [ " ", "Back", "Exit"];
float MENU_TIMEOUT_CHECK = 10.0;
integer MENU_TIMEOUT = 120;
integer MAX_TEXT = 510;

integer STRIDE_DESCRIPTION = 8;
integer STRIDE_ACTIVE = 4;
integer DEBUG = FALSE;

// ********************************************************************
// Variables
// ********************************************************************

list menusDescription;
list menusActive;

// ********************************************************************
// Functions - General
// ********************************************************************

debug(string debug)
{
if (DEBUG) llWhisper(0,"DEBUG:"+llGetScriptName()+":"+debug+" : Free("+(string)llGetFreeMemory()+")");
}

integer string2Bool (string test)
{
if (test == "TRUE") return TRUE;
else return FALSE;
}

// ********************************************************************
// Functions - Menu Helpers
// ********************************************************************

integer NewChannel()
{ // generates unique channel number
integer channel;

do channel = -(llRound(llFrand(999999)) + 99999);
while (~llListFindList(menusDescription, [channel]));

return channel;
}

string CheckTitleLength(string title)
{
if (llStringLength(title) > MAX_TEXT) title = llGetSubString(title, 0, MAX_TEXT-1);

return title;
}

list FillMenu(list buttons)
{ //adds empty buttons until the list length is multiple of 3, to max of 12
integer i;
list listButtons;

for(i=0;i<llGetListLength(buttons);i++)
{
string name = llList2String(buttons,i);
if (llStringLength(name) > 24) name = llGetSubString(name, 0, 23);
listButtons = listButtons + [name];
}

while (llGetListLength(listButtons) != 3 && llGetListLength(listButtons) != 6 && llGetListLength(listButtons) != 9 && llGetListLength(listButtons) < 12)
{
listButtons = listButtons + [" "];
}

buttons = llList2List(listButtons, 9, 11);
buttons = buttons + llList2List(listButtons, 6, 8);
buttons = buttons + llList2List(listButtons, 3, 5);
buttons = buttons + llList2List(listButtons, 0, 2);

return buttons;
}

RemoveUser(key id)
{
integer index_id = llListFindList(menusDescription, [id]);

while (~index_id)
{
integer channel = llList2Integer(menusDescription, index_id-1);
RemoveMenu(channel, FALSE);
}
}

RemoveMenu(integer channel, integer echo)
{
integer index = llListFindList(menusDescription, [channel]);

if (index != -1)
{
key id = llList2Key(menusDescription, index+1);
menusDescription = llDeleteSubList(menusDescription, index, index + STRIDE_DESCRIPTION -1);
RemoveListen(channel);

if (echo) llMessageLinked(LINK_THIS, LINK_MENU_TIMEOUT, "Timeout", id);
}
}

RemoveListen(integer channel)
{
integer index = llListFindList(menusActive, [channel]);
if (index != -1)
{
llListenRemove(llList2Integer(menusActive, index + 1));
menusActive = llDeleteSubList(menusActive, index, index + STRIDE_ACTIVE - 1);
}
}

// ********************************************************************
// Functions - Menu Main
// ********************************************************************

NewMenu(string message, integer senderNum, key id)
{ // Setup New Menu
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]

list temp = llParseString2List(message, ["|"], []);
integer channel = NewChannel();

if (llGetListLength(temp) > 2)
{
menusDescription = [channel, id, llList2String(temp, 0), senderNum, string2Bool(llList2String(temp, 1)), llList2String(temp, 2), llList2String(temp, 3), llList2String(temp, 4)] + menusDescription;

DisplayMenu(id, channel, 0);
}
else llOwnerSay ("ERROR: Dialog Script. Incorrect menu format");
}

DisplayMenu(key id, integer channel, integer page)
{
string menuTitle;
list menuSubTitles;
list menuButtonsAll;
list menuButtons;
list menuNavigateButtons;
list menuFixedButtons;

integer max = 12;

// Populate values
integer index = llListFindList(menusDescription, [channel]);
menuButtonsAll = llParseString2List(llList2String(menusDescription, index+6), ["~"], []);
if (llList2String(menusDescription, index+7) != "") menuFixedButtons = llParseString2List(llList2String(menusDescription, index+7), ["~"], []);

// Set up the menu buttons
if (llList2Integer(menusDescription, index+4)) menuNavigateButtons= MENU_NAVIGATE_BUTTONS;
else if (llGetListLength(menuButtonsAll) > (max-llGetListLength(menuFixedButtons))) menuNavigateButtons = [" ", " ", " "];

// FIXME: add sanity check for menu page

max = max - llGetListLength(menuFixedButtons) - llGetListLength(menuNavigateButtons);
integer start = page*max;
integer stop = (page+1)*max - 1;
menuButtons = FillMenu(menuFixedButtons + llList2List(menuButtonsAll, start, stop));

// Generate the title
list tempTitle = llParseString2List(llList2String(menusDescription, index+5), ["~"], []);
menuTitle = llList2String(tempTitle,0);
if (llGetListLength(tempTitle) > 1) menuSubTitles = llList2List(tempTitle, 1, -1);
if (llGetListLength(menuSubTitles) > 0)
{
integer i;
for(i=start;i<(stop+1);++i)
{
if (llList2String(menuSubTitles, i) != "") menuTitle += "\n"+llList2String(menuSubTitles, i);
}
}
menuTitle = CheckTitleLength(menuTitle);

// Add navigate buttons if necessary
if (page > 0) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [BACK], 0, 0);
if (llGetListLength(menuButtonsAll) > (page+1)*max) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [FOWARD], 2, 2);

// Set up listen and add the row details
integer menuHandle = llListen(channel, "", id, "");
menusActive = [channel, menuHandle, llGetUnixTime(), page] + menusActive;

llSetTimerEvent(MENU_TIMEOUT_CHECK);

// Display menu
llDialog(id, menuTitle, menuNavigateButtons + menuButtons, channel);
}

// ********************************************************************
// Event Handlers
// ********************************************************************

default
{
listen(integer channel, string name, key id, string message)
{
if (message == BACK)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)-1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == FOWARD)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)+1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == " ")
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3);
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else
{
integer index = llListFindList(menusDescription, [channel]);
llMessageLinked(llList2Integer(menusDescription, index+3), LINK_MENU_RETURN, llList2String(menusDescription, index+2)+"|"+message, id);
RemoveMenu(channel, FALSE);
}
}

link_message(integer senderNum, integer num, string message, key id)
{
if (num == LINK_MENU_DISPLAY) NewMenu(message, senderNum, id);
else if (num == LINK_MENU_CLOSE) RemoveUser(id);
}

timer()
{ // Check through timers and close if necessary
integer i;
list toRemove;
integer currentTime = llGetUnixTime();
integer length = llGetListLength(menusActive);

for(i=0;i<length;i+=STRIDE_ACTIVE)
{
if (currentTime - llList2Integer(menusActive, i+2) > MENU_TIMEOUT) toRemove = [llList2Integer(menusActive, i)] + toRemove;
}

length = llGetListLength(toRemove);
if (length > 0)
{
for(i=0;i<length;i++)
{
RemoveMenu(llList2Integer(toRemove, i), TRUE);
}
}
}
}

</lsl>

==See also==
*[[ Script_Library | Script Library ]]

MultiUser Dialog Handler

2010-10-14T02:22:15Z

SimonT Quinnell: /* Calling a Simple Menu */

==Introduction==

I found that i was constantly rewriting a pile of dialog handling functions in my scrips so i decided to write a single dialog handler script. It needed to have the following features;

* Support multiple simultaneous menus from different users.
* Support fixed top buttons that will persist on lists.
* Support fixed bottom buttons with include Back and Exit buttons.
* Handle item lists > 12 and automatically insert << and >> buttons to scroll through the lists.
* Handle timeouts and communicate timeout back to calling script.
* Handles truncation of the buttons and text to stop errors in llDialog

==Using The Script==

===Calling a Simple Menu===
In the script that is calling the menu I use a function something like this. This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|-
| || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "menudescriptor|TRUE"; //Menudescriptor is some text i use to identify what menu called the script. The display of the bottom navigation buttons is set to TRUE
string menuText = "This is the menu text that will be displayed."; // The text ( will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

===Calling a Complex Menu===
The above case is a simple menu. The script can also do more complex menus.

In the following case we will have 10 buttons that are going to be displayed. Because we will also display the bottom 3 buttons this will be spanned across 2 menus. We will also include 2 fixed buttons that always display at the top of the menu, PLUS each button has a unique descriptor that is displayed.

This will display the following 2 menus

Menu1
Main text displayed.
item1
item2
item3
item4
item5
item6
item7

{| border="1"
|FIXED1 || FIXED2 || B1
|-
|B2 || B3 || B4
|-
|B5 || B6 || B7
|-
| || Back || >>
|}

Menu2 (on clicking the >> button)
Main text displayed.
item8
item9
item10

{| border="1"
|FIXED1 || FIXED2 || B8
|-
| B9 || B10 ||
|-
| << || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "menudescriptor|TRUE";
string menuText = "Main text displayed.~text1~text2~text3~text4~text5~text6~text7~text8~text9~text10";
string menuButtons = "B1~B2~B3~B4~B5~B6~B7~B8~B9~B10";
string menuFixedButtons = "FIXED1~FIXED2"

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuText+"|"+ menuButtons+"|"+menuFixedButtons, id);
}
</lsl>

===Parsing the returning Menu information===

Note that if the user clicks on the << or >> buttons the calling script WILL NOT see any response. The correct menu is displayed. The calling script only receives a response when one of the buttons or Back/Exit are clicked. Clicking on a space button will cause the menu to redisplay.

The script that expects the response back from the menu has the following

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

default
{
link_message(integer intSenderNum, integer num, string message, key id)
{
if (num == LINK_MENU_RETURN)
{
list returnMenu = llParseString2List(message, ["|"], []);

string menuDescriptor = llList2String(returnMenu,0); // The idenfifying descriptor. I sometimes use the name of the script plus menu and parent menu name
string item = llList2String(returnMenu,1); // The actual button pushed

// id == the key of the menu user.
// The button pressed in the menu is 'item', so now do something with it
}
else if (num == LINK_MENU_TIMEOUT)
{
// We received a timeout (don't worry the listens are all dealt with) so you might want to IM the menu user.
}
}
}
</lsl>

==The Script==
<lsl>
// ********************************************************************
//
// Menu Display Script
//
// Menu command format
// string = menuname ~ menuparent | display navigate? TRUE/FALSE | menuMaintitle~subtitle1~subtitle2~subtitle3 | button1~button2~button3 {| fixedbutton1~fixedbutton2~fixedbutton3 optional}
// key = menuuser key
//
//
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]
// menusActive [menuchannel, menuhandle, time, page]
//
// by SimonT Quinnell
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

// Main Menu Details
string BACK = "<<";
string FOWARD = ">>";
list MENU_NAVIGATE_BUTTONS = [ " ", "Back", "Exit"];
float MENU_TIMEOUT_CHECK = 10.0;
integer MENU_TIMEOUT = 120;
integer MAX_TEXT = 510;

integer STRIDE_DESCRIPTION = 8;
integer STRIDE_ACTIVE = 4;
integer DEBUG = FALSE;

// ********************************************************************
// Variables
// ********************************************************************

list menusDescription;
list menusActive;

// ********************************************************************
// Functions - General
// ********************************************************************

debug(string debug)
{
if (DEBUG) llWhisper(0,"DEBUG:"+llGetScriptName()+":"+debug+" : Free("+(string)llGetFreeMemory()+")");
}

integer string2Bool (string test)
{
if (test == "TRUE") return TRUE;
else return FALSE;
}

// ********************************************************************
// Functions - Menu Helpers
// ********************************************************************

integer NewChannel()
{ // generates unique channel number
integer channel;

do channel = -(llRound(llFrand(999999)) + 99999);
while (~llListFindList(menusDescription, [channel]));

return channel;
}

string CheckTitleLength(string title)
{
if (llStringLength(title) > MAX_TEXT) title = llGetSubString(title, 0, MAX_TEXT-1);

return title;
}

list FillMenu(list buttons)
{ //adds empty buttons until the list length is multiple of 3, to max of 12
integer i;
list listButtons;

for(i=0;i<llGetListLength(buttons);i++)
{
string name = llList2String(buttons,i);
if (llStringLength(name) > 24) name = llGetSubString(name, 0, 23);
listButtons = listButtons + [name];
}

while (llGetListLength(listButtons) != 3 && llGetListLength(listButtons) != 6 && llGetListLength(listButtons) != 9 && llGetListLength(listButtons) < 12)
{
listButtons = listButtons + [" "];
}

buttons = llList2List(listButtons, 9, 11);
buttons = buttons + llList2List(listButtons, 6, 8);
buttons = buttons + llList2List(listButtons, 3, 5);
buttons = buttons + llList2List(listButtons, 0, 2);

return buttons;
}

RemoveUser(key id)
{
integer index_id = llListFindList(menusDescription, [id]);

while (~index_id)
{
integer channel = llList2Integer(menusDescription, index_id-1);
RemoveMenu(channel, FALSE);
}
}

RemoveMenu(integer channel, integer echo)
{
integer index = llListFindList(menusDescription, [channel]);

if (index != -1)
{
key id = llList2Key(menusDescription, index+1);
menusDescription = llDeleteSubList(menusDescription, index, index + STRIDE_DESCRIPTION -1);
RemoveListen(channel);

if (echo) llMessageLinked(LINK_THIS, LINK_MENU_TIMEOUT, "Timeout", id);
}
}

RemoveListen(integer channel)
{
integer index = llListFindList(menusActive, [channel]);
if (index != -1)
{
llListenRemove(llList2Integer(menusActive, index + 1));
menusActive = llDeleteSubList(menusActive, index, index + STRIDE_ACTIVE - 1);
}
}

// ********************************************************************
// Functions - Menu Main
// ********************************************************************

NewMenu(string message, integer senderNum, key id)
{ // Setup New Menu
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]

list temp = llParseString2List(message, ["|"], []);
integer channel = NewChannel();

if (llGetListLength(temp) > 2)
{
menusDescription = [channel, id, llList2String(temp, 0), senderNum, string2Bool(llList2String(temp, 1)), llList2String(temp, 2), llList2String(temp, 3), llList2String(temp, 4)] + menusDescription;

DisplayMenu(id, channel, 0);
}
else llOwnerSay ("ERROR: Dialog Script. Incorrect menu format");
}

DisplayMenu(key id, integer channel, integer page)
{
string menuTitle;
list menuSubTitles;
list menuButtonsAll;
list menuButtons;
list menuNavigateButtons;
list menuFixedButtons;

integer max = 12;

// Populate values
integer index = llListFindList(menusDescription, [channel]);
menuButtonsAll = llParseString2List(llList2String(menusDescription, index+6), ["~"], []);
if (llList2String(menusDescription, index+7) != "") menuFixedButtons = llParseString2List(llList2String(menusDescription, index+7), ["~"], []);

// Set up the menu buttons
if (llList2Integer(menusDescription, index+4)) menuNavigateButtons= MENU_NAVIGATE_BUTTONS;
else if (llGetListLength(menuButtonsAll) > (max-llGetListLength(menuFixedButtons))) menuNavigateButtons = [" ", " ", " "];

// FIXME: add sanity check for menu page

max = max - llGetListLength(menuFixedButtons) - llGetListLength(menuNavigateButtons);
integer start = page*max;
integer stop = (page+1)*max - 1;
menuButtons = FillMenu(menuFixedButtons + llList2List(menuButtonsAll, start, stop));

// Generate the title
list tempTitle = llParseString2List(llList2String(menusDescription, index+5), ["~"], []);
menuTitle = llList2String(tempTitle,0);
if (llGetListLength(tempTitle) > 1) menuSubTitles = llList2List(tempTitle, 1, -1);
if (llGetListLength(menuSubTitles) > 0)
{
integer i;
for(i=start;i<(stop+1);++i)
{
if (llList2String(menuSubTitles, i) != "") menuTitle += "\n"+llList2String(menuSubTitles, i);
}
}
menuTitle = CheckTitleLength(menuTitle);

// Add navigate buttons if necessary
if (page > 0) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [BACK], 0, 0);
if (llGetListLength(menuButtonsAll) > (page+1)*max) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [FOWARD], 2, 2);

// Set up listen and add the row details
integer menuHandle = llListen(channel, "", id, "");
menusActive = [channel, menuHandle, llGetUnixTime(), page] + menusActive;

llSetTimerEvent(MENU_TIMEOUT_CHECK);

// Display menu
llDialog(id, menuTitle, menuNavigateButtons + menuButtons, channel);
}

// ********************************************************************
// Event Handlers
// ********************************************************************

default
{
listen(integer channel, string name, key id, string message)
{
if (message == BACK)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)-1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == FOWARD)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)+1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == " ")
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3);
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else
{
integer index = llListFindList(menusDescription, [channel]);
llMessageLinked(llList2Integer(menusDescription, index+3), LINK_MENU_RETURN, llList2String(menusDescription, index+2)+"|"+message, id);
RemoveMenu(channel, FALSE);
}
}

link_message(integer senderNum, integer num, string message, key id)
{
if (num == LINK_MENU_DISPLAY) NewMenu(message, senderNum, id);
else if (num == LINK_MENU_CLOSE) RemoveUser(id);
}

timer()
{ // Check through timers and close if necessary
integer i;
list toRemove;
integer currentTime = llGetUnixTime();
integer length = llGetListLength(menusActive);

for(i=0;i<length;i+=STRIDE_ACTIVE)
{
if (currentTime - llList2Integer(menusActive, i+2) > MENU_TIMEOUT) toRemove = [llList2Integer(menusActive, i)] + toRemove;
}

length = llGetListLength(toRemove);
if (length > 0)
{
for(i=0;i<length;i++)
{
RemoveMenu(llList2Integer(toRemove, i), TRUE);
}
}
}
}

</lsl>

==See also==
*[[ Script_Library | Script Library ]]

MultiUser Dialog Handler

2010-10-14T02:20:46Z

SimonT Quinnell: /* Parsing the returning Menu information */

==Introduction==

I found that i was constantly rewriting a pile of dialog handling functions in my scrips so i decided to write a single dialog handler script. It needed to have the following features;

* Support multiple simultaneous menus from different users.
* Support fixed top buttons that will persist on lists.
* Support fixed bottom buttons with include Back and Exit buttons.
* Handle item lists > 12 and automatically insert << and >> buttons to scroll through the lists.
* Handle timeouts and communicate timeout back to calling script.
* Handles truncation of the buttons and text to stop errors in llDialog

==Using The Script==

===Calling a Simple Menu===
In the script that is calling the menu I use a function something like this. This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|-
| || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "menudescriptor|TRUE"; //Menu name is 'menu with a parent menu name 'parent'. The display of the bottom navigation buttons is set to TRUE
string menuText = "This is the menu text that will be displayed."; // The text ( will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

===Calling a Complex Menu===
The above case is a simple menu. The script can also do more complex menus.

In the following case we will have 10 buttons that are going to be displayed. Because we will also display the bottom 3 buttons this will be spanned across 2 menus. We will also include 2 fixed buttons that always display at the top of the menu, PLUS each button has a unique descriptor that is displayed.

This will display the following 2 menus

Menu1
Main text displayed.
item1
item2
item3
item4
item5
item6
item7

{| border="1"
|FIXED1 || FIXED2 || B1
|-
|B2 || B3 || B4
|-
|B5 || B6 || B7
|-
| || Back || >>
|}

Menu2 (on clicking the >> button)
Main text displayed.
item8
item9
item10

{| border="1"
|FIXED1 || FIXED2 || B8
|-
| B9 || B10 ||
|-
| << || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "menudescriptor|TRUE";
string menuText = "Main text displayed.~text1~text2~text3~text4~text5~text6~text7~text8~text9~text10";
string menuButtons = "B1~B2~B3~B4~B5~B6~B7~B8~B9~B10";
string menuFixedButtons = "FIXED1~FIXED2"

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuText+"|"+ menuButtons+"|"+menuFixedButtons, id);
}
</lsl>

===Parsing the returning Menu information===

Note that if the user clicks on the << or >> buttons the calling script WILL NOT see any response. The correct menu is displayed. The calling script only receives a response when one of the buttons or Back/Exit are clicked. Clicking on a space button will cause the menu to redisplay.

The script that expects the response back from the menu has the following

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

default
{
link_message(integer intSenderNum, integer num, string message, key id)
{
if (num == LINK_MENU_RETURN)
{
list returnMenu = llParseString2List(message, ["|"], []);

string menuDescriptor = llList2String(returnMenu,0); // The idenfifying descriptor. I sometimes use the name of the script plus menu and parent menu name
string item = llList2String(returnMenu,1); // The actual button pushed

// id == the key of the menu user.
// The button pressed in the menu is 'item', so now do something with it
}
else if (num == LINK_MENU_TIMEOUT)
{
// We received a timeout (don't worry the listens are all dealt with) so you might want to IM the menu user.
}
}
}
</lsl>

==The Script==
<lsl>
// ********************************************************************
//
// Menu Display Script
//
// Menu command format
// string = menuname ~ menuparent | display navigate? TRUE/FALSE | menuMaintitle~subtitle1~subtitle2~subtitle3 | button1~button2~button3 {| fixedbutton1~fixedbutton2~fixedbutton3 optional}
// key = menuuser key
//
//
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]
// menusActive [menuchannel, menuhandle, time, page]
//
// by SimonT Quinnell
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

// Main Menu Details
string BACK = "<<";
string FOWARD = ">>";
list MENU_NAVIGATE_BUTTONS = [ " ", "Back", "Exit"];
float MENU_TIMEOUT_CHECK = 10.0;
integer MENU_TIMEOUT = 120;
integer MAX_TEXT = 510;

integer STRIDE_DESCRIPTION = 8;
integer STRIDE_ACTIVE = 4;
integer DEBUG = FALSE;

// ********************************************************************
// Variables
// ********************************************************************

list menusDescription;
list menusActive;

// ********************************************************************
// Functions - General
// ********************************************************************

debug(string debug)
{
if (DEBUG) llWhisper(0,"DEBUG:"+llGetScriptName()+":"+debug+" : Free("+(string)llGetFreeMemory()+")");
}

integer string2Bool (string test)
{
if (test == "TRUE") return TRUE;
else return FALSE;
}

// ********************************************************************
// Functions - Menu Helpers
// ********************************************************************

integer NewChannel()
{ // generates unique channel number
integer channel;

do channel = -(llRound(llFrand(999999)) + 99999);
while (~llListFindList(menusDescription, [channel]));

return channel;
}

string CheckTitleLength(string title)
{
if (llStringLength(title) > MAX_TEXT) title = llGetSubString(title, 0, MAX_TEXT-1);

return title;
}

list FillMenu(list buttons)
{ //adds empty buttons until the list length is multiple of 3, to max of 12
integer i;
list listButtons;

for(i=0;i<llGetListLength(buttons);i++)
{
string name = llList2String(buttons,i);
if (llStringLength(name) > 24) name = llGetSubString(name, 0, 23);
listButtons = listButtons + [name];
}

while (llGetListLength(listButtons) != 3 && llGetListLength(listButtons) != 6 && llGetListLength(listButtons) != 9 && llGetListLength(listButtons) < 12)
{
listButtons = listButtons + [" "];
}

buttons = llList2List(listButtons, 9, 11);
buttons = buttons + llList2List(listButtons, 6, 8);
buttons = buttons + llList2List(listButtons, 3, 5);
buttons = buttons + llList2List(listButtons, 0, 2);

return buttons;
}

RemoveUser(key id)
{
integer index_id = llListFindList(menusDescription, [id]);

while (~index_id)
{
integer channel = llList2Integer(menusDescription, index_id-1);
RemoveMenu(channel, FALSE);
}
}

RemoveMenu(integer channel, integer echo)
{
integer index = llListFindList(menusDescription, [channel]);

if (index != -1)
{
key id = llList2Key(menusDescription, index+1);
menusDescription = llDeleteSubList(menusDescription, index, index + STRIDE_DESCRIPTION -1);
RemoveListen(channel);

if (echo) llMessageLinked(LINK_THIS, LINK_MENU_TIMEOUT, "Timeout", id);
}
}

RemoveListen(integer channel)
{
integer index = llListFindList(menusActive, [channel]);
if (index != -1)
{
llListenRemove(llList2Integer(menusActive, index + 1));
menusActive = llDeleteSubList(menusActive, index, index + STRIDE_ACTIVE - 1);
}
}

// ********************************************************************
// Functions - Menu Main
// ********************************************************************

NewMenu(string message, integer senderNum, key id)
{ // Setup New Menu
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]

list temp = llParseString2List(message, ["|"], []);
integer channel = NewChannel();

if (llGetListLength(temp) > 2)
{
menusDescription = [channel, id, llList2String(temp, 0), senderNum, string2Bool(llList2String(temp, 1)), llList2String(temp, 2), llList2String(temp, 3), llList2String(temp, 4)] + menusDescription;

DisplayMenu(id, channel, 0);
}
else llOwnerSay ("ERROR: Dialog Script. Incorrect menu format");
}

DisplayMenu(key id, integer channel, integer page)
{
string menuTitle;
list menuSubTitles;
list menuButtonsAll;
list menuButtons;
list menuNavigateButtons;
list menuFixedButtons;

integer max = 12;

// Populate values
integer index = llListFindList(menusDescription, [channel]);
menuButtonsAll = llParseString2List(llList2String(menusDescription, index+6), ["~"], []);
if (llList2String(menusDescription, index+7) != "") menuFixedButtons = llParseString2List(llList2String(menusDescription, index+7), ["~"], []);

// Set up the menu buttons
if (llList2Integer(menusDescription, index+4)) menuNavigateButtons= MENU_NAVIGATE_BUTTONS;
else if (llGetListLength(menuButtonsAll) > (max-llGetListLength(menuFixedButtons))) menuNavigateButtons = [" ", " ", " "];

// FIXME: add sanity check for menu page

max = max - llGetListLength(menuFixedButtons) - llGetListLength(menuNavigateButtons);
integer start = page*max;
integer stop = (page+1)*max - 1;
menuButtons = FillMenu(menuFixedButtons + llList2List(menuButtonsAll, start, stop));

// Generate the title
list tempTitle = llParseString2List(llList2String(menusDescription, index+5), ["~"], []);
menuTitle = llList2String(tempTitle,0);
if (llGetListLength(tempTitle) > 1) menuSubTitles = llList2List(tempTitle, 1, -1);
if (llGetListLength(menuSubTitles) > 0)
{
integer i;
for(i=start;i<(stop+1);++i)
{
if (llList2String(menuSubTitles, i) != "") menuTitle += "\n"+llList2String(menuSubTitles, i);
}
}
menuTitle = CheckTitleLength(menuTitle);

// Add navigate buttons if necessary
if (page > 0) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [BACK], 0, 0);
if (llGetListLength(menuButtonsAll) > (page+1)*max) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [FOWARD], 2, 2);

// Set up listen and add the row details
integer menuHandle = llListen(channel, "", id, "");
menusActive = [channel, menuHandle, llGetUnixTime(), page] + menusActive;

llSetTimerEvent(MENU_TIMEOUT_CHECK);

// Display menu
llDialog(id, menuTitle, menuNavigateButtons + menuButtons, channel);
}

// ********************************************************************
// Event Handlers
// ********************************************************************

default
{
listen(integer channel, string name, key id, string message)
{
if (message == BACK)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)-1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == FOWARD)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)+1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == " ")
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3);
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else
{
integer index = llListFindList(menusDescription, [channel]);
llMessageLinked(llList2Integer(menusDescription, index+3), LINK_MENU_RETURN, llList2String(menusDescription, index+2)+"|"+message, id);
RemoveMenu(channel, FALSE);
}
}

link_message(integer senderNum, integer num, string message, key id)
{
if (num == LINK_MENU_DISPLAY) NewMenu(message, senderNum, id);
else if (num == LINK_MENU_CLOSE) RemoveUser(id);
}

timer()
{ // Check through timers and close if necessary
integer i;
list toRemove;
integer currentTime = llGetUnixTime();
integer length = llGetListLength(menusActive);

for(i=0;i<length;i+=STRIDE_ACTIVE)
{
if (currentTime - llList2Integer(menusActive, i+2) > MENU_TIMEOUT) toRemove = [llList2Integer(menusActive, i)] + toRemove;
}

length = llGetListLength(toRemove);
if (length > 0)
{
for(i=0;i<length;i++)
{
RemoveMenu(llList2Integer(toRemove, i), TRUE);
}
}
}
}

</lsl>

==See also==
*[[ Script_Library | Script Library ]]

MultiUser Dialog Handler

2010-10-14T02:18:50Z

SimonT Quinnell: /* Calling a Complex Menu */

==Introduction==

I found that i was constantly rewriting a pile of dialog handling functions in my scrips so i decided to write a single dialog handler script. It needed to have the following features;

* Support multiple simultaneous menus from different users.
* Support fixed top buttons that will persist on lists.
* Support fixed bottom buttons with include Back and Exit buttons.
* Handle item lists > 12 and automatically insert << and >> buttons to scroll through the lists.
* Handle timeouts and communicate timeout back to calling script.
* Handles truncation of the buttons and text to stop errors in llDialog

==Using The Script==

===Calling a Simple Menu===
In the script that is calling the menu I use a function something like this. This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|-
| || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "menudescriptor|TRUE"; //Menu name is 'menu with a parent menu name 'parent'. The display of the bottom navigation buttons is set to TRUE
string menuText = "This is the menu text that will be displayed."; // The text ( will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

===Calling a Complex Menu===
The above case is a simple menu. The script can also do more complex menus.

In the following case we will have 10 buttons that are going to be displayed. Because we will also display the bottom 3 buttons this will be spanned across 2 menus. We will also include 2 fixed buttons that always display at the top of the menu, PLUS each button has a unique descriptor that is displayed.

This will display the following 2 menus

Menu1
Main text displayed.
item1
item2
item3
item4
item5
item6
item7

{| border="1"
|FIXED1 || FIXED2 || B1
|-
|B2 || B3 || B4
|-
|B5 || B6 || B7
|-
| || Back || >>
|}

Menu2 (on clicking the >> button)
Main text displayed.
item8
item9
item10

{| border="1"
|FIXED1 || FIXED2 || B8
|-
| B9 || B10 ||
|-
| << || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "menudescriptor|TRUE";
string menuText = "Main text displayed.~text1~text2~text3~text4~text5~text6~text7~text8~text9~text10";
string menuButtons = "B1~B2~B3~B4~B5~B6~B7~B8~B9~B10";
string menuFixedButtons = "FIXED1~FIXED2"

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuText+"|"+ menuButtons+"|"+menuFixedButtons, id);
}
</lsl>

===Parsing the returning Menu information===

Note that if the user clicks on the << or >> buttons the calling script WILL NOT see any response. The correct menu is displayed. The calling script only receives a response when one of the buttons or Back/Exit are clicked. Clicking on a space button will cause the menu to redisplay.

The script that expects the response back from the menu has the following

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

default
{
link_message(integer intSenderNum, integer num, string message, key id)
{
if (num == LINK_MENU_RETURN)
{
list returnMenu = llParseString2List(message, ["|"], []);
list temp = llParseString2List(llList2String(returnMenu,0), ["~"], []);

string menu = llList2String(temp,0); // The name of the menu
string parent = llList2String(temp,1); // The parent of the menu
string item = llList2String(returnMenu,1); // The actual button pushed

// id == the key of the menu user.
// The button pressed in the menu is 'item', so now do something with it
}
else if (num == LINK_MENU_TIMEOUT)
{
// We received a timeout (don't worry the listens are all dealt with) so you might want to IM the menu user.
}
}
}
</lsl>

==The Script==
<lsl>
// ********************************************************************
//
// Menu Display Script
//
// Menu command format
// string = menuname ~ menuparent | display navigate? TRUE/FALSE | menuMaintitle~subtitle1~subtitle2~subtitle3 | button1~button2~button3 {| fixedbutton1~fixedbutton2~fixedbutton3 optional}
// key = menuuser key
//
//
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]
// menusActive [menuchannel, menuhandle, time, page]
//
// by SimonT Quinnell
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

// Main Menu Details
string BACK = "<<";
string FOWARD = ">>";
list MENU_NAVIGATE_BUTTONS = [ " ", "Back", "Exit"];
float MENU_TIMEOUT_CHECK = 10.0;
integer MENU_TIMEOUT = 120;
integer MAX_TEXT = 510;

integer STRIDE_DESCRIPTION = 8;
integer STRIDE_ACTIVE = 4;
integer DEBUG = FALSE;

// ********************************************************************
// Variables
// ********************************************************************

list menusDescription;
list menusActive;

// ********************************************************************
// Functions - General
// ********************************************************************

debug(string debug)
{
if (DEBUG) llWhisper(0,"DEBUG:"+llGetScriptName()+":"+debug+" : Free("+(string)llGetFreeMemory()+")");
}

integer string2Bool (string test)
{
if (test == "TRUE") return TRUE;
else return FALSE;
}

// ********************************************************************
// Functions - Menu Helpers
// ********************************************************************

integer NewChannel()
{ // generates unique channel number
integer channel;

do channel = -(llRound(llFrand(999999)) + 99999);
while (~llListFindList(menusDescription, [channel]));

return channel;
}

string CheckTitleLength(string title)
{
if (llStringLength(title) > MAX_TEXT) title = llGetSubString(title, 0, MAX_TEXT-1);

return title;
}

list FillMenu(list buttons)
{ //adds empty buttons until the list length is multiple of 3, to max of 12
integer i;
list listButtons;

for(i=0;i<llGetListLength(buttons);i++)
{
string name = llList2String(buttons,i);
if (llStringLength(name) > 24) name = llGetSubString(name, 0, 23);
listButtons = listButtons + [name];
}

while (llGetListLength(listButtons) != 3 && llGetListLength(listButtons) != 6 && llGetListLength(listButtons) != 9 && llGetListLength(listButtons) < 12)
{
listButtons = listButtons + [" "];
}

buttons = llList2List(listButtons, 9, 11);
buttons = buttons + llList2List(listButtons, 6, 8);
buttons = buttons + llList2List(listButtons, 3, 5);
buttons = buttons + llList2List(listButtons, 0, 2);

return buttons;
}

RemoveUser(key id)
{
integer index_id = llListFindList(menusDescription, [id]);

while (~index_id)
{
integer channel = llList2Integer(menusDescription, index_id-1);
RemoveMenu(channel, FALSE);
}
}

RemoveMenu(integer channel, integer echo)
{
integer index = llListFindList(menusDescription, [channel]);

if (index != -1)
{
key id = llList2Key(menusDescription, index+1);
menusDescription = llDeleteSubList(menusDescription, index, index + STRIDE_DESCRIPTION -1);
RemoveListen(channel);

if (echo) llMessageLinked(LINK_THIS, LINK_MENU_TIMEOUT, "Timeout", id);
}
}

RemoveListen(integer channel)
{
integer index = llListFindList(menusActive, [channel]);
if (index != -1)
{
llListenRemove(llList2Integer(menusActive, index + 1));
menusActive = llDeleteSubList(menusActive, index, index + STRIDE_ACTIVE - 1);
}
}

// ********************************************************************
// Functions - Menu Main
// ********************************************************************

NewMenu(string message, integer senderNum, key id)
{ // Setup New Menu
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]

list temp = llParseString2List(message, ["|"], []);
integer channel = NewChannel();

if (llGetListLength(temp) > 2)
{
menusDescription = [channel, id, llList2String(temp, 0), senderNum, string2Bool(llList2String(temp, 1)), llList2String(temp, 2), llList2String(temp, 3), llList2String(temp, 4)] + menusDescription;

DisplayMenu(id, channel, 0);
}
else llOwnerSay ("ERROR: Dialog Script. Incorrect menu format");
}

DisplayMenu(key id, integer channel, integer page)
{
string menuTitle;
list menuSubTitles;
list menuButtonsAll;
list menuButtons;
list menuNavigateButtons;
list menuFixedButtons;

integer max = 12;

// Populate values
integer index = llListFindList(menusDescription, [channel]);
menuButtonsAll = llParseString2List(llList2String(menusDescription, index+6), ["~"], []);
if (llList2String(menusDescription, index+7) != "") menuFixedButtons = llParseString2List(llList2String(menusDescription, index+7), ["~"], []);

// Set up the menu buttons
if (llList2Integer(menusDescription, index+4)) menuNavigateButtons= MENU_NAVIGATE_BUTTONS;
else if (llGetListLength(menuButtonsAll) > (max-llGetListLength(menuFixedButtons))) menuNavigateButtons = [" ", " ", " "];

// FIXME: add sanity check for menu page

max = max - llGetListLength(menuFixedButtons) - llGetListLength(menuNavigateButtons);
integer start = page*max;
integer stop = (page+1)*max - 1;
menuButtons = FillMenu(menuFixedButtons + llList2List(menuButtonsAll, start, stop));

// Generate the title
list tempTitle = llParseString2List(llList2String(menusDescription, index+5), ["~"], []);
menuTitle = llList2String(tempTitle,0);
if (llGetListLength(tempTitle) > 1) menuSubTitles = llList2List(tempTitle, 1, -1);
if (llGetListLength(menuSubTitles) > 0)
{
integer i;
for(i=start;i<(stop+1);++i)
{
if (llList2String(menuSubTitles, i) != "") menuTitle += "\n"+llList2String(menuSubTitles, i);
}
}
menuTitle = CheckTitleLength(menuTitle);

// Add navigate buttons if necessary
if (page > 0) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [BACK], 0, 0);
if (llGetListLength(menuButtonsAll) > (page+1)*max) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [FOWARD], 2, 2);

// Set up listen and add the row details
integer menuHandle = llListen(channel, "", id, "");
menusActive = [channel, menuHandle, llGetUnixTime(), page] + menusActive;

llSetTimerEvent(MENU_TIMEOUT_CHECK);

// Display menu
llDialog(id, menuTitle, menuNavigateButtons + menuButtons, channel);
}

// ********************************************************************
// Event Handlers
// ********************************************************************

default
{
listen(integer channel, string name, key id, string message)
{
if (message == BACK)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)-1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == FOWARD)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)+1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == " ")
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3);
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else
{
integer index = llListFindList(menusDescription, [channel]);
llMessageLinked(llList2Integer(menusDescription, index+3), LINK_MENU_RETURN, llList2String(menusDescription, index+2)+"|"+message, id);
RemoveMenu(channel, FALSE);
}
}

link_message(integer senderNum, integer num, string message, key id)
{
if (num == LINK_MENU_DISPLAY) NewMenu(message, senderNum, id);
else if (num == LINK_MENU_CLOSE) RemoveUser(id);
}

timer()
{ // Check through timers and close if necessary
integer i;
list toRemove;
integer currentTime = llGetUnixTime();
integer length = llGetListLength(menusActive);

for(i=0;i<length;i+=STRIDE_ACTIVE)
{
if (currentTime - llList2Integer(menusActive, i+2) > MENU_TIMEOUT) toRemove = [llList2Integer(menusActive, i)] + toRemove;
}

length = llGetListLength(toRemove);
if (length > 0)
{
for(i=0;i<length;i++)
{
RemoveMenu(llList2Integer(toRemove, i), TRUE);
}
}
}
}

</lsl>

==See also==
*[[ Script_Library | Script Library ]]

MultiUser Dialog Handler

2010-10-14T02:18:26Z

SimonT Quinnell: /* Calling a Simple Menu */

==Introduction==

I found that i was constantly rewriting a pile of dialog handling functions in my scrips so i decided to write a single dialog handler script. It needed to have the following features;

* Support multiple simultaneous menus from different users.
* Support fixed top buttons that will persist on lists.
* Support fixed bottom buttons with include Back and Exit buttons.
* Handle item lists > 12 and automatically insert << and >> buttons to scroll through the lists.
* Handle timeouts and communicate timeout back to calling script.
* Handles truncation of the buttons and text to stop errors in llDialog

==Using The Script==

===Calling a Simple Menu===
In the script that is calling the menu I use a function something like this. This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|-
| || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "menudescriptor|TRUE"; //Menu name is 'menu with a parent menu name 'parent'. The display of the bottom navigation buttons is set to TRUE
string menuText = "This is the menu text that will be displayed."; // The text ( will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

===Calling a Complex Menu===
The above case is a simple menu. The script can also do more complex menus.

In the following case we will have 10 buttons that are going to be displayed. Because we will also display the bottom 3 buttons this will be spanned across 2 menus. We will also include 2 fixed buttons that always display at the top of the menu, PLUS each button has a unique descriptor that is displayed.

This will display the following 2 menus

Menu1
Main text displayed.
item1
item2
item3
item4
item5
item6
item7

{| border="1"
|FIXED1 || FIXED2 || B1
|-
|B2 || B3 || B4
|-
|B5 || B6 || B7
|-
| || Back || >>
|}

Menu2 (on clicking the >> button)
Main text displayed.
item8
item9
item10

{| border="1"
|FIXED1 || FIXED2 || B8
|-
| B9 || B10 ||
|-
| << || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "menu~parent|TRUE";
string menuText = "Main text displayed.~text1~text2~text3~text4~text5~text6~text7~text8~text9~text10";
string menuButtons = "B1~B2~B3~B4~B5~B6~B7~B8~B9~B10";
string menuFixedButtons = "FIXED1~FIXED2"

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuText+"|"+ menuButtons+"|"+menuFixedButtons, id);
}
</lsl>

===Parsing the returning Menu information===

Note that if the user clicks on the << or >> buttons the calling script WILL NOT see any response. The correct menu is displayed. The calling script only receives a response when one of the buttons or Back/Exit are clicked. Clicking on a space button will cause the menu to redisplay.

The script that expects the response back from the menu has the following

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

default
{
link_message(integer intSenderNum, integer num, string message, key id)
{
if (num == LINK_MENU_RETURN)
{
list returnMenu = llParseString2List(message, ["|"], []);
list temp = llParseString2List(llList2String(returnMenu,0), ["~"], []);

string menu = llList2String(temp,0); // The name of the menu
string parent = llList2String(temp,1); // The parent of the menu
string item = llList2String(returnMenu,1); // The actual button pushed

// id == the key of the menu user.
// The button pressed in the menu is 'item', so now do something with it
}
else if (num == LINK_MENU_TIMEOUT)
{
// We received a timeout (don't worry the listens are all dealt with) so you might want to IM the menu user.
}
}
}
</lsl>

==The Script==
<lsl>
// ********************************************************************
//
// Menu Display Script
//
// Menu command format
// string = menuname ~ menuparent | display navigate? TRUE/FALSE | menuMaintitle~subtitle1~subtitle2~subtitle3 | button1~button2~button3 {| fixedbutton1~fixedbutton2~fixedbutton3 optional}
// key = menuuser key
//
//
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]
// menusActive [menuchannel, menuhandle, time, page]
//
// by SimonT Quinnell
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

// Main Menu Details
string BACK = "<<";
string FOWARD = ">>";
list MENU_NAVIGATE_BUTTONS = [ " ", "Back", "Exit"];
float MENU_TIMEOUT_CHECK = 10.0;
integer MENU_TIMEOUT = 120;
integer MAX_TEXT = 510;

integer STRIDE_DESCRIPTION = 8;
integer STRIDE_ACTIVE = 4;
integer DEBUG = FALSE;

// ********************************************************************
// Variables
// ********************************************************************

list menusDescription;
list menusActive;

// ********************************************************************
// Functions - General
// ********************************************************************

debug(string debug)
{
if (DEBUG) llWhisper(0,"DEBUG:"+llGetScriptName()+":"+debug+" : Free("+(string)llGetFreeMemory()+")");
}

integer string2Bool (string test)
{
if (test == "TRUE") return TRUE;
else return FALSE;
}

// ********************************************************************
// Functions - Menu Helpers
// ********************************************************************

integer NewChannel()
{ // generates unique channel number
integer channel;

do channel = -(llRound(llFrand(999999)) + 99999);
while (~llListFindList(menusDescription, [channel]));

return channel;
}

string CheckTitleLength(string title)
{
if (llStringLength(title) > MAX_TEXT) title = llGetSubString(title, 0, MAX_TEXT-1);

return title;
}

list FillMenu(list buttons)
{ //adds empty buttons until the list length is multiple of 3, to max of 12
integer i;
list listButtons;

for(i=0;i<llGetListLength(buttons);i++)
{
string name = llList2String(buttons,i);
if (llStringLength(name) > 24) name = llGetSubString(name, 0, 23);
listButtons = listButtons + [name];
}

while (llGetListLength(listButtons) != 3 && llGetListLength(listButtons) != 6 && llGetListLength(listButtons) != 9 && llGetListLength(listButtons) < 12)
{
listButtons = listButtons + [" "];
}

buttons = llList2List(listButtons, 9, 11);
buttons = buttons + llList2List(listButtons, 6, 8);
buttons = buttons + llList2List(listButtons, 3, 5);
buttons = buttons + llList2List(listButtons, 0, 2);

return buttons;
}

RemoveUser(key id)
{
integer index_id = llListFindList(menusDescription, [id]);

while (~index_id)
{
integer channel = llList2Integer(menusDescription, index_id-1);
RemoveMenu(channel, FALSE);
}
}

RemoveMenu(integer channel, integer echo)
{
integer index = llListFindList(menusDescription, [channel]);

if (index != -1)
{
key id = llList2Key(menusDescription, index+1);
menusDescription = llDeleteSubList(menusDescription, index, index + STRIDE_DESCRIPTION -1);
RemoveListen(channel);

if (echo) llMessageLinked(LINK_THIS, LINK_MENU_TIMEOUT, "Timeout", id);
}
}

RemoveListen(integer channel)
{
integer index = llListFindList(menusActive, [channel]);
if (index != -1)
{
llListenRemove(llList2Integer(menusActive, index + 1));
menusActive = llDeleteSubList(menusActive, index, index + STRIDE_ACTIVE - 1);
}
}

// ********************************************************************
// Functions - Menu Main
// ********************************************************************

NewMenu(string message, integer senderNum, key id)
{ // Setup New Menu
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]

list temp = llParseString2List(message, ["|"], []);
integer channel = NewChannel();

if (llGetListLength(temp) > 2)
{
menusDescription = [channel, id, llList2String(temp, 0), senderNum, string2Bool(llList2String(temp, 1)), llList2String(temp, 2), llList2String(temp, 3), llList2String(temp, 4)] + menusDescription;

DisplayMenu(id, channel, 0);
}
else llOwnerSay ("ERROR: Dialog Script. Incorrect menu format");
}

DisplayMenu(key id, integer channel, integer page)
{
string menuTitle;
list menuSubTitles;
list menuButtonsAll;
list menuButtons;
list menuNavigateButtons;
list menuFixedButtons;

integer max = 12;

// Populate values
integer index = llListFindList(menusDescription, [channel]);
menuButtonsAll = llParseString2List(llList2String(menusDescription, index+6), ["~"], []);
if (llList2String(menusDescription, index+7) != "") menuFixedButtons = llParseString2List(llList2String(menusDescription, index+7), ["~"], []);

// Set up the menu buttons
if (llList2Integer(menusDescription, index+4)) menuNavigateButtons= MENU_NAVIGATE_BUTTONS;
else if (llGetListLength(menuButtonsAll) > (max-llGetListLength(menuFixedButtons))) menuNavigateButtons = [" ", " ", " "];

// FIXME: add sanity check for menu page

max = max - llGetListLength(menuFixedButtons) - llGetListLength(menuNavigateButtons);
integer start = page*max;
integer stop = (page+1)*max - 1;
menuButtons = FillMenu(menuFixedButtons + llList2List(menuButtonsAll, start, stop));

// Generate the title
list tempTitle = llParseString2List(llList2String(menusDescription, index+5), ["~"], []);
menuTitle = llList2String(tempTitle,0);
if (llGetListLength(tempTitle) > 1) menuSubTitles = llList2List(tempTitle, 1, -1);
if (llGetListLength(menuSubTitles) > 0)
{
integer i;
for(i=start;i<(stop+1);++i)
{
if (llList2String(menuSubTitles, i) != "") menuTitle += "\n"+llList2String(menuSubTitles, i);
}
}
menuTitle = CheckTitleLength(menuTitle);

// Add navigate buttons if necessary
if (page > 0) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [BACK], 0, 0);
if (llGetListLength(menuButtonsAll) > (page+1)*max) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [FOWARD], 2, 2);

// Set up listen and add the row details
integer menuHandle = llListen(channel, "", id, "");
menusActive = [channel, menuHandle, llGetUnixTime(), page] + menusActive;

llSetTimerEvent(MENU_TIMEOUT_CHECK);

// Display menu
llDialog(id, menuTitle, menuNavigateButtons + menuButtons, channel);
}

// ********************************************************************
// Event Handlers
// ********************************************************************

default
{
listen(integer channel, string name, key id, string message)
{
if (message == BACK)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)-1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == FOWARD)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)+1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == " ")
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3);
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else
{
integer index = llListFindList(menusDescription, [channel]);
llMessageLinked(llList2Integer(menusDescription, index+3), LINK_MENU_RETURN, llList2String(menusDescription, index+2)+"|"+message, id);
RemoveMenu(channel, FALSE);
}
}

link_message(integer senderNum, integer num, string message, key id)
{
if (num == LINK_MENU_DISPLAY) NewMenu(message, senderNum, id);
else if (num == LINK_MENU_CLOSE) RemoveUser(id);
}

timer()
{ // Check through timers and close if necessary
integer i;
list toRemove;
integer currentTime = llGetUnixTime();
integer length = llGetListLength(menusActive);

for(i=0;i<length;i+=STRIDE_ACTIVE)
{
if (currentTime - llList2Integer(menusActive, i+2) > MENU_TIMEOUT) toRemove = [llList2Integer(menusActive, i)] + toRemove;
}

length = llGetListLength(toRemove);
if (length > 0)
{
for(i=0;i<length;i++)
{
RemoveMenu(llList2Integer(toRemove, i), TRUE);
}
}
}
}

</lsl>

==See also==
*[[ Script_Library | Script Library ]]

MultiUser Dialog Handler

2010-09-01T06:52:41Z

SimonT Quinnell: /* Parsing the returning Menu information */

==Introduction==

I found that i was constantly rewriting a pile of dialog handling functions in my scrips so i decided to write a single dialog handler script. It needed to have the following features;

* Support multiple simultaneous menus from different users.
* Support fixed top buttons that will persist on lists.
* Support fixed bottom buttons with include Back and Exit buttons.
* Handle item lists > 12 and automatically insert << and >> buttons to scroll through the lists.
* Handle timeouts and communicate timeout back to calling script.
* Handles truncation of the buttons and text to stop errors in llDialog

==Using The Script==

===Calling a Simple Menu===
In the script that is calling the menu I use a function something like this. This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|-
| || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "menu~parent|TRUE"; //Menu name is 'menu with a parent menu name 'parent'. The display of the bottom navigation buttons is set to TRUE
string menuText = "This is the menu text that will be displayed."; // The text ( will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

===Calling a Complex Menu===
The above case is a simple menu. The script can also do more complex menus.

In the following case we will have 10 buttons that are going to be displayed. Because we will also display the bottom 3 buttons this will be spanned across 2 menus. We will also include 2 fixed buttons that always display at the top of the menu, PLUS each button has a unique descriptor that is displayed.

This will display the following 2 menus

Menu1
Main text displayed.
item1
item2
item3
item4
item5
item6
item7

{| border="1"
|FIXED1 || FIXED2 || B1
|-
|B2 || B3 || B4
|-
|B5 || B6 || B7
|-
| || Back || >>
|}

Menu2 (on clicking the >> button)
Main text displayed.
item8
item9
item10

{| border="1"
|FIXED1 || FIXED2 || B8
|-
| B9 || B10 ||
|-
| << || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "menu~parent|TRUE";
string menuText = "Main text displayed.~text1~text2~text3~text4~text5~text6~text7~text8~text9~text10";
string menuButtons = "B1~B2~B3~B4~B5~B6~B7~B8~B9~B10";
string menuFixedButtons = "FIXED1~FIXED2"

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuText+"|"+ menuButtons+"|"+menuFixedButtons, id);
}
</lsl>

===Parsing the returning Menu information===

Note that if the user clicks on the << or >> buttons the calling script WILL NOT see any response. The correct menu is displayed. The calling script only receives a response when one of the buttons or Back/Exit are clicked. Clicking on a space button will cause the menu to redisplay.

The script that expects the response back from the menu has the following

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

default
{
link_message(integer intSenderNum, integer num, string message, key id)
{
if (num == LINK_MENU_RETURN)
{
list returnMenu = llParseString2List(message, ["|"], []);
list temp = llParseString2List(llList2String(returnMenu,0), ["~"], []);

string menu = llList2String(temp,0); // The name of the menu
string parent = llList2String(temp,1); // The parent of the menu
string item = llList2String(returnMenu,1); // The actual button pushed

// id == the key of the menu user.
// The button pressed in the menu is 'item', so now do something with it
}
else if (num == LINK_MENU_TIMEOUT)
{
// We received a timeout (don't worry the listens are all dealt with) so you might want to IM the menu user.
}
}
}
</lsl>

==The Script==
<lsl>
// ********************************************************************
//
// Menu Display Script
//
// Menu command format
// string = menuname ~ menuparent | display navigate? TRUE/FALSE | menuMaintitle~subtitle1~subtitle2~subtitle3 | button1~button2~button3 {| fixedbutton1~fixedbutton2~fixedbutton3 optional}
// key = menuuser key
//
//
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]
// menusActive [menuchannel, menuhandle, time, page]
//
// by SimonT Quinnell
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

// Main Menu Details
string BACK = "<<";
string FOWARD = ">>";
list MENU_NAVIGATE_BUTTONS = [ " ", "Back", "Exit"];
float MENU_TIMEOUT_CHECK = 10.0;
integer MENU_TIMEOUT = 120;
integer MAX_TEXT = 510;

integer STRIDE_DESCRIPTION = 8;
integer STRIDE_ACTIVE = 4;
integer DEBUG = FALSE;

// ********************************************************************
// Variables
// ********************************************************************

list menusDescription;
list menusActive;

// ********************************************************************
// Functions - General
// ********************************************************************

debug(string debug)
{
if (DEBUG) llWhisper(0,"DEBUG:"+llGetScriptName()+":"+debug+" : Free("+(string)llGetFreeMemory()+")");
}

integer string2Bool (string test)
{
if (test == "TRUE") return TRUE;
else return FALSE;
}

// ********************************************************************
// Functions - Menu Helpers
// ********************************************************************

integer NewChannel()
{ // generates unique channel number
integer channel;

do channel = -(llRound(llFrand(999999)) + 99999);
while (~llListFindList(menusDescription, [channel]));

return channel;
}

string CheckTitleLength(string title)
{
if (llStringLength(title) > MAX_TEXT) title = llGetSubString(title, 0, MAX_TEXT-1);

return title;
}

list FillMenu(list buttons)
{ //adds empty buttons until the list length is multiple of 3, to max of 12
integer i;
list listButtons;

for(i=0;i<llGetListLength(buttons);i++)
{
string name = llList2String(buttons,i);
if (llStringLength(name) > 24) name = llGetSubString(name, 0, 23);
listButtons = listButtons + [name];
}

while (llGetListLength(listButtons) != 3 && llGetListLength(listButtons) != 6 && llGetListLength(listButtons) != 9 && llGetListLength(listButtons) < 12)
{
listButtons = listButtons + [" "];
}

buttons = llList2List(listButtons, 9, 11);
buttons = buttons + llList2List(listButtons, 6, 8);
buttons = buttons + llList2List(listButtons, 3, 5);
buttons = buttons + llList2List(listButtons, 0, 2);

return buttons;
}

RemoveUser(key id)
{
integer index_id = llListFindList(menusDescription, [id]);

while (~index_id)
{
integer channel = llList2Integer(menusDescription, index_id-1);
RemoveMenu(channel, FALSE);
}
}

RemoveMenu(integer channel, integer echo)
{
integer index = llListFindList(menusDescription, [channel]);

if (index != -1)
{
key id = llList2Key(menusDescription, index+1);
menusDescription = llDeleteSubList(menusDescription, index, index + STRIDE_DESCRIPTION -1);
RemoveListen(channel);

if (echo) llMessageLinked(LINK_THIS, LINK_MENU_TIMEOUT, "Timeout", id);
}
}

RemoveListen(integer channel)
{
integer index = llListFindList(menusActive, [channel]);
if (index != -1)
{
llListenRemove(llList2Integer(menusActive, index + 1));
menusActive = llDeleteSubList(menusActive, index, index + STRIDE_ACTIVE - 1);
}
}

// ********************************************************************
// Functions - Menu Main
// ********************************************************************

NewMenu(string message, integer senderNum, key id)
{ // Setup New Menu
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]

list temp = llParseString2List(message, ["|"], []);
integer channel = NewChannel();

if (llGetListLength(temp) > 2)
{
menusDescription = [channel, id, llList2String(temp, 0), senderNum, string2Bool(llList2String(temp, 1)), llList2String(temp, 2), llList2String(temp, 3), llList2String(temp, 4)] + menusDescription;

DisplayMenu(id, channel, 0);
}
else llOwnerSay ("ERROR: Dialog Script. Incorrect menu format");
}

DisplayMenu(key id, integer channel, integer page)
{
string menuTitle;
list menuSubTitles;
list menuButtonsAll;
list menuButtons;
list menuNavigateButtons;
list menuFixedButtons;

integer max = 12;

// Populate values
integer index = llListFindList(menusDescription, [channel]);
menuButtonsAll = llParseString2List(llList2String(menusDescription, index+6), ["~"], []);
if (llList2String(menusDescription, index+7) != "") menuFixedButtons = llParseString2List(llList2String(menusDescription, index+7), ["~"], []);

// Set up the menu buttons
if (llList2Integer(menusDescription, index+4)) menuNavigateButtons= MENU_NAVIGATE_BUTTONS;
else if (llGetListLength(menuButtonsAll) > (max-llGetListLength(menuFixedButtons))) menuNavigateButtons = [" ", " ", " "];

// FIXME: add sanity check for menu page

max = max - llGetListLength(menuFixedButtons) - llGetListLength(menuNavigateButtons);
integer start = page*max;
integer stop = (page+1)*max - 1;
menuButtons = FillMenu(menuFixedButtons + llList2List(menuButtonsAll, start, stop));

// Generate the title
list tempTitle = llParseString2List(llList2String(menusDescription, index+5), ["~"], []);
menuTitle = llList2String(tempTitle,0);
if (llGetListLength(tempTitle) > 1) menuSubTitles = llList2List(tempTitle, 1, -1);
if (llGetListLength(menuSubTitles) > 0)
{
integer i;
for(i=start;i<(stop+1);++i)
{
if (llList2String(menuSubTitles, i) != "") menuTitle += "\n"+llList2String(menuSubTitles, i);
}
}
menuTitle = CheckTitleLength(menuTitle);

// Add navigate buttons if necessary
if (page > 0) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [BACK], 0, 0);
if (llGetListLength(menuButtonsAll) > (page+1)*max) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [FOWARD], 2, 2);

// Set up listen and add the row details
integer menuHandle = llListen(channel, "", id, "");
menusActive = [channel, menuHandle, llGetUnixTime(), page] + menusActive;

llSetTimerEvent(MENU_TIMEOUT_CHECK);

// Display menu
llDialog(id, menuTitle, menuNavigateButtons + menuButtons, channel);
}

// ********************************************************************
// Event Handlers
// ********************************************************************

default
{
listen(integer channel, string name, key id, string message)
{
if (message == BACK)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)-1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == FOWARD)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)+1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == " ")
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3);
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else
{
integer index = llListFindList(menusDescription, [channel]);
llMessageLinked(llList2Integer(menusDescription, index+3), LINK_MENU_RETURN, llList2String(menusDescription, index+2)+"|"+message, id);
RemoveMenu(channel, FALSE);
}
}

link_message(integer senderNum, integer num, string message, key id)
{
if (num == LINK_MENU_DISPLAY) NewMenu(message, senderNum, id);
else if (num == LINK_MENU_CLOSE) RemoveUser(id);
}

timer()
{ // Check through timers and close if necessary
integer i;
list toRemove;
integer currentTime = llGetUnixTime();
integer length = llGetListLength(menusActive);

for(i=0;i<length;i+=STRIDE_ACTIVE)
{
if (currentTime - llList2Integer(menusActive, i+2) > MENU_TIMEOUT) toRemove = [llList2Integer(menusActive, i)] + toRemove;
}

length = llGetListLength(toRemove);
if (length > 0)
{
for(i=0;i<length;i++)
{
RemoveMenu(llList2Integer(toRemove, i), TRUE);
}
}
}
}

</lsl>

==See also==
*[[ Script_Library | Script Library ]]

MultiUser Dialog Handler

2010-09-01T06:51:44Z

SimonT Quinnell: /* Parsing the returning Menu information */

==Introduction==

I found that i was constantly rewriting a pile of dialog handling functions in my scrips so i decided to write a single dialog handler script. It needed to have the following features;

* Support multiple simultaneous menus from different users.
* Support fixed top buttons that will persist on lists.
* Support fixed bottom buttons with include Back and Exit buttons.
* Handle item lists > 12 and automatically insert << and >> buttons to scroll through the lists.
* Handle timeouts and communicate timeout back to calling script.
* Handles truncation of the buttons and text to stop errors in llDialog

==Using The Script==

===Calling a Simple Menu===
In the script that is calling the menu I use a function something like this. This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|-
| || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "menu~parent|TRUE"; //Menu name is 'menu with a parent menu name 'parent'. The display of the bottom navigation buttons is set to TRUE
string menuText = "This is the menu text that will be displayed."; // The text ( will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

===Calling a Complex Menu===
The above case is a simple menu. The script can also do more complex menus.

In the following case we will have 10 buttons that are going to be displayed. Because we will also display the bottom 3 buttons this will be spanned across 2 menus. We will also include 2 fixed buttons that always display at the top of the menu, PLUS each button has a unique descriptor that is displayed.

This will display the following 2 menus

Menu1
Main text displayed.
item1
item2
item3
item4
item5
item6
item7

{| border="1"
|FIXED1 || FIXED2 || B1
|-
|B2 || B3 || B4
|-
|B5 || B6 || B7
|-
| || Back || >>
|}

Menu2 (on clicking the >> button)
Main text displayed.
item8
item9
item10

{| border="1"
|FIXED1 || FIXED2 || B8
|-
| B9 || B10 ||
|-
| << || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "menu~parent|TRUE";
string menuText = "Main text displayed.~text1~text2~text3~text4~text5~text6~text7~text8~text9~text10";
string menuButtons = "B1~B2~B3~B4~B5~B6~B7~B8~B9~B10";
string menuFixedButtons = "FIXED1~FIXED2"

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuText+"|"+ menuButtons+"|"+menuFixedButtons, id);
}
</lsl>

===Parsing the returning Menu information===

Note that if the user clicks on the << or >> buttons the calling script WILL NOT see any response. The correct menu is displayed. The calling script only receives a response when one of the buttons or Back/Exit are clicked. Clicking on a space button will cause the menu to redisplay.

The script that expects the response back from the menu has the following

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

default
{
link_message(integer intSenderNum, integer num, string message, key id)
{
if (num == LINK_MENU_RETURN)
{
list returnMenu = llParseString2List(message, ["|"], []);
list temp = llParseString2List(llList2String(returnMenu,0), ["~"], []);

string menu = llList2String(temp,0); // The name of the menu
string parent = llList2String(temp,1); // The parent of the menu
string item = llList2String(returnMenu,1); // The actual button pushed

// id == the key of the menu user.
// now do something with your response which is the variable 'item'
}
else if (num == LINK_MENU_TIMEOUT)
{
// We received a timeout (don't worry the listens are all dealt with) so you might want to IM the menu user.
}
}
}
</lsl>

==The Script==
<lsl>
// ********************************************************************
//
// Menu Display Script
//
// Menu command format
// string = menuname ~ menuparent | display navigate? TRUE/FALSE | menuMaintitle~subtitle1~subtitle2~subtitle3 | button1~button2~button3 {| fixedbutton1~fixedbutton2~fixedbutton3 optional}
// key = menuuser key
//
//
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]
// menusActive [menuchannel, menuhandle, time, page]
//
// by SimonT Quinnell
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

// Main Menu Details
string BACK = "<<";
string FOWARD = ">>";
list MENU_NAVIGATE_BUTTONS = [ " ", "Back", "Exit"];
float MENU_TIMEOUT_CHECK = 10.0;
integer MENU_TIMEOUT = 120;
integer MAX_TEXT = 510;

integer STRIDE_DESCRIPTION = 8;
integer STRIDE_ACTIVE = 4;
integer DEBUG = FALSE;

// ********************************************************************
// Variables
// ********************************************************************

list menusDescription;
list menusActive;

// ********************************************************************
// Functions - General
// ********************************************************************

debug(string debug)
{
if (DEBUG) llWhisper(0,"DEBUG:"+llGetScriptName()+":"+debug+" : Free("+(string)llGetFreeMemory()+")");
}

integer string2Bool (string test)
{
if (test == "TRUE") return TRUE;
else return FALSE;
}

// ********************************************************************
// Functions - Menu Helpers
// ********************************************************************

integer NewChannel()
{ // generates unique channel number
integer channel;

do channel = -(llRound(llFrand(999999)) + 99999);
while (~llListFindList(menusDescription, [channel]));

return channel;
}

string CheckTitleLength(string title)
{
if (llStringLength(title) > MAX_TEXT) title = llGetSubString(title, 0, MAX_TEXT-1);

return title;
}

list FillMenu(list buttons)
{ //adds empty buttons until the list length is multiple of 3, to max of 12
integer i;
list listButtons;

for(i=0;i<llGetListLength(buttons);i++)
{
string name = llList2String(buttons,i);
if (llStringLength(name) > 24) name = llGetSubString(name, 0, 23);
listButtons = listButtons + [name];
}

while (llGetListLength(listButtons) != 3 && llGetListLength(listButtons) != 6 && llGetListLength(listButtons) != 9 && llGetListLength(listButtons) < 12)
{
listButtons = listButtons + [" "];
}

buttons = llList2List(listButtons, 9, 11);
buttons = buttons + llList2List(listButtons, 6, 8);
buttons = buttons + llList2List(listButtons, 3, 5);
buttons = buttons + llList2List(listButtons, 0, 2);

return buttons;
}

RemoveUser(key id)
{
integer index_id = llListFindList(menusDescription, [id]);

while (~index_id)
{
integer channel = llList2Integer(menusDescription, index_id-1);
RemoveMenu(channel, FALSE);
}
}

RemoveMenu(integer channel, integer echo)
{
integer index = llListFindList(menusDescription, [channel]);

if (index != -1)
{
key id = llList2Key(menusDescription, index+1);
menusDescription = llDeleteSubList(menusDescription, index, index + STRIDE_DESCRIPTION -1);
RemoveListen(channel);

if (echo) llMessageLinked(LINK_THIS, LINK_MENU_TIMEOUT, "Timeout", id);
}
}

RemoveListen(integer channel)
{
integer index = llListFindList(menusActive, [channel]);
if (index != -1)
{
llListenRemove(llList2Integer(menusActive, index + 1));
menusActive = llDeleteSubList(menusActive, index, index + STRIDE_ACTIVE - 1);
}
}

// ********************************************************************
// Functions - Menu Main
// ********************************************************************

NewMenu(string message, integer senderNum, key id)
{ // Setup New Menu
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]

list temp = llParseString2List(message, ["|"], []);
integer channel = NewChannel();

if (llGetListLength(temp) > 2)
{
menusDescription = [channel, id, llList2String(temp, 0), senderNum, string2Bool(llList2String(temp, 1)), llList2String(temp, 2), llList2String(temp, 3), llList2String(temp, 4)] + menusDescription;

DisplayMenu(id, channel, 0);
}
else llOwnerSay ("ERROR: Dialog Script. Incorrect menu format");
}

DisplayMenu(key id, integer channel, integer page)
{
string menuTitle;
list menuSubTitles;
list menuButtonsAll;
list menuButtons;
list menuNavigateButtons;
list menuFixedButtons;

integer max = 12;

// Populate values
integer index = llListFindList(menusDescription, [channel]);
menuButtonsAll = llParseString2List(llList2String(menusDescription, index+6), ["~"], []);
if (llList2String(menusDescription, index+7) != "") menuFixedButtons = llParseString2List(llList2String(menusDescription, index+7), ["~"], []);

// Set up the menu buttons
if (llList2Integer(menusDescription, index+4)) menuNavigateButtons= MENU_NAVIGATE_BUTTONS;
else if (llGetListLength(menuButtonsAll) > (max-llGetListLength(menuFixedButtons))) menuNavigateButtons = [" ", " ", " "];

// FIXME: add sanity check for menu page

max = max - llGetListLength(menuFixedButtons) - llGetListLength(menuNavigateButtons);
integer start = page*max;
integer stop = (page+1)*max - 1;
menuButtons = FillMenu(menuFixedButtons + llList2List(menuButtonsAll, start, stop));

// Generate the title
list tempTitle = llParseString2List(llList2String(menusDescription, index+5), ["~"], []);
menuTitle = llList2String(tempTitle,0);
if (llGetListLength(tempTitle) > 1) menuSubTitles = llList2List(tempTitle, 1, -1);
if (llGetListLength(menuSubTitles) > 0)
{
integer i;
for(i=start;i<(stop+1);++i)
{
if (llList2String(menuSubTitles, i) != "") menuTitle += "\n"+llList2String(menuSubTitles, i);
}
}
menuTitle = CheckTitleLength(menuTitle);

// Add navigate buttons if necessary
if (page > 0) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [BACK], 0, 0);
if (llGetListLength(menuButtonsAll) > (page+1)*max) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [FOWARD], 2, 2);

// Set up listen and add the row details
integer menuHandle = llListen(channel, "", id, "");
menusActive = [channel, menuHandle, llGetUnixTime(), page] + menusActive;

llSetTimerEvent(MENU_TIMEOUT_CHECK);

// Display menu
llDialog(id, menuTitle, menuNavigateButtons + menuButtons, channel);
}

// ********************************************************************
// Event Handlers
// ********************************************************************

default
{
listen(integer channel, string name, key id, string message)
{
if (message == BACK)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)-1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == FOWARD)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)+1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == " ")
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3);
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else
{
integer index = llListFindList(menusDescription, [channel]);
llMessageLinked(llList2Integer(menusDescription, index+3), LINK_MENU_RETURN, llList2String(menusDescription, index+2)+"|"+message, id);
RemoveMenu(channel, FALSE);
}
}

link_message(integer senderNum, integer num, string message, key id)
{
if (num == LINK_MENU_DISPLAY) NewMenu(message, senderNum, id);
else if (num == LINK_MENU_CLOSE) RemoveUser(id);
}

timer()
{ // Check through timers and close if necessary
integer i;
list toRemove;
integer currentTime = llGetUnixTime();
integer length = llGetListLength(menusActive);

for(i=0;i<length;i+=STRIDE_ACTIVE)
{
if (currentTime - llList2Integer(menusActive, i+2) > MENU_TIMEOUT) toRemove = [llList2Integer(menusActive, i)] + toRemove;
}

length = llGetListLength(toRemove);
if (length > 0)
{
for(i=0;i<length;i++)
{
RemoveMenu(llList2Integer(toRemove, i), TRUE);
}
}
}
}

</lsl>

==See also==
*[[ Script_Library | Script Library ]]

Category:LSL Library

2010-09-01T05:20:51Z

SimonT Quinnell: /* LSL Script Library */

{{LSL Header|ml=*}}{{RightToc}}
==Script Library==

<div id="box">
<div style="padding: 0.5em 0.5em 1.5em">
Come to this page to see complex examples that show how to combine parts of LSL.

Go to the [[:Category:LSL Examples|LSL Examples]] page to see brief examples of how to use parts of LSL

Why collect complex examples here? Well, ...

There are many [[script|scripts]] that have become buried in the [http://forums-archive.secondlife.com/15/1.html Scripting Library archive] or the newer [https://blogs.secondlife.com/community/forums/scripting_library?view=discussions Scripting Library forum], were lost with the death of the early scripting forums, or sit idle in [[inventory|inventories]] that could be useful and should be more accessible.

Other scripters may be in the same situation. This wiki is a well-suited medium for a script library. Feel free to add your scripts to the script library by creating new pages for them and linking to those pages here.

Note that there are many more scripts in the LSL Library here, but you can't get to them if you don't know they exist, because they are subpages now, instead of an automatically updated category. Good luck searching.
</div>
</div>

<div id="box">

== Rules for posting: ==
<div style="padding: 0.5em">
#Your script must be tested and working. If it's not, stick it in your user-space until it is. This is a list of working, usable scripts.
#Add a link to your script's page here. Link back to this page from your script's page. Start your page with <nowiki>{{LSL Header}}</nowiki>.
#Do not add scripts that duplicate the same functionality as an existing script or built in {{LSLGC|Functions|function}}. If yours does, explain why.
#Do not list simple scripts here. Include those among the [[:Category:LSL Examples|LSL Examples]] instead.
</div></div>

<div id="box">
==LSL Script Library==

{| class="sortable" {{Prettytable}}
|- {{Hl2}}
! '''Name'''
! '''Creator'''
! '''Description'''
|-
||[[1st necessity of SL]]
||[[User:Beer Dailey|Beer Dailey]]
||Monitors for avatars and (de)activates scripts states to control script performance/lag.
|-
||[[3D Radar]]
||[[User:Jesse Barnett|Jesse Barnett]]
||Rezzes a ball for each avatar in range. Each ball tracks its own AV and displays distance.
|-
||[[Access (NewAge)]]
||[[User:Asia Snowfall|Asia Snowfall]]
||An easy to use script for permissions on who can use the script, Public/Group/Owner
|-
||[[Aim Detection]]
||[[User:Han Shuffle|Han Shuffle]]
||Monitors for avatars and reports back to owner about who is aiming at them.
|-
||[[AntiDelay Node]]
||[[User:Xaviar Czervik|Xaviar Czervik]]
||Uses [[llMessageLinked]] to stop those pesky delays.
|-
||[[AO Overriding Pose Ball]]
||[[User:Jesse Barnett|Jesse Barnett]]
||No more turning your AO off and on when you sit down
|-
||[[ARCFOUR Strong Encryption Implementation]]
||[[User:Nekow42 Zarf|Nekow42 Zarf]]
||An LSL implementation of ARCFOUR, the most popular stream cipher still in use. It is licensed under a Creative Commons Attribution 3.0 license.
|-
||[[Assembly Programming Language|Assembly-Like Programming Language]]
||[[User:Xaviar Czervik|Xaviar Czervik]]
||A compiler that runs assembly-like programs.
|-
||[[Associative Array Emulator|Associative Array (Dictionary) Emulator]]
||[[User:Alynna Vixen|Alynna Vixen]]
||This library provides a set of functions for using a list as an associative array where string based keys can refer to one or more variant elements.
|-
||[[AvatarFollower]]
||[[User:Dale Innis|Dale Innis]]
||Allows one avatar to automatically follow another.
|-
||[[Avatar Radar (NewAge)]]
||[[User:Asia Snowfall|Asia Snowfall]]
||Version 1.2; A nice new avatar radar script i just finish that you can place in your hud, Also features avatar locator
|-
||[[Base2Dec]]
||[[User:Siann Beck|Siann Beck]]
||Convert a number to decimal from any base.
|-
||[[BaseN]]
||[[User:Nexii Malthus|Nexii Malthus]]
||Variable base compression, dynamically maps to usable UTF code points.
|-
||[[Basic A-Star Pathfinder]]
||[[User:Nexii Malthus|Nexii Malthus]]
|| My own interpretation of A Star into a highly efficient algorithmn
|-
||[[Basic Encryption Modules]]
||[[User:Beverly Larkin|Beverly Larkin]]
||Basic encryption scripts, allows you to encrypt a float and shout it to another prim on a randomly chosen channel.
|-
||[[Be happy]]
||[[User:Emmas Seetan|Emmas Seetan]]
||Basic smile attachment script, makes your avatar smile.
|-
||[[Best Neighbor Ad Hiding Script|Best Neighbor]]
||[[User:Doran Zemlja|Doran Zemlja]]
||Reduce ad clutter by hiding ads when users are on their own land nearby.
|-
||[[BigNum|BigNum Library (RSA Encryption)]]
||[[User:Xaviar Czervik|Xaviar Czervik]]
||A BigNum Library for dealing with big numbers! Specialized for modular multiplication, and RSA encryption.
|-
||[[Binary Clock v1.1|Binary Clock]]
||[[User:Fox Diller|Fox Diller]]
||A Binary Clock.
|-
||[[BinaryDecimalConverter]]
||[[User:Soundless Smalls|Soundless Smalls]]
||Converts a binary value to a decimal value and vice versa.
|-
||[[Blacklist and Remote Kill|Blacklist and Remote Kill]]
||[[User:Chase Quinnell|Chase Quinnell]]
||Blacklist(denial of use) or a creator kill script(can delete someone's item by command on private channel)
|-
||[[User_talk:Rolig_Loon/Bookmark_URLs|Bookmark URLs]]
||[[User:Rolig Loon|Rolig Loon]]
||Dialog driven HUD reads bookmarked URLs from notecards and navigates directly to them with user's in-world browser.
|-
||[[Builders Buddy|Builder's Buddy Tool]]
||[[User:Newfie Pendragon|Newfie Pendragon]]
||Script to easily move/rotate large builds that exceed the linkable size limit (30 meters).
|-
||[[Button Click Detector]]
||{{User|Sendao Goodman}}
||Use [[llDetectedTouchUV]] to determine which button was pressed on a texture.
|-
||[[Camera following prim]]
||[[User:Dale Innis|Dale Innis]]
||Pair of scripts to make a prim follow your camera position around (for lights etc).
|-
||[[Camera Sync]]
||[[User:Meyermagic Salome|Meyermagic Salome]] and [[User:Nomad Padar|Nomad Padar]]
||A system to synchronize the cameras of two avatars.
|-
||[[Chatbot]]
||Anonymous
||Compile and run the LSL you type on a channel, faster than you can thru the 2007-08 SL GUI.
|-
||[[Chat Logger (GPL)]]
||[[User:Nobody Fugazi|Nobody Fugazi]]
||Chat logger which requests permission from participants before recording them.
|-
||[[Chat_Relay|Chat Relay]]
||[[User:grumble Loudon|grumble Loudon]]
||A Chat relay which can be routed using a path header and won't echo.
|-
||[[ClickAndDrag]]
||[[User:Nexii Malthus|Nexii Malthus]]
|| Click and Drag user interface elements using dynamic feedback
|-
||[[Code Racer]]
||Anonymous
||Race two versions of code forever, to see which runs faster.
|-
||[[Code Sizer]]
||Anonymous
||Count the bytes compiled from source code, to measure how to write small code.
|-
||[[User:Void_Singer/Programs#v7-D_Enh._Color_Picker|Color Changer]]
||[[User:Void_Singer|Void_Singer]]
||Dialog driven color changer. Supports 16million+ colors, web color codes, multiple targeted prims, with save and recall.
|-
||[[Color Changer|Color Changer Plus]]
||[[User:Neo Calcutt|Neo Calcutt]]
||A color changer with 14 colors, a random function, and a custom vector function.
|-
||[[Color conversion scripts|Color Conversion]]
||[[User:Sally LaSalle|Sally LaSalle]]
||Convert between Red Green Blue (RGB) and Hue Saturation Value (HSV).
|-
||[[ColorConvert]]
||[[User:Siann Beck|Siann Beck]]
||Convert color values to vector from RGB, hex or HTML color name.
|-
||[[Color script]]
||[[User:Masakazu Kojima|Masakazu Kojima]]
||Script for changing colors trough a listener with pre-defined colors.
|-
||[[Library Combined Library|Combined Library]]
||[[User:Strife Onizuka|Strife Onizuka]]
||Library of mostly encoding and decoding functions, some more useful then others.
* String functions: Replace / Trim right / Trim left / Trim both
* Unicode conversion: UTF8 to Unicode / Unicode to UTF8
* List functions: Replace / Compare
|-
||[[Computer:jaycoonlanguage]]
||[[User:jayco121 Bing|jayco121 Bing]]
|| A language written in LSL that is meant for my computer (available at the shop).
|-
||[[Read Note Card Configuration|Configuration Notecard Reader]]
||{{User|Dedric Mauriac}}
||A script to read configuration information from a notecard. Parses notecard to extract key words and their assigned values. Allows for comment lines and many more useful features.
|-
||[[AdvancedNotecardReader|Configuration Notecard Reader (advanced)]]
||[[Lear Cale|Lear Cale]]
||Robust configuration notecard reader; supports multiple notecards with same suffix, handles reconfig on inventory change, and does not usurp the default state.
|-
||[[Library_Chat_Relay|Conversation Relay]]
||[[User:Jippen Faddoul|Jippen Faddoul]]
||Chat relay which requests permission from participants before relaying their messages. Also includes their attachments. (ToS compliant).
|-
||[[Curtain script]]
||[[User:Zilla Larsson|Zilla Larsson]]
||A simple script to retract/stretch curtains, blinds, bedcovers and more
|-
||[[Dataserver API]]
||[[User:Revolution Perenti|Revolution Perenti]]
||Dataserver Framework for Notecards.
|-
||[[Date Library]]
||[[User:Corto Maltese|Corto Maltese]]
|| Date library, based on number of day since march 3rd 1600, can be used to calculate weekday, date differences, and date offset, and date formating.
|-
||[[Day of the Week]]
||[[User:DoteDote Edison|DoteDote Edison]]
||Function to get day of the week from [[llGetUnixTime]].
|-
||[[Days in Month]]
||[[User:IntLibber Brautigan begin_of_the_skype_highlighting end_of_the_skype_highlighting begin_of_the_skype_highlighting end_of_the_skype_highlighting|IntLibber Brautigan]]
||Clicking on it returns the number of days in the present month. Useful for scripting calendars and tier systems that need to know the number of days in the month at hand or to calculate for any month. Even adjusts for leap years.
|-
||[[Deed Tools]]
||[[User:Falados Kapuskas|Falados Kapuskas]]
||Tools that allow the creator to modify Group-Owned (Deeded) Objects via chat.
|-
||[[Describe Chatter]]
||Anonymous
||Chat to see yourself as others do.
|-
||[[Dialog Control]]
||[[User:Nargus Asturias|Nargus Asturias]]
|| A (not-so) simple dialog & menu control script. Call dialog and receive selected value via [[link_message]](), with built-in timer and [[link_message]]() notification on time out. Supports multi-pages dialog and numeric property dialog. Button text and dialog's returned value can differ.
Latest version also has [[Dialog Menus Control]] built-in; which allow multi-level menus through SL dialog system.
|-
||[[MultiUser_Dialog_Handler|Dialog Menus (multiuser)]]
||[[User:SimonT Quinnell|SimonT Quinnell]]
|| Menu dialog handler that supports multiple menus open at once from the single script. Displays multi-page menus if necessary as well as allowing for fixed header and footer buttons. Timeouts as well as Text and button size limits are handled.
|-
||[[Dialog NumberPad|Dialog Number Pad]]
||[[User:DoteDote Edison|DoteDote Edison]]
||Use a dialog to accept positive integer input from users.
|-
||[[Displayer Script]]
||[[User:Akinori Kimagawa|Akinori Kimagawa]]
||[[Display Words On Top Of An Object]]
|-
||[[Drink script]]
||[[User:Emmas Seetan|Emmas Seetan]]
||Used mainly for food and drink in Second Life.
|-
||[[TOXDropBox|DropBox]]
||[[User:Dimentox Travanti|Dimentox Travanti]]
|| This is a Drop box which allows people to drop certain items in a object & has many config options.
|-
||[[Efficiency Tester]]
||[[User:Xaviar Czervik|Xaviar Czervik]]
||Tests the speed of a function.
|-
||[[Email-to-IM|Email2IM]]
||[[User:DoteDote Edison|DoteDote Edison]]
||Send IMs to SL friends via [[email]] (translate emails from friends into IMs).
|-
|-
||[[User:Kireji_Haiku/SIMchat_headset|Encrypted Region-wide chat]]
||'''[[User:Kireji Haiku|Kireji Haiku]]''' <sup><small>([[User talk:Kireji Haiku|talk]]|[[Special:Contributions/Kireji Haiku|contribs]])</small></sup>
||Encrypted Region-wide chat
|-
||[[ExplodingObjects]]
||[[User:Dale Innis|Dale Innis]]
||Causes an object (of the appropriate type) to explode on command.
|-
||[[FadeEasy]]
||[[User:Nika Rugani|Nika Rugani]]
||The easy way of fading objects in or out (Using llSetLinkAlpha)
|-
||[[FastConeSpread]]
||[[User:Nexii Malthus|Nexii Malthus]]
|| Fast Algorithmn to achieve cone spread, main use in weaponry systems.
|-
||[[User:PixelProphet Lane/Scripts#Fast List Prim Contents|Fast List Prim Contents]]
||[[User:PixelProphet Lane|PixelProphet Lane]]
||Fast and efficient method to print Object Inventory (Name, Type and next Owner permissions)
|-
||[[Find Avatar Key|Find Avatar Key]]
||[[User:Huney Jewell|Huney Jewell]]
||Explores [[UUID]] of avatar whose name is said in local chat or who touches the prim.
|-
||[[First Name Letter Prize]]
||[[User:RaithSphere Whybrow|RaithSphere Whybrow]]
||Gives a prize if the person who sits on it's first letter of first name matches the random letter!
|-
||[[Fix Small Prims|Fix_Small_Prims]]
||[[User:Emma Nowhere|Emma Nowhere]]
||Finds and adjusts the smallest prims in a linkset so that it can be scaled down further.
|-
||[[Float2Hex]]
||[[User:Strife Onizuka|Strife Onizuka]]
||Very useful for transporting [[float|floats]].
|-
||[[Float Box Contents]]
||[[User:Rolig Loon|Rolig Loon]]
||Displays object inventory in hover text, identified by type and updated marquee-style.
|-
||[[Follower (script)|Follower]]
||Unknown, uploaded by [[User:Slik Swindlehurst|Slik Swindlehurst]]
||Makes an object follow the nearest person. Do not use for [[grief|griefing]].
|-
||[[GA Event Notifier]]
||[[User:Victor Hua|Victor Hua]]
||Gathers seven days event data from a Google calendar and display it through a simple interface. The lsl script can access several calendars at once through seperate php files. One file per calendar. Host the included php on your own web server.
|-
||[[Geometric|Geometric Library]]
||Community Project
||A substantial amount of various geometric functions for intersection and other purposes of 3D maths.
|-
||[[Get Profile Picture]]
||[[User:Valentine Foxdale|Valentine Foxdale]]
||Sets the texture of the object to profile picture of the person that touches ot
|-
||[[GetTimestampOffset]]
||[[User:Siann_Beck|Siann Beck]]
||Returns [[llGetTimestamp]]() with an hour offset.
|-
||[[Give InvItem every n hours]]
||[[User:Criz Collins|Criz Collins]]
||Will give an inventory item on touch only every n hours, even if somebody touches the object more than once.
|-
||[[Give random object]]
||[[User:Emmas Seetan|Emmas Seetan]]
||Touch to receive a random object in the prim's inventory
|-
||[[Google Charts]]
||[[User:Dedric Mauriac|Dedric Mauriac]]
||Create links to display raw data as a chart image.
|-
||[[Google_Translator]]
||[[User:Ugleh Ulrik|Ugleh Ulrik]]
||Translates spanish to english, and its simple to make it any other way.
|-
||[[Go transparent when walking]]
||[[User:Emmas Seetan|Emmas Seetan]]
||An attachment that goes invisible when you walk and visible when you don't walk.
|-
||[[Group Authorization]]
||[[User:Chase Quinnell|Chase Quinnell]]
||Checks to see if object is set to appropriate group (checks by [[Group key finder|group key]])
|-
||[[Group Information v1.0]]
||[[User:Tyrennic Rivera|Tyrennic Rivera]]
||When clicked the prim will show group information (set on the prim) from the official Second Life Search page.
|-
||[[Group key finder]]
||[[User:Emmas Seetan|Emmas Seetan]]
||Touch to find the key of the group
|-
||[[Group Privacy]]
||[[User:Chance Unknown|Chance Unknown]]
||Security device to insure members of a group can have a private area. Deactivates when nobody present.
|-
||[[Hello Avatar]]
||Linden Lab
||SL's default script.
|-
||[[Hello Avatar Companion]]
||[[Chase Quinnell]]
||Companion to the original [[Hello Avatar]] script
|-
||[[Hierarchics]]
||[[User:Nexii Malthus|Nexii Malthus]]
|| Advanced script to create an efficient self-aware hierarchic structure.
|-
||[[Hierarchics2]]
||[[User:Nexii Malthus|Nexii Malthus]]
|| Second generation, one script per object. Only two functions, can be embedded in others. Uses the new [[llSetLinkPrimitiveParamsFast]]/[[llGetLinkPrimitiveParams]] functions.
|-
||[[User:Rolig_Loon/High-Capacity_Greeter-Counter|High-Capacity Greeter-Counter]]
||[[User:Rolig Loon|Rolig Loon]]
||Uses a memory compression algorithm to store hashed visitor UUID's in a string instead of using a list.
|-
||[[Holodeck]]
||[[User:Revolution Perenti|Revolution Perenti]]
||Home Rezzing System (Open Source).
|-
||[[Interpolation|Interpolation Library]]
||[[User:Nexii_Malthus|Nexii Malthus]]
||A small set of interpolation functions.
|-
||[[Intra-Region Update Server]]
||[[User:Emma_Nowhere|Emma Nowhere]]
||Centrally update objects such as Freeview screens or teleport pads within a region that are configured by notecards or contain modifiable objects or media assets.
|-
||[[Inventory_Based_Menu]]
||[[User:Revolution Perenti|Revolution Perenti]]
||Inventory Based Menu System.
|-
||[[iTunes RPC Email|iTunes RPC]]
||[[User:Fox Diller|Fox Diller]]
||iTunes RPC via LSL [[llEmail]] and [[llRemoteDataReply]].
|-
||[[Kilt Editor|Kilt / Skirt Editor]]
||[[User:Brangus Weir|Brangus Weir]]
|| This changes all the parameters of all the flexis in the link set in one swell foop!
|-
||[[Key Pad Door|Keypad Door]]
||[[User:Tdub Dowler|Tdub Dowler]]
|| Door and keypad with changeable code. Follow instructions carefully!
|-
||[[Last Sound System]]
||[[User:Babbage Linden|Babbage Linden]]
||An LSL [http://Last.fm Last.fm] client.
|-
||[[LibraryDisplayLandScreenshot]]
||[[User:Jon Desmoulins|Jon Desmoulins]]
||A modified version of LibraryDisplayProfilePic using the new [[PARCEL_DETAILS_ID]] Implemented in Server v1.36
|-
||[[User:Daemonika_Nightfire/Scripts/LinkNumber-List_in_llSetLinkPrimitiveParamsFast|LinkNumber-List_in_llSetLinkPrimitiveParamsFast]]
||[[User:Daemonika Nightfire|Daemonika Nightfire]]
||Changed several prims in linkset with the same parameters, with a list. Without separate llSetLinkPrimitiveParams for each prim. (ideal for show/hide effects)
|-
||[[Linkset resizer]]
||[[User:Maestro Linden|Maestro Linden]]
||Systematically rescales a linkset by moving and resizing each prim (by using [[llGetLinkPrimitiveParams]] and [[llSetLinkPrimitiveParamsFast]])
|-
||[[Linkset resizer with menu]]
||[[User:Brilliant Scientist|Brilliant Scientist]]
||A menu-driven script that rescales a linkset by moving and resizing the prims using [[llGetLinkPrimitiveParams]] and [[llSetLinkPrimitiveParamsFast]] functions. Based on [[Linkset resizer]].
|-
||[[Linkset Resizer 2]]
||[[User:Emma Nowhere|Emma Nowhere]]
||A more user-friendly resizer script designed for either drop-in use by the end-user or builder or for use in products. Based on [[Fix Small Prims]].
|-
||[[List2CSV]]
||[[User:Kunnis Basiat|Kunnis Basiat]]
||List2CSV & CSV2List that include preserving type and escaping characters.
|-
||[[list_cast]]
||[[User:Fractured Crystal|Fractured Crystal]]
||Casts a list of strings into the type they appear to be. Designed for preprocessing user input for feeding into [[llSetPrimitiveParams]]
|-
||[[Listener Script]]
||[[User:Emmas Seetan|Emmas Seetan]]
||Use to [[listen]] to other people's conversations (Like spying)
|-
||[[User:Void_Singer/Functions#List:_Find_Last_Index|List: Find Last Index]]
||[[User:Void Singer|Void Singer]]
||Returns the last index of searched item in a source list. (backwards version of [[llListFindList]])
|-
||[[User:Void_Singer/Functions#List:_Multi-Find_Index_.28First_or_Last.29|List: Multi Find]]
||[[User:Void Singer|Void Singer]]
||Returns the first found index of multiple search items in a list. (Multi-item version of [[llListFindList]]. Fwd and Rev versions included)
|-
||[[User:Void_Singer/Functions#List:_Get_Reverse_Order|List: Reverse]]
||[[User:Void Singer|Void Singer]]
||Returns an input List in reverse order
|-
||[[Load URL]]
||[[User:Emmas Seetan|Emmas Seetan]]
||Touch to get a dialog to visit the URL inside the script.
|-
||[[User:Kephra_Nurmi/lsDancemachine|lsDancemachine]]
||[[User:Kephra_Nurmi|Kephra Nurmi]]
|| Low lag client server dancemachine.
|-
||[[User:Kephra_Nurmi/lsDeejay|lsDeejay Home Edition]]
||[[User:Kephra_Nurmi|Kephra Nurmi]]
|| Client server media control for music, video, youtube, pictures, and texture animations.
|-
||[[User:Kephra_Nurmi/lsDialog|lsDialog]]
||[[User:Kephra_Nurmi|Kephra Nurmi]]
|| Universal notecard driven menu dialog system.
|-
||[[User:Kephra_Nurmi/lsDisplay|lsDisplay]]
||[[User:Kephra_Nurmi|Kephra Nurmi]]
|| Picture cycler with preloader.
|-
||[[User:Kephra_Nurmi/lsDistributor|lsDistributor]]
||[[User:Kephra_Nurmi|Kephra Nurmi]]
|| Simple 'try' and 'buy' vendor system.
|-
||[[LSL_languageAPI]]
||[[User:Gypsy paz|Gypsy Paz]]
||Multi-lingual API from notecard based language files
|-
||[[Mandelbrot Explorer]]
||[[User:Babbage Linden|Babbage Linden]]
||An interactive fractal explorer.
|-
||[[Merge Sort]]
||[[User:Xaviar Czervik|Xaviar Czervik]]
||Implements a Merge Sort in LSL, however this code is 300(ish) times slower than [[llListSort]]. Don't use this in a script!
|-
||[[Minesweeper]]
||[[User:Xaviar Czervik|Xaviar Czervik]]
||A simple minesweeper game.
|-
||[[Morse Code]]
||{{User|Bobbyb30 Swashbuckler}}
||A script that allows for the conversion to and from morse code and can "play" morse code.
|-
||[[Multi Item Rezzer|Multi Item Rezzer]]
||[[User:Jesse Barnett|Jesse Barnett]]
||A rework of my old High Altitude Rezzer. Place the objects that you wish to choose from to be rezzed inside. Sit on the rezzer and pick the item and the height. It will go to target height and rez the object.
|-
||[[Multirezzer|Multirezzer (on collision)]]
||[[User:Beet Streeter|Beet Streeter]]
||Spawns up to 10 objects when the object containing the script collides with a user.
|-
||[[Name2Key in LSL]]
||[[User:Maeva Anatine|Maeva Anatine]]
||Get the Name2Key feature inside your scripts. Works even on lastly subscribed avatars.
|-
||[[No Auto-Return]]
||[[User:Bellla Clarity|Bella Clarity]]
||To stop your long and hard builds from getting returned in sandboxes (''only single prims, though!'').
|-
||[[No Auto-Return NR]]
||[[User:Jor3l Boa|Jor3l Boa]]
||This really works (29-05-09), needs a nearby region to do the trick and avoid auto return. (Tested on Blue and Rausch)
|-
||[[No Auto-Return (Multi)]]
||[[User:Xaviar Czervik|Xaviar Czervik]]
||A revision of Bella's that works for multi-prim objects.
|-
||[[No Limit Teleporter]]
||[[User:Morgam Biedermann|Morgam Biedermann]]
||Teleport to infinite altitudes (up to 4096m)
|-
||[[Object Size]]
||[[User:Chase Quinnell|Chase Quinnell]]
||Gets the dimensions and footprint of a linkset
|-
||[[Object to Data v1.3|Object to Data]]
||[[User:Xaviar Czervik|Xaviar Czervik]]
||Turns an object into text (and back). Allows people to transfer objects through notecards (or otherwise).
|-
||[[Online Indicator|Online Indicator]]
||[[User:Kristy Fanshaw|Kristy Fanshaw]]
||Will show if the user is online or not. Displays users profile picture and allows to send IM's to user. Also gives a link to open the users profile
|-
||[[Open Group Join]]
||[[User:Alicia Stella|Alicia Stella]]
||User Touches Object to Join Group from Group Info window, (no bot.)
|-
||[[Open Zyngo Skin Installer]]
||[[User:Tmzasz Luminos|Tmzasz Luminos]]
||A Simple Script designed to install skins on the popular Skill machines.
|-
||[[One Script, many doors]]
||[[User:Kyrah Abattoir|Kyrah Abattoir]]
||Door script able to manage more than 50 linked doors from a single script instance.
|-
||[[ParseString2List]]
||[[User:Strife Onizuka|Strife Onizuka]]
||Same as [[llParseString2List]] and [[llParseStringKeepNulls]], but not limited to 8 spacers or separators. Thus substitute a call to the [[llParseString2List]] and [[llParseStringKeepNulls]] functions by a call to [[Parse_String_To_List|ParseString2List]] whenever you have more than 8 separators or more than 8 spacers.
|-
||[[Password Generator]]
||[[User:Syntrax Canucci|Syntrax Canucci]]
||This is an over-complicated, semi-complex password generator, which goes through multiple steps.
|-
||[[Pathfinder]]
||[[User:Babbage Linden|Babbage Linden]]
||A potential field based pathfinding library.
|-
||[[Phantom Child]]
||[[User:Aeron Kohime|Aeron Kohime]]
||Causes a child in a link set to become phantom without the entire object becoming phantom.
|-
||[[PhysicsLib]]
||[[User:Nexii Malthus|Nexii Malthus]]
|| Interesting set of fun physics functions.
|-
||[[Play and Loop Sound]]
||[[User:Bellla Clarity|Bella Clarity]]
||Very short and simple script; plays and loops a sound in an object.
|-
||[[Posing stand|Posing Stand]]
||[[User:Bellla Clarity|Bella Clarity]]
||Just a pose script to edit [[attachments]] more easily.
|-
||[[PosJump]]
||[[User:Uchi Desmoulins|Uchi Desmoulins]]
||A much more efficient alternative to the popular [[warpPos]] function for bypassing 10m distance-moved limitations.
|-
||[[Prefix Calculator]]
||[[User:Xaviar Czervik|Xaviar Czervik]]
|| A calculator that evaluates expressions in prefix notation.
<code>+ 3 4 = 5. * + 1 2 + 3 4 = 14.</code>
|-
||[[Progress Bar]]
||[[User:Nexii Malthus|Nexii Malthus]]
|| Flexible and powerful little function for creating progress bars useful in hovertext.
|-
||[[Pseudo-random Number Generator]]
||[[User:Xaviar Czervik|Xaviar Czervik]]
||Generates a Pseudo-random number between -0x7FFFFFFF and 0x7FFFFFFF
|-
||[[User:Rolig_Loon/Quiz_From_Notecard|Quiz From Notecard]]
||[[User:Rolig Loon|Rolig Loon]]
||A multiple-choice testing script that reads questions and answer choices from a notecard and presents them in dialog boxes.
|-
||[[Rainbow_palette]]
||[[User:Rui Clary|Rui Clary]]
||Build a color picker, using only one prim, and a few lines of code.
|-
||[[Random AV Profile Projector]]
||[[User:Debbie Trilling|Debbie Trilling]]
||Randomly selects an AV from a crowd & then projects their profile picture as a 'holographic' image
|-
||[[Random Object Vendor]]
||[[User:CodeBastard Redgrave|CodeBastard Redgrave]]
||Simple vendor that gives out random objects when paid the right amount
|-
||[[Random Password Generator]]
||[[User:Jor3l Boa|Jor3l Boa]]
||Generate Random passwords based on String Length.
|-
||[[RavText]]
||[[User:Ravenous Dingo|Ravenous Dingo]]
||An alternate to XyText. This is a lightweight, multiple font 10 character text display system. It only supports uppercase alphanumeric text and a few special characters, but it is very fast, renders quickly and supports multiple fonts. It is meant for specialized use when all that is desired is basic, fast text display and the extra "bells and whistles" are not needed.
|-
||[[User:PixelProphet Lane/Scripts#Real Object Inventory To Dialog|Real Object Inventory To Dialog]]
||[[User:PixelProphet Lane|PixelProphet Lane]]
||Display any amount of items contained in an Object in a Dialog, regardless of item name length.
|-
||[[RentalBoxv1|Rental Box, Simply]]
||[[User:Sendao Goodman|Sendao Goodman]]
||Simple explanation of how to make rental boxes.
|-
||[[Rental Cube]]
||[[User:Hank Ramos|Hank Ramos]]
||Simple cube for renting out a space.
|-
||[[Remote Texture Loader]]
||{{User|Bobbyb30 Swashbuckler}}
||A set of scripts for remotely loading textures within a sim. This means that a single "texture server" can manage multiple changing billboards within a sim.
|-
||[[Say Region Frames Per Second|Region Frames Per Second]]
||[[User:Heymeriou Mystakidou|Heymariou Mystakidou]]
|| Says the region name and frames per second out loud on command.
|-
||[[sbDialog]]
||[[User:Siann_Beck|Siann Beck]]
||A simple replacement function for [[llDialog]]. It re-orders the button list so that the button values, as passed to it, display left-to-right, top-to-bottom. It also opens a [[llListen|listen]] on the specified channel, and returns the handle.
|-
||[[Scheduler]]
||[[User:Haravikk Mistral|Haravikk Mistral]]
||Schedule multiple events using a single script timer
|-
||[[Scheme_Interpreter|Scheme Interpreter]]
||[[User:Xaviar Czervik|Xaviar Czervik]]
||A scheme interpreter capable of handling most scheme expressions, including lambda and lists.
|-
||[[Script Override Functions]]
||[[User:Revolution Perenti|Revolution Perenti]]
||bypass default strings, integer etc in chat channel.
|-
||[[Scripted Attachment Detector.lsl|Scripted Attachment Detector]]
||{{User|Bobbyb30 Swashbuckler}}
||A script that will display avatars wearing scripted attatchments in hovertext. This may be worn as an hud or rezzed.
|-
||[[Self Upgrading Script Enhanced]]
||[[User:Cron Stardust|Cron Stardust]]
||Keeps only latest version of the script on prim (even with multiple adds of the same script!)
|-
||[[Sensor Visualizer]]
||[[User:Cerise Sorbet|Cerise Sorbet]]
||Shows the size and shape you get with [[llSensor]] range and arc parameters
|-
||[[Serverless Key Exchange]]
||[[User:Sendao Goodman|Sendao Goodman]]
||Maintains a network of object keys without using an external server.
|-
||[[SHA1|SHA1 Hash]]
||[[User:Xaviar Czervik|Xaviar Czervik]]
||Preforms a SHA1 Hash on an input text. Similar to MD5 only (slightly) more secure.
|-
||[[Sim Map Particle Projector]]
||[[User:Jesse Barnett|Jesse Barnett]]
||Displays a floating map of the sim the script is in.
|-
||[[Sim Restart Logger]]
||[[User:Kyrah Abattoir|Kyrah Abattoir]]
||Counts region restarts and displays log of last 9 restarts together with region FPS and dilation.
|-
||[[Simple Elevator in a Box]]
||[[User:Hank Ramos|Hank Ramos]]
||Simple elevator example.
|-
||[[Skillingo AntiHack Script]]
||[[User:Tmzasz Luminos|Tmzasz Luminos]]
||A simple Protection script for skillingo thats modifyable to work with other machines.
|-
||[[Skunk Money]]
||[[User:Hank Ramos|Hank Ramos]]
||Fun gambling machine of yesteryear, which only supports freeplay now due to SL regulations against gambling.
|-
||[[SLateIt]]
||[[User:Babbage Linden|Babbage Linden]]
||An augmented virtual reality HUD.
|-
||[[SLetanque]]
||[[User:Babbage Linden|Babbage Linden]]
||An LSL petanque game.
|-
||[[SLURL HUD]]
||[[User:CodeBastard Redgrave|CodeBastard Redgrave]]
||Touch this HUD to get a SLURL through IM, email and floating text.
|-
||[[llSLURL (NewAge)]]
||[[User:Archile Azalee|Archile Azalee]]
||Newest most easiest way to create SLURL in a single function llSLURL
|-
||[[SL Mail V1.2]]
||[[User:Flennan Roffo|Flennan Roffo]]
||Second Life mail client V1.2 (released sept'07). Send and receive mail from within Second Life from and to any address. With Address Book function and many chat commands. V1.3 is upcoming soon!
|-
||[[SL_NTPoHTTP_v1.1_client|SL NTPoHTTP client]]
|[[User:SignpostMarv Martin|SignpostMarv Martin]]
||Second Life Needs Time Parsing over Hyper Text Transfer Protocol
Emulates the function of [[llGetWallclock]] for any timezone by using SLOpenID's SLNTPoHTTP service. Also supports ISO 8601 and RFC 2822 timestamps. Script is dependent upon an external service operated by the author!
|-
||[[Smooth Rotating Door]]
|[[User:Toy Wylie|Toy Wylie]]
||A script for doors that open and close smoothly using llTargetOmega
|-
||[[Smooth Sliding Door]]
|[[User:SimonT Quinnell|SimonT Quinnell]]
||A script for sliding doors that open and close smoothly using [[llMoveToTarget]]. Asjusts for prim orientation.
|-
||[[Speed Tester]]
||{{User|Bobbyb30 Swashbuckler}}
||Similar to the [[Efficiency Tester]], this script allows you to test the speed of a particular function or snippet with multiple trials giving min/max/avg/median and the standard deviation.
|-
||[[Spiral Staircase Generator]]
|[[User:Meyermagic Salome|Meyermagic Salome]]
||Generates nice looking spiral staircases without much hassle.
|-
||[[Static URL's for HTTP-In Service|Static_URLs]]
||[[User:Jor3l Boa|Jor3l Boa]]
||How to generate a static url for HTTP-In temporal limitations.
|-
||[[String Compare]]
||[[User:Xaviar Czervik|Xaviar Czervik]]
||Compares two strings and reliably returns either 1, -1, or 0 if they are the same.
|-
||[[User:Void_Singer/Functions#String:_Find_Last_Index|String: Reverse]]
||[[User:Void Singer|Void Singer]]
||Returns an input string in reverse order
|-
||[[User:Void_Singer/Functions#String:_Get_Reverse_Order|String: Last Index]]
||[[User:Void Singer|Void Singer]]
||Returns the last index of search found in string (the backward equivalent of [[llSubStringIndex]])
|-
||[[Tail Messages (NewAge)]]
||[[User:Asia Snowfall|Asia Snowfall]]
||A super nice easy to use script for those non-scripters out there! NewAge coding has done it again where you no longer need to scroll up and down adding buttons and adding messages, Features a tag system (you'll see what i mean :P)
|-
||[[Teleport HUD]]
||[[User:Jesse Barnett|Jesse Barnett]]
||WORKS TO 4096 METERS!! Very user friendly teleport HUD. Add destinations by touching "Add" & naming destination in chat. Automatically gets sim name and coordinates. Will only display the destinations in the sim you are currently in. Demonstrates more advanced list manipulation and stride functions.
|-
||[[User:Void_Singer/Programs#v7-D_Enh._Landmark-2-Map|Teleporter (landmark based)]]
||[[User:Void_Singer|Void_Singer]]
||Uses Landmarks to offer map teleports. Works as Hud or inworld objects, just drop in landmarks and go.
|-
||[[Text_Scroller|Text Scroller]]
||[[User:Fred_Gandt|Fred Gandt]]
||A simple text display object that scrolls text (applied as a texture) from right to left (like ''those'' LED signs) in a continuous loop.
|-
||[[Bobbyb's texture changer|Texture Changers]]
||{{User|Bobbyb30 Swashbuckler}}
||A collection of texture changing scripts.
|-
||[[Texture Menu Management|Texture Management]]
||[[User:Revolution Perenti|Revolution Perenti]]
||Dialog Menu based Texture Selection.
|-
||[[Tic Tac Toe]]
||[[User:CG Linden|CG Linden]]
||Step by step demo on how to implement a larger scripting project
|-
||[[TightList]]
||[[User:Strife Onizuka|Revolution Perenti]]
||Tight List is a family of functions for encoding lists as strings and then decoding them back into lists.
There are two flavors: TightList and TightListType. TightListType preserves types and uses a 6 char header, while TightList uses a 1 char header that doesn't preserve type.
|-
||[[Timer Module]]
||[[User:Isabelle Aquitaine|Isabelle Aquitaine]]
||Manage multiple timers via linked messages.
|-
||[[User:Void_Singer/Functions#Unix_time_code_to_list_format|Timestamp:<br>Unix time code to list format]]
||[[User:Void Singer|Void Singer]]
||converts Unix timestamps to their [Y, M, D, h, m, s] equivalents (ex: 1234567890 to [2009, 2, 13, 3, 31, 30])
|-
||[[User:Void_Singer/Functions#List_format_to_Unix_time_code.|Timestamp:<br>List format to Unix time code]]
||[[User:Void Singer|Void Singer]]
||converts [Y, M, D, h, m, s] timestamps to their Unix equivalents (ex: [2009, 2, 13, 3, 31, 30] to 1234567890)
|-
||[[User:Void_Singer/Functions#Weekday_from_Unix_timestamp|Timestamp:<br>Weekday from Unix timestamp]]
||[[User:Void Singer|Void Singer]]
||Gets weekday from Unix timestamps (ex: "Friday" from 1234567890)
|-
||[[User:Void_Singer/Functions#Weekday_from_.28_Y.2C_M.2C_D_.29_format|Timestamp:<br>Weekday from (Y, M, D) format]]
||[[User:Void Singer|Void Singer]]
||Gets weekday from (Y, M, D) timestamps (ex: "Friday" from (2009, 2, 13))
|-
||[[Touch A Quote]]
||[[User:CodeBastard Redgrave|CodeBastard Redgrave]]
||Touch an object to read quotes sequentially from a notecard
|-
||[[Touring Balloon]]
||[[User:Hank Ramos|Hank Ramos]]
||Automated touring balloon with many options from long ago. Always seems to work on one SL release, and not the other.
|-
||[[Under Age Boot]]
|[[User:Chance Unknown|Chance Unknown]]
||Security device example to teleport home accounts below a minimum age limit; can be useful in combating free griefer accounts.
|-
||[[User:Rolig_Loon/UNDO_PosRot|UNDO_PosRot]]
||[[User:Rolig Loon|Rolig Loon]]
||Allows user to undo position and rotation changes that have been made "manually" to any or all prims in a linkset.
|-
||[[Universal Translator]]
|[[User:Hank Ramos|Hank Ramos]]
||Chat listener that handles seamless translation of public chat between 50+ written languages without the need for configuration. Handles numerous avatars, auto-detects languages, and works together with multiple copies of translators to spread-workload using a sophisticated back-end communications sub-system.
|-
||[[Unix2DateTime]]
|[[User:Flennan Roffo|Flennan Roffo]]
||Conversion from Unix time ([[llGetUnixTime]]()) to date and time string and vice versa.
|-
||[[Unmutable Descript Nagger]]
|[[User:Bobbyb30 Zohari|Bobbyb30 Zohari]]
||To nag avatars to take off their scripted attatchments.
|-
||[[Unpacker On Rez (NewAge)]]
|[[User:Asia Snowfall|Asia Snowfall]]
||A very simple to use script for all you creators out there, This script will enable you to send out boxed items and make it easier for users to unpack, Also features auto die on completion. Very simple to configure!
|-
||[[Unpacker On Touch (NewAge)]]
|[[User:Asia Snowfall|Asia Snowfall]]
||Exactly like Unpacker On Rez, But changed some things about to make it Unpack On Touch
|-
||[[Update distributor]]
|[[User:Dale Innis|Dale Innis]]
||Distribute an object (like a project update) to a list of people named in a notecard.
|-
||[[UUID2Channel]]
||[[User:Project Neox|Project Neox]]
||Optimised version of the original key2channel generators.
|-
||[[UUID Song Generator]]
||{{User|Sendao Goodman}}
||Translates a UUID into a simple song and plays it.
|-
||[[VirtualID_URLMap|VirtualID URL Mapper for HTTP-in]]
|[[User:Cenji Neutra|Cenji Neutra]]
||A script showing how to setup a static URL of the form <your-alias>.obj.virtualid.info which maps to the dynamic HTTP-in URL LSL generates and keeps it up-to-date.
|-
||[[User:Void_Singer/Programs#v7-D_Advanced_Visitor_Greeter|Visitor Greeter]]
|[[User:Void_Singer|Void_Singer]]
||Reduced spam visitor greeter, highly configurable, easy to modify.
|-
||[[Visitor Logger (Web/Basic) ]]
|[[User:Buddy Sprocket|Buddy Sprocket]]
||A very basic visitor logger - log visitors in SL to a text file on your web-site.
|-
||[[Vote Simple]]
|[[User:JB_Kraft|JB Kraft]]
||Simple vote collector. One avi, one vote.
|-
||[[Walking Sound (NewAge)]]
|[[User:Asia Snowfall|Asia Snowfall]]
||Very powerful walking sound script, Featuring customer ability to add their own sounds with the API Sound Feature!
|-
||[[WarpPos]]
|[[User:Keknehv Psaltery|Keknehv Psaltery]]
||Non-physical movement without the 10m limit.
|-
||[[Wiki3DBuilder]] [[Wiki3DBuilder1.0]]
||[[User:Salahzar Stenvaag|Salahzar Stenvaag]]
||Allows a group of people to collectively build up complex 3D mindmaps with connected concepts. Uses particles for connections and low prim usage. Nodes can be textured, colored, changed form size moved collectively by everybody and can distribute notecards, landmarks, URL, objects, textures. I provide two version 0.1 and 1.0 and probably next version will communicate with moodle and sloodle external websites.
|-
||[[Window Control]]
||[[User:Emmas Seetan|Emmas Seetan]]
||For window opacity, helpful for buildings.
|-
||[[WHMcs SecondLife plugin]]
|[[User:Alicia Sautereau|Alicia Sautereau]]
||Linden Dollar payment plugin for the WHMcs hosting portal.
|-
||[[XTEA Strong Encryption Implementation]]
||[[User:Morse Dillon|Morse Dillon]]
||An LSL implementation of XTEA (eXtended Tiny Encryption Algorithm). This is the first known public release of a 'real' strong encryption implementation in LSL and is released under the GNU General Public License (GPL).
|-
||[[XyText 1.5|XyText]]
||[[User:Xylor Baysklef|Xylor Baysklef]]
|| Display text (up to 10 characters) on a prim. Use as many prims as desired.
|-
||[[XyyyyzText|XyyyyzText]]
||[[User:Criz Collins|Criz Collins]]
|| Display text (up to 10 characters) on a prim. Displays different text for each line instead of one single text, that will be broken into the next lines. Watch here for what that means: http://screencast.com/t/1wMLujLcEO
|-
||[[XyzzyText|XyzzyText]]
||[[User:Thraxis Epsilon|Thraxis Epsilon]] and [[User:Gigs Taggart|Gigs Taggart]]
|| Display text (up to 10 characters) on a prim. Way more efficient than XyText.
|-
||[[Youtube TV]]
||[[User:Morgam Biedermann|Morgam Biedermann]]
||Watch your favorite Youtube videos / auto set the texture to the parcel media texture.
|-
||[[Zero Lag Poseball]]
||[[User:Jippen Faddoul|Jippen Faddoul]] and [[User:Daemonika Nightfire|Daemonika Nightfire]]
||A simple poseball with no lag
|}

</div>
<div id="box">

==Support Script Library==
These are scripts in other languages, intended to be run on other systems that support scripts written in LSL

{| class="sortable" {{Prettytable}}
|- {{Hl2}}
! '''Name'''
! '''Creator'''
! '''Description'''
|-
|| [[User:Ina Centaur/UUID/calimg.api|Calendar Image UUID API]]
|| [[User:Ina Centaur|Ina Centaur]]
|| API that gives the UUID of an image of a calendar image give month and year arguments.
|-
||[[HTTP Post request to a PHP server]]
||[[User:Corto Maltese|Corto Maltese]]
|| This small library allows you to make simple POST requests to your website. The libraries allow you to get your request through the variable $_POST on the server. It also include a basic security mechanism aimed to stop hacking. Comprises of LSL client script and PHP server script.
|-
|| [[User:Ina Centaur/PHP/k2n.php|Key2Name.php]]
|| [[User:Ina Centaur|Ina Centaur]]
|| Get Avatar's Name using Second Life search service. (like in LSL Key2Name)
|-
|| [[Lame_Object_DNS_and_Cross_Sim_Messaging|Lame Object DNS and Cross Sim Messaging]]
|| [[User:Liandra Ceawlin|Liandra Ceawlin]]
|| Simple, cheeseball method of doing cross-sim communications with http-in and an external object DNS service.
|-
|| [[User:SignpostMarv Martin/PHP/llXorBase64StringsCorrect|llXorBase64StringsCorrect]]
|| [[User:SignpostMarv Martin|SignpostMarv Martin]]
|| An implementation of [[llXorBase64StringsCorrect]] in PHP- should be useful if you're using llXorBase64StringsCorrect to do cryptography work in LSL2 and posting it out to the web via [[llHTTPRequest]].
|-
|| [[User:SignpostMarv Martin/PHP/lsl fu.php|lsl_fu.php]]
|| [[User:SignpostMarv Martin|SignpostMarv Martin]]
|| A basic OOP'd PHP Class containing VeloxSeverine's $_POST fixer and Marv's own eccentric ideas for "fixing" things.
|-
|| [[User:Jor3l Boa/PHP/n2k.php|Name2Key.php]]
|| [[User:Jor3l Boa|Jor3l Boa]]
|| Get Avatar's UUID using Second Life search service. (like in LSL Name2Key)
|-
|| [[Public_Object_DNS|Public Object DNS]]
|| [[User:Liandra Ceawlin|Liandra Ceawlin]]
|| Public object DNS-like system running on GAE, for http-in. Hopefully scalable enough for wide-spread usage.
|-
|| Silo
|| [[User:Zero_Linden|Zero Linden]]
|| General purpose data store in PHP. Use this to persist arbitrary data from LSL via [[llHTTPRequest]]. See:
* [http://www.notabene-sl.com/misc/silo-README.txt README] file
* [http://www.notabene-sl.com/misc/silo.tgz silo.tgz] tarball
* forum post [http://forums-archive.secondlife.com/54/69/119570/1.html Announcement].
|-
||[[Silverday ObjectDNS]]
||[[User:Till Stirling|Till Stirling]]
||Dynamic Object-DNS-System to provide dynamic mapping of LSL-URLs to persistent domains. Features include redirect service, password protected domains, write protected domains, LSL-API for all necessary functions, optional web-interface.
|-
|| [http://aubretec.com/products/sldb SLDB]
|| [[User:Luc Aubret|Luc Aubret]]
|| Flexible web database storage using PHP/MySQL. Used to store per-user field/value pairs from in-world objects using [[llHTTPRequest]].
* [http://aubretec.com/support/manuals/sldbkit/ Implementation Guide]
* [http://aubretec.com/wp-content/uploads/2009/05/sldb.zip Download] (.zip, 12kb)
|}

== See Also ==
<div style="padding: 0.5em">
'''Articles'''
*[[:Category:LSL Examples| Examples]]

</div></div>

{{LSLC|}}

Category:LSL Library

2010-09-01T05:18:53Z

SimonT Quinnell: /* LSL Script Library */

{{LSL Header|ml=*}}{{RightToc}}
==Script Library==

<div id="box">
<div style="padding: 0.5em 0.5em 1.5em">
Come to this page to see complex examples that show how to combine parts of LSL.

Go to the [[:Category:LSL Examples|LSL Examples]] page to see brief examples of how to use parts of LSL

Why collect complex examples here? Well, ...

There are many [[script|scripts]] that have become buried in the [http://forums-archive.secondlife.com/15/1.html Scripting Library archive] or the newer [https://blogs.secondlife.com/community/forums/scripting_library?view=discussions Scripting Library forum], were lost with the death of the early scripting forums, or sit idle in [[inventory|inventories]] that could be useful and should be more accessible.

Other scripters may be in the same situation. This wiki is a well-suited medium for a script library. Feel free to add your scripts to the script library by creating new pages for them and linking to those pages here.

Note that there are many more scripts in the LSL Library here, but you can't get to them if you don't know they exist, because they are subpages now, instead of an automatically updated category. Good luck searching.
</div>
</div>

<div id="box">

== Rules for posting: ==
<div style="padding: 0.5em">
#Your script must be tested and working. If it's not, stick it in your user-space until it is. This is a list of working, usable scripts.
#Add a link to your script's page here. Link back to this page from your script's page. Start your page with <nowiki>{{LSL Header}}</nowiki>.
#Do not add scripts that duplicate the same functionality as an existing script or built in {{LSLGC|Functions|function}}. If yours does, explain why.
#Do not list simple scripts here. Include those among the [[:Category:LSL Examples|LSL Examples]] instead.
</div></div>

<div id="box">
==LSL Script Library==

{| class="sortable" {{Prettytable}}
|- {{Hl2}}
! '''Name'''
! '''Creator'''
! '''Description'''
|-
||[[1st necessity of SL]]
||[[User:Beer Dailey|Beer Dailey]]
||Monitors for avatars and (de)activates scripts states to control script performance/lag.
|-
||[[3D Radar]]
||[[User:Jesse Barnett|Jesse Barnett]]
||Rezzes a ball for each avatar in range. Each ball tracks its own AV and displays distance.
|-
||[[Access (NewAge)]]
||[[User:Asia Snowfall|Asia Snowfall]]
||An easy to use script for permissions on who can use the script, Public/Group/Owner
|-
||[[Aim Detection]]
||[[User:Han Shuffle|Han Shuffle]]
||Monitors for avatars and reports back to owner about who is aiming at them.
|-
||[[AntiDelay Node]]
||[[User:Xaviar Czervik|Xaviar Czervik]]
||Uses [[llMessageLinked]] to stop those pesky delays.
|-
||[[AO Overriding Pose Ball]]
||[[User:Jesse Barnett|Jesse Barnett]]
||No more turning your AO off and on when you sit down
|-
||[[ARCFOUR Strong Encryption Implementation]]
||[[User:Nekow42 Zarf|Nekow42 Zarf]]
||An LSL implementation of ARCFOUR, the most popular stream cipher still in use. It is licensed under a Creative Commons Attribution 3.0 license.
|-
||[[Assembly Programming Language|Assembly-Like Programming Language]]
||[[User:Xaviar Czervik|Xaviar Czervik]]
||A compiler that runs assembly-like programs.
|-
||[[Associative Array Emulator|Associative Array (Dictionary) Emulator]]
||[[User:Alynna Vixen|Alynna Vixen]]
||This library provides a set of functions for using a list as an associative array where string based keys can refer to one or more variant elements.
|-
||[[AvatarFollower]]
||[[User:Dale Innis|Dale Innis]]
||Allows one avatar to automatically follow another.
|-
||[[Avatar Radar (NewAge)]]
||[[User:Asia Snowfall|Asia Snowfall]]
||Version 1.2; A nice new avatar radar script i just finish that you can place in your hud, Also features avatar locator
|-
||[[Base2Dec]]
||[[User:Siann Beck|Siann Beck]]
||Convert a number to decimal from any base.
|-
||[[BaseN]]
||[[User:Nexii Malthus|Nexii Malthus]]
||Variable base compression, dynamically maps to usable UTF code points.
|-
||[[Basic A-Star Pathfinder]]
||[[User:Nexii Malthus|Nexii Malthus]]
|| My own interpretation of A Star into a highly efficient algorithmn
|-
||[[Basic Encryption Modules]]
||[[User:Beverly Larkin|Beverly Larkin]]
||Basic encryption scripts, allows you to encrypt a float and shout it to another prim on a randomly chosen channel.
|-
||[[Be happy]]
||[[User:Emmas Seetan|Emmas Seetan]]
||Basic smile attachment script, makes your avatar smile.
|-
||[[Best Neighbor Ad Hiding Script|Best Neighbor]]
||[[User:Doran Zemlja|Doran Zemlja]]
||Reduce ad clutter by hiding ads when users are on their own land nearby.
|-
||[[BigNum|BigNum Library (RSA Encryption)]]
||[[User:Xaviar Czervik|Xaviar Czervik]]
||A BigNum Library for dealing with big numbers! Specialized for modular multiplication, and RSA encryption.
|-
||[[Binary Clock v1.1|Binary Clock]]
||[[User:Fox Diller|Fox Diller]]
||A Binary Clock.
|-
||[[BinaryDecimalConverter]]
||[[User:Soundless Smalls|Soundless Smalls]]
||Converts a binary value to a decimal value and vice versa.
|-
||[[Blacklist and Remote Kill|Blacklist and Remote Kill]]
||[[User:Chase Quinnell|Chase Quinnell]]
||Blacklist(denial of use) or a creator kill script(can delete someone's item by command on private channel)
|-
||[[User_talk:Rolig_Loon/Bookmark_URLs|Bookmark URLs]]
||[[User:Rolig Loon|Rolig Loon]]
||Dialog driven HUD reads bookmarked URLs from notecards and navigates directly to them with user's in-world browser.
|-
||[[Builders Buddy|Builder's Buddy Tool]]
||[[User:Newfie Pendragon|Newfie Pendragon]]
||Script to easily move/rotate large builds that exceed the linkable size limit (30 meters).
|-
||[[Button Click Detector]]
||{{User|Sendao Goodman}}
||Use [[llDetectedTouchUV]] to determine which button was pressed on a texture.
|-
||[[Camera following prim]]
||[[User:Dale Innis|Dale Innis]]
||Pair of scripts to make a prim follow your camera position around (for lights etc).
|-
||[[Camera Sync]]
||[[User:Meyermagic Salome|Meyermagic Salome]] and [[User:Nomad Padar|Nomad Padar]]
||A system to synchronize the cameras of two avatars.
|-
||[[Chatbot]]
||Anonymous
||Compile and run the LSL you type on a channel, faster than you can thru the 2007-08 SL GUI.
|-
||[[Chat Logger (GPL)]]
||[[User:Nobody Fugazi|Nobody Fugazi]]
||Chat logger which requests permission from participants before recording them.
|-
||[[Chat_Relay|Chat Relay]]
||[[User:grumble Loudon|grumble Loudon]]
||A Chat relay which can be routed using a path header and won't echo.
|-
||[[ClickAndDrag]]
||[[User:Nexii Malthus|Nexii Malthus]]
|| Click and Drag user interface elements using dynamic feedback
|-
||[[Code Racer]]
||Anonymous
||Race two versions of code forever, to see which runs faster.
|-
||[[Code Sizer]]
||Anonymous
||Count the bytes compiled from source code, to measure how to write small code.
|-
||[[User:Void_Singer/Programs#v7-D_Enh._Color_Picker|Color Changer]]
||[[User:Void_Singer|Void_Singer]]
||Dialog driven color changer. Supports 16million+ colors, web color codes, multiple targeted prims, with save and recall.
|-
||[[Color Changer|Color Changer Plus]]
||[[User:Neo Calcutt|Neo Calcutt]]
||A color changer with 14 colors, a random function, and a custom vector function.
|-
||[[Color conversion scripts|Color Conversion]]
||[[User:Sally LaSalle|Sally LaSalle]]
||Convert between Red Green Blue (RGB) and Hue Saturation Value (HSV).
|-
||[[ColorConvert]]
||[[User:Siann Beck|Siann Beck]]
||Convert color values to vector from RGB, hex or HTML color name.
|-
||[[Color script]]
||[[User:Masakazu Kojima|Masakazu Kojima]]
||Script for changing colors trough a listener with pre-defined colors.
|-
||[[Library Combined Library|Combined Library]]
||[[User:Strife Onizuka|Strife Onizuka]]
||Library of mostly encoding and decoding functions, some more useful then others.
* String functions: Replace / Trim right / Trim left / Trim both
* Unicode conversion: UTF8 to Unicode / Unicode to UTF8
* List functions: Replace / Compare
|-
||[[Computer:jaycoonlanguage]]
||[[User:jayco121 Bing|jayco121 Bing]]
|| A language written in LSL that is meant for my computer (available at the shop).
|-
||[[Read Note Card Configuration|Configuration Notecard Reader]]
||{{User|Dedric Mauriac}}
||A script to read configuration information from a notecard. Parses notecard to extract key words and their assigned values. Allows for comment lines and many more useful features.
|-
||[[AdvancedNotecardReader|Configuration Notecard Reader (advanced)]]
||[[Lear Cale|Lear Cale]]
||Robust configuration notecard reader; supports multiple notecards with same suffix, handles reconfig on inventory change, and does not usurp the default state.
|-
||[[Library_Chat_Relay|Conversation Relay]]
||[[User:Jippen Faddoul|Jippen Faddoul]]
||Chat relay which requests permission from participants before relaying their messages. Also includes their attachments. (ToS compliant).
|-
||[[Curtain script]]
||[[User:Zilla Larsson|Zilla Larsson]]
||A simple script to retract/stretch curtains, blinds, bedcovers and more
|-
||[[Dataserver API]]
||[[User:Revolution Perenti|Revolution Perenti]]
||Dataserver Framework for Notecards.
|-
||[[Date Library]]
||[[User:Corto Maltese|Corto Maltese]]
|| Date library, based on number of day since march 3rd 1600, can be used to calculate weekday, date differences, and date offset, and date formating.
|-
||[[Day of the Week]]
||[[User:DoteDote Edison|DoteDote Edison]]
||Function to get day of the week from [[llGetUnixTime]].
|-
||[[Days in Month]]
||[[User:IntLibber Brautigan begin_of_the_skype_highlighting end_of_the_skype_highlighting begin_of_the_skype_highlighting end_of_the_skype_highlighting|IntLibber Brautigan]]
||Clicking on it returns the number of days in the present month. Useful for scripting calendars and tier systems that need to know the number of days in the month at hand or to calculate for any month. Even adjusts for leap years.
|-
||[[Deed Tools]]
||[[User:Falados Kapuskas|Falados Kapuskas]]
||Tools that allow the creator to modify Group-Owned (Deeded) Objects via chat.
|-
||[[Describe Chatter]]
||Anonymous
||Chat to see yourself as others do.
|-
||[[Dialog Control]]
||[[User:Nargus Asturias|Nargus Asturias]]
|| A (not-so) simple dialog & menu control script. Call dialog and receive selected value via [[link_message]](), with built-in timer and [[link_message]]() notification on time out. Supports multi-pages dialog and numeric property dialog. Button text and dialog's returned value can differ.
Latest version also has [[Dialog Menus Control]] built-in; which allow multi-level menus through SL dialog system.
|-
||[[MultiUser_Dialog_Handler|Dialog Handler (multiuser)]]
||[[User:SimonT Quinnell|SimonT Quinnell]]
|| Menu dialog handler that supports multiple menus open at once from the single script. Displays multi-page menus if necessary as well as allowing for fixed header and footer buttons.
|-
||[[Dialog NumberPad|Dialog Number Pad]]
||[[User:DoteDote Edison|DoteDote Edison]]
||Use a dialog to accept positive integer input from users.
|-
||[[Displayer Script]]
||[[User:Akinori Kimagawa|Akinori Kimagawa]]
||[[Display Words On Top Of An Object]]
|-
||[[Drink script]]
||[[User:Emmas Seetan|Emmas Seetan]]
||Used mainly for food and drink in Second Life.
|-
||[[TOXDropBox|DropBox]]
||[[User:Dimentox Travanti|Dimentox Travanti]]
|| This is a Drop box which allows people to drop certain items in a object & has many config options.
|-
||[[Efficiency Tester]]
||[[User:Xaviar Czervik|Xaviar Czervik]]
||Tests the speed of a function.
|-
||[[Email-to-IM|Email2IM]]
||[[User:DoteDote Edison|DoteDote Edison]]
||Send IMs to SL friends via [[email]] (translate emails from friends into IMs).
|-
|-
||[[User:Kireji_Haiku/SIMchat_headset|Encrypted Region-wide chat]]
||'''[[User:Kireji Haiku|Kireji Haiku]]''' <sup><small>([[User talk:Kireji Haiku|talk]]|[[Special:Contributions/Kireji Haiku|contribs]])</small></sup>
||Encrypted Region-wide chat
|-
||[[ExplodingObjects]]
||[[User:Dale Innis|Dale Innis]]
||Causes an object (of the appropriate type) to explode on command.
|-
||[[FadeEasy]]
||[[User:Nika Rugani|Nika Rugani]]
||The easy way of fading objects in or out (Using llSetLinkAlpha)
|-
||[[FastConeSpread]]
||[[User:Nexii Malthus|Nexii Malthus]]
|| Fast Algorithmn to achieve cone spread, main use in weaponry systems.
|-
||[[User:PixelProphet Lane/Scripts#Fast List Prim Contents|Fast List Prim Contents]]
||[[User:PixelProphet Lane|PixelProphet Lane]]
||Fast and efficient method to print Object Inventory (Name, Type and next Owner permissions)
|-
||[[Find Avatar Key|Find Avatar Key]]
||[[User:Huney Jewell|Huney Jewell]]
||Explores [[UUID]] of avatar whose name is said in local chat or who touches the prim.
|-
||[[First Name Letter Prize]]
||[[User:RaithSphere Whybrow|RaithSphere Whybrow]]
||Gives a prize if the person who sits on it's first letter of first name matches the random letter!
|-
||[[Fix Small Prims|Fix_Small_Prims]]
||[[User:Emma Nowhere|Emma Nowhere]]
||Finds and adjusts the smallest prims in a linkset so that it can be scaled down further.
|-
||[[Float2Hex]]
||[[User:Strife Onizuka|Strife Onizuka]]
||Very useful for transporting [[float|floats]].
|-
||[[Float Box Contents]]
||[[User:Rolig Loon|Rolig Loon]]
||Displays object inventory in hover text, identified by type and updated marquee-style.
|-
||[[Follower (script)|Follower]]
||Unknown, uploaded by [[User:Slik Swindlehurst|Slik Swindlehurst]]
||Makes an object follow the nearest person. Do not use for [[grief|griefing]].
|-
||[[GA Event Notifier]]
||[[User:Victor Hua|Victor Hua]]
||Gathers seven days event data from a Google calendar and display it through a simple interface. The lsl script can access several calendars at once through seperate php files. One file per calendar. Host the included php on your own web server.
|-
||[[Geometric|Geometric Library]]
||Community Project
||A substantial amount of various geometric functions for intersection and other purposes of 3D maths.
|-
||[[Get Profile Picture]]
||[[User:Valentine Foxdale|Valentine Foxdale]]
||Sets the texture of the object to profile picture of the person that touches ot
|-
||[[GetTimestampOffset]]
||[[User:Siann_Beck|Siann Beck]]
||Returns [[llGetTimestamp]]() with an hour offset.
|-
||[[Give InvItem every n hours]]
||[[User:Criz Collins|Criz Collins]]
||Will give an inventory item on touch only every n hours, even if somebody touches the object more than once.
|-
||[[Give random object]]
||[[User:Emmas Seetan|Emmas Seetan]]
||Touch to receive a random object in the prim's inventory
|-
||[[Google Charts]]
||[[User:Dedric Mauriac|Dedric Mauriac]]
||Create links to display raw data as a chart image.
|-
||[[Google_Translator]]
||[[User:Ugleh Ulrik|Ugleh Ulrik]]
||Translates spanish to english, and its simple to make it any other way.
|-
||[[Go transparent when walking]]
||[[User:Emmas Seetan|Emmas Seetan]]
||An attachment that goes invisible when you walk and visible when you don't walk.
|-
||[[Group Authorization]]
||[[User:Chase Quinnell|Chase Quinnell]]
||Checks to see if object is set to appropriate group (checks by [[Group key finder|group key]])
|-
||[[Group Information v1.0]]
||[[User:Tyrennic Rivera|Tyrennic Rivera]]
||When clicked the prim will show group information (set on the prim) from the official Second Life Search page.
|-
||[[Group key finder]]
||[[User:Emmas Seetan|Emmas Seetan]]
||Touch to find the key of the group
|-
||[[Group Privacy]]
||[[User:Chance Unknown|Chance Unknown]]
||Security device to insure members of a group can have a private area. Deactivates when nobody present.
|-
||[[Hello Avatar]]
||Linden Lab
||SL's default script.
|-
||[[Hello Avatar Companion]]
||[[Chase Quinnell]]
||Companion to the original [[Hello Avatar]] script
|-
||[[Hierarchics]]
||[[User:Nexii Malthus|Nexii Malthus]]
|| Advanced script to create an efficient self-aware hierarchic structure.
|-
||[[Hierarchics2]]
||[[User:Nexii Malthus|Nexii Malthus]]
|| Second generation, one script per object. Only two functions, can be embedded in others. Uses the new [[llSetLinkPrimitiveParamsFast]]/[[llGetLinkPrimitiveParams]] functions.
|-
||[[User:Rolig_Loon/High-Capacity_Greeter-Counter|High-Capacity Greeter-Counter]]
||[[User:Rolig Loon|Rolig Loon]]
||Uses a memory compression algorithm to store hashed visitor UUID's in a string instead of using a list.
|-
||[[Holodeck]]
||[[User:Revolution Perenti|Revolution Perenti]]
||Home Rezzing System (Open Source).
|-
||[[Interpolation|Interpolation Library]]
||[[User:Nexii_Malthus|Nexii Malthus]]
||A small set of interpolation functions.
|-
||[[Intra-Region Update Server]]
||[[User:Emma_Nowhere|Emma Nowhere]]
||Centrally update objects such as Freeview screens or teleport pads within a region that are configured by notecards or contain modifiable objects or media assets.
|-
||[[Inventory_Based_Menu]]
||[[User:Revolution Perenti|Revolution Perenti]]
||Inventory Based Menu System.
|-
||[[iTunes RPC Email|iTunes RPC]]
||[[User:Fox Diller|Fox Diller]]
||iTunes RPC via LSL [[llEmail]] and [[llRemoteDataReply]].
|-
||[[Kilt Editor|Kilt / Skirt Editor]]
||[[User:Brangus Weir|Brangus Weir]]
|| This changes all the parameters of all the flexis in the link set in one swell foop!
|-
||[[Key Pad Door|Keypad Door]]
||[[User:Tdub Dowler|Tdub Dowler]]
|| Door and keypad with changeable code. Follow instructions carefully!
|-
||[[Last Sound System]]
||[[User:Babbage Linden|Babbage Linden]]
||An LSL [http://Last.fm Last.fm] client.
|-
||[[LibraryDisplayLandScreenshot]]
||[[User:Jon Desmoulins|Jon Desmoulins]]
||A modified version of LibraryDisplayProfilePic using the new [[PARCEL_DETAILS_ID]] Implemented in Server v1.36
|-
||[[User:Daemonika_Nightfire/Scripts/LinkNumber-List_in_llSetLinkPrimitiveParamsFast|LinkNumber-List_in_llSetLinkPrimitiveParamsFast]]
||[[User:Daemonika Nightfire|Daemonika Nightfire]]
||Changed several prims in linkset with the same parameters, with a list. Without separate llSetLinkPrimitiveParams for each prim. (ideal for show/hide effects)
|-
||[[Linkset resizer]]
||[[User:Maestro Linden|Maestro Linden]]
||Systematically rescales a linkset by moving and resizing each prim (by using [[llGetLinkPrimitiveParams]] and [[llSetLinkPrimitiveParamsFast]])
|-
||[[Linkset resizer with menu]]
||[[User:Brilliant Scientist|Brilliant Scientist]]
||A menu-driven script that rescales a linkset by moving and resizing the prims using [[llGetLinkPrimitiveParams]] and [[llSetLinkPrimitiveParamsFast]] functions. Based on [[Linkset resizer]].
|-
||[[Linkset Resizer 2]]
||[[User:Emma Nowhere|Emma Nowhere]]
||A more user-friendly resizer script designed for either drop-in use by the end-user or builder or for use in products. Based on [[Fix Small Prims]].
|-
||[[List2CSV]]
||[[User:Kunnis Basiat|Kunnis Basiat]]
||List2CSV & CSV2List that include preserving type and escaping characters.
|-
||[[list_cast]]
||[[User:Fractured Crystal|Fractured Crystal]]
||Casts a list of strings into the type they appear to be. Designed for preprocessing user input for feeding into [[llSetPrimitiveParams]]
|-
||[[Listener Script]]
||[[User:Emmas Seetan|Emmas Seetan]]
||Use to [[listen]] to other people's conversations (Like spying)
|-
||[[User:Void_Singer/Functions#List:_Find_Last_Index|List: Find Last Index]]
||[[User:Void Singer|Void Singer]]
||Returns the last index of searched item in a source list. (backwards version of [[llListFindList]])
|-
||[[User:Void_Singer/Functions#List:_Multi-Find_Index_.28First_or_Last.29|List: Multi Find]]
||[[User:Void Singer|Void Singer]]
||Returns the first found index of multiple search items in a list. (Multi-item version of [[llListFindList]]. Fwd and Rev versions included)
|-
||[[User:Void_Singer/Functions#List:_Get_Reverse_Order|List: Reverse]]
||[[User:Void Singer|Void Singer]]
||Returns an input List in reverse order
|-
||[[Load URL]]
||[[User:Emmas Seetan|Emmas Seetan]]
||Touch to get a dialog to visit the URL inside the script.
|-
||[[User:Kephra_Nurmi/lsDancemachine|lsDancemachine]]
||[[User:Kephra_Nurmi|Kephra Nurmi]]
|| Low lag client server dancemachine.
|-
||[[User:Kephra_Nurmi/lsDeejay|lsDeejay Home Edition]]
||[[User:Kephra_Nurmi|Kephra Nurmi]]
|| Client server media control for music, video, youtube, pictures, and texture animations.
|-
||[[User:Kephra_Nurmi/lsDialog|lsDialog]]
||[[User:Kephra_Nurmi|Kephra Nurmi]]
|| Universal notecard driven menu dialog system.
|-
||[[User:Kephra_Nurmi/lsDisplay|lsDisplay]]
||[[User:Kephra_Nurmi|Kephra Nurmi]]
|| Picture cycler with preloader.
|-
||[[User:Kephra_Nurmi/lsDistributor|lsDistributor]]
||[[User:Kephra_Nurmi|Kephra Nurmi]]
|| Simple 'try' and 'buy' vendor system.
|-
||[[LSL_languageAPI]]
||[[User:Gypsy paz|Gypsy Paz]]
||Multi-lingual API from notecard based language files
|-
||[[Mandelbrot Explorer]]
||[[User:Babbage Linden|Babbage Linden]]
||An interactive fractal explorer.
|-
||[[Merge Sort]]
||[[User:Xaviar Czervik|Xaviar Czervik]]
||Implements a Merge Sort in LSL, however this code is 300(ish) times slower than [[llListSort]]. Don't use this in a script!
|-
||[[Minesweeper]]
||[[User:Xaviar Czervik|Xaviar Czervik]]
||A simple minesweeper game.
|-
||[[Morse Code]]
||{{User|Bobbyb30 Swashbuckler}}
||A script that allows for the conversion to and from morse code and can "play" morse code.
|-
||[[Multi Item Rezzer|Multi Item Rezzer]]
||[[User:Jesse Barnett|Jesse Barnett]]
||A rework of my old High Altitude Rezzer. Place the objects that you wish to choose from to be rezzed inside. Sit on the rezzer and pick the item and the height. It will go to target height and rez the object.
|-
||[[Multirezzer|Multirezzer (on collision)]]
||[[User:Beet Streeter|Beet Streeter]]
||Spawns up to 10 objects when the object containing the script collides with a user.
|-
||[[Name2Key in LSL]]
||[[User:Maeva Anatine|Maeva Anatine]]
||Get the Name2Key feature inside your scripts. Works even on lastly subscribed avatars.
|-
||[[No Auto-Return]]
||[[User:Bellla Clarity|Bella Clarity]]
||To stop your long and hard builds from getting returned in sandboxes (''only single prims, though!'').
|-
||[[No Auto-Return NR]]
||[[User:Jor3l Boa|Jor3l Boa]]
||This really works (29-05-09), needs a nearby region to do the trick and avoid auto return. (Tested on Blue and Rausch)
|-
||[[No Auto-Return (Multi)]]
||[[User:Xaviar Czervik|Xaviar Czervik]]
||A revision of Bella's that works for multi-prim objects.
|-
||[[No Limit Teleporter]]
||[[User:Morgam Biedermann|Morgam Biedermann]]
||Teleport to infinite altitudes (up to 4096m)
|-
||[[Object Size]]
||[[User:Chase Quinnell|Chase Quinnell]]
||Gets the dimensions and footprint of a linkset
|-
||[[Object to Data v1.3|Object to Data]]
||[[User:Xaviar Czervik|Xaviar Czervik]]
||Turns an object into text (and back). Allows people to transfer objects through notecards (or otherwise).
|-
||[[Online Indicator|Online Indicator]]
||[[User:Kristy Fanshaw|Kristy Fanshaw]]
||Will show if the user is online or not. Displays users profile picture and allows to send IM's to user. Also gives a link to open the users profile
|-
||[[Open Group Join]]
||[[User:Alicia Stella|Alicia Stella]]
||User Touches Object to Join Group from Group Info window, (no bot.)
|-
||[[Open Zyngo Skin Installer]]
||[[User:Tmzasz Luminos|Tmzasz Luminos]]
||A Simple Script designed to install skins on the popular Skill machines.
|-
||[[One Script, many doors]]
||[[User:Kyrah Abattoir|Kyrah Abattoir]]
||Door script able to manage more than 50 linked doors from a single script instance.
|-
||[[ParseString2List]]
||[[User:Strife Onizuka|Strife Onizuka]]
||Same as [[llParseString2List]] and [[llParseStringKeepNulls]], but not limited to 8 spacers or separators. Thus substitute a call to the [[llParseString2List]] and [[llParseStringKeepNulls]] functions by a call to [[Parse_String_To_List|ParseString2List]] whenever you have more than 8 separators or more than 8 spacers.
|-
||[[Password Generator]]
||[[User:Syntrax Canucci|Syntrax Canucci]]
||This is an over-complicated, semi-complex password generator, which goes through multiple steps.
|-
||[[Pathfinder]]
||[[User:Babbage Linden|Babbage Linden]]
||A potential field based pathfinding library.
|-
||[[Phantom Child]]
||[[User:Aeron Kohime|Aeron Kohime]]
||Causes a child in a link set to become phantom without the entire object becoming phantom.
|-
||[[PhysicsLib]]
||[[User:Nexii Malthus|Nexii Malthus]]
|| Interesting set of fun physics functions.
|-
||[[Play and Loop Sound]]
||[[User:Bellla Clarity|Bella Clarity]]
||Very short and simple script; plays and loops a sound in an object.
|-
||[[Posing stand|Posing Stand]]
||[[User:Bellla Clarity|Bella Clarity]]
||Just a pose script to edit [[attachments]] more easily.
|-
||[[PosJump]]
||[[User:Uchi Desmoulins|Uchi Desmoulins]]
||A much more efficient alternative to the popular [[warpPos]] function for bypassing 10m distance-moved limitations.
|-
||[[Prefix Calculator]]
||[[User:Xaviar Czervik|Xaviar Czervik]]
|| A calculator that evaluates expressions in prefix notation.
<code>+ 3 4 = 5. * + 1 2 + 3 4 = 14.</code>
|-
||[[Progress Bar]]
||[[User:Nexii Malthus|Nexii Malthus]]
|| Flexible and powerful little function for creating progress bars useful in hovertext.
|-
||[[Pseudo-random Number Generator]]
||[[User:Xaviar Czervik|Xaviar Czervik]]
||Generates a Pseudo-random number between -0x7FFFFFFF and 0x7FFFFFFF
|-
||[[User:Rolig_Loon/Quiz_From_Notecard|Quiz From Notecard]]
||[[User:Rolig Loon|Rolig Loon]]
||A multiple-choice testing script that reads questions and answer choices from a notecard and presents them in dialog boxes.
|-
||[[Rainbow_palette]]
||[[User:Rui Clary|Rui Clary]]
||Build a color picker, using only one prim, and a few lines of code.
|-
||[[Random AV Profile Projector]]
||[[User:Debbie Trilling|Debbie Trilling]]
||Randomly selects an AV from a crowd & then projects their profile picture as a 'holographic' image
|-
||[[Random Object Vendor]]
||[[User:CodeBastard Redgrave|CodeBastard Redgrave]]
||Simple vendor that gives out random objects when paid the right amount
|-
||[[Random Password Generator]]
||[[User:Jor3l Boa|Jor3l Boa]]
||Generate Random passwords based on String Length.
|-
||[[RavText]]
||[[User:Ravenous Dingo|Ravenous Dingo]]
||An alternate to XyText. This is a lightweight, multiple font 10 character text display system. It only supports uppercase alphanumeric text and a few special characters, but it is very fast, renders quickly and supports multiple fonts. It is meant for specialized use when all that is desired is basic, fast text display and the extra "bells and whistles" are not needed.
|-
||[[User:PixelProphet Lane/Scripts#Real Object Inventory To Dialog|Real Object Inventory To Dialog]]
||[[User:PixelProphet Lane|PixelProphet Lane]]
||Display any amount of items contained in an Object in a Dialog, regardless of item name length.
|-
||[[RentalBoxv1|Rental Box, Simply]]
||[[User:Sendao Goodman|Sendao Goodman]]
||Simple explanation of how to make rental boxes.
|-
||[[Rental Cube]]
||[[User:Hank Ramos|Hank Ramos]]
||Simple cube for renting out a space.
|-
||[[Remote Texture Loader]]
||{{User|Bobbyb30 Swashbuckler}}
||A set of scripts for remotely loading textures within a sim. This means that a single "texture server" can manage multiple changing billboards within a sim.
|-
||[[Say Region Frames Per Second|Region Frames Per Second]]
||[[User:Heymeriou Mystakidou|Heymariou Mystakidou]]
|| Says the region name and frames per second out loud on command.
|-
||[[sbDialog]]
||[[User:Siann_Beck|Siann Beck]]
||A simple replacement function for [[llDialog]]. It re-orders the button list so that the button values, as passed to it, display left-to-right, top-to-bottom. It also opens a [[llListen|listen]] on the specified channel, and returns the handle.
|-
||[[Scheduler]]
||[[User:Haravikk Mistral|Haravikk Mistral]]
||Schedule multiple events using a single script timer
|-
||[[Scheme_Interpreter|Scheme Interpreter]]
||[[User:Xaviar Czervik|Xaviar Czervik]]
||A scheme interpreter capable of handling most scheme expressions, including lambda and lists.
|-
||[[Script Override Functions]]
||[[User:Revolution Perenti|Revolution Perenti]]
||bypass default strings, integer etc in chat channel.
|-
||[[Scripted Attachment Detector.lsl|Scripted Attachment Detector]]
||{{User|Bobbyb30 Swashbuckler}}
||A script that will display avatars wearing scripted attatchments in hovertext. This may be worn as an hud or rezzed.
|-
||[[Self Upgrading Script Enhanced]]
||[[User:Cron Stardust|Cron Stardust]]
||Keeps only latest version of the script on prim (even with multiple adds of the same script!)
|-
||[[Sensor Visualizer]]
||[[User:Cerise Sorbet|Cerise Sorbet]]
||Shows the size and shape you get with [[llSensor]] range and arc parameters
|-
||[[Serverless Key Exchange]]
||[[User:Sendao Goodman|Sendao Goodman]]
||Maintains a network of object keys without using an external server.
|-
||[[SHA1|SHA1 Hash]]
||[[User:Xaviar Czervik|Xaviar Czervik]]
||Preforms a SHA1 Hash on an input text. Similar to MD5 only (slightly) more secure.
|-
||[[Sim Map Particle Projector]]
||[[User:Jesse Barnett|Jesse Barnett]]
||Displays a floating map of the sim the script is in.
|-
||[[Sim Restart Logger]]
||[[User:Kyrah Abattoir|Kyrah Abattoir]]
||Counts region restarts and displays log of last 9 restarts together with region FPS and dilation.
|-
||[[Simple Elevator in a Box]]
||[[User:Hank Ramos|Hank Ramos]]
||Simple elevator example.
|-
||[[Skillingo AntiHack Script]]
||[[User:Tmzasz Luminos|Tmzasz Luminos]]
||A simple Protection script for skillingo thats modifyable to work with other machines.
|-
||[[Skunk Money]]
||[[User:Hank Ramos|Hank Ramos]]
||Fun gambling machine of yesteryear, which only supports freeplay now due to SL regulations against gambling.
|-
||[[SLateIt]]
||[[User:Babbage Linden|Babbage Linden]]
||An augmented virtual reality HUD.
|-
||[[SLetanque]]
||[[User:Babbage Linden|Babbage Linden]]
||An LSL petanque game.
|-
||[[SLURL HUD]]
||[[User:CodeBastard Redgrave|CodeBastard Redgrave]]
||Touch this HUD to get a SLURL through IM, email and floating text.
|-
||[[llSLURL (NewAge)]]
||[[User:Archile Azalee|Archile Azalee]]
||Newest most easiest way to create SLURL in a single function llSLURL
|-
||[[SL Mail V1.2]]
||[[User:Flennan Roffo|Flennan Roffo]]
||Second Life mail client V1.2 (released sept'07). Send and receive mail from within Second Life from and to any address. With Address Book function and many chat commands. V1.3 is upcoming soon!
|-
||[[SL_NTPoHTTP_v1.1_client|SL NTPoHTTP client]]
|[[User:SignpostMarv Martin|SignpostMarv Martin]]
||Second Life Needs Time Parsing over Hyper Text Transfer Protocol
Emulates the function of [[llGetWallclock]] for any timezone by using SLOpenID's SLNTPoHTTP service. Also supports ISO 8601 and RFC 2822 timestamps. Script is dependent upon an external service operated by the author!
|-
||[[Smooth Rotating Door]]
|[[User:Toy Wylie|Toy Wylie]]
||A script for doors that open and close smoothly using llTargetOmega
|-
||[[Smooth Sliding Door]]
|[[User:SimonT Quinnell|SimonT Quinnell]]
||A script for sliding doors that open and close smoothly using [[llMoveToTarget]]. Asjusts for prim orientation.
|-
||[[Speed Tester]]
||{{User|Bobbyb30 Swashbuckler}}
||Similar to the [[Efficiency Tester]], this script allows you to test the speed of a particular function or snippet with multiple trials giving min/max/avg/median and the standard deviation.
|-
||[[Spiral Staircase Generator]]
|[[User:Meyermagic Salome|Meyermagic Salome]]
||Generates nice looking spiral staircases without much hassle.
|-
||[[Static URL's for HTTP-In Service|Static_URLs]]
||[[User:Jor3l Boa|Jor3l Boa]]
||How to generate a static url for HTTP-In temporal limitations.
|-
||[[String Compare]]
||[[User:Xaviar Czervik|Xaviar Czervik]]
||Compares two strings and reliably returns either 1, -1, or 0 if they are the same.
|-
||[[User:Void_Singer/Functions#String:_Find_Last_Index|String: Reverse]]
||[[User:Void Singer|Void Singer]]
||Returns an input string in reverse order
|-
||[[User:Void_Singer/Functions#String:_Get_Reverse_Order|String: Last Index]]
||[[User:Void Singer|Void Singer]]
||Returns the last index of search found in string (the backward equivalent of [[llSubStringIndex]])
|-
||[[Tail Messages (NewAge)]]
||[[User:Asia Snowfall|Asia Snowfall]]
||A super nice easy to use script for those non-scripters out there! NewAge coding has done it again where you no longer need to scroll up and down adding buttons and adding messages, Features a tag system (you'll see what i mean :P)
|-
||[[Teleport HUD]]
||[[User:Jesse Barnett|Jesse Barnett]]
||WORKS TO 4096 METERS!! Very user friendly teleport HUD. Add destinations by touching "Add" & naming destination in chat. Automatically gets sim name and coordinates. Will only display the destinations in the sim you are currently in. Demonstrates more advanced list manipulation and stride functions.
|-
||[[User:Void_Singer/Programs#v7-D_Enh._Landmark-2-Map|Teleporter (landmark based)]]
||[[User:Void_Singer|Void_Singer]]
||Uses Landmarks to offer map teleports. Works as Hud or inworld objects, just drop in landmarks and go.
|-
||[[Text_Scroller|Text Scroller]]
||[[User:Fred_Gandt|Fred Gandt]]
||A simple text display object that scrolls text (applied as a texture) from right to left (like ''those'' LED signs) in a continuous loop.
|-
||[[Bobbyb's texture changer|Texture Changers]]
||{{User|Bobbyb30 Swashbuckler}}
||A collection of texture changing scripts.
|-
||[[Texture Menu Management|Texture Management]]
||[[User:Revolution Perenti|Revolution Perenti]]
||Dialog Menu based Texture Selection.
|-
||[[Tic Tac Toe]]
||[[User:CG Linden|CG Linden]]
||Step by step demo on how to implement a larger scripting project
|-
||[[TightList]]
||[[User:Strife Onizuka|Revolution Perenti]]
||Tight List is a family of functions for encoding lists as strings and then decoding them back into lists.
There are two flavors: TightList and TightListType. TightListType preserves types and uses a 6 char header, while TightList uses a 1 char header that doesn't preserve type.
|-
||[[Timer Module]]
||[[User:Isabelle Aquitaine|Isabelle Aquitaine]]
||Manage multiple timers via linked messages.
|-
||[[User:Void_Singer/Functions#Unix_time_code_to_list_format|Timestamp:<br>Unix time code to list format]]
||[[User:Void Singer|Void Singer]]
||converts Unix timestamps to their [Y, M, D, h, m, s] equivalents (ex: 1234567890 to [2009, 2, 13, 3, 31, 30])
|-
||[[User:Void_Singer/Functions#List_format_to_Unix_time_code.|Timestamp:<br>List format to Unix time code]]
||[[User:Void Singer|Void Singer]]
||converts [Y, M, D, h, m, s] timestamps to their Unix equivalents (ex: [2009, 2, 13, 3, 31, 30] to 1234567890)
|-
||[[User:Void_Singer/Functions#Weekday_from_Unix_timestamp|Timestamp:<br>Weekday from Unix timestamp]]
||[[User:Void Singer|Void Singer]]
||Gets weekday from Unix timestamps (ex: "Friday" from 1234567890)
|-
||[[User:Void_Singer/Functions#Weekday_from_.28_Y.2C_M.2C_D_.29_format|Timestamp:<br>Weekday from (Y, M, D) format]]
||[[User:Void Singer|Void Singer]]
||Gets weekday from (Y, M, D) timestamps (ex: "Friday" from (2009, 2, 13))
|-
||[[Touch A Quote]]
||[[User:CodeBastard Redgrave|CodeBastard Redgrave]]
||Touch an object to read quotes sequentially from a notecard
|-
||[[Touring Balloon]]
||[[User:Hank Ramos|Hank Ramos]]
||Automated touring balloon with many options from long ago. Always seems to work on one SL release, and not the other.
|-
||[[Under Age Boot]]
|[[User:Chance Unknown|Chance Unknown]]
||Security device example to teleport home accounts below a minimum age limit; can be useful in combating free griefer accounts.
|-
||[[User:Rolig_Loon/UNDO_PosRot|UNDO_PosRot]]
||[[User:Rolig Loon|Rolig Loon]]
||Allows user to undo position and rotation changes that have been made "manually" to any or all prims in a linkset.
|-
||[[Universal Translator]]
|[[User:Hank Ramos|Hank Ramos]]
||Chat listener that handles seamless translation of public chat between 50+ written languages without the need for configuration. Handles numerous avatars, auto-detects languages, and works together with multiple copies of translators to spread-workload using a sophisticated back-end communications sub-system.
|-
||[[Unix2DateTime]]
|[[User:Flennan Roffo|Flennan Roffo]]
||Conversion from Unix time ([[llGetUnixTime]]()) to date and time string and vice versa.
|-
||[[Unmutable Descript Nagger]]
|[[User:Bobbyb30 Zohari|Bobbyb30 Zohari]]
||To nag avatars to take off their scripted attatchments.
|-
||[[Unpacker On Rez (NewAge)]]
|[[User:Asia Snowfall|Asia Snowfall]]
||A very simple to use script for all you creators out there, This script will enable you to send out boxed items and make it easier for users to unpack, Also features auto die on completion. Very simple to configure!
|-
||[[Unpacker On Touch (NewAge)]]
|[[User:Asia Snowfall|Asia Snowfall]]
||Exactly like Unpacker On Rez, But changed some things about to make it Unpack On Touch
|-
||[[Update distributor]]
|[[User:Dale Innis|Dale Innis]]
||Distribute an object (like a project update) to a list of people named in a notecard.
|-
||[[UUID2Channel]]
||[[User:Project Neox|Project Neox]]
||Optimised version of the original key2channel generators.
|-
||[[UUID Song Generator]]
||{{User|Sendao Goodman}}
||Translates a UUID into a simple song and plays it.
|-
||[[VirtualID_URLMap|VirtualID URL Mapper for HTTP-in]]
|[[User:Cenji Neutra|Cenji Neutra]]
||A script showing how to setup a static URL of the form <your-alias>.obj.virtualid.info which maps to the dynamic HTTP-in URL LSL generates and keeps it up-to-date.
|-
||[[User:Void_Singer/Programs#v7-D_Advanced_Visitor_Greeter|Visitor Greeter]]
|[[User:Void_Singer|Void_Singer]]
||Reduced spam visitor greeter, highly configurable, easy to modify.
|-
||[[Visitor Logger (Web/Basic) ]]
|[[User:Buddy Sprocket|Buddy Sprocket]]
||A very basic visitor logger - log visitors in SL to a text file on your web-site.
|-
||[[Vote Simple]]
|[[User:JB_Kraft|JB Kraft]]
||Simple vote collector. One avi, one vote.
|-
||[[Walking Sound (NewAge)]]
|[[User:Asia Snowfall|Asia Snowfall]]
||Very powerful walking sound script, Featuring customer ability to add their own sounds with the API Sound Feature!
|-
||[[WarpPos]]
|[[User:Keknehv Psaltery|Keknehv Psaltery]]
||Non-physical movement without the 10m limit.
|-
||[[Wiki3DBuilder]] [[Wiki3DBuilder1.0]]
||[[User:Salahzar Stenvaag|Salahzar Stenvaag]]
||Allows a group of people to collectively build up complex 3D mindmaps with connected concepts. Uses particles for connections and low prim usage. Nodes can be textured, colored, changed form size moved collectively by everybody and can distribute notecards, landmarks, URL, objects, textures. I provide two version 0.1 and 1.0 and probably next version will communicate with moodle and sloodle external websites.
|-
||[[Window Control]]
||[[User:Emmas Seetan|Emmas Seetan]]
||For window opacity, helpful for buildings.
|-
||[[WHMcs SecondLife plugin]]
|[[User:Alicia Sautereau|Alicia Sautereau]]
||Linden Dollar payment plugin for the WHMcs hosting portal.
|-
||[[XTEA Strong Encryption Implementation]]
||[[User:Morse Dillon|Morse Dillon]]
||An LSL implementation of XTEA (eXtended Tiny Encryption Algorithm). This is the first known public release of a 'real' strong encryption implementation in LSL and is released under the GNU General Public License (GPL).
|-
||[[XyText 1.5|XyText]]
||[[User:Xylor Baysklef|Xylor Baysklef]]
|| Display text (up to 10 characters) on a prim. Use as many prims as desired.
|-
||[[XyyyyzText|XyyyyzText]]
||[[User:Criz Collins|Criz Collins]]
|| Display text (up to 10 characters) on a prim. Displays different text for each line instead of one single text, that will be broken into the next lines. Watch here for what that means: http://screencast.com/t/1wMLujLcEO
|-
||[[XyzzyText|XyzzyText]]
||[[User:Thraxis Epsilon|Thraxis Epsilon]] and [[User:Gigs Taggart|Gigs Taggart]]
|| Display text (up to 10 characters) on a prim. Way more efficient than XyText.
|-
||[[Youtube TV]]
||[[User:Morgam Biedermann|Morgam Biedermann]]
||Watch your favorite Youtube videos / auto set the texture to the parcel media texture.
|-
||[[Zero Lag Poseball]]
||[[User:Jippen Faddoul|Jippen Faddoul]] and [[User:Daemonika Nightfire|Daemonika Nightfire]]
||A simple poseball with no lag
|}

</div>
<div id="box">

==Support Script Library==
These are scripts in other languages, intended to be run on other systems that support scripts written in LSL

{| class="sortable" {{Prettytable}}
|- {{Hl2}}
! '''Name'''
! '''Creator'''
! '''Description'''
|-
|| [[User:Ina Centaur/UUID/calimg.api|Calendar Image UUID API]]
|| [[User:Ina Centaur|Ina Centaur]]
|| API that gives the UUID of an image of a calendar image give month and year arguments.
|-
||[[HTTP Post request to a PHP server]]
||[[User:Corto Maltese|Corto Maltese]]
|| This small library allows you to make simple POST requests to your website. The libraries allow you to get your request through the variable $_POST on the server. It also include a basic security mechanism aimed to stop hacking. Comprises of LSL client script and PHP server script.
|-
|| [[User:Ina Centaur/PHP/k2n.php|Key2Name.php]]
|| [[User:Ina Centaur|Ina Centaur]]
|| Get Avatar's Name using Second Life search service. (like in LSL Key2Name)
|-
|| [[Lame_Object_DNS_and_Cross_Sim_Messaging|Lame Object DNS and Cross Sim Messaging]]
|| [[User:Liandra Ceawlin|Liandra Ceawlin]]
|| Simple, cheeseball method of doing cross-sim communications with http-in and an external object DNS service.
|-
|| [[User:SignpostMarv Martin/PHP/llXorBase64StringsCorrect|llXorBase64StringsCorrect]]
|| [[User:SignpostMarv Martin|SignpostMarv Martin]]
|| An implementation of [[llXorBase64StringsCorrect]] in PHP- should be useful if you're using llXorBase64StringsCorrect to do cryptography work in LSL2 and posting it out to the web via [[llHTTPRequest]].
|-
|| [[User:SignpostMarv Martin/PHP/lsl fu.php|lsl_fu.php]]
|| [[User:SignpostMarv Martin|SignpostMarv Martin]]
|| A basic OOP'd PHP Class containing VeloxSeverine's $_POST fixer and Marv's own eccentric ideas for "fixing" things.
|-
|| [[User:Jor3l Boa/PHP/n2k.php|Name2Key.php]]
|| [[User:Jor3l Boa|Jor3l Boa]]
|| Get Avatar's UUID using Second Life search service. (like in LSL Name2Key)
|-
|| [[Public_Object_DNS|Public Object DNS]]
|| [[User:Liandra Ceawlin|Liandra Ceawlin]]
|| Public object DNS-like system running on GAE, for http-in. Hopefully scalable enough for wide-spread usage.
|-
|| Silo
|| [[User:Zero_Linden|Zero Linden]]
|| General purpose data store in PHP. Use this to persist arbitrary data from LSL via [[llHTTPRequest]]. See:
* [http://www.notabene-sl.com/misc/silo-README.txt README] file
* [http://www.notabene-sl.com/misc/silo.tgz silo.tgz] tarball
* forum post [http://forums-archive.secondlife.com/54/69/119570/1.html Announcement].
|-
||[[Silverday ObjectDNS]]
||[[User:Till Stirling|Till Stirling]]
||Dynamic Object-DNS-System to provide dynamic mapping of LSL-URLs to persistent domains. Features include redirect service, password protected domains, write protected domains, LSL-API for all necessary functions, optional web-interface.
|-
|| [http://aubretec.com/products/sldb SLDB]
|| [[User:Luc Aubret|Luc Aubret]]
|| Flexible web database storage using PHP/MySQL. Used to store per-user field/value pairs from in-world objects using [[llHTTPRequest]].
* [http://aubretec.com/support/manuals/sldbkit/ Implementation Guide]
* [http://aubretec.com/wp-content/uploads/2009/05/sldb.zip Download] (.zip, 12kb)
|}

== See Also ==
<div style="padding: 0.5em">
'''Articles'''
*[[:Category:LSL Examples| Examples]]

</div></div>

{{LSLC|}}

MultiUser Dialog Handler

2010-09-01T05:05:34Z

SimonT Quinnell: /* Calling a Complex Menu */

==Introduction==

I found that i was constantly rewriting a pile of dialog handling functions in my scrips so i decided to write a single dialog handler script. It needed to have the following features;

* Support multiple simultaneous menus from different users.
* Support fixed top buttons that will persist on lists.
* Support fixed bottom buttons with include Back and Exit buttons.
* Handle item lists > 12 and automatically insert << and >> buttons to scroll through the lists.
* Handle timeouts and communicate timeout back to calling script.
* Handles truncation of the buttons and text to stop errors in llDialog

==Using The Script==

===Calling a Simple Menu===
In the script that is calling the menu I use a function something like this. This will display a menu that looks something like

This is the menu text that will be displayed.

{| border="1"
|Owner || Group || All
|-
| || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "menu~parent|TRUE"; //Menu name is 'menu with a parent menu name 'parent'. The display of the bottom navigation buttons is set to TRUE
string menuText = "This is the menu text that will be displayed."; // The text ( will be trimmed to 510 characters
string menuButtons = "Owner~Group~All"; // The buttons, each button separated by a '~'. Buttons will be trimmed to 24 characters

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuText+"|"+ menuButtons, id);
}
</lsl>

===Calling a Complex Menu===
The above case is a simple menu. The script can also do more complex menus.

In the following case we will have 10 buttons that are going to be displayed. Because we will also display the bottom 3 buttons this will be spanned across 2 menus. We will also include 2 fixed buttons that always display at the top of the menu, PLUS each button has a unique descriptor that is displayed.

This will display the following 2 menus

Menu1
Main text displayed.
item1
item2
item3
item4
item5
item6
item7

{| border="1"
|FIXED1 || FIXED2 || B1
|-
|B2 || B3 || B4
|-
|B5 || B6 || B7
|-
| || Back || >>
|}

Menu2 (on clicking the >> button)
Main text displayed.
item8
item9
item10

{| border="1"
|FIXED1 || FIXED2 || B8
|-
| B9 || B10 ||
|-
| << || Back || Exit
|}

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

DisplayMenu(key id)
{ // Menu Functions
string menuDescripter = "menu~parent|TRUE";
string menuText = "Main text displayed.~text1~text2~text3~text4~text5~text6~text7~text8~text9~text10";
string menuButtons = "B1~B2~B3~B4~B5~B6~B7~B8~B9~B10";
string menuFixedButtons = "FIXED1~FIXED2"

llMessageLinked(LINK_THIS, LINK_MENU_DISPLAY, menuDescripter+"|"+menuText+"|"+ menuButtons+"|"+menuFixedButtons, id);
}
</lsl>

===Parsing the returning Menu information===

Note that if the user clicks on the << or >> buttons the calling script WILL NOT see any response. The correct menu is displayed. The calling script only receives a response when one of the buttons or Back/Exit are clicked. Clicking on a space button will cause the menu to redisplay.

The script that expects the response back from the menu has the following

<lsl>
// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

default
{
link_message(integer intSenderNum, integer num, string message, key id)
{
if (num == LINK_MENU_RETURN)
{
list returnMenu = llParseString2List(message, ["|"], []);
list temp = llParseString2List(llList2String(returnMenu,0), ["~"], []);

string menu = llList2String(temp,0); // The name of the menu
string parent = llList2String(temp,1); // The parent of the menu
string item = llList2String(returnMenu,1); // The actual button pushed

//now do something with your response which is the variable 'item'
}
else if (num == LINK_MENU_TIMEOUT)
{
// We received a timeout (don't worry the listens are all dealt with) so you might want to IM the menu user.
}
}
}
</lsl>

==The Script==
<lsl>
// ********************************************************************
//
// Menu Display Script
//
// Menu command format
// string = menuname ~ menuparent | display navigate? TRUE/FALSE | menuMaintitle~subtitle1~subtitle2~subtitle3 | button1~button2~button3 {| fixedbutton1~fixedbutton2~fixedbutton3 optional}
// key = menuuser key
//
//
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]
// menusActive [menuchannel, menuhandle, time, page]
//
// by SimonT Quinnell
//
// ********************************************************************

// ********************************************************************
// CONSTANTS
// ********************************************************************

// Link Commands
integer LINK_MENU_DISPLAY = 300;
integer LINK_MENU_CLOSE = 310;
integer LINK_MENU_RETURN = 320;
integer LINK_MENU_TIMEOUT = 330;

// Main Menu Details
string BACK = "<<";
string FOWARD = ">>";
list MENU_NAVIGATE_BUTTONS = [ " ", "Back", "Exit"];
float MENU_TIMEOUT_CHECK = 10.0;
integer MENU_TIMEOUT = 120;
integer MAX_TEXT = 510;

integer STRIDE_DESCRIPTION = 8;
integer STRIDE_ACTIVE = 4;
integer DEBUG = FALSE;

// ********************************************************************
// Variables
// ********************************************************************

list menusDescription;
list menusActive;

// ********************************************************************
// Functions - General
// ********************************************************************

debug(string debug)
{
if (DEBUG) llWhisper(0,"DEBUG:"+llGetScriptName()+":"+debug+" : Free("+(string)llGetFreeMemory()+")");
}

integer string2Bool (string test)
{
if (test == "TRUE") return TRUE;
else return FALSE;
}

// ********************************************************************
// Functions - Menu Helpers
// ********************************************************************

integer NewChannel()
{ // generates unique channel number
integer channel;

do channel = -(llRound(llFrand(999999)) + 99999);
while (~llListFindList(menusDescription, [channel]));

return channel;
}

string CheckTitleLength(string title)
{
if (llStringLength(title) > MAX_TEXT) title = llGetSubString(title, 0, MAX_TEXT-1);

return title;
}

list FillMenu(list buttons)
{ //adds empty buttons until the list length is multiple of 3, to max of 12
integer i;
list listButtons;

for(i=0;i<llGetListLength(buttons);i++)
{
string name = llList2String(buttons,i);
if (llStringLength(name) > 24) name = llGetSubString(name, 0, 23);
listButtons = listButtons + [name];
}

while (llGetListLength(listButtons) != 3 && llGetListLength(listButtons) != 6 && llGetListLength(listButtons) != 9 && llGetListLength(listButtons) < 12)
{
listButtons = listButtons + [" "];
}

buttons = llList2List(listButtons, 9, 11);
buttons = buttons + llList2List(listButtons, 6, 8);
buttons = buttons + llList2List(listButtons, 3, 5);
buttons = buttons + llList2List(listButtons, 0, 2);

return buttons;
}

RemoveUser(key id)
{
integer index_id = llListFindList(menusDescription, [id]);

while (~index_id)
{
integer channel = llList2Integer(menusDescription, index_id-1);
RemoveMenu(channel, FALSE);
}
}

RemoveMenu(integer channel, integer echo)
{
integer index = llListFindList(menusDescription, [channel]);

if (index != -1)
{
key id = llList2Key(menusDescription, index+1);
menusDescription = llDeleteSubList(menusDescription, index, index + STRIDE_DESCRIPTION -1);
RemoveListen(channel);

if (echo) llMessageLinked(LINK_THIS, LINK_MENU_TIMEOUT, "Timeout", id);
}
}

RemoveListen(integer channel)
{
integer index = llListFindList(menusActive, [channel]);
if (index != -1)
{
llListenRemove(llList2Integer(menusActive, index + 1));
menusActive = llDeleteSubList(menusActive, index, index + STRIDE_ACTIVE - 1);
}
}

// ********************************************************************
// Functions - Menu Main
// ********************************************************************

NewMenu(string message, integer senderNum, key id)
{ // Setup New Menu
// menusDescription [menuchannel, key, menu & parent, return link, nav?, titles, buttons, fixed buttons]

list temp = llParseString2List(message, ["|"], []);
integer channel = NewChannel();

if (llGetListLength(temp) > 2)
{
menusDescription = [channel, id, llList2String(temp, 0), senderNum, string2Bool(llList2String(temp, 1)), llList2String(temp, 2), llList2String(temp, 3), llList2String(temp, 4)] + menusDescription;

DisplayMenu(id, channel, 0);
}
else llOwnerSay ("ERROR: Dialog Script. Incorrect menu format");
}

DisplayMenu(key id, integer channel, integer page)
{
string menuTitle;
list menuSubTitles;
list menuButtonsAll;
list menuButtons;
list menuNavigateButtons;
list menuFixedButtons;

integer max = 12;

// Populate values
integer index = llListFindList(menusDescription, [channel]);
menuButtonsAll = llParseString2List(llList2String(menusDescription, index+6), ["~"], []);
if (llList2String(menusDescription, index+7) != "") menuFixedButtons = llParseString2List(llList2String(menusDescription, index+7), ["~"], []);

// Set up the menu buttons
if (llList2Integer(menusDescription, index+4)) menuNavigateButtons= MENU_NAVIGATE_BUTTONS;
else if (llGetListLength(menuButtonsAll) > (max-llGetListLength(menuFixedButtons))) menuNavigateButtons = [" ", " ", " "];

// FIXME: add sanity check for menu page

max = max - llGetListLength(menuFixedButtons) - llGetListLength(menuNavigateButtons);
integer start = page*max;
integer stop = (page+1)*max - 1;
menuButtons = FillMenu(menuFixedButtons + llList2List(menuButtonsAll, start, stop));

// Generate the title
list tempTitle = llParseString2List(llList2String(menusDescription, index+5), ["~"], []);
menuTitle = llList2String(tempTitle,0);
if (llGetListLength(tempTitle) > 1) menuSubTitles = llList2List(tempTitle, 1, -1);
if (llGetListLength(menuSubTitles) > 0)
{
integer i;
for(i=start;i<(stop+1);++i)
{
if (llList2String(menuSubTitles, i) != "") menuTitle += "\n"+llList2String(menuSubTitles, i);
}
}
menuTitle = CheckTitleLength(menuTitle);

// Add navigate buttons if necessary
if (page > 0) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [BACK], 0, 0);
if (llGetListLength(menuButtonsAll) > (page+1)*max) menuNavigateButtons = llListReplaceList(menuNavigateButtons, [FOWARD], 2, 2);

// Set up listen and add the row details
integer menuHandle = llListen(channel, "", id, "");
menusActive = [channel, menuHandle, llGetUnixTime(), page] + menusActive;

llSetTimerEvent(MENU_TIMEOUT_CHECK);

// Display menu
llDialog(id, menuTitle, menuNavigateButtons + menuButtons, channel);
}

// ********************************************************************
// Event Handlers
// ********************************************************************

default
{
listen(integer channel, string name, key id, string message)
{
if (message == BACK)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)-1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == FOWARD)
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3)+1;
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else if (message == " ")
{
integer index = llListFindList(menusActive, [channel]);
integer page = llList2Integer(menusActive, index+3);
RemoveListen(channel);
DisplayMenu(id, channel, page);
}
else
{
integer index = llListFindList(menusDescription, [channel]);
llMessageLinked(llList2Integer(menusDescription, index+3), LINK_MENU_RETURN, llList2String(menusDescription, index+2)+"|"+message, id);
RemoveMenu(channel, FALSE);
}
}

link_message(integer senderNum, integer num, string message, key id)
{
if (num == LINK_MENU_DISPLAY) NewMenu(message, senderNum, id);
else if (num == LINK_MENU_CLOSE) RemoveUser(id);
}

timer()
{ // Check through timers and close if necessary
integer i;
list toRemove;
integer currentTime = llGetUnixTime();
integer length = llGetListLength(menusActive);

for(i=0;i<length;i+=STRIDE_ACTIVE)
{
if (currentTime - llList2Integer(menusActive, i+2) > MENU_TIMEOUT) toRemove = [llList2Integer(menusActive, i)] + toRemove;
}

length = llGetListLength(toRemove);
if (length > 0)
{
for(i=0;i<length;i++)
{
RemoveMenu(llList2Integer(toRemove, i), TRUE);
}
}
}
}

</lsl>

==See also==
*[[ Script_Library | Script Library ]]