Difference between revisions of "Select"

From Hercules Wiki
Jump to: navigation, search
(Created page with "== Syntax == *'''select'''("<option>"{,"<option>",...}); *'''select'''("<op tion>{:<option>:<option>}"); * '''prompt'''("<option>"{,"<option>",...}); * '''prompt'''("<...")
 

Latest revision as of 09:22, 9 June 2013

Syntax

  • select("<option>"{,"<option>",...});
  • select("<op tion>{:<option>:<option>}");
  • prompt("<option>"{,"<option>",...});
  • prompt("<option>{:<option>:<option>}");

Description

This function is a handy replacement for 'menu' for some specific cases where you don't want a complex label structure - like, for example, asking simple yes-no questions. It will return the number of menu option picked, starting with 1. Like 'menu', it will also set the variable @menu to contain the option the user picked.

And like 'menu', the selected option is consistent with grouped options and empty options.

'prompt' works almost the same as 'select', except that when a character clicks the Cancel button, this function will return 255 instead.

Examples

if(select("Yes:No") == 1) mes "You said yes, I know.";

select("21","22","23");
set .@opt,20+@menu;

set .@choice$,"Apple:Banana:Lemon";
select(.@choice$);
explode(.@option$,.@choice$,":");
mes "You have chosen "+.@option$[@menu-1];