input

From MapToolDoc
Jump to: navigation, search

input() Function

Introduced in version 1.3b42

Allows the user to input several values at once via a modal dialog. The function takes one or more string arguments, one for each variable requiring assignment. Execution of the calling macro is paused while waiting for the user to interact with the input dialog.

Returns 1 if the user clicked the OK button, or 0 if they clicked Cancel (or hit Esc to exit the dialog). If input() returns 0, no variable assignments were made.

Note that there are no built-in mechanisms for input validation for TEXT input types.

Usage

  1. input(inputField, ..., ...)

Parameters

  • inputField - A string containing various 'sub-parameters' that set the type and options of each inputField; requires at least one inputField but will accept a reasonably large amount. The inputFields can be set using a series of individual parameters, or as one or more String Lists. If a String List is used, the delimiter must be "##". This allows, among other things, for more dynamic input menus, with the number and type of input requests customized to the circumstances. Normally, each line is described by a string, wrapped in quotes, and the strings are separated by commas. The input function looks for unquoted commas to determine which strings are intended to be read as line entries. The function, however, can also recognize ## as a denotation of such a line break. Since this denotation can be surrounded by quotes more easily, it is possible to have a single string, wrapped in quotes, describe multiple input requests. The strings can be compiled in any number of ways: for instance using listAppend() and setting the delimiter to "##". Strings involving these ##'s can be intermixed with other standard strings. See the example below.

You declare the 'sub-parameters' of each inputField in the following manner:

  • "variableName|value|prompt|inputType|options"

Sub-Parameters

  • variableName - The name of the variable to which the value of the inputField is assigned.
  • value - The initial value present in the dialog box. If not present, it defaults to 0. In some cases you use a special syntax to indicate multiple values.
  • prompt - The prompt displayed to the user to indicate the meaning of the inputField.
  • inputType - Describes the type of input control presented to the user. Each of the different types are described in more detail below.
  • options - Contains one or more options that control the appearance of the input control or how information entered in the control is treated; options are given in the format option=value and separated by a space.

Input Types and Options

TEXT

Creates a text box containing the value or 0. The contents typed in the box are assigned to the variable, and there is no limit to the length of the data that can be entered.

TEXT Options
  • WIDTH=nnn - Sets the width of the text box; defaults to WIDTH=16.
  • SPAN=TRUE - Causes the prompt to be hidden and allows the inputField to span the width of the dialog; defaults to SPAN=FALSE. If hidden the prompt text is used as a tooltip.

LIST

Creates a drop-down list of choices. The variable is assigned the index (starting at 0) of the item that was selected. The value sub-parameter is a comma delimited list of the values that can be chosen.

LIST Options
  • SELECT=nnn - Sets the index of the initial selection in the drop-down list (the first item is number 0); defaults to SELECT=0.
  • VALUE=STRING - The variable is assigned the string contents of the selected item instead of the index; defaults to VALUE=NUMBER.
  • ICON=TRUE - If the string for the item contains a space and then an image asset URL, the image is displayed in the entry; defaults to ICON=FALSE. Text before the URL is used for the entry's text. The getTokenImage() and getStateImage() functions can be used to obtain asset URLs.
  • ICONSIZE=nnn - The size the icons; defaults to ICONSIZE=50. All icons are stretched to fit a square this size. If the asset URL points to an image that is not square, some distortion will occur.
  • TEXT=FALSE - No text is shown in the list entries next to the icons; defaults to TEXT=TRUE, and is ignored if no icon is set.
  • SPAN=TRUE - Causes the prompt to be hidden and allows the inputField to span the width of the dialog; defaults to SPAN=FALSE. If hidden the prompt text is used as a tooltip.

CHECK

Creates a checkbox. The variable is assigned either 0 (unchecked) or 1 (checked).

CHECK Options
  • SPAN=TRUE - Causes the prompt to be hidden and allows the inputField to span the width of the dialog; defaults to SPAN=FALSE. If hidden the prompt text is used as a tooltip.

RADIO

Creates a group of radio buttons. This option works much like LIST, returning the index of the choice that was selected.

RADIO Options
  • ORIENT=H - Arranges the radio buttons horizontally on a single line; defaults to ORIENT=V.
  • SELECT=nnn - Sets the initially selected radio button (the first item is number 0); defaults to SELECT=0.
  • VALUE=STRING - The variable is assigned the string contents of the selected item instead of the index; defaults to VALUE=NUMBER.
  • SPAN=TRUE - Causes the prompt to be hidden and allows the inputField to span the width of the dialog; defaults to SPAN=FALSE. If hidden the prompt text is used as title placed in the border of the radio button group.

LABEL

Creates a static label. The variableName is ignored, and nothing is assigned to it.

LABEL Options
  • ICON=TRUE - If the string for the value contains a space and then an image asset URL, the image is displayed; defaults to ICON=FALSE.
  • ICONSIZE=nnn - The size the icon; defaults to ICONSIZE=50. The icon is stretched to fit a square this size. If the asset URL points to an image that is not square, some distortion will occur.
  • TEXT=FALSE - The value is not shown; defaults to TEXT=TRUE.
  • SPAN=TRUE - Causes the prompt to be hidden and allows the inputField to span the width of the dialog; defaults to SPAN=FALSE. If hidden the prompt text is used as a tooltip.

PROPS

Creates a bordered sub-area containing multiple text boxes, one for each entry in a String Property List stored in value. The variableName is assigned a new string property containing all the entries with their updated values.

PROPS Options
  • SETVARS=SUFFIXED - Makes a variable assignment for each of the sub-values, with an underscore appended to the name; defaults to SETVARS=NONE.
  • SETVARS=UNSUFFIXED - Makes variable assignments to unmodified variable names. SUFFIXED is usually preferred, unless you are not using variable names that match Token Properties or if you specifically intend to overwrite them.
  • SPAN=TRUE - Causes the prompt to be hidden and allows the inputField to span the width of the dialog; defaults to SPAN=FALSE. If hidden the prompt text is used as title placed in the border of the PROPS group.

TAB

Creates a tab for a tabbed dialog box. The variableName variable gets assigned a String Property List containing all the variable assignments made on this tab. Since some of the variables may be property strings themselves, the tab property string uses the non-default delimiter "##". When using tabs, the first inputField must be a TAB.

TAB Options
  • SELECT=TRUE - Causes this tab to be displayed when the dialog appears; defaults to SELECT=FALSE.

TAB Example

  1. [H: input(
  2.      "tab0 | Info || TAB", 
  3.      "Name ## Rank ## Serial number | 1,2,3 || LIST",
  4.      "tab1 | Abilities || TAB", 
  5.      "Strength ## Dexterity ## Wisdom"
  6. )]

Examples

1. A simple input() requesting 3 different text variables.

  1. [input("AtkBonus", "DmgBonus", "CombatAdvantage")]

Displays:

simple-input.jpg

Note that only the variableName is required to generate an input dialog - if that is all that is provided, input() assumes that each variableName will be assigned using a text field.

2. A more complex input, including LABEL, CHECK, and TEXT fields.

  1. [h:status=input(
  2.     "junkVar|"+powerClicked+"|Selected Power|LABEL",
  3.     "ComAdv|0|Combat Advantage|CHECK",
  4.     "MarkPenalty|0|Marked by an enemy other than your target|CHECK",
  5.     "TargetConcealed|0|Target has Concealment|CHECK",
  6.     "MiscBonus|0|Miscellaneous BONUSES to your attack roll",
  7.     "MiscPenalty|0|Miscellaneous PENALTIES to your attack roll",
  8.     "mdb|0|Miscellaneous BONUS to Damage")]
  9. [h:abort(status)]

Displays:

Input-checksntext.jpg

Recall that junkVar, as the variableName for a LABEL control, has no value assigned to it. In this example, we assume powerClicked is a variable that is passed in some fashion to the macro generating this input. It is incorporated using the standard method of concatenating a variable into a string ("string text"+variable+"more string text"). Finally, observe that the variable status is assigned the value returned by the input() function, and the abort() function is called using the value of status. In this fashion, the macro is terminated if the user clicks the Cancel button or hits the ESC key.

3. An input showing several LIST boxes, as well as the VALUE=STRING option.

  1. [h:status=input(
  2.     "targetNum|"+imgList+"|Select Target|LIST|SELECT=0 ICON=TRUE ICONSIZE=30",
  3.     "feature|Hunter's Quarry, Sneak Attack, Warlock's Curse|Type of Striker Damage|LIST|SELECT=0 VALUE=STRING",
  4.     "CQSDice|1d6,1d8,2d6,2d8,3d6,3d8|Curse, Quarry, or Sneak Attack Dice|LIST|SELECT=0 VALUE=STRING",
  5.     "critAttack|0|Was the attack a critical hit?|CHECK"
  6. )]

Displays:

Input-lists.jpg

Note that the prompt section for each list contains a list of items, or a variable containing a String List (e.g., the variable imgList). In the first list, the ICON and ICONSIZE options are set, because that list contains image asset URLs for token images. In the second two lists, the VALUE=STRING option is set so that the value in the corresponding variable is the actual string (e.g. "Sneak Attack") rather than the index of the list item.

4. An input using the "##" delimiter trick.

  1. [h:inptext=""]
  2. [h:num=1]
  3.  
  4. [h,foreach(entry,"SPD1,SPD2,SPD3,SPD4,SPD5,SPD6,SPD7,SPD8,SPD9"),code:{
  5.   [if(num<=CMSL),code:{
  6.     [inptext=listAppend(inptext,entry+"|"+eval(entry)+"|Level "+num,"##")]
  7.   }]
  8.   [num=num+1]
  9. }]
  10.  
  11. [h:screen0=input(
  12.   "junkvar|Include any bonus spells from high Wisdom|Enter your Cleric spells per day|LABEL",
  13.   inptext
  14. )]

In this example, variables SPD1-SPD9 and CMSL are called earlier from a token and represent spells per day for spell levels 1-9 and the maximum spell level accessible by the token at the moment for the class in question. The macro is intended to allow manual changing of the number of spells per day for the token, but the input is cleaned up and prevents complications by not allowing for inputs to spell levels beyond what is available. The first line in the input is a standard string, followed by a comma. The second is a "##"-containing string set by the [foreach():] function above, which will contain just the number of input requests, separated by ##'s, needed in the situation.

5. A much more elegant and way more sophisticated way to example no. 4 is aliasmaks(?) strformat/json.evaluate trick If you are in need of an input() function where the number of inputs can vary like in ex. 4, you can also opt to use a json array and use json.evaluate(). This will look as follows:

  1. <!-- Define local vars -->
  2. [H: Strength = 12]
  3. [H: Toughness = 14]
  4. [H: Hitpoints = 20]
  5. [H: statList = "Strength, Toughness, Hitpoints"]
  6. [H: inputStr = "[]"]
  7.  
  8. <!-- Build input form simple -->
  9. [H: inputStr = json.append(inputStr,"junk|<html><b>A simple example</b></html>|-|LABEL|SPAN=TRUE")]
  10. [H: inputStr = json.append(inputStr, "Strength|"+Strength+"|Enter Strenght value")]
  11. [H: inputStr = json.append(inputStr, "Toughness|"+Toughness+"|Enter Toughness value")]
  12. [H: inputStr = json.append(inputStr, "Hitpoints|"+Hitpoints+"|Entere number of Hitpoints")]
  13.  
  14. <!-- Build input form advanced -->
  15. [H: inputStr = json.append(inputStr,"junk|<html><b>A complex example</b></html>|-|LABEL|SPAN=TRUE")]
  16. [H, foreach(stat,statList): inputStr = json.append(inputStr,strformat("%{stat}|%s|<html><b><font color=blue>Enter %{stat} value</b></font></html>|TEXT|WIDTH=6", eval(stat)))]
  17.  
  18. <!-- put local variables in input form -->
  19. [H: inputStr = json.evaluate(inputStr)]
  20.  
  21. <!-- get user input -->
  22. [H: hasInput = input(json.toList(inputStr,"##"))]

6. An input using aliasmask's no-zero-trick Usually, when you leave a value blank for input it puts that annoying 0 in it's place. Here's one way to avoid that. The only limitation, I suppose is that the variable name is visible as the prompt (and the variable name/contents must be StrProp-compatible).

(thanks to aliasmask for the trick and biodude for stating the limits.)

  1. [h:abort(input(
  2. 	"junk|<html><b>Enter player names. These should match the user names:<br><font color='red'>"+getAllPlayerNames()+"</font></html>|-|LABEL|SPAN=TRUE",
  3. 	"Enter Player Names|player0=;player1=;player2=||PROPS|SPAN=TRUE SETVARS=UNSUFFIXED"
  4. ))]

7. An input using Wolph42's tooltip-trick It is possible to use HTML mark up by just adding HTML tags around the input text. This makes it possible to use e.g. bold and italic tags, but also the span tag. This span tag allows tooltips to be added anywhere via its title attribute. Here's an example:

  1. [H: hasInput = input(
  2. "junk|<html>Some title text</html>|<html>here comes the tooltip text</html>|LABEL|SPAN=TRUE",
  3. "someVariable|0|<html><span title='<html>This text will be shown as a tooltip if you hover with your mouse over the text</html>'>Do you wish to turn the <b>setting</b> on?</span></html>|CHECK"
  4. )]

Another interesting trick is adding pictures to the input. This example show the image of the selected token:

  1. [h:input(
  2. 	"junk|<html><b>Show picture of token<br></html>|-|LABEL|SPAN=TRUE",
  3. 	"junk|<html><img src='"+getTokenImage(60)+"'></img></html>|-|LABEL|SPAN=TRUE"
  4. )]
b89 (b90 also ?): input() no longer eats the colon ':'. And as the getTokenImage() will return 'asset://....' this will fail.
It might get fixed in b90 but if not there is a workaround. Just change the last line into:
  1. "junk|<html><img src='"+replace(getTokenImage(), ":", "&#58;")+"' height=60 width=60></img></html>|-|LABEL|SPAN=TRUE"

If you really want to go full monty on the tooltip INSIDE the input, here's an example of what is possible (the wiki can't properly handle all the code here so it comes out a bit funky):

  1. [h:hasInput 	= input('
  2. 	someVariable|0|<html><span title="<html>
  3. 	This setting allows for more advanced use of the movement limiter. First off: <b>In order for this to work <i>Limit Movement</i> must be<br>
  4. 	set to a number other then 0(the actual number wont be used).</b> If you enter 0 here then this setting will be ignored and the movement<br>
  5. 	will be limited to what you have set in <i>Limit Movement</i>.<br>
  6. 	<br>
  7. 	<b>Example of how to use this setting:</b><br>
  8. 	Let say that all the tokens have a characteristic: <i>Dexterity</i> and the max amount of cells a token is allowed to move is 4 x <i>Dexterity</i>.<br>
  9. 	Then what you set here is: <font bgcolor=white color=gray>[r:4*Dexterity]</font> You can enter any piece of code in here, as long as the output of that code<br>
  10. 	results in a number. The token that is moved will be the currentToken for this code! Note that if multiple tokens are moved, the first selected<br>
  11. 	token will be the currentToken.<br>
  12. 	<br>
  13. 	<b>Adding states and changing the output message</b>.<br>
  14. 	You can take this code even a step further and also change the output to the chat. This can be done by setting the predefined message variable to<br>
  15. 	something else. Here you can make use of other predefined variables as well. The default message is:<br>
  16. 	<font bgcolor=white color=gray>[h:message	= &quot;You moved %{tok} %{usedMove} cells. The maximum allowed movement is %{limitMovement} cells.&quot;]</font><br>
  17. 	(HTML make up can be used, but is removed from this example cause it does not show in a tool-tip) Here:<br>
  18. 	<font bgcolor=white color=gray>message</font> is the actual message to the ouput. Note that strformat is used.<br>
  19. 	<font bgcolor=white color=gray>tok</font> is the name of the selected token<br>
  20. 	<font bgcolor=white color=gray>usedMove</font> is the amount of cells the token moved<br>
  21. 	<font bgcolor=white color=gray>limitMovement</font> is the max amount the token is allowed to move.<br>
  22. 	These you can use to create your own message type <b>as long as the resulting output is a number</b>. E.g.:<br>
  23. 	<font bgcolor=white color=gray>
  24. 	[r,if(getState(&quot;Dead&quot;) &#124;&#124; getState(&quot;Incapacitated&quot;), CODE:{
  25. 		[r:0]	
  26. 		[h:message	= &quot;%{tok} is incapacitated and cannot move&quot;]
  27. 	};{
  28. 		[r:4*Dexterity]
  29. 	}]
  30. 	</font></html>">
  31. 	Enter code here (hover over this for more info)
  32. 	</html></span></html>
  33. ')]

For this to work I had to replace the quotes (") and the OR bars (||) by there ASCII representation. This is the result:

Advanced Example Tooltip.jpg

Note that this technique isn't perfect, because HTML tags inside the title may be interpreted as ending tags in the outer <html> block as the input() function is merely processing text and not looking at the content.

8. Images in Input It requires a bit of fiddling, but because HTML is allowed it's possible to add images to your input functions as well (besides the LIST trick described above). This can simply be done with the <html><img> tags. However the preset image size, e.g. from getTokenHandout(90) which retrieves the asset ID of the token handout and presets it to a max width or height (whichever is bigger) of 90 pixels, does work for LABEL but not for the rest! Example use:

  1. [h:input("junk|<html><img src='"+getTokenHandout(90)+"'></img></html>|-|LABEL|SPAN=TRUE")]
b89 (and possibly b90): this will not work anymore.
As a workaround, use this:
  1. [h:input("junk|<html><img src='"+replace(getTokenHandout(), ":", "&#58;")+"' height=90 width=90></img></html>|-|LABEL|SPAN=TRUE")]

LABEL Picture.jpg

For other uses, e.g. choosing a picture from a RADIO option, you will need to limit the image sizes using the image tags:

  1. [h:me = getSelected()]
  2. [h, token(me),CODE:{
  3. 	[image		= "<html><table><tr><td height='100'><img width=90 height=90 src='"+getTokenImage()+"'></img>	</td></tr><tr><td align='center'>Image</td>	</tr></table></html>"]
  4. 	[portrait	= "<html><table><tr><td height='100'><img width=90 height=90 src='"+getTokenPortrait()+"'></img>	</td></tr><tr><td align='center'>Portrait</td>	</tr></table></html>"]
  5. 	[handout	= "<html><table><tr><td height='100'><img width=90 height=90 src='"+getTokenHandout()+"'></img>	</td></tr><tr><td align='center'>Handout</td>	</tr></table></html>"]
  6. }] 
  7.  
  8. [H: abort(input(
  9. 	"junk|<html><b>Choose picture to show to players:<br></html>|-|LABEL|SPAN=TRUE",
  10. 	"picChoice|"+image+","+portrait+","+handout+"|Which picture|RADIO|ORIENT=H SELECT=2",
  11. 	"picSize|100|Size of picture (px)"
  12. ))]
  13.  
  14. [r,token(me), if(picChoice == 0): "<img src='"+getTokenImage(picSize)+"'></img>"]
  15. [r,token(me), if(picChoice == 1): "<img src='"+getTokenPortrait(picSize)+"'></img>"]
  16. [r,token(me), if(picChoice == 2): "<img src='"+getTokenHandout(picSize)+"'></img>"]

RADIO Picture.jpg

9. Using PROPS

  1. [h: abort(input("resultVars|strength=0;toughness=0;willpower=0|Enter values|PROPS|SPAN=TRUE SETVARS=UNSUFFIXED"))]
  2. [r:resultVars]