"14"\
\
@@ -3096,7 +3096,7 @@ Returns a number than is between \
@@ -200,11 +200,11 @@ addAllNPCsToInitiative.summary = \
\
\
-addAllPCsToInitiative.description = Adds all the PC tokens on the current map to the initiative panel .
+addAllPCsToInitiative.description = Adds all the PC tokens on the current map to the initiative panel .
addAllPCsToInitiative.summary = \
\
\
- \ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\Adds all the NPC tokens on the current map to the initiative panel. This function returns the number of tokens that were added to the initiative panel.\
-
\
This function will not assign any initiative value to the tokens, you can use the setInitiative() function\
+
Adds all the NPC tokens on the current map to the initiative panel. This function returns the number of tokens that were added to the initiative panel.\
+
\
This function will not assign any initiative value to the tokens, you can use the setInitiative() function\
\ @@ -239,7 +239,7 @@ to set the initiative value of tokens.
\
\
\
@@ -249,11 +249,11 @@ addAllPCsToInitiative.summary = \
\
\
-addAllToInitiative.description = Adds all of the tokens on the current map to the initiative panel .
+addAllToInitiative.description = Adds all of the tokens on the current map to the initiative panel .
addAllToInitiative.summary = \
\
\
- \ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\Adds all the PC tokens on the current map to the initiative panel. This function returns the number of tokens that were added to the initiative panel.\
-
\
This function will not assign any initiative value to the tokens, you can use the setInitiative()\
+
Adds all the PC tokens on the current map to the initiative panel. This function returns the number of tokens that were added to the initiative panel.\
+
\
This function will not assign any initiative value to the tokens, you can use the setInitiative()\
\ @@ -283,7 +283,7 @@ function to set the initiative value of tokens.
\
\
\
@@ -293,11 +293,11 @@ addAllToInitiative.summary = \
\
\
+\
\
- \ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\Adds all of the tokens on the current map to the initiative panel. This function returns the number of tokens that were added to the initiative panel.\
-\
@@ -337,7 +337,7 @@ addTableEntry.summary = \
\
\
-addToInitiative.description = Adds the Current Token to the initiative panel .
+addToInitiative.description = Adds the Current Token to the initiative panel .
addToInitiative.summary = \
This function will not assign any initiative value to the tokens, you can use the setInitiative()\
+
Adds all of the tokens on the current map to the initiative panel. This function returns the number of tokens that were added to the initiative panel.\
+
\
This function will not assign any initiative value to the tokens, you can use the setInitiative()\
\
@@ -337,7 +337,7 @@ addTableEntry.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.0.1\
@@ -384,7 +384,7 @@ addTableEntry(tableName,rangeStart,rangeEnd,result,imageId)\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\\
\
Version Changes\
@@ -1067,7 +1067,7 @@ bringDrawingToFront.summary = \
\
\
-bringToFront.description = Adjust the z order (or draw order) of the Token so that is is drawn after all other Tokens on the same Map Layer , this has the effect of making the Token appear to be in front of the other Tokens as it will obscure other Tokens on the same Map Layer in the same location.
+bringToFront.description = Adjust the z order (or draw order) of the Token so that is is drawn after all other Tokens on the same Map Layer , this has the effect of making the Token appear to be in front of the other Tokens as it will obscure other Tokens on the same Map Layer in the same location.
bringToFront.summary = \
\
@@ -392,7 +392,7 @@ addToInitiative.summary = \
\
addToInitiative() Function\
\
-
\
Adds the Current Token to the initiative panel. Additional parameters allow you to specify the token and an initiative value.
\
+ Adds the Current Token to the initiative panel. Additional parameters allow you to specify the token and an initiative value.
\
\ Usage\
\ @@ -409,14 +409,14 @@ addToInitiative(AllowDuplicates, value, id, mapname)\- \
AllowDuplicates- If false (default) then will not add the token if it is already in the initiative list. If true (1) an additional entry will be added to the initiative list (so there could be multiple initiative entries for the same token). \
value- The initiative value to set. If included, the initiative will be set even if the token is already on the initiative list and duplicates are not allowed. \
- id- The tokenidof the token to add to the initiative. Defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidof the token to add to the initiative. Defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
return- Returns 1 if added to the initiative, 0 if did not. \
\ Example\
\ -The following example shows how to add a Current Token to the initiative panel, set its initiative and then sort the initiative panel. Normally you would not sort the initiative panel every time you add a Current Token but its done here to show you how it is done.\
+
\
isNumber()\
abort()\
\
- macro.catchAssert\
+ macro.catchAssert\
The following example shows how to add a Current Token to the initiative panel, set its initiative and then sort the initiative panel. Normally you would not sort the initiative panel every time you add a Current Token but its done here to show you how it is done.\
\
@@ -631,7 +631,7 @@ Since 1.5.0 you can change that behaviour by using macro.catchAssert.[h: addToInitiative()]\
[h: setInitiative(1d20)]\
[h: sortInitiative()]\
Version Changes\
@@ -1067,7 +1067,7 @@ bringDrawingToFront.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.1.7\
@@ -1103,7 +1103,7 @@ bringDrawingToFront.summary = \
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\\
\
\
@@ -1112,7 +1112,7 @@ bringToFront.summary = \
bringToFront() Function\
\
\
@@ -1173,7 +1173,7 @@ broadcast.summary = \
\
\
-clearLights.description = Turns off all of the light sources for the Current Token .
+clearLights.description = Turns off all of the light sources for the Current Token .
clearLights.summary = \
• Introduced in version 1.3b48
\
- Adjust the z order (or draw order) of the Token so that is is drawn after all other Tokens on the same Map Layer, this has the effect of making the Token appear to be in front of the other Tokens as it will obscure other Tokens on the same Map Layer in the same location.
\
+ Adjust the z order (or draw order) of the Token so that is is drawn after all other Tokens on the same Map Layer, this has the effect of making the Token appear to be in front of the other Tokens as it will obscure other Tokens on the same Map Layer in the same location.
\
\ Usage\
\ @@ -1125,7 +1125,7 @@ bringToFront(id, mapname)\ Parameter\ \- \
-
id- The tokenidor name of the token to effect, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidor name of the token to effect, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\
@@ -1173,7 +1173,7 @@ broadcast.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b77\
@@ -1271,7 +1271,7 @@ canSeeToken.summary = \
canSeeToken() Function\
\
• Introduced in version 1.3b77\
- Returns a json array of the points visible on the target token from the source token as an enumerated list. Default source is Current Token. The enumerated list will contain zero to five of the following values:\
+ Returns a json array of the points visible on the target token from the source token as an enumerated list. Default source is Current Token. The enumerated list will contain zero to five of the following values:\
- TOP_RIGHT
- BOTTOM_RIGHT
- TOP_LEFT
- BOTTOM_LEFT
- CENTER
\
When a token is not visible, an empty json array is returned: '[]'\
\
@@ -1471,7 +1471,7 @@ Returns -1.
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\Returns a json array of the points visible on the target token from the source token as an enumerated list. Default source is Current Token. The enumerated list will contain zero to five of the following values:\
\
- TOP_RIGHT
- BOTTOM_RIGHT
- TOP_LEFT
- BOTTOM_LEFT
- CENTER
\ @@ -1471,7 +1471,7 @@ Returns -1.
\
\
@@ -2907,7 +2907,7 @@ drawVBL.summary = \
\
\
@@ -1480,7 +1480,7 @@ clearLights.summary = \
clearLights() Function\
\
\
@@ -1586,7 +1586,7 @@ clearTable.summary = \
\
\
-closeDialog.description = Closes the specified macro dialog that was previously created using [ dialog():] .
+closeDialog.description = Closes the specified macro dialog that was previously created using [ dialog():] .
closeDialog.summary = \
• Introduced in version 1.3b48
\
- Turns off all of the light sources for the Current Token.
\
+ Turns off all of the light sources for the Current Token.
\
\ Usage\
\ @@ -1493,7 +1493,7 @@ clearLights(id, mapname)\ Parameters\ \- \
-
id- The tokenidof the token for which to turn off all light sources, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidof the token for which to turn off all light sources, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\
@@ -1586,7 +1586,7 @@ clearTable.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.0.1\
@@ -1617,7 +1617,7 @@ clearTable.summary = \
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\\
\
\
@@ -1626,12 +1626,12 @@ closeDialog.summary = \
closeDialog() Function\
\
\
• Introduced in version 1.3b49
\
- Closes the specified macro dialog that was previously created using [ dialog():]. If the\
-
\
dialog is not open then the function has no effect.\ -
The most common use for this function is closing a dialog based from a macro that is run when clicking on a link or button for the\ -dialog that has no close button.\ +
Closes the specified macro dialog that was previously created using [ dialog():]. If the\
+
\
+NOTE In later versions of maptool (tested in b74) this works only for dialogs opened with [dialog():]. Frames cant be closed with this. But there is a new analog function available for that, too. See closeFrame()dialog is not open then the function has no effect.\ +
The most common use for this function is closing a dialog based from a macro that is run when clicking on a link or button for the\ +dialog that has no close button.\
\ -NOTE In later versions of maptool (tested in b74) this works only for dialogs opened with [dialog():]. Frames cant be closed with this. But there is a new analog function available for that, too. See closeFrame()\ Usage\
\ @@ -1645,8 +1645,8 @@ closeDialog.summary = \\
\
- [h: closeDialog("CharacterSheet")]\
Assuming a dialog called "Name Entry" has been created without the input flag but containing a form. In the macro called when the\ -form is submitted you can use the following logic to check that the "name" field is not blank and close the dialog.\ +
Assuming a dialog called "Name Entry" has been created without the input flag but containing a form. In the macro called when the\ +form is submitted you can use the following logic to check that the "name" field is not blank and close the dialog.\
\\
\
-closeFrame.description = Closes the specified macro frame that was previously created using [frame():] .
+closeFrame.description = Closes the specified macro frame that was previously created using [frame():] .
closeFrame.summary = \
[h, if(listGet(macro.args, "name")), code: {\
@@ -1660,7 +1660,7 @@ form is submitted you can use the following logic to check that the "name" field
\
\
@@ -2747,7 +2747,7 @@ drawMBL.summary = \
\
\
@@ -1669,12 +1669,12 @@ closeFrame.summary = \
closeFrame() Function\
\
\
-closeOverlay.description = Closes/deregisters the specified overlay that was previously created using [overlay():] .
+closeOverlay.description = Closes/deregisters the specified overlay that was previously created using [overlay():] .
closeOverlay.summary = \
• Introduced in version 1.3b70
\
- Closes the specified macro frame that was previously created using [frame():]. If the\
+
\
Closes the specified macro frame that was previously created using [frame():]. If the\
\
+NOTE this function can not close dialogs opened with [dialog():]. Use closeDialog() for that.frame is not open then the function has no effect.\
The most common use for this function is closing a frame based from a macro that is run when clicking on a link or button for the\ frame that has no close button.\
\ -NOTE this function can not close dialogs opened with [dialog():]. Use closeDialog() for that.\ Usage\
\ @@ -1685,7 +1685,7 @@ frame that has no close button.\\
\
\
@@ -1694,7 +1694,7 @@ closeOverlay.summary = \
closeOverlay() Function\
\
\
-deleteStrProp.description = Returns a copy of the string property list with the specified key removed.
+deleteStrProp.description = Returns a copy of the string property list with the specified key removed.
deleteStrProp.summary = \
• Introduced in version 1.7.0
\
- Closes/deregisters the specified overlay that was previously created using [overlay():]. If the overlay is not registered then the function has no effect.\
+ \
Usage\
@@ -1752,7 +1752,7 @@ copyMap.summary = \
\
\
-copyToken.description = Creates one or more copies of a Token and returns the id of the created copy.
+copyToken.description = Creates one or more copies of a Token and returns the id of the created copy.
copyToken.summary = \
Closes/deregisters the specified overlay that was previously created using [overlay():]. If the overlay is not registered then the function has no effect.\
Note that while each connected client can hide any overlay from the
\
Window > Overlays menu, they still run in the background unless you use this function to close them.\
Usage\
@@ -1752,7 +1752,7 @@ copyMap.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.0.1\
@@ -1793,7 +1793,7 @@ copyTable.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -1815,7 +1815,7 @@ copyTable.summary = \
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\\
\
\
@@ -1825,11 +1825,11 @@ copyToken.summary = \
\
\
@@ -2368,7 +2368,7 @@ defineAudioSource(nickname, uri, preload, cycleCount, volume, start, stop)
\
\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b51
\
- Creates one or more copies of a Token and returns the id of the created copy. This function is used to copy Tokens into the current map, the Tokens you are making copies of can reside on any map. Note: prior to MapTool v1.5.7, making changes to the copies required special techniques to ensure the changes were kept. See copyToken legacy page.
\
+ Creates one or more copies of a Token and returns the id of the created copy. This function is used to copy Tokens into the current map, the Tokens you are making copies of can reside on any map. Note: prior to MapTool v1.5.7, making changes to the copies required special techniques to ensure the changes were kept. See copyToken legacy page.
\
\ Usage\
\ @@ -1847,38 +1847,38 @@ newId = copyToken(id, numCopies, fromMap, updates)\id - The id or name of the token to copy.numCopies - The number of copies to create, defaults to 1fromMap - The name of the map to copy from, defaults to the current map.updates - a JSON Object that contains updates to be made to the copied Tokens.updates - a JSON Object that contains updates to be made to the copied Tokens.You can use an empty string ("") for fromMap for the current map as of b54.\
The return type of this function is determined by the number of copies that you are making. If you are only creating a single\ -copy of the token then a string containing the Tokens id, if you are making more than one copy then a JSON Array\ -containing the Token ids of all the newly created Tokens is returned.\ +copy of the token then a string containing the Tokens id, if you are making more than one copy then a JSON Array\ +containing the Token ids of all the newly created Tokens is returned.\
\\ Updates parameter\
\ -updates is a JSON Object that can contain one or more of the following fields. Field names are case-sensitive.\
+
updates is a JSON Object that can contain one or more of the following fields. Field names are case-sensitive.\
- \
-
name- The name of the new Token. \
- label- The label for the new Token. \
- gmName- The GM name for the new Token. \
- layer- The layer for the new Token. By default, changing the layer of a new token will also change its shape. Tokens changed to theObjectorBackgroundlayer will become top-down tokens. For tokens moved to theTokenorHiddenlayer, MapTool will attempt to determine their shape based on their image. \
+ name- The name of the new Token. \
+ label- The label for the new Token. \
+ gmName- The GM name for the new Token. \
+ layer- The layer for the new Token. By default, changing the layer of a new token will also change its shape. Tokens changed to theObjectorBackgroundlayer will become top-down tokens. For tokens moved to theTokenorHiddenlayer, MapTool will attempt to determine their shape based on their image. \
forceShape- when the layer field is set, setting this tofalse(0) will disable the automatic change of shape. \
- x- The X Co-ordinate for the new Token. Default is0. \
- y- The Y Co-ordinate for the new Token. Default is0. \
+ x- The X Co-ordinate for the new Token. Default is0. \
+ y- The Y Co-ordinate for the new Token. Default is0. \
useDistance-1(true) or0(false). Determines if the "Distance Per Cell" measurement for the map is used for the x,y coordinates. Unused if neitherxnoryis specified. Default is false. Use1(true) for tokens that are not snap-to-grid and must be placed by pixel position instead of grid cell position. \
- facing- Sets the facing for the Token. If the Token is on the background or object layer this sets the rotation. \
- size- Sets the size of the Token. The list of sizes is dependent on the type of grid. \
+ facing- Sets the facing for the Token. If the Token is on the background or object layer this sets the rotation. \
+ size- Sets the size of the Token. The list of sizes is dependent on the type of grid. \
delta- Userelativetoinstead ofdeltastarting in 1.9.0.1(true) or0(false). Indicates whether the x,y coordinates are relative to the position of the original token. Added in 1.3b77. To be considered deprecated in 1.9.0 \
- relativeto- A string defining what thexandyparameters should be relative to. Can be"map"for absolute positioning,"source"for the token to be copied, or"current"for the Current Token. Defaults to"map". To be added in 1.9.0 \
+ relativeto- A string defining what thexandyparameters should be relative to. Can be"map"for absolute positioning,"source"for the token to be copied, or"current"for the Current Token. Defaults to"map". To be added in 1.9.0 \
tokenImage/tokenPortrait/tokenHandout- Changes the coresponding image. Value can be either an assetId or an image token name. Added in 1.3b77. \
The values for all of these fields are evaluated so all text within {} or [] goes through the standard macro processing. There is currently no way to modify the new token from inside these macro commands, however.\
When the name is not changed using the updates parameter, the new name for the token follows the naming method for cut and paste.\
-This function can copy Tokens in the token, hidden, object, and background layers. If you do not override the destination using the\
+This function can copy Tokens in the token, hidden, object, and background layers. If you do not override the destination using the\
layer field of updates then the new copies are made in the same layer as the source. Likewise if x and y are not specified then these locations are the same as the source.\
\
@@ -1942,7 +1942,7 @@ This function can copy \
The source token was configured as a Top Down token for this effect, otherwise the This example shows using the new This example shows using the new Make three copies of the currently selected token on the current map. Place the first copy two grid cells to the right of the Current Token.\
+ Make three copies of the currently selected token on the current map. Place the first copy two grid cells to the right of the Current Token.\
\
\
-countStrProp.description = Returns the number of keys in a string property list .
+countStrProp.description = Returns the number of keys in a string property list .
countStrProp.summary = \
\
- \
+ \
\
\
\
Tumbling Clones using Top-down Tokens\
@@ -1950,19 +1950,19 @@ This function can copy \
facing setting would produce a facing arrow\
-for Tokens on the token or hidden layers.\
+for Tokens on the token or hidden layers.\
relativeto parameter available in 1.9.0. Specifying "map" means all x,y coordinates are treated as absolute coordinates on the map. Specifying "source" places copied tokens relative to the position of the token that is beingc copied. Specifying "current" places copied tokens relative to the Current Token. x and y are measured in grid cells if useDistance is false (the default) or in pixels if true.\
+ relativeto parameter available in 1.9.0. Specifying "map" means all x,y coordinates are treated as absolute coordinates on the map. Specifying "source" places copied tokens relative to the position of the token that is beingc copied. Specifying "current" places copied tokens relative to the Current Token. x and y are measured in grid cells if useDistance is false (the default) or in pixels if true.\
\
\
- [h: x = 0]\
@@ -1982,7 +1982,7 @@ for Tokens
}" ]\
[h: copyToken(currentToken(), 3, "", updates)]
\
\
also\
@@ -2004,7 +2004,7 @@ for Tokens
\
\
\
-createMacro.description = Creates a macro button for the Current Token and returns the index of the newly created button.
+createMacro.description = Creates a macro button for the Current Token and returns the index of the newly created button.
createMacro.summary = \
\
@@ -2013,7 +2013,7 @@ countStrProp.summary = \
countStrProp() Function\
\
\
• Introduced in version 1.3b42
\
- Returns the number of keys in a string property list.
\
+ Returns the number of keys in a string property list.
\
\ Usage\
\ @@ -2071,12 +2071,12 @@ Returns a number than is between0 and 12, which is th
\ See Also\
\ -For another method of rolling dice, see Dice Expressions.
\
+ For another method of rolling dice, see Dice Expressions.
\
\
\
-currentToken.description = Returns the id of the Current Token .
+currentToken.description = Returns the id of the Current Token .
currentToken.summary = \
\
@@ -2085,7 +2085,7 @@ createMacro.summary = \
createMacro() Function\
\
\
• Introduced in version 1.3b48
\
- Creates a macro button for the Current Token and returns the index of the newly created button.
\
+ Creates a macro button for the Current Token and returns the index of the newly created button.
\
\ Usage\
\ @@ -2110,11 +2110,11 @@ createMacro(props, id, mapname)\- \
label- The label for the macro button. \
command- The command to run when the macro button is clicked, or the macro is called. \
- props- A String Property List or JSON Object containing the properties for the button.\ -applyToSelected- Should the macro be applied to the selected tokens.autoExecute- If the macro will be automatically executed when the button is clicked, acceptstrue(1) orfalse(0).color- The name of the color for the button.command- The command for the macro (only when using JSON version of function).fontColor- The name of the font color for the button.fontSize- The size of the font for the button.includeLabel- If the label will be output when the button is clicked. Acceptstrue(1) orfalse(0).group- The name of the group that the button belongs to.sortBy- The sort by value of the macro button.label- The label for the button.maxWidth- The maximum width of the button.minWidth- The minimum width of the button.playerEditable- Is the button player editable, acceptstrue(1) orfalse(0).tooltip- The tool tip for the macro button.compare- Takes a JSON Array which can contain one or more of the following keywords (only usable with JSON version of the function).\ +props- A String Property List or JSON Object containing the properties for the button.\ +applyToSelected- Should the macro be applied to the selected tokens.autoExecute- If the macro will be automatically executed when the button is clicked, acceptstrue(1) orfalse(0).color- The name of the color for the button.command- The command for the macro (only when using JSON version of function).fontColor- The name of the font color for the button.fontSize- The size of the font for the button.includeLabel- If the label will be output when the button is clicked. Acceptstrue(1) orfalse(0).group- The name of the group that the button belongs to.sortBy- The sort by value of the macro button.label- The label for the button.maxWidth- The maximum width of the button.minWidth- The minimum width of the button.playerEditable- Is the button player editable, acceptstrue(1) orfalse(0).tooltip- The tool tip for the macro button.compare- Takes a JSON Array which can contain one or more of the following keywords (only usable with JSON version of the function).\applyToSelected- Use the macro applyToSelected for common macro comparisons.autoExecute- Use the macro autoExec for common macro comparisons.command- Use the macro command for common macro comparisons.group- Use the macro group for common macro comparisons.includeLabel- Use the macro includeLabel for common macro comparisons.sortPrefix- Use the macro sortPrefix for common macro comparisons.
\
- delim- The delimiter used in the String Property List that is sent to thepropsparameter, defaults to";". If you are sending a JSON Object to thepropsparameter, and using theidparameter, you can set this to"json". \
- id- The tokenidof the token that the macro is created on.Note: This parameter can only be used in a Trusted Macro.
\
+ delim- The delimiter used in the String Property List that is sent to thepropsparameter, defaults to";". If you are sending a JSON Object to thepropsparameter, and using theidparameter, you can set this to"json". \
+ id- The tokenidof the token that the macro is created on.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ @@ -2130,7 +2130,7 @@ createMacro(props, id, mapname)\ "autoExecute=true;color=red;fontColor=white", ";") ]\
Will create the following buttons on the current token.\ -File:createMacros.png\ +File:createMacros.png\
\Note that if you want to provide a macro command in the command section, you will have issues with quotations as you cannot use double quotes " inside, so macro commands need to be with single ' quotes.\
\ @@ -2169,7 +2169,7 @@ createTable.summary = \ \\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.4.0.1
\
@@ -2211,7 +2211,7 @@ createTable(tableName, visible, accessible, imageId)\
\
\
\
@@ -2220,7 +2220,7 @@ currentToken.summary = \
currentToken() Function\
\
\
• Introduced in version 1.3b48
\
- Returns the id of the Current Token. In most cases this will return the same as getImpersonated() function. The difference is when it is called in a [token():] or after a call to the switchToken() function, in both these cases it will return the id of the token being operated on, while getImpersonated() will return the id of the impersonated token.
\
+ Returns the id of the Current Token. In most cases this will return the same as getImpersonated() function. The difference is when it is called in a [token():] or after a call to the switchToken() function, in both these cases it will return the id of the token being operated on, while getImpersonated() will return the id of the impersonated token.
\
\ Usage\
\ @@ -2235,7 +2235,7 @@ currentToken.summary = \\ Examples\
\ -Get the Token ID of the Current Token.\
+
Get the Token ID of the Current Token.\
\
[r:id = currentToken()]\ See Also\ @@ -2304,12 +2304,12 @@ d.summary = \ [h: listOfRolls = listAppend(listOfRolls, r)]\ }]\ You rolled [r: listSort(listOfRolls, "N-")] = [r: sum].
Rolls 5 times a d6 and returns these as sorted list as well as the total.\ -
- See also[count():], listAppend() and listSort().
- See also[count():], listAppend() and listSort().
\ See Also\
\ -For another method of rolling dice, see Dice Expressions.
\
+ For another method of rolling dice, see Dice Expressions.
\
- \
nickname- The nickname of the file. For example, "tense music" \
- uri- The URI/URL of the file. For example, http://www.mywebsite/mysong.mp3 or file:/C:/mysong.mp3 \
+ uri- The URI/URL of the file. For example, https://www.mywebsite/mysong.mp3 or file:/C:/mysong.mp3 \
preload- A string indicating if the audio should be pre-loaded or not. If set to "clip", preloads it as a clip. If set to "stream", preloads it as a stream. Any other string does not preload the audio source. \
cycleCount- Set the default number of times the audio should play. If set to -1, the file is played continuously. \
volume- Set the default volume the audio is to be played at. Can range from 0 to 1. \
@@ -2379,7 +2379,7 @@ defineAudioSource(nickname, uri, preload, cycleCount, volume, start, stop)
Examples\
\
ignoreOutput- If the defined function should ignore all output and only return the value ofmacro.return, defaults tofalse(0). \
newScope- If the defined function should create a new variable scope when executed, defaults totrue(1). A new variable scope means that the defined function can only read the variables of the macro that called it; if you do not create a new scope the defined function can read, update, and create variables in its parent's variable scope. Updating variables in the parent's scope includes over-writing any parameters that a parent might have stored within arg(), if a user-defined function that does not create a new scope is called within another user-defined function. \
\
- - If the UDF sets the value of macro.return and
ignoreOutputis0then any output is the return value and macro.return has the value assigned. \
+ - If the UDF sets the value of macro.return and
ignoreOutputis0then any output is the return value and macro.return has the value assigned. \
- If the UDF sets the value of macro.return and
ignoreOutputis1then the return value is the value assigned to macro.return and macro.return has the value assigned. \
+ - If the UDF sets the value of macro.return and
ignoreOutputis1then the return value is the value assigned to macro.return and macro.return has the value assigned. \
- If the UDF has output to chat, macro.return is not set and
ignoreOutputis0then that output is the return value and macro.return is empty. \
+ - If the UDF has output to chat, macro.return is not set and
ignoreOutputis0then that output is the return value and macro.return is empty. \
- If the UDF has output to chat, macro.return is not set and
ignoreOutputis1then the return value and macro.return are empty. \
+ - If the UDF has output to chat, macro.return is not set and
ignoreOutputis1then the return value and macro.return are empty. \
An example on how to define an audio source:\
-\
+\
\
@@ -2398,11 +2398,11 @@ defineFunction.summary = \
\
\
+onCampaignLoad[defineAudioSource("no sorrow", "http://erinmcnamee.com.hostbaby.com/files/07_No_Sorrow__Banish_Misfortune.mp3", "stream", -1, 0.5)][defineAudioSource("no sorrow", "https://erinmcnamee.com.hostbaby.com/files/07_No_Sorrow__Banish_Misfortune.mp3", "stream", -1, 0.5)]The source can now be played as\
\[playStream("no sorrow")]\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b51
\
- Defines a user function that can be used anywhere that core functions can be used. A user defined function is a link to another macro. A special macro labeled onCampaignLoad is useful for defining functions upon the loading of your campaign. This because the function will be defined AFTER the macro has been run. In case of onCampaignLoad, that macro is always run when the campaign is loaded. This saves you the hassle of manually requiring to run this macro to enable the definition.
\
+ Defines a user function that can be used anywhere that core functions can be used. A user defined function is a link to another macro. A special macro labeled onCampaignLoad is useful for defining functions upon the loading of your campaign. This because the function will be defined AFTER the macro has been run. In case of onCampaignLoad, that macro is always run when the campaign is loaded. This saves you the hassle of manually requiring to run this macro to enable the definition.
\
\ Usage\
\ @@ -2424,19 +2424,19 @@ defineFunction.summary = \Interactions between the ignoreOutput parameter and the macro.return special variable:\
+
Interactions between the ignoreOutput parameter and the macro.return special variable:\
- \
-
- \
-
- \
-
- \
-
\ Example\ @@ -2466,7 +2466,7 @@ defineFunction.summary = \
getDefinedFunctions(),\ arg(),\ argCount(),\ -
onCampaignLoad\ Version Changes\
\ @@ -2479,7 +2479,7 @@ defineFunction.summary = \\
\
\
@@ -2488,7 +2488,7 @@ deleteStrProp.summary = \
deleteStrProp() Function\
\
• Introduced in version 1.3b42
\
- Returns a copy of the string property list with the specified key removed.
\
+ Returns a copy of the string property list with the specified key removed.
\
\ Usage\
\ @@ -2514,7 +2514,7 @@ deleteTable.summary = \ \\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.4.0.1
\
@@ -2554,7 +2554,7 @@ deleteTableEntry.summary = \
\
\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.4.0.1
\
@@ -2622,15 +2622,15 @@ deselectTokens.summary = \
\
- \
id- the id string or name of a specific token to deselect (the examples below use the token name, but token IDs are also valid); if left blank all currently selected tokens are deselected. \
- tokens- a String List of tokens to deselect. \
- delim- Specifies the delimiter used in the string list that is supplied. If the delimiter is "json", then the value forlistmay be a JSON Array instead. Note: if using a JSON Array or String List,delimmust be specified. \
+ tokens- a String List of tokens to deselect. \
+ delim- Specifies the delimiter used in the string list that is supplied. If the delimiter is "json", then the value forlistmay be a JSON Array instead. Note: if using a JSON Array or String List,delimmust be specified. \
\ Example\
\To deselect a single token with the name "Adventurer":\
\
-
\
[h:deselectTokens("Adventurer")]To deselect a list of Tokens using a String List:\ +
To deselect a list of Tokens using a String List:\
\[h:deselectTokens("Adventurer, Orc 2, Goblin 1", 0, ",")]\ @@ -2702,12 +2702,12 @@ dice.summary = \ [h: listOfRolls = listAppend(listOfRolls, r)]\ }]\ You rolled [r: listSort(listOfRolls, "N-")] = [r: sum].
Rolls 5 times a d6 and returns these as sorted list as well as the total.\ -
- See also[count():], listAppend() and listSort().
- See also[count():], listAppend() and listSort().
\ See Also\
\ -For another method of rolling dice, see Dice Expressions.
\
+ For another method of rolling dice, see Dice Expressions.
\
\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.9.0
\
@@ -2765,7 +2765,7 @@ drawMBL.summary = \
Parameters\
\
- \
-
shapesList- A JSON Array of JSON objects, one of the latter for each MBL shape. \
+ shapesList- A JSON Array of JSON objects, one of the latter for each MBL shape. \
The shapes can be one of "Rectangle", "Circle", "Polygon" or "Cross".\
- \
-
"points"- JSON Array of 2 or more"x","y"coordinates. \
+ "points"- JSON Array of 2 or more"x","y"coordinates. \
\ Optional arguments\ @@ -2892,7 +2892,7 @@ TODO: Add image of results.
\ See Also\
\ - \ + \\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b89
\
@@ -2925,7 +2925,7 @@ drawVBL.summary = \
Parameters\
\
- \
-
shapesList- A JSON Array of JSON objects, one of the latter for each VBL shape. \
+ shapesList- A JSON Array of JSON objects, one of the latter for each VBL shape. \
The shapes can be one of "Rectangle", "Circle", "Polygon" or "Cross".\
- \
-
"points"- JSON Array of 2 or more"x","y"coordinates. \
+ "points"- JSON Array of 2 or more"x","y"coordinates. \
\ Optional arguments\ @@ -3048,11 +3048,11 @@ and a square (note that this square does not have the dimensions 200x200 [h:drawVBL(objectArrary)]
results in:
\
\ See Also\
\ - \ + \3 and 30, with a high
\ See Also\
\ -For another method of rolling dice, see Dice Expressions.
\
+ For another method of rolling dice, see Dice Expressions.
\
\
\
@@ -3141,7 +3141,7 @@ Returns a number than is between 3 and 30, with a low
\ See Also\
\ -For another method of rolling dice, see Dice Expressions.
\
+ For another method of rolling dice, see Dice Expressions.
\
\ Version Changes\
\ @@ -3464,7 +3464,7 @@ eraseMBL.summary = \ \\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.9.0
\
@@ -3493,7 +3493,7 @@ This function works the same as drawMBL()
\ See Also\
\ - \ + \ \ \ @@ -3508,7 +3508,7 @@ eraseVBL.summary = \ \\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b89
\
@@ -3537,7 +3537,7 @@ This function works the same as drawVBL()
\ See Also\
\ - \ + \ \ \ @@ -3615,7 +3615,7 @@ evalMacro.summary = \ \\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b49
\
@@ -3642,7 +3642,7 @@ The advantage of this function over eval()
\ Examples\
\ -[h: setNotes(evalMacro('[r,macro("CreateNotes@Lib:Notes"): ""]'))]Sets the Notes of a Token to the output of the CreateNotes macro located on the Lib:Notes Library Token.\
+
[h: setNotes(evalMacro('[r,macro("CreateNotes@Lib:Notes"): ""]'))]Sets the Notes of a Token to the output of the CreateNotes macro located on the Lib:Notes Library Token.\
[r: evalMacro("[h: TestVar1 = 5][h: TestVar2 = 10][TestVar1+TestVar2]")]Returns 15\
[h: TestVar3 = 10]\
[h: TestVar4 = 20]\
@@ -3681,7 +3681,7 @@ execFunction.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.7\
@@ -3732,7 +3732,7 @@ execLink.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b55\
@@ -3827,7 +3827,7 @@ execMacro.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b49\
@@ -3854,7 +3854,7 @@ The advantage of this function over eval()
\
Examples\
\
- [h: setNotes(evalMacro('[r,macro("CreateNotes@Lib:Notes"): ""]'))]Sets the Notes of a Token to the output of the CreateNotes macro located on the Lib:Notes Library Token.\
+
[h: setNotes(evalMacro('[r,macro("CreateNotes@Lib:Notes"): ""]'))]Sets the Notes of a Token to the output of the CreateNotes macro located on the Lib:Notes Library Token.\
[r: evalMacro("[h: TestVar1 = 5][h: TestVar2 = 10][TestVar1+TestVar2]")]Returns 15\
[h: TestVar3 = 10]\
[h: TestVar4 = 20]\
@@ -3920,7 +3920,7 @@ Returns a number than is usually between 5 and 50, wit
\
See Also\
\
- For another method of rolling dice, see Dice Expressions.\
+ For another method of rolling dice, see Dice Expressions.\
\
\
@@ -3964,7 +3964,7 @@ Returns a number than is between 0 and 5.\
\
See Also\
\
- For another method of rolling dice, see Dice Expressions.\
+ For another method of rolling dice, see Dice Expressions.\
\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.5.0
\
@@ -4020,7 +4020,7 @@ exposeAllOwnedArea.summary = \
\
\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.5.0
\
@@ -4058,7 +4058,7 @@ exposeFogAtWaypoints.summary = \
\
\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.4.1.8
\
@@ -4106,7 +4106,7 @@ exposeFOW.summary = \
\
\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b76
\
@@ -4170,12 +4170,12 @@ exposePCAreaOnly.summary = \
\
\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b76
\
Clears Fog of War (FOW) where PC tokens can see and establishes/restores FOW everywhere they cannot. This works the same as the hotkey Meta-Shift-O. Note that the keystroke may be different for locales other than U.S. English.\
-This function is often used in combination with the onTokenMove event.
\
+This function is often used in combination with the onTokenMove event.\ Usage\
\ @@ -4214,12 +4214,12 @@ exposePCOnlyArea.summary = \ \\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b76
\
Clears Fog of War (FOW) where PC tokens can see and establishes/restores FOW everywhere they cannot. This works the same as the hotkey Meta-Shift-O. Note that the keystroke may be different for locales other than U.S. English.\
-This function is often used in combination with the onTokenMove event.
\
+This function is often used in combination with the onTokenMove event.\
\ Usage\
\ @@ -4286,7 +4286,7 @@ Returns a number than is between-5 and 5.\
\ See Also\
\ -For another method of rolling dice, see Dice Expressions.
\
+ For another method of rolling dice, see Dice Expressions.
\
\
\
@@ -4301,7 +4301,7 @@ findDrawings.summary = \
\
\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.5.0
\
@@ -4342,7 +4342,7 @@ findDrawings(mapName, name, delim)\
\
-findToken.description = Finds a token on the current map by the token name, GM name, or ID and returns its id.
+findToken.description = Finds a token on the current map by the token name, GM name, or ID and returns its id.
findToken.summary = \
\
\
\
@@ -4590,7 +4590,7 @@ ge.summary = \
\
-getAllMapDisplayNames.description = Returns the display names of all of the maps as either a String List or JSON Array .
+getAllMapDisplayNames.description = Returns the display names of all of the maps as either a String List or JSON Array .
getAllMapDisplayNames.summary = \
\
@@ -4352,11 +4352,11 @@ findToken.summary = \
\
\
\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b48
\
- Finds a token on the current map by the token name, GM name, or ID and returns its id. If the optional mapname parameter is supplied that map will be searched instead. If the token is not found then an empty string "" is returned.
\
+ Finds a token on the current map by the token name, GM name, or ID and returns its id. If the optional mapname parameter is supplied that map will be searched instead. If the token is not found then an empty string "" is returned.
\
\ Usage\
\ @@ -4533,7 +4533,7 @@ Returns a number than is between-5 and 5.\ See Also\
\ -For another method of rolling dice, see Dice Expressions.
\
+ For another method of rolling dice, see Dice Expressions.
\
\
\
@@ -4600,11 +4600,11 @@ getAllMapDisplayNames.summary = \
\
\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.9.0
\
- Returns the display names of all of the maps as either a String List or JSON Array.
\
+ Returns the display names of all of the maps as either a String List or JSON Array.
\
\ Usage\
\ @@ -4616,14 +4616,14 @@ getAllMapDisplayNames(delim)\ Parameters\ \- \
-
delim- The delimiter to use for the String List. If the value isjsonthen a JSON Array is returned. \
+ delim- The delimiter to use for the String List. If the value isjsonthen a JSON Array is returned. \
\ Examples\
\ -To get the display names of all of the maps in a String List.\
+
\
-getAllMapNames.description = Returns the names of all of the maps as either a String List or JSON Array .
+getAllMapNames.description = Returns the names of all of the maps as either a String List or JSON Array .
getAllMapNames.summary = \
To get the display names of all of the maps in a String List.\
\
-
\
[h: maps = getAllMapDisplayNames()]To get the display names of all of the maps in a JSON Array\ +
To get the display names of all of the maps in a JSON Array\
\[h: maps = getAllMapDisplayNames("json")]\ @@ -4637,7 +4637,7 @@ getAllMapDisplayNames(delim)\
\
\
@@ -4647,11 +4647,11 @@ getAllMapNames.summary = \
\
\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b55
\
- Returns the names of all of the maps as either a String List or JSON Array.
\
+ Returns the names of all of the maps as either a String List or JSON Array.
\
\ Usage\
\ @@ -4663,14 +4663,14 @@ getAllMapNames(delim)\ Parameters\ \- \
-
delim- The delimiter to use for the String List. If the value isjsonthen a JSON Array is returned. \
+ delim- The delimiter to use for the String List. If the value isjsonthen a JSON Array is returned. \
\ Examples\
\ -To get the names of all of the maps in a String List.\
+
\
-getAllPlayerNames.description = Gets a string list containing the names of all the players that are connected.
+getAllPlayerNames.description = Gets a string list containing the names of all the players that are connected.
getAllPlayerNames.summary = \
To get the names of all of the maps in a String List.\
\
-
\
[h: maps = getAllMapNames()]To get the names of all of the maps in a JSON Array\ +
To get the names of all of the maps in a JSON Array\
\[h: maps = getAllMapNames("json")]\ @@ -4684,7 +4684,7 @@ getAllMapNames(delim)\
\
\
-getAllPropertyNames.description = Gets a list containing the token property names that are defined in the Campaign Properties .
+getAllPropertyNames.description = Gets a list containing the token property names that are defined in the Campaign Properties .
getAllPropertyNames.summary = \
\
@@ -4694,11 +4694,11 @@ getAllPlayerNames.summary = \
\
\
- \
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b48
\
- Gets a string list containing the names of all the players that are connected.
\
+ Gets a string list containing the names of all the players that are connected.
\
\ Usage\
\ @@ -4706,7 +4706,7 @@ getAllPlayerNames.summary = \getAllPlayerNames()\ getAllPlayerNames(delim)\
If delim is specified then it is used to separate the values in the list; if it is not specified then it defaults to ",". When delim is the string "json" the return value will be in the form of a JSON Array.\
+
If delim is specified then it is used to separate the values in the list; if it is not specified then it defaults to ",". When delim is the string "json" the return value will be in the form of a JSON Array.\
\ Example\ @@ -4719,7 +4719,7 @@ getAllPlayerNames(delim)\
\
\
@@ -4728,8 +4728,8 @@ getAllPropertyNames.summary = \
getAllPropertyNames() Function\
\
• Introduced in version 1.3b48
\
- Gets a list containing the token property names that are defined in the Campaign Properties. The type of the list returned depends on the delimiter parameter.\
-
- If the delimiter is not specified then a string list is returned and the default value of
","is used. - If the delimiter is
"json"then a JSON Array is returned. - Otherwise, a string list is returned using the delimiter passed in.
Gets a list containing the token property names that are defined in the Campaign Properties. The type of the list returned depends on the delimiter parameter.\
+
\
- If the delimiter is not specified then a string list is returned and the default value of
","is used. - If the delimiter is
"json"then a JSON Array is returned. - Otherwise, a string list is returned using the delimiter passed in.
\ Usage\ @@ -4746,12 +4746,12 @@ getAllPropertyNames(type, delim)\
type - The name of the property set to be retrieved. Defaults to all defined token property sets. Use "*" or "" when using a delimiter to get all sets.delim - The delimiter to be used in the list of names returned. Default is ,If type is specified then the string list contains the property names for that token property type, otherwise it will contain the token property names for all token property types. If delim is specified then it is used to separate the values in the string list, if it is not specified then it defaults to ','.\ +
If type is specified then the string list contains the property names for that token property type, otherwise it will contain the token property names for all token property types. If delim is specified then it is used to separate the values in the string list, if it is not specified then it defaults to ','.\
\\ Examples\
\ -You can use the following code to print out all of the properties in the campaign properties list..\
+ \
@@ -4796,7 +4796,7 @@ getAlwaysVisible.summary = \
\
\
-getAssetProperties.description = Returns a JSON Object holding the properties of the asset.
+getAssetProperties.description = Returns a JSON Object holding the properties of the asset.
getAssetProperties.summary = \
You can use the following code to print out all of the properties in the campaign properties list..\
\
@@ -4760,7 +4760,7 @@ getAllPropertyNames(type, delim)\
\
-
\
Campaign Properties<br>\
[h: props = getAllPropertyNames()]\
[foreach(name, props, "<br>"): name]PC Properties<br>\
[h: props=getAllPropertyNames("PC")]\
[foreach(name, props, "<br>"): name]Get the Basic properties in a JSON Array:\ +
Get the Basic properties in a JSON Array:\
\[r: props=getAllPropertyNames("Basic","json")]\
@@ -4796,7 +4796,7 @@ getAlwaysVisible.summary = \
\
\
value - The value of the setting to set, true(1) or false(0).id - OPTIONAL: The token id of the token for which you want to set this setting, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - OPTIONAL: The token id of the token for which you want to set this setting, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
\
\
Example\
@@ -4811,7 +4811,7 @@ getAlwaysVisible.summary = \
value - The value of the setting to set, true(1) or false(0).id - OPTIONAL: The token id of the token for which you want to set this setting, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - OPTIONAL: The token id of the token for which you want to set this setting, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
\
\
@@ -4820,7 +4820,7 @@ getAssetProperties.summary = \
getAssetProperties() Function\
\
\
-getBar.description = Gets the value of the specified bar for the Current Token .
+getBar.description = Gets the value of the specified bar for the Current Token .
getBar.summary = \
• Introduced in version 1.5.8
\
- Returns a JSON Object holding the properties of the asset.
\
+ Returns a JSON Object holding the properties of the asset.
\
\ Usage\
\ @@ -4846,7 +4846,7 @@ getAssetProperties.summary = \\
\
-getBarImage.description = Gets the asset id for a specific image in a bar.
+getBarImage.description = Gets the asset id for a specific image in a bar.
getBarImage.summary = \
\
@@ -4855,7 +4855,7 @@ getBar.summary = \
getBar() Function\
\
\
@@ -4899,17 +4899,17 @@ getBar(name, id, mapname)\
\
\
• Introduced in version 1.3b42
\
- Gets the value of the specified bar for the Current Token. The value returned is between 0 and 1 for 0% to 100% respectively.
\
+ Gets the value of the specified bar for the Current Token. The value returned is between 0 and 1 for 0% to 100% respectively.
\
\ Usage\
\ @@ -4869,7 +4869,7 @@ getBar(name, id, mapname)\ \- \
name- The name of the bar. \
- id- The tokenidof the token to get the bar value from, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidof the token to get the bar value from, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\
@@ -4899,17 +4899,17 @@ getBar(name, id, mapname)\
\
\
- \
- HP and Health Bars\
+ HP and Health Bars\
\
- \
- The
bar.name special variable\
+ The bar.name special variable\
\
\
bar.name special variable\
+ The bar.name special variable\
\
\
@@ -4918,7 +4918,7 @@ getBarImage.summary = \
getBarImage() Function\
\
\
-getCurrentInitiative.description = Gets the offset of the token in the initiative panel that has the initiative .
+getCurrentInitiative.description = Gets the offset of the token in the initiative panel that has the initiative .
getCurrentInitiative.summary = \
• Introduced in version unreleased
\
- Gets the asset id for a specific image in a bar. The bar must be one of the image types (single-, double-, or multi-image) for this to work.
\
+ Gets the asset id for a specific image in a bar. The bar must be one of the image types (single-, double-, or multi-image) for this to work.
\
\ Usage\
\ @@ -4942,13 +4942,13 @@ getBarImage.summary = \\ Example\
\ -To display the image for the midway point of a custom bar called "Mana", use\
+
\
To display the image for the midway point of a custom bar called "Mana", use\
\
<img src='[r:getBarImage("Mana", 0, 0.5)]'></img>\
\
@@ -4958,10 +4958,10 @@ getCurrentInitiative.summary = \
\
\
\
- \ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\Gets the offset of the token in the initiative panel that has the initiative. The offset starts at 0, if no token has initiative then -1 is returned.
\
+ Gets the offset of the token in the initiative panel that has the initiative. The offset starts at 0, if no token has initiative then -1 is returned.
\
\ Usage\
\ @@ -5125,7 +5125,7 @@ getDistance.summary = \ \\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b51
\
@@ -5212,7 +5212,7 @@ getTokenX(units, id, mapname)\
\
- \
units- If set tofalse(0), the coordinate is a location on the grid in number of cells. Defaults totrue(1), where the coordinate is in number of Pixels (in other words 0:distance in cells, 1: distance in pixels)'. \
- id- The id of the token to move, defaults to the Current Token. \
+ id- The id of the token to move, defaults to the Current Token. \
mapname- The name of the map to find the token. Defaults to the current map. \
\ @@ -5244,13 +5244,13 @@ The exception to this is when the token is 'Freesize' AND 'Snapped to Grid' AND
\ Examples\
\ -Moves the Current Token down
5 units, and left 10 units.\
+ Moves the Current Token down \
-\
-getExposedTokenNames.description = Gets a list containing the names of all of the tokens on the current map that have been exposed, (i.e. not covered by fog of war ).
+getExposedTokenNames.description = Gets a list containing the names of all of the tokens on the current map that have been exposed, (i.e. not covered by fog of war ).
getExposedTokenNames.summary = \
5 units, and left 10 units.\
[h: CurrentX = getTokenX()]\
[h: CurrentY = getTokenY()]\
[h: NewX = CurrentX + 5]\
[h: NewY = CurrentY - 10]\
[h: moveToken(NewX, NewY)]Moves the Current Token down 5 cells, and left 10 cells.\
+
Moves the Current Token down 5 cells, and left 10 cells.\
[h: CurrentX = getTokenX(0)]\
[h: CurrentY = getTokenY(0)]\
@@ -5352,7 +5352,7 @@ getDrawingEraser.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -5398,11 +5398,11 @@ getDrawingInfo.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.2\
- Returns extensive information about the specified drawing. The information is returned as a JSON object.\
+ Returns extensive information about the specified drawing. The information is returned as a JSON object.\
\
Usage\
\
@@ -5622,7 +5622,7 @@ getDrawingLayer.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -5668,7 +5668,7 @@ getDrawingOpacity.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -5714,7 +5714,7 @@ getDrawingProperties.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -5774,7 +5774,7 @@ getTokenDrawOrder(id, mapname)\
Parameter\
\
- \
-
id- The id of the token to move, defaults to the Current Token. \
+ id- The id of the token to move, defaults to the Current Token. \
mapname- The name of the map to find the token. Defaults to the current map. \
\ @@ -5808,7 +5808,7 @@ getEnvironmentVariable.summary = \ \
\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.5.0
\
@@ -5838,7 +5838,7 @@ The Allow External Macro Access option on the Application tab of MapTool'
\
\
@@ -5848,12 +5848,12 @@ getExposedTokenNames.summary = \
\
\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b48
\
- Gets a list containing the names of all of the tokens on the current map that have been exposed, (i.e. not covered by fog of war). The type of the value returned depends on the delimiter parameter.\
-\
Usage\
@@ -5862,12 +5862,12 @@ getExposedTokenNames.summary = \
\
- - If the delimiter is not specified then a string list is returned and the default value of
","is used. - If the delimiter
"json"then a JSON Array is returned. - Otherwise, a string list is returned with the delimiter passed in.
Gets a list containing the names of all of the tokens on the current map that have been exposed, (i.e. not covered by fog of war). The type of the value returned depends on the delimiter parameter.\
+
\
- If the delimiter is not specified then a string list is returned and the default value of
","is used. - If the delimiter
"json"then a JSON Array is returned. - Otherwise, a string list is returned with the delimiter passed in.
\
Usage\
@@ -5862,12 +5862,12 @@ getExposedTokenNames.summary = \
getExposedTokenNames()\
getExposedTokenNames(delim)
\
If delim is specified then it is used as the delimiter that separates the token names.\ +
If delim is specified then it is used as the delimiter that separates the token names.\
\\ Example\
\ -The following example will print out the names of all the tokens on the current map not covered by fog of war.\
+
The following example will print out the names of all the tokens on the current map not covered by fog of war.\
\
\
-getExposedTokens.description = Gets a list containing the ids of all of the tokens on the current map that have been exposed, (i.e. not covered by fog of war ).
+getExposedTokens.description = Gets a list containing the ids of all of the tokens on the current map that have been exposed, (i.e. not covered by fog of war ).
getExposedTokens.summary = \
[h: names = getExposedTokenNames()]\
[r: foreach(name, names, "<br>"): name]The following example will return the exposed tokens from the TOKEN layer only.\ @@ -5899,7 +5899,7 @@ getExposedTokenNames(delim)\
\
\
@@ -5909,12 +5909,12 @@ getExposedTokens.summary = \
\
\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b48
\
- Gets a list containing the ids of all of the tokens on the current map that have been exposed, (i.e. not covered by fog of war). The type of the value returned depends on the delimiter parameter.\
-\
Usage\
@@ -5923,12 +5923,12 @@ getExposedTokens.summary = \
\
- - If the delimiter is not specified then a string list is returned with the default value of ',' is used.
- If the delimiter "json" then a JSON Array is returned.
- Otherwise a string list is returned with the delimiter passed in.
Gets a list containing the ids of all of the tokens on the current map that have been exposed, (i.e. not covered by fog of war). The type of the value returned depends on the delimiter parameter.\
+
\
- If the delimiter is not specified then a string list is returned with the default value of ',' is used.
- If the delimiter "json" then a JSON Array is returned.
- Otherwise a string list is returned with the delimiter passed in.
\
Usage\
@@ -5923,12 +5923,12 @@ getExposedTokens.summary = \
getExposedTokenNames()\
getExposedTokenNames(delim)
\
If delim is specified then it is used as the delimiter that separates the token ids.\ +
If delim is specified then it is used as the delimiter that separates the token ids.\
\\ Example\
\ -The following example will print out the ids of all the tokens on the current map not covered by fog of war.\
+ \
Example\
@@ -6068,7 +6068,7 @@ getGMName.summary = \
\
\
-getGMNotes.description = Returns the GM notes from the Current Token .
+getGMNotes.description = Returns the GM notes from the Current Token .
getGMNotes.summary = \
The following example will print out the ids of all the tokens on the current map not covered by fog of war.\
\
[h: ids = getExposedTokens()]\
[r: foreach(id, ids "<br>"): id]\ @@ -5956,7 +5956,7 @@ getFillColor.summary = \ \
\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.5.0
\
@@ -6009,7 +6009,7 @@ getFindCount.summary = \
\
\
- getFindCount(id)\
The id is the id value returned by strfind().\ +
The id is the id value returned by strfind().\
\\
Example\
@@ -6068,7 +6068,7 @@ getGMName.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b49\
@@ -6085,7 +6085,7 @@ getGMName(id, mapname)\
Parameter\
\
\
- id - The token id of the token that has its GM Name returned, defaults to the Current Token.id - The token id of the token that has its GM Name returned, defaults to the Current Token.mapname - The name of the map to find the token. Defaults to the current map.
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\id - The token id of the token that has its GM Name returned, defaults to the Current Token.id - The token id of the token that has its GM Name returned, defaults to the Current Token.mapname - The name of the map to find the token. Defaults to the current map.\ @@ -6104,7 +6104,7 @@ getGMName(id, mapname)\
\
\
@@ -6114,11 +6114,11 @@ getGMNotes.summary = \
\
The first group \
Every group after that will return partial matches that are within \
\
-
\
-getHalo.description = Gets the color value of a token's Halo .
+getHalo.description = Gets the color value of a token's Halo .
getHalo.summary = \
\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b48
\
- Returns the GM notes from the Current Token.
\
+ Returns the GM notes from the Current Token.
\
\ Usage\
\ @@ -6131,7 +6131,7 @@ getGMNotes(id, mapname)\ Parameter\ \- \
-
id- The tokenidof the token to get the GM notes from.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidof the token to get the GM notes from.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ @@ -6214,7 +6214,7 @@ match 2, group 2 = test \
+ = '1 or more'* = '0 or more'Have a look here for an overview.\ +
Have a look here for an overview.\
\Second important thing to know is that a group is defined by '('parenthesis')': (group1)(group2)(etc.), where group '0' returns the entire "match" result.\
'0' returns the ENTIRE match.().Here a link to test your regex statements (remember that for this applet you only use one \ while in MT you need \\.\
+
Here a link to test your regex statements (remember that for this applet you only use one \ while in MT you need \\.\
\
\
@@ -6404,7 +6404,7 @@ match 2, group 2 start = 10 \
\
\
@@ -6413,7 +6413,7 @@ getHalo.summary = \
getHalo() Function\
\
• Introduced in version 1.3b49
\
- Gets the color value of a token's Halo. The value returned is a string that represents the hexadecimal value of the color of the Halo in the format
\
+ "#RRGGBB" or "None" if the token has no Halo.Gets the color value of a token's Halo. The value returned is a string that represents the hexadecimal value of the color of the Halo in the format
\
"#RRGGBB" or "None" if the token has no Halo.\ Usage\
\ @@ -6427,17 +6427,17 @@ getHalo.summary = \ Parameter\ \- \
-
id- The tokenidof the token which has its halo color returned, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidof the token which has its halo color returned, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
\ Example\
\ -The following example will display the text "Halo Color Text" in the color of the Current Token's Halo.\
+
The following example will display the text "Halo Color Text" in the color of the Current Token's Halo.\
\
<span style="color:[r: getHalo()]">Halo Color Text</span>\ See Also\
\ - \ -getImage.description = Returns the asset id for the image of a Token or Image Token . +getImage.description = Returns the asset id for the image of a Token or Image Token . getImage.summary = \\
\
@@ -6460,7 +6460,7 @@ getImage.summary = \
getImage() Function\
\
• Introduced in version 1.3b48
\
- \
+ \
\ Usage\
\ @@ -6480,7 +6480,7 @@ Error handling on duplicates should be pointed out.\\ Example\
\ -To display the image from an image token called
image:Map you can do the following:\
+ To display the image from an image token called \
\
-getImpersonated.description = Returns the id of the impersonated token .
+getImpersonated.description = Returns the id of the impersonated token .
getImpersonated.summary = \
image:Map you can do the following:\
<img src="[r: getImage('image:Map')]"></img>Alternatively this can be used to retrieve a normal token:\
\ @@ -6493,7 +6493,7 @@ Error handling on duplicates should be pointed out.\\
\
@@ -6502,7 +6502,7 @@ getImpersonated.summary = \
getImpersonated() Function\
\
\
-getImpersonatedName.description = Returns the name of the impersonated token .
+getImpersonatedName.description = Returns the name of the impersonated token .
getImpersonatedName.summary = \
• Introduced in version 1.3b48
\
- Returns the id of the impersonated token.
\
+ Returns the id of the impersonated token.
\
\ Usage\
\ @@ -6538,7 +6538,7 @@ getImpersonated(global)\\
\
@@ -6547,7 +6547,7 @@ getImpersonatedName.summary = \
getImpersonatedName() Function\
\
\
-getInfo.description = Returns a JSON Object with lots of information about a specified topic.
+getInfo.description = Returns a JSON Object with lots of information about a specified topic.
getInfo.summary = \
• Introduced in version 1.3b48
\
- Returns the name of the impersonated token.
\
+ Returns the name of the impersonated token.
\
\ Usage\
\ @@ -6577,7 +6577,7 @@ getImpersonatedName(global)\\
\
@@ -6586,7 +6586,7 @@ getInfo.summary = \
getInfo() Function\
\
\
-getInitiative.description = Returns the initiative of the current token
+getInitiative.description = Returns the initiative of the current token
getInitiative.summary = \
• Introduced in version 1.3b69
\
- Returns a JSON Object with lots of information about a specified topic.
\
+ Returns a JSON Object with lots of information about a specified topic.
\
\ Usage\
\ @@ -7004,7 +7004,7 @@ Sample output:\\
\
@@ -7013,7 +7013,7 @@ getInitiative.summary = \
getInitative() Function\
\
\
-getInitiativeHold.description = Returns if the token is on hold in the initiative panel or not.
+getInitiativeHold.description = Returns if the token is on hold in the initiative panel or not.
getInitiativeHold.summary = \
• Introduced in version 1.3b41
\
- Returns the initiative of the current token
\
+ Returns the initiative of the current token
\
\ Usage\
\ @@ -7026,7 +7026,7 @@ getInitiative(id, mapname)\ Parameter\ \- \
-
id- The tokenidof the token to get the initiative value from. Defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidof the token to get the initiative value from. Defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token if the id parameter is used. Defaults to the current map. \
\ @@ -7042,7 +7042,7 @@ The initiative value of the token that currently has the initiative is [r: getIn
\
\
@@ -7051,7 +7051,7 @@ getInitiativeHold.summary = \
getInitiativeHold() Function\
\
\
@@ -7089,7 +7089,7 @@ getInitiativeList.summary = \
\
\
• Introduced in version 1.3b41
\
- Returns if the token is on hold in the initiative panel or not. This function will return 1 if the token is on hold or 0 if it is not.
\
+ Returns if the token is on hold in the initiative panel or not. This function will return 1 if the token is on hold or 0 if it is not.
\
\ Usage\
\ @@ -7064,7 +7064,7 @@ getInitiativeHold(id, mapname)\ Parameter\ \- \
-
id- The tokenidof the token to get the initiative hold value from. Defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidof the token to get the initiative hold value from. Defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token if the id parameter is used. Defaults to the current map. \
\
@@ -7089,7 +7089,7 @@ getInitiativeList.summary = \
\
• Introduced in version 1.3b57\
Retrieves a list of all tokens currently in the Initiative Panel. The return value is a JSON object with various information about initiative, including global information (round number, which map is current, which token is current) and token-specific information (token id, initiative value, whether the token is holding or not).\
-When called from a Trusted Macro or by a client with GM authority, it will return all information. Otherwise it only returns information visible to the current player. In other words, it respects the Initiative Panel's Hide NPCs and the token's Visible To Owner Only flags, among others. (This is new in 1.3b78. Prior versions didn't have the check for trusted context at all.)\
+When called from a Trusted Macro or by a client with GM authority, it will return all information. Otherwise it only returns information visible to the current player. In other words, it respects the Initiative Panel's Hide NPCs and the token's Visible To Owner Only flags, among others. (This is new in 1.3b78. Prior versions didn't have the check for trusted context at all.)
Hide NPCs and the token's Visible To Owner Only flags, among others. (This is new in 1.3b78. Prior versions didn't have the check for trusted context at all.)\ Usage\
\ @@ -7102,7 +7102,7 @@ None.\\ Example\
\ -The following code will simply return a JSON object and print each property name one at a time on separate lines. Refer to JSON Object for more information about JSON object themselves and json.get for information on retrieving properties and their values.\
+
The following code will simply return a JSON object and print each property name one at a time on separate lines. Refer to JSON Object for more information about JSON object themselves and json.get for information on retrieving properties and their values.\
\
\
-getInitiativeRound.description = Returns the current round number in the initiative panel .
+getInitiativeRound.description = Returns the current round number in the initiative panel .
getInitiativeRound.summary = \
[h: json = getInitiativeList() ]\
[r, foreach(item, json, "<br>"), code: {\
[r: item]: [r:json.get(json,item)]\
@@ -7135,7 +7135,7 @@ tokens: An Array of Objects for Each Token in List\
\
@@ -7143,7 +7143,7 @@ getInitiativeRound.summary = \
\
getInitiativeRound() Function\
\
- \
+ \
\
-getLabel.description = Returns the Token Label for a specific Token .
+getLabel.description = Returns the Token Label for a specific Token .
getLabel.summary = \
\ Usage\
\ @@ -7172,7 +7172,7 @@ getInitiativeToken.summary = \ \\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b51
\
@@ -7187,7 +7187,7 @@ getInitiativeToken.summary = \
\
\
@@ -7196,7 +7196,7 @@ getLabel.summary = \
getLabel() Function\
\
\
-getLayer.description = Returns the Map Layer that a Token is on.
+getLayer.description = Returns the Map Layer that a Token is on.
getLayer.summary = \
• Introduced in version 1.3b48
\
- Returns the Token Label for a specific Token.
\
+ Returns the Token Label for a specific Token.
\
\ Usage\
\ @@ -7210,7 +7210,7 @@ getLabel.summary = \ Parameter\ \- \
-
id- The tokenidof the token that has its Token Label returned, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidof the token that has its Token Label returned, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
\
\
@@ -7266,7 +7266,7 @@ getLastPath.summary = \
\
\
@@ -7275,8 +7275,8 @@ getLayer.summary = \
getLayer() Function\
\
• Introduced in version 1.3b48
\
- Returns the Map Layer that a Token is on.\
-
\
-getLibProperty.description = Returns the value of a token property from a library token .
+getLibProperty.description = Returns the value of a token property from a library token .
getLibProperty.summary = \
The Map Layer will be one of:\ +
Returns the Map Layer that a Token is on.\
+
\
@@ -7292,7 +7292,7 @@ getLayer(id, mapname)\
Parameter\
\
The Map Layer will be one of:\
\TOKENGMalso known as HiddenOBJECTBACKGROUND
- \
-
id- The tokenidof the token which has its Map Layer returned, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidof the token which has its Map Layer returned, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ @@ -7317,7 +7317,7 @@ getLayer(id, mapname)\
\
\
@@ -7326,7 +7326,7 @@ getLibProperty.summary = \
getLibProperty() Function\
\
• Introduced in version 1.3b48
\
- Returns the value of a token property from a library token. If the lib argument is not specified then the token property will be retrieved from the library token that the macro is currently running from.\
+ \
Usage\
@@ -7351,20 +7351,20 @@ As mentioned in the introduction, if the value of the property on the Token equa
\
-getLibPropertyNames.description = Returns a String List or JSON Array containing the names of the Token Properties on a Library Token .
+getLibPropertyNames.description = Returns a String List or JSON Array containing the names of the Token Properties on a Library Token .
getLibPropertyNames.summary = \
Returns the value of a token property from a library token. If the lib argument is not specified then the token property will be retrieved from the library token that the macro is currently running from.\
Unlike getProperty(), this function will not retrieve the default value of a campaign property. Default values are generally programmed as local variables in a macro, then overridden with the result of this function if this function returns a value. An example is shown below.
\
\
Usage\
@@ -7351,20 +7351,20 @@ As mentioned in the introduction, if the value of the property on the Token equa
\
Examples\
\
- To get the "init" token property from the library token that a macro is running from use\
+ To get the "init" token property from the library token that a macro is running from use\
[getLibProperty("init")]\
-To get the "init" token property from the library token if the library token has such a property. If not, use a default value of "default".\
+
To get the "init" token property from the library token if the library token has such a property. If not, use a default value of "default".\
\
[result = getLibProperty("init")]\
[IF(result == ""): result = "default" ]\
-To get the "init" token property from a library token called "lib:Attacks" use\
+
To get the "init" token property from a library token called "lib:Attacks" use\
\
[getLibProperty("init", "lib:Attacks")]\
\
To get the "init" token property from the library token that a macro is running from use\
\
-\
-
\
[getLibProperty("init")]To get the "init" token property from the library token if the library token has such a property. If not, use a default value of "default".\ +
To get the "init" token property from the library token if the library token has such a property. If not, use a default value of "default".\
\[result = getLibProperty("init")]\
[IF(result == ""): result = "default" ]To get the "init" token property from a library token called "lib:Attacks" use\ +
To get the "init" token property from a library token called "lib:Attacks" use\
\[getLibProperty("init", "lib:Attacks")]\
\
@@ -7373,7 +7373,7 @@ getLibPropertyNames.summary = \
getLibPropertyNames() Function\
\
• Introduced in version 1.5.0
\
- Returns a String List or JSON Array containing the names of the Token Properties on a Library Token. The type of the value returned depends on the delimiter parameter.\
+
\
-getLights.description = Returns a string list containing the names of the light sources that are turned on for the Current Token .
+getLights.description = Returns a string list containing the names of the light sources that are turned on for the Current Token .
getLights.summary = \
Returns a String List or JSON Array containing the names of the Token Properties on a Library Token. The type of the value returned depends on the delimiter parameter.\
\
@@ -7393,8 +7393,8 @@ getLibPropertyNames.summary = \
Parameters\
\
When token properties are created during campaign, they are persistent in the MapTool campaign, regardless of whether they are editable in the Edit Token window. In other words, even though a property is removed from the campaign properties, it remains available to macros. getLibPropertyNames will return all token properties that exist or have ever existed in the particular campaign, even if users cannot directly edit those properties (i.e., they do not appear in the token's properties when you double click on a token). To get only properties that are currently visible and editable, use getAllPropertyNames().\
- \
-
delim- The delimiter used to separate the values in the String List, defaults to",". Returns a JSON Array if set to"json". \
- id- The tokenidof the token which has its property names returned, defaults to the Current Token. This parameter may be*orthisto indicate the current Lib token that this macro is executing on.Note: This parameter can only be used in a Trusted Macro.
\
+ delim- The delimiter used to separate the values in the String List, defaults to",". Returns a JSON Array if set to"json". \
+ id- The tokenidof the token which has its property names returned, defaults to the Current Token. This parameter may be*orthisto indicate the current Lib token that this macro is executing on.Note: This parameter can only be used in a Trusted Macro.
\
\ Example\ @@ -7413,7 +7413,7 @@ getLibPropertyNames.summary = \
\
\
@@ -7422,7 +7422,7 @@ getLights.summary = \
getLights() Function\
\
• Introduced in version 1.3b48
\
- Returns a string list containing the names of the light sources that are turned on for the Current Token. The type of the value returned depends on the delimiter parameter.
\
+ Returns a string list containing the names of the light sources that are turned on for the Current Token. The type of the value returned depends on the delimiter parameter.
\
\ Usage\
\ @@ -7438,16 +7438,16 @@ getLights(type, delim, id, mapname)\ \- \
type- The light source type, (e.g. "Generic", "D20"). If set to "*", all light sources are returned. Defaults to "*". \
- delim- The delimiter used to separate values in the string list. If set to "json", a JSON Array is returned. Defaults to ",". \
- id- The tokenidof the token to change the light sources, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ delim- The delimiter used to separate values in the string list. If set to "json", a JSON Array is returned. Defaults to ",". \
+ id- The tokenidof the token to change the light sources, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ Examples\
\ -To get a string list of all of the light sources that the current token has on.\
+ \
@@ -7473,7 +7473,7 @@ getLineCap.summary = \
\
\
-getMacroButtonIndex.description = Returns the index of the Token macro button that was clicked on.
+getMacroButtonIndex.description = Returns the index of the Token macro button that was clicked on.
getMacroButtonIndex.summary = \
To get a string list of all of the light sources that the current token has on.\
\
-
\
[getLights()]To get a string list of the light sources that the current token has on with the light source type of "Generic".\ +
To get a string list of the light sources that the current token has on with the light source type of "Generic".\
\[getLights("Generic")]\
@@ -7473,7 +7473,7 @@ getLineCap.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -7509,7 +7509,7 @@ getLineCap.summary = \
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\\
\
@@ -7518,7 +7518,7 @@ getMacroButtonIndex.summary = \
getMacroButtonIndex() Function\
\
\
-If the macro is not run from an auto-execute macro button on a Token, \
+If the macro is not run from an auto-execute macro button on a Token,
\
• Introduced in version 1.3b50
\
- Returns the index of the Token macro button that was clicked on. The macro button must have the auto-execute check box selected. If the macro is not running from a Token macro button then
\
+ -1 is returned.Returns the index of the Token macro button that was clicked on. The macro button must have the auto-execute check box selected. If the macro is not running from a Token macro button then
\
-1 is returned.\ Usage\
\ @@ -7529,7 +7529,7 @@ getMacroButtonIndex.summary = \ Example\ \[h: ind = getMacroButtonIndex()]ind is set to -1. Otherwise ind is set to a non-negative number which is the index of the button.ind is set to -1. Otherwise ind is set to a non-negative number which is the index of the button.\ See Also\
\ @@ -7540,7 +7540,7 @@ If the macro is not run from an auto-execute macro button on a macro button on the Current Token . +getMacroCommand.description = Returns the command that would be executed for a macro button on the Current Token . getMacroCommand.summary = \\
\
@@ -7549,7 +7549,7 @@ getMacroCommand.summary = \
getMacroCommand() Function\
\
\
-getMacroIndexes.description = Returns a list of the macro buttons on the Current Token that have the specified label.
+getMacroIndexes.description = Returns a list of the macro buttons on the Current Token that have the specified label.
getMacroIndexes.summary = \
• Introduced in version 1.3b48
\
- Returns the command that would be executed for a macro button on the Current Token. The getMacroIndexes() function can be used to get the index of a macro button.
\
+ Returns the command that would be executed for a macro button on the Current Token. The getMacroIndexes() function can be used to get the index of a macro button.
\
\ Usage\
\ @@ -7563,7 +7563,7 @@ getMacroCommand(index, id, mapname)\ \- \
index- The index of the macro button which will have the command returned. \
- id- The tokenidof the token that the function is executed on.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidof the token that the function is executed on.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ @@ -7624,7 +7624,7 @@ getMacroGroup.summary = \ \
\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b51
\
@@ -7662,7 +7662,7 @@ getMacroGroup(group, delim, id, mapname)\
\
\
@@ -7671,7 +7671,7 @@ getMacroIndexes.summary = \
getMacroIndexes() Function\
\
\
-getMacroProps.description = Returns a property list of the properties for a macro button for the Current Token .
+getMacroProps.description = Returns a property list of the properties for a macro button for the Current Token .
getMacroProps.summary = \
• Introduced in version 1.3b48
\
- Returns a list of the macro buttons on the Current Token that have the specified label. The type of the value returned depends on the delimiter parameter.
\
+ Returns a list of the macro buttons on the Current Token that have the specified label. The type of the value returned depends on the delimiter parameter.
\
\ Usage\
\ @@ -7686,8 +7686,8 @@ getMacroIndexes(label, delim, id, mapname)\ \- \
label- The label for the macro buttons to return. \
- delim- The delimiter used to separate the values in the String List which defaults to","if not specified. This function returns a JSON Object if"json"is specified. \
- id- The tokenidof the token that the function is executed on.Note: This parameter can only be used in a Trusted Macro.
\
+ delim- The delimiter used to separate the values in the String List which defaults to","if not specified. This function returns a JSON Object if"json"is specified. \
+ id- The tokenidof the token that the function is executed on.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ @@ -7776,7 +7776,7 @@ getMacroName.summary = \
\
\
@@ -7785,7 +7785,7 @@ getMacroProps.summary = \
getMacroProps() Function\
\
\
-getMacros.description = Returns a list of the labels of all of the macro buttons on the Current Token .
+getMacros.description = Returns a list of the labels of all of the macro buttons on the Current Token .
getMacros.summary = \
• Introduced in version 1.3b48
\
- Returns a property list of the properties for a macro button for the Current Token. You can retrieve the index of a macro button with the getMacroIndexes() or getMacroButtonIndex() function. The type of the value returned depends on the delimiter parameter.
\
+ Returns a property list of the properties for a macro button for the Current Token. You can retrieve the index of a macro button with the getMacroIndexes() or getMacroButtonIndex() function. The type of the value returned depends on the delimiter parameter.
\
\ Usage\
\ @@ -7799,9 +7799,9 @@ getMacroProps(index, delim, id, mapname)\ Parameters\ \- \
-
index- The index of the macro button. \
- delim- The delimiter used to separate the values in the string property list which defaults to";"if not specified. This function returns a JSON Object if"json"is specified. \
- id- The tokenidof the token that the function is executed on.Note: This parameter can only be used in a Trusted Macro.
\
+ index- The index of the macro button. \
+ delim- The delimiter used to separate the values in the string property list which defaults to";"if not specified. This function returns a JSON Object if"json"is specified. \
+ id- The tokenidof the token that the function is executed on.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ @@ -7823,9 +7823,9 @@ getMacroProps(index, delim, id, mapname)\
minWidth - The minimum width of the button.playerEditable - Is the button player editable, accepts true(1) or false(0).tooltip - The tool tip for the macro button.compare - A JSON Array of the selected Macro Commonality options.\
+ compare - A JSON Array of the selected Macro Commonality options.\
applyToSelected- Use the macro applyToSelected for common macro comparisons.autoExecute- Use the macro autoExec for common macro comparisons.command- Use the macro command for common macro comparisons.group- Use the macro group for common macro comparisons.includeLabel- Use the macro includeLabel for common macro comparisons.sortPrefix- Use the macro sortPrefix for common macro comparisons.
metadata - A JSON Object holding the metadata key/value pairs for the macro.\
+ metadata - A JSON Object holding the metadata key/value pairs for the macro.\
uuid-commandChecksum-propsChecksum-
\ @@ -7847,7 +7847,7 @@ getMacroProps(index, delim, id, mapname)\
\
\
@@ -7856,7 +7856,7 @@ getMacros.summary = \
getMacros() Function\
\
• Introduced in version 1.3b48
\
- Returns a list of the labels of all of the macro buttons on the Current Token. The type of the value returned depends on the delimiter parameter.
\
+ Returns a list of the labels of all of the macro buttons on the Current Token. The type of the value returned depends on the delimiter parameter.
\
\ Usage\
\ @@ -7870,14 +7870,14 @@ getMacros(delim, id, mapname)\ Parameters\ \- \
-
delim- The delimiter used to separate the values in the String List, a JSON array is returned if"json"is specified as the delimiter. Defaults to","\
- id- The tokenidof the token that the function is executed on.Note: This parameter can only be used in a Trusted Macro.
\
+ delim- The delimiter used to separate the values in the String List, a JSON array is returned if"json"is specified as the delimiter. Defaults to","\
+ id- The tokenidof the token that the function is executed on.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ Examples\
\ -To display all of the macro button labels on the current token use.\
+
\
-getMatchingLibProperties.description = Returns a String List or JSON Array with names of the Token Properties on a specific Library Token that match the given pattern.
+getMatchingLibProperties.description = Returns a String List or JSON Array with names of the Token Properties on a specific Library Token that match the given pattern.
getMatchingLibProperties.summary = \
To display all of the macro button labels on the current token use.\
\
[h: macroLabels = getMacros()]\
[foreach(macro, macroLabels, "<br>"): macro]\ @@ -7966,7 +7966,7 @@ getMapVisible(mapName)\
\
\
@@ -7975,7 +7975,7 @@ getMatchingLibProperties.summary = \
getMatchingLibProperties() Function\
\
• Introduced in version 1.3b54
\
- Returns a String List or JSON Array with names of the Token Properties on a specific Library Token that match the given pattern.
\
+ Returns a String List or JSON Array with names of the Token Properties on a specific Library Token that match the given pattern.
\
\ Usage\
\ @@ -7993,13 +7993,13 @@ getMatchingLibProperties.summary = \ \- \
pattern- A regular expression(regex) that represents the pattern the properties should match. \
- lib- The name of the Library Token that is checked for properties that match, defaults to the Library Token the macro is running on. \
- delim- The delimiter used in the String List that is returned, defaults to",". Returns a JSON Array if"json"is specified. \
+ lib- The name of the Library Token that is checked for properties that match, defaults to the Library Token the macro is running on. \
+ delim- The delimiter used in the String List that is returned, defaults to",". Returns a JSON Array if"json"is specified. \
\ Examples\
\ -Assuming that you have a Library Token that contained a list of all the items and their detail in your campaign stored as Token properties names with the following format
Type:Item Name (for example Weapon:Longsword), you could use the following code to loop through\
+ Assuming that you have a Library Token that contained a list of all the items and their detail in your campaign stored as Token properties names with the following format \
-getMatchingProperties.description = Returns a String List or JSON Array with names of the Token Properties on a specific Token that match the given pattern.
+getMatchingProperties.description = Returns a String List or JSON Array with names of the Token Properties on a specific Token that match the given pattern.
getMatchingProperties.summary = \
Type:Item Name (for example Weapon:Longsword), you could use the following code to loop through\
all the weapons.\
\[foreach(item, getMatchingLibProperties("Weapon:.*", "Lib:Items")): {\
@@ -8026,7 +8026,7 @@ getMatchingLibProperties.summary = \
\
\
@@ -8035,7 +8035,7 @@ getMatchingProperties.summary = \
getMatchingProperties() Function\
\
• Introduced in version 1.3b54
\
- Returns a String List or JSON Array with names of the Token Properties on a specific Token that match the given pattern.
\
+ Returns a String List or JSON Array with names of the Token Properties on a specific Token that match the given pattern.
\
\ Usage\
\ @@ -8049,15 +8049,15 @@ getMatchingProperties(pattern, delim, id, mapname)\ Parameters\ \- \
-
pattern- A regular expression(regex) that represents the pattern the properties should match. \
- delim- The delimiter used in the String List that is returned, defaults to",". Returns a JSON Array if"json"is specified. \
- id- The tokenidof the token that is checked for properties that match the given pattern, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ pattern- A regular expression(regex) that represents the pattern the properties should match. \
+ delim- The delimiter used in the String List that is returned, defaults to",". Returns a JSON Array if"json"is specified. \
+ id- The tokenidof the token that is checked for properties that match the given pattern, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ Examples\
\ -Say you wanted to keep an inventory list for the Token you could prefix all of your inventory properties with
Inv:Category:. For example Inv:Weapon:Longsword.\
+ Say you wanted to keep an inventory list for the Token you could prefix all of your inventory properties with \
-getMaxLoopIterations.description = Returns the max amount of loops (in [count():] , [foreach():] , [for():] , [while():] ) that are allowed.
+getMaxLoopIterations.description = Returns the max amount of loops (in [count():] , [foreach():] , [for():] , [while():] ) that are allowed.
getMaxLoopIterations.summary = \
\
-getName.description = Returns the name of a Token .
+getName.description = Returns the name of a Token .
getName.summary = \
Inv:Category:. For example Inv:Weapon:Longsword.\
Then to loop through all of the inventory properties you could use\
\[foreach(item, getMatchingProperties("Inv:.*")): {\
@@ -8092,7 +8092,7 @@ getMatchingProperties(pattern, delim, id, mapname)\
\
\
@@ -8221,7 +8221,7 @@ getMoveCount.summary = \
\
\
@@ -8101,7 +8101,7 @@ getMaxLoopIterations.summary = \
getMaxLoopIterations() Function\
\
\
• Introduced in version 1.4.0.2
\
- Returns the max amount of loops (in [count():], [foreach():], [for():], [while():]) that are allowed.
\
+ Returns the max amount of loops (in [count():], [foreach():], [for():], [while():]) that are allowed.
\
\ Usage\
\ @@ -8167,7 +8167,7 @@ getMBL.summary = \ \\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.9.0
\
@@ -8206,7 +8206,7 @@ getMBL.summary = \
\ See Also\
\ - \ + \\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b76
\
@@ -8258,7 +8258,7 @@ getMoveCount(fractionOnly,useTerrainMods)\
\
\
@@ -8267,7 +8267,7 @@ getName.summary = \
getName() Function\
\
\
-getNotes.description = Returns the token notes for the Current Token .
+getNotes.description = Returns the token notes for the Current Token .
getNotes.summary = \
• Introduced in version 1.3b40
\
- Returns the name of a Token.
\
+ Returns the name of a Token.
\
\ Usage\
\ @@ -8280,7 +8280,7 @@ getName(id, mapname)\ Parameters\ \- \
-
id- The tokenidof the token to name, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidof the token to name, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ @@ -8371,7 +8371,7 @@ Roll 3: « 3d6 = 6 »\
\
\
@@ -8380,7 +8380,7 @@ getNotes.summary = \
getNotes() Function\
\
\
-getNPC.description = Returns a list containing the ids of the NPC tokens on the current map .
+getNPC.description = Returns a list containing the ids of the NPC tokens on the current map .
getNPC.summary = \
• Introduced in version 1.3b48
\
- Returns the token notes for the Current Token.
\
+ Returns the token notes for the Current Token.
\
\ Usage\
\ @@ -8394,7 +8394,7 @@ getNotes(id, mapname)\ Parameter\ \- \
-
id- The tokenidof the token to get the notes from.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidof the token to get the notes from.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ @@ -8417,7 +8417,7 @@ getNotes(id, mapname)\
\
\
@@ -8427,12 +8427,12 @@ getNPC.summary = \
\
\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b48
\
- Returns a list containing the ids of the NPC tokens on the current map. The type of the value returned depends on the delimiter parameter.\
-\
Usage\
@@ -8441,19 +8441,19 @@ getNPC.summary = \
\
- - If the delimiter is not specified then a string list is returned with the default value of
","is used. - If the delimiter
jsonthen a json array is returned. - Otherwise a string list is returned with the delimiter passed in.
Returns a list containing the ids of the NPC tokens on the current map. The type of the value returned depends on the delimiter parameter.\
+
\
- If the delimiter is not specified then a string list is returned with the default value of
","is used. - If the delimiter
jsonthen a json array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
Usage\
@@ -8441,19 +8441,19 @@ getNPC.summary = \
getNPC()\
getNPC(delim)
\
delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
+
delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
\ Example\
\ -To display the ids of all of the NPC tokens on the current map use.\
+
\
-getNPCNames.description = Returns a list containing the names of the NPC tokens on the current map .
+getNPCNames.description = Returns a list containing the names of the NPC tokens on the current map .
getNPCNames.summary = \
To display the ids of all of the NPC tokens on the current map use.\
\
[h: ids = getNPC()]\
[foreach(id, ids, "<br>"): id]\ See Also\
\\
- [foreach():]\
+ [foreach():]\
\
\ Version Changes\ @@ -8467,7 +8467,7 @@ getNPC(delim)\
\
\
@@ -8477,12 +8477,12 @@ getNPCNames.summary = \
\
\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b48
\
- Returns a list containing the names of the NPC tokens on the current map. The type of the value returned depends on the delimiter parameter.\
-\
Usage\
@@ -8491,19 +8491,19 @@ getNPCNames.summary = \
\
- - If the delimiter is not specified then a string list is returned with the default value of
","is used. - If the delimiter
jsonthen a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
Returns a list containing the names of the NPC tokens on the current map. The type of the value returned depends on the delimiter parameter.\
+
\
- If the delimiter is not specified then a string list is returned with the default value of
","is used. - If the delimiter
jsonthen a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
Usage\
@@ -8491,19 +8491,19 @@ getNPCNames.summary = \
[h: macros = getNPCNames()]\
[h: macros = getNPCNames(delim)]
\
delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
+
delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
\ Example\
\ -To display the names of all of the NPC tokens on the current map use.\
+
\
-getNPCs.description = Returns a list containing the ids of the NPC tokens on the current map .
+getNPCs.description = Returns a list containing the ids of the NPC tokens on the current map .
getNPCs.summary = \
To display the names of all of the NPC tokens on the current map use.\
\
[h: names = getNPCNames()]\
[foreach(name, names, "<br>"): name]\ See Also\
\\
- [foreach():]\
+ [foreach():]\
\
\ Version Changes\ @@ -8517,7 +8517,7 @@ getNPCNames.summary = \
\
\
@@ -8527,12 +8527,12 @@ getNPCs.summary = \
\
\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b48
\
- Returns a list containing the ids of the NPC tokens on the current map. The type of the value returned depends on the delimiter parameter.\
-\
Usage\
@@ -8541,19 +8541,19 @@ getNPCs.summary = \
\
- - If the delimiter is not specified then a string list is returned with the default value of
","is used. - If the delimiter
jsonthen a json array is returned. - Otherwise a string list is returned with the delimiter passed in.
Returns a list containing the ids of the NPC tokens on the current map. The type of the value returned depends on the delimiter parameter.\
+
\
- If the delimiter is not specified then a string list is returned with the default value of
","is used. - If the delimiter
jsonthen a json array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
Usage\
@@ -8541,19 +8541,19 @@ getNPCs.summary = \
getNPC()\
getNPC(delim)
\
delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
+
delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
\ Example\
\ -To display the ids of all of the NPC tokens on the current map use.\
+
\
-getOwned.description = Returns a list containing the ids of the tokens on the current map that are owned by the specified player.
+getOwned.description = Returns a list containing the ids of the tokens on the current map that are owned by the specified player.
getOwned.summary = \
To display the ids of all of the NPC tokens on the current map use.\
\
[h: ids = getNPC()]\
[foreach(id, ids, "<br>"): id]\ See Also\
\\
- [foreach():]\
+ [foreach():]\
\
\ Version Changes\ @@ -8604,7 +8604,7 @@ getOverlayProperties.summary = \
\
\
@@ -8614,12 +8614,12 @@ getOwned.summary = \
\
\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b48
\
- Returns a list containing the ids of the tokens on the current map that are owned by the specified player. The type of the value returned depends on the delimiter parameter.\
-\
Usage\
@@ -8635,13 +8635,13 @@ getOwned(player, delim, mapname)\
\
- If the delimiter is not specified then a string list is returned with the default value of
","is used. - If the delimiter
jsonthen a json array is returned. - Otherwise a string list is returned with the delimiter passed in.
Returns a list containing the ids of the tokens on the current map that are owned by the specified player. The type of the value returned depends on the delimiter parameter.\
+
\
- If the delimiter is not specified then a string list is returned with the default value of
","is used. - If the delimiter
jsonthen a json array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
Usage\
@@ -8635,13 +8635,13 @@ getOwned(player, delim, mapname)\
\
\
player - The player for which you want to retrieve the owned tokens, defaults to the current player.delim - the delimiter used to separate the values in the string list which defaults to "," if not specified.delim - the delimiter used to separate the values in the string list which defaults to "," if not specified.mapname - The name of the map to find the tokens. Defaults to the current map.
\
\
Example\
\
- To display the ids of all of the tokens on the current map by the Player use.\
+ To display the ids of all of the tokens on the current map by the Player use.\
[h: ids = getOwned(getPlayerName())]\
[foreach(id, ids, "<br>"): id]
\
\
@@ -8663,7 +8663,7 @@ getOwned(player, delim, mapname)\
\
-getOwnedNames.description = Returns a list containing the names of the tokens on the current map that are owned by the specified player.
+getOwnedNames.description = Returns a list containing the names of the tokens on the current map that are owned by the specified player.
getOwnedNames.summary = \
\
\
@@ -8673,12 +8673,12 @@ getOwnedNames.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
- Returns a list containing the names of the tokens on the current map that are owned by the specified player. The type of the value returned depends on the delimiter parameter.\
-- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a json array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
+ Returns a list containing the names of the tokens on the current map that are owned by the specified player. The type of the value returned depends on the delimiter parameter.\
+- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a json array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
\
\
Usage\
@@ -8693,13 +8693,13 @@ getOwnedNames(player, delim, mapname)\
\
\
player - The player for which you want to retrieve the owned tokens, defaults to the current player.delim - the delimiter used to separate the values in the string list which defaults to "," if not specified.delim - the delimiter used to separate the values in the string list which defaults to "," if not specified.mapname - The name of the map to find the tokens. Defaults to the current map.
\
\
Examples\
\
- To display the ids of all of the tokens on the current map by the Player use.\
+ To display the ids of all of the tokens on the current map by the Player use.\
[h: names = getOwnedNames(getPlayerName())]\
[foreach(name, names, "<br>"): name]
\
\
@@ -8721,7 +8721,7 @@ getOwnedNames(player, delim, mapname)\
\
-getOwnerOnlyVisible.description = Returns true ( 1 ) if the Visible to Owners Only flag is set on a Token otherwise returns false ( 0 ).
+getOwnerOnlyVisible.description = Returns true ( 1 ) if the Visible to Owners Only flag is set on a Token otherwise returns false ( 0 ).
getOwnerOnlyVisible.summary = \
\
\
@@ -8730,7 +8730,7 @@ getOwnerOnlyVisible.summary = \
getOwnerOnlyVisible() Function\
\
• Introduced in version 1.3b74\
- \
+ \
\
Usage\
\
@@ -8744,7 +8744,7 @@ getOwnerOnlyVisible.summary = \
Parameter\
\
\
- id - The token id of token that has its player visibility checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of token that has its player visibility checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
\
\
\
@@ -8757,7 +8757,7 @@ getOwnerOnlyVisible.summary = \
\
-getOwners.description = Returns a String List or JSON Array containing the names of the owners of a Token .
+getOwners.description = Returns a String List or JSON Array containing the names of the owners of a Token .
getOwners.summary = \
\
\
@@ -8766,7 +8766,7 @@ getOwners.summary = \
getOwners() Function\
\
• Introduced in version 1.3b48\
- Returns a String List or JSON Array containing the names of the owners of a Token. The type of the value returned depends on the delimiter parameter.\
+ Returns a String List or JSON Array containing the names of the owners of a Token. The type of the value returned depends on the delimiter parameter.\
\
Usage\
\
@@ -8780,14 +8780,14 @@ getOwners(delim, id, mapname)\
Parameters\
\
\
- delim - The delimiter used to separate the values in the String List, defaults to ",". If set to "json", this function will return a JSON Array instead of a String List.id - The token id of the token which has its owners returned, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
delim - The delimiter used to separate the values in the String List, defaults to ",". If set to "json", this function will return a JSON Array instead of a String List.id - The token id of the token which has its owners returned, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
Example\
\
- To display the owners of the Current Token use.\
+ To display the owners of the Current Token use.\
[h: names = getOwners()]\
[foreach(name, names, "<br>"): name]
\
\
@@ -8809,7 +8809,7 @@ getOwners(delim, id, mapname)\
\
-getPC.description = Returns a list containing the ids of the PC tokens on the current map .
+getPC.description = Returns a list containing the ids of the PC tokens on the current map .
getPC.summary = \
\
\
@@ -8819,12 +8819,12 @@ getPC.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
- Returns a list containing the ids of the PC tokens on the current map. The type of the value returned depends on the delimiter parameter.\
-- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
+ Returns a list containing the ids of the PC tokens on the current map. The type of the value returned depends on the delimiter parameter.\
+- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
\
\
Usage\
@@ -8833,19 +8833,19 @@ getPC.summary = \
getPC()\
getPC(delim)
\
\
- delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
+
delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
\
\
Example\
\
- To display the ids of all of the PC tokens on the current map use.\
+ To display the ids of all of the PC tokens on the current map use.\
[h: ids = getPC()]\
[foreach(id, ids, "<br>"): id]
\
\
See Also\
\
\
- [foreach():]\
+ [foreach():]\
\
\
Version Changes\
@@ -8859,7 +8859,7 @@ getPC(delim)\
\
-getPCNames.description = Returns a list containing the names of the PC tokens on the current map .
+getPCNames.description = Returns a list containing the names of the PC tokens on the current map .
getPCNames.summary = \
\
\
@@ -8869,12 +8869,12 @@ getPCNames.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
- Returns a list containing the names of the PC tokens on the current map. The type of the value returned depends on the delimiter parameter.\
-- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
+ Returns a list containing the names of the PC tokens on the current map. The type of the value returned depends on the delimiter parameter.\
+- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
\
\
Usage\
@@ -8883,19 +8883,19 @@ getPCNames.summary = \
getPCNames()\
getPCNames(delim)
\
\
- delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
+
delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
\
\
Example\
\
- To display the names of all of the PC tokens on the current map use.\
+ To display the names of all of the PC tokens on the current map use.\
[h: names = getPCNames()]\
[foreach(name, names, "<br>"): name]
\
\
See Also\
\
\
- [foreach():]\
+ [foreach():]\
\
\
Version Changes\
@@ -8909,7 +8909,7 @@ getPCNames(delim)\
\
-getPCs.description = Returns a list containing the ids of the PC tokens on the current map .
+getPCs.description = Returns a list containing the ids of the PC tokens on the current map .
getPCs.summary = \
\
\
@@ -8919,12 +8919,12 @@ getPCs.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
- Returns a list containing the ids of the PC tokens on the current map. The type of the value returned depends on the delimiter parameter.\
-- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
+ Returns a list containing the ids of the PC tokens on the current map. The type of the value returned depends on the delimiter parameter.\
+- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
\
\
Usage\
@@ -8933,19 +8933,19 @@ getPCs.summary = \
getPC()\
getPC(delim)
\
\
- delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
+
delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
\
\
Example\
\
- To display the ids of all of the PC tokens on the current map use.\
+ To display the ids of all of the PC tokens on the current map use.\
[h: ids = getPC()]\
[foreach(id, ids, "<br>"): id]
\
\
See Also\
\
\
- [foreach():]\
+ [foreach():]\
\
\
Version Changes\
@@ -8969,7 +8969,7 @@ getPenColor.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -9016,7 +9016,7 @@ getPenWidth.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -9054,7 +9054,7 @@ A drawing will have a line width, even if the line itself is not displayed. See
\
-getPlayerName.description = Returns the name of the player for the Client that it executes on.
+getPlayerName.description = Returns the name of the player for the Client that it executes on.
getPlayerName.summary = \
\
\
@@ -9063,7 +9063,7 @@ getPlayerName.summary = \
getPlayerName() Function\
\
• Introduced in version 1.3b48\
- Returns the name of the player for the Client that it executes on.\
+ Returns the name of the player for the Client that it executes on.\
\
Usage\
\
@@ -9082,7 +9082,7 @@ getPlayerName.summary = \
\
-getProperty.description = Returns the value of a Token Property on a Token .
+getProperty.description = Returns the value of a Token Property on a Token .
getProperty.summary = \
\
\
@@ -9091,8 +9091,8 @@ getProperty.summary = \
getProperty() Function\
\
• Introduced in version 1.3b48\
- Returns the value of a Token Property on a Token.\
-If the Token Property is empty (NULL) or not defined, an empty string ("") is returned.\
+ Returns the value of a Token Property on a Token.\
+If the Token Property is empty (NULL) or not defined, an empty string ("") is returned.\
\
Usage\
\
@@ -9106,7 +9106,7 @@ getProperty(property, id, mapname)\
\
\
property - The property that has its value returned. For referencing the literal name of the property (for instance, if you wish to get the property Constitution configured in Campaign Properties), enclose the property name in quotes. If using a variable whose value is the name of the property, do not enclose the variable name in quotes.id - The token id or name of the token that has its property value returned, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id or name of the token that has its property value returned, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -9145,7 +9145,7 @@ The value of property 'Constitution' is 12.
\
\
-getPropertyDefault.description = Returns the default value of a token property for the Current Token .
+getPropertyDefault.description = Returns the default value of a token property for the Current Token .
getPropertyDefault.summary = \
\
\
@@ -9154,7 +9154,7 @@ getPropertyDefault.summary = \
getPropertyDefault() Function\
\
• Introduced in version 1.3b48\
- Returns the default value of a token property for the Current Token. If the default value contains nothing then an empty string ("") is returned.\
+ Returns the default value of a token property for the Current Token. If the default value contains nothing then an empty string ("") is returned.\
\
Usage\
\
@@ -9167,13 +9167,13 @@ getPropertyDefault(name, propType)\
\
\
name - The name of the property to get the default value of.propType - The token type to get the property from. Defaults to the token type of the Current Token.propType - The token type to get the property from. Defaults to the token type of the Current Token.
\
\
\
-getPropertyNames.description = Returns a String List or JSON Array containing the names of the Token Properties for the Current Token .
+getPropertyNames.description = Returns a String List or JSON Array containing the names of the Token Properties for the Current Token .
getPropertyNames.summary = \
\
\
@@ -9182,7 +9182,7 @@ getPropertyNames.summary = \
getPropertyNames() Function\
\
• Introduced in version 1.3b48\
- Returns a String List or JSON Array containing the names of the Token Properties for the Current Token. The type of the value returned depends on the delimiter parameter. All names returned will be in lower case. Use getPropertyNamesRaw() to get the names as they are shown in Campaign Properties.\
+ Returns a String List or JSON Array containing the names of the Token Properties for the Current Token. The type of the value returned depends on the delimiter parameter. All names returned will be in lower case. Use getPropertyNamesRaw() to get the names as they are shown in Campaign Properties.\
\
When a token is added to a campaign it inherits the currently defined properties of the current campaign. These properties are persistent in the token even if the properties are subsequently removed from the campaign. Properties that have been removed from the campaign are no longer editable via the Edit Token dialog but they are still present on the token and may be read and set with getProperty() and setProperty() respectively. To get all properties defined on a token, including those removed from the campaign, use getPropertyNames(). To see only the currently defined properties for the campaign, use getAllPropertyNames().\
\
@@ -9198,14 +9198,14 @@ getPropertyNames(delim, id, mapname)\
Parameters\
\
\
- delim - The delimiter used to separate the values in the String List, defaults to ",". Returns a JSON Array if set to "json".id - The token id of the token which has its property names returned, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
delim - The delimiter used to separate the values in the String List, defaults to ",". Returns a JSON Array if set to "json".id - The token id of the token which has its property names returned, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
Example\
\
- To display the names of all of the properties on the current token use.\
+ To display the names of all of the properties on the current token use.\
[h: names = getPropertyNames()]\
[foreach(name, names, "<br>"): name]
\
\
@@ -9225,7 +9225,7 @@ getPropertyNames(delim, id, mapname)\
\
-getPropertyNamesRaw.description = Returns a String List or JSON Array containing the names of the Token Properties on a Token .
+getPropertyNamesRaw.description = Returns a String List or JSON Array containing the names of the Token Properties on a Token .
getPropertyNamesRaw.summary = \
\
\
@@ -9234,8 +9234,8 @@ getPropertyNamesRaw.summary = \
getPropertyNamesRaw() Function\
\
• Introduced in version 1.3b64\
- Returns a String List or JSON Array containing the names of the Token Properties on a Token. The type of the value returned depends on the delimiter parameter.\
-The difference between this function and getPropertyNames() is that getPropertyNames() returns all the property names in lower case (see this forum thread to get the reason why it was created).\
+ Returns a String List or JSON Array containing the names of the Token Properties on a Token. The type of the value returned depends on the delimiter parameter.\
+The difference between this function and getPropertyNames() is that getPropertyNames() returns all the property names in lower case (see this forum thread to get the reason why it was created).\
\
Usage\
\
@@ -9249,14 +9249,14 @@ getPropertyNamesRaw(delim, id, mapname)\
Parameters\
\
\
- delim - The delimiter used to separate the values in the String List, defaults to ",". Returns a JSON Array if set to "json".id - The token id of the token which has its property names returned, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
delim - The delimiter used to separate the values in the String List, defaults to ",". Returns a JSON Array if set to "json".id - The token id of the token which has its property names returned, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
Example\
\
- To display the names of all of the properties on the current token use.\
+ To display the names of all of the properties on the current token use.\
[h: names = getPropertyNamesRaw()]\
[foreach(name, names, "<br>"): name]
\
\
@@ -9279,7 +9279,7 @@ getPropertyNamesRaw(delim, id, mapname)\
\
-getPropertyType.description = Returns the Property Type of a Token .
+getPropertyType.description = Returns the Property Type of a Token .
getPropertyType.summary = \
\
\
@@ -9288,7 +9288,7 @@ getPropertyType.summary = \
getPropertyType() Function\
\
• Introduced in version 1.3b48\
- Returns the Property Type of a Token.\
+ Returns the Property Type of a Token.\
\
Usage\
\
@@ -9301,7 +9301,7 @@ getPropertyType(id, mapname)\
Parameter\
\
\
- id - The token id of the token which has its Property Type returned, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token which has its Property Type returned, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -9326,7 +9326,7 @@ getPropertyType(id, mapname)\
\
-getRawProperty.description = Gets the unevaluated value of a token property , returns "" if the property is empty.
+getRawProperty.description = Gets the unevaluated value of a token property , returns "" if the property is empty.
getRawProperty.summary = \
\
\
@@ -9335,7 +9335,7 @@ getRawProperty.summary = \
getRawProperty() Function\
\
• Introduced in version 1.3b51\
- Gets the unevaluated value of a token property, returns "" if the property is empty. This will not return the property's default value.\
+ Gets the unevaluated value of a token property, returns "" if the property is empty. This will not return the property's default value.\
\
Usage\
\
@@ -9394,13 +9394,13 @@ getRecursionDepth.summary = \
\
See Also\
\
- \
+ \
\
\
-getRolled.description = Returns a JSON Array of all the raw, i.e. unmodified, dice rolls that have occurred within the current macro context.
+getRolled.description = Returns a JSON Array of all the raw, i.e. unmodified, dice rolls that have occurred within the current macro context.
getRolled.summary = \
\
\
@@ -9409,7 +9409,7 @@ getRolled.summary = \
getRolled() Function\
\
• Introduced in version 1.5.2\
- Returns a JSON Array of all the raw, i.e. unmodified, dice rolls that have occurred within the current macro context.\
+ Returns a JSON Array of all the raw, i.e. unmodified, dice rolls that have occurred within the current macro context.\
\
Usage\
\
@@ -9446,7 +9446,7 @@ Get Rolled: [9,6,5,1]\
\
-getSelected.description = Returns a list containing the ids of the selected tokens on the current map .
+getSelected.description = Returns a list containing the ids of the selected tokens on the current map .
getSelected.summary = \
\
\
@@ -9455,8 +9455,8 @@ getSelected.summary = \
getSelected() Function\
\
• Introduced in version 1.3b48\
- Returns a list containing the ids of the selected tokens on the current map. The type of the value returned depends on the delimiter parameter.\
-- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
+ Returns a list containing the ids of the selected tokens on the current map. The type of the value returned depends on the delimiter parameter.\
+- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
\
\
Usage\
@@ -9465,12 +9465,12 @@ getSelected.summary = \
getSelected()\
getSelected(delim)
\
\
- delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
+
delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
\
\
Example\
\
- To display the ids of all of the selected tokens on the current map use.\
+ To display the ids of all of the selected tokens on the current map use.\
[h: ids = getSelected()]\
[foreach(id, ids, "<br>"): id]
\
\
@@ -9489,7 +9489,7 @@ getSelected(delim)\
\
-getSelectedNames.description = Returns a list containing the names of the selected tokens on the current map .
+getSelectedNames.description = Returns a list containing the names of the selected tokens on the current map .
getSelectedNames.summary = \
\
\
@@ -9498,8 +9498,8 @@ getSelectedNames.summary = \
getSelectedNames() Function\
\
• Introduced in version 1.3b48\
- Returns a list containing the names of the selected tokens on the current map. The type of the value returned depends on the delimiter parameter.\
-- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
+ Returns a list containing the names of the selected tokens on the current map. The type of the value returned depends on the delimiter parameter.\
+- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
\
\
Usage\
@@ -9508,12 +9508,12 @@ getSelectedNames.summary = \
getSelectedNames()\
getSelectedNames(delim)
\
\
- delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
+
delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
\
\
Example\
\
- To display the names of all of the selected tokens on the current map use.\
+ To display the names of all of the selected tokens on the current map use.\
[h: names = getSelectedNames()]\
[foreach(name, names, "<br>"): name]
\
\
@@ -9532,7 +9532,7 @@ getSelectedNames(delim)\
\
-getSightType.description = Returns the type of sight that the Current Token has.
+getSightType.description = Returns the type of sight that the Current Token has.
getSightType.summary = \
\
\
@@ -9541,7 +9541,7 @@ getSightType.summary = \
getSightType() Function\
\
• Introduced in version 1.3b48\
- Returns the type of sight that the Current Token has. When no sight type is set, returns an empty string.\
+ Returns the type of sight that the Current Token has. When no sight type is set, returns an empty string.\
\
Usage\
\
@@ -9554,7 +9554,7 @@ getSightType(mapname)\
Parameters\
\
\
- id - The id of the token to have the State set. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The id of the token to have the State set. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -9573,7 +9573,7 @@ getSightType(mapname)\
\
-getSize.description = Returns the Size of a Token .
+getSize.description = Returns the Size of a Token .
getSize.summary = \
\
\
@@ -9582,7 +9582,7 @@ getSize.summary = \
getSize() Function\
\
• Introduced in version 1.3b48\
- Returns the Size of a Token.\
+ Returns the Size of a Token.\
The sizes returned are:\
\
FineDiminutiveTinySmallMediumLargeHugeGargantuanColossal
\
@@ -9599,7 +9599,7 @@ getSize(id, mapname)\
Parameter\
\
\
- id - The token id of the token which has its Size returned, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token which has its Size returned, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -9648,7 +9648,7 @@ getSoundProperties(uri)\
Parameter\
\
\
- uri - The uri/url of the audio source to edit. If set to "*", a JSON Array containing the properties of all audio sources is returned. Defaults to "*".uri - The uri/url of the audio source to edit. If set to "*", a JSON Array containing the properties of all audio sources is returned. Defaults to "*".
\
Properties returned for streams: nicknames, uri, cycleCount, volume, startTime, stopTime, currentTime, totalTime, bufferTime, currentCount, status.\
\
@@ -9669,7 +9669,7 @@ getSoundProperties(uri)\
\
-getSpeech.description = Returns the Speech value from the Current Token .
+getSpeech.description = Returns the Speech value from the Current Token .
getSpeech.summary = \
\
\
@@ -9678,7 +9678,7 @@ getSpeech.summary = \
getSpeech() Function\
\
• Introduced in version 1.3b48\
- Returns the Speech value from the Current Token.\
+ Returns the Speech value from the Current Token.\
\
Usage\
\
@@ -9689,7 +9689,7 @@ getSpeech.summary = \
\
-getSpeechNames.description = Returns a list containing the speech names of the Current Token .
+getSpeechNames.description = Returns a list containing the speech names of the Current Token .
getSpeechNames.summary = \
\
\
@@ -9698,8 +9698,8 @@ getSpeechNames.summary = \
getSpeechNames() Function\
\
• Introduced in version 1.3b48\
- Returns a list containing the speech names of the Current Token. The type of the value returned depends on the delimiter parameter.\
-- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
+ Returns a list containing the speech names of the Current Token. The type of the value returned depends on the delimiter parameter.\
+- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
\
\
Usage\
@@ -9708,12 +9708,12 @@ getSpeechNames.summary = \
getSpeechNames()\
getSpeechNames(delim)
\
\
- delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
+
delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
\
\
Example\
\
- To display the names of all of the speech values for the Current Token use.\
+ To display the names of all of the speech values for the Current Token use.\
[h: names = getSpeech()]\
[foreach(name, names, "<br>"): name]
\
\
@@ -9731,7 +9731,7 @@ getSpeechNames(delim)\
\
-getState.description = Checks whether the specified State is active on a token, returning true ( 1 ) or false ( 0 ).
+getState.description = Checks whether the specified State is active on a token, returning true ( 1 ) or false ( 0 ).
getState.summary = \
\
\
@@ -9740,7 +9740,7 @@ getState.summary = \
getState() Function\
\
• Introduced in version 1.3b40\
- \
+ \
\
Usage\
\
@@ -9754,7 +9754,7 @@ getState(state, id, mapname)\
\
\
state - The name of the state to check for.id - The token id of the token to check for the state. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to check for the state. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -9768,7 +9768,7 @@ getState(state, id, mapname)\
\
See Also\
\
- \
+ \
\
Version Changes\
\
@@ -9782,7 +9782,7 @@ getState(state, id, mapname)\
\
-getStateImage.description = Gets the asset id for the image of a state, the state must be one of the image types for this to work.
+getStateImage.description = Gets the asset id for the image of a state, the state must be one of the image types for this to work.
getStateImage.summary = \
\
\
@@ -9791,7 +9791,7 @@ getStateImage.summary = \
getStateImage() Function\
\
• Introduced in version 1.3b40\
- Gets the asset id for the image of a state, the state must be one of the image types for this to work.\
+ Gets the asset id for the image of a state, the state must be one of the image types for this to work.\
\
Usage\
\
@@ -9811,7 +9811,7 @@ getStateImage.summary = \
\
Example\
\
- To display the image for the "Dead" token state use.\
+ To display the image for the "Dead" token state use.\
<img src='[r:getStateImage("Dead")]'></img>\
\
\
@@ -9838,7 +9838,7 @@ getSoundProperties(uri)\
Parameter\
\
\
- uri - The uri/url of the audio source to edit. If set to "*", a JSON Array containing the properties of all audio sources is returned. Defaults to "*".uri - The uri/url of the audio source to edit. If set to "*", a JSON Array containing the properties of all audio sources is returned. Defaults to "*".
\
Properties returned for streams: nicknames, uri, cycleCount, volume, startTime, stopTime, currentTime, totalTime, bufferTime, currentCount, status.\
\
@@ -9859,7 +9859,7 @@ getSoundProperties(uri)\
\
-getStrProp.description = Returns the value associated with a key from the specified string property list .
+getStrProp.description = Returns the value associated with a key from the specified string property list .
getStrProp.summary = \
\
\
@@ -9868,7 +9868,7 @@ getStrProp.summary = \
getStrProp() Function\
\
• Introduced in version 1.3b42\
- Returns the value associated with a key from the specified string property list.\
+ Returns the value associated with a key from the specified string property list.\
\
Usage\
\
@@ -9889,16 +9889,16 @@ getStrProp(propList, key, default, delim)\
\
Example\
\
- To get the name from a weapon string property list\
+ To get the name from a weapon string property list\
[h: weapon = "name=longsword; damage=1d8; maxdamage=8"]\
Name of Weapon: [r: getStrProp(weapon, "name")]
\
Returns Name of Weapon: longsword.\
-
To get the minimum damage from a weapon string property list with a default value should the key not exist\
+
To get the minimum damage from a weapon string property list with a default value should the key not exist\
\
[h: weapon = "name=longsword; damage=1d8; maxdamage=8"]\
Minimum damage of Weapon: [r: getStrProp(weapon, "mindamage", 1)]
\
Returns Minimum damage of Weapon: 1.\
-
To get the damage from a weapon string property list where the field delimiter is a colon. The default is 1d3 (note that a default value must be provided in order to specify the delimiter).\
+
To get the damage from a weapon string property list where the field delimiter is a colon. The default is 1d3 (note that a default value must be provided in order to specify the delimiter).\
\
[h: weapon = "name=longsword: damage=1d8: maxdamage=8"]\
Damage of Weapon: [r: getStrProp(weapon, "damage", "1d3", ":")]
\
@@ -9965,7 +9965,7 @@ getTableEntry.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.4\
@@ -10002,7 +10002,7 @@ getTableEntry.summary = \
\
-getTableImage.description = Gets the asset id for the image of the current row for the given table.
+getTableImage.description = Gets the asset id for the image of the current row for the given table.
getTableImage.summary = \
\
\
@@ -10012,11 +10012,11 @@ getTableImage.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
- Gets the asset id for the image of the current row for the given table. See setTableRoll() to learn how to set the current row.\
+ Gets the asset id for the image of the current row for the given table. See setTableRoll() to learn how to set the current row.\
\
Usage\
\
@@ -10050,7 +10050,7 @@ getTableNames.summary = \
getTableNames()\
getTableNames(delim)
\
\
- If delim is specified then it is used to separate the values in the list; if it is not specified then it defaults to ",". When delim is the string "json" the return value will be in the form of a JSON Array.\
+
If delim is specified then it is used to separate the values in the list; if it is not specified then it defaults to ",". When delim is the string "json" the return value will be in the form of a JSON Array.\
\
\
Examples\
@@ -10065,7 +10065,7 @@ getTableNames(delim)\
\
See Also\
\
- \
+ \
\
\
@@ -10080,7 +10080,7 @@ getTablePickOnce.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.6.0\
@@ -10121,7 +10121,7 @@ getTablePicksLeft.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.6.0\
@@ -10163,7 +10163,7 @@ getTableRoll.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.0.1\
@@ -10240,7 +10240,7 @@ getTerrainModifier.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.2\
@@ -10309,7 +10309,7 @@ getTextLabelStatus.summary = \
\
• Introduced in version 1.6\
• Last checked for compatibility with version 1.6\
- Get the display status for Text Labels. This is also shown in the View menu.\
+ Get the display status for Text Labels. This is also shown in the View menu.\
\
Usage\
\
@@ -10362,7 +10362,7 @@ getTokenDrawOrder(id, mapname)\
Parameter\
\
\
- id - The id of the token to move, defaults to the Current Token.id - The id of the token to move, defaults to the Current Token.mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -10408,7 +10408,7 @@ getTokenFacing(id, mapname)\
Parameters\
\
\
- id - The id of the token to get the facing from, defaults to the current token. Note: This parameter can only be used in a Trusted Macro.
id - The id of the token to get the facing from, defaults to the current token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
Returns\
@@ -10432,7 +10432,7 @@ The angle in degrees or "" if no facing has been set\
Returns:\
\
\
- \
+ \
\
\
\
@@ -10469,7 +10469,7 @@ getTokenGMName.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b40\
@@ -10509,7 +10509,7 @@ getTokenHalo.summary = \
\
-getTokenHandout.description = Returns the asset id of the handout image for the for the Current Token .
+getTokenHandout.description = Returns the asset id of the handout image for the for the Current Token .
getTokenHandout.summary = \
\
\
@@ -10517,7 +10517,7 @@ getTokenHandout.summary = \
\
getTokenHandout() Function\
\
- Returns the asset id of the handout image for the for the Current Token.\
+ Returns the asset id of the handout image for the for the Current Token.\
\
Usage\
\
@@ -10532,13 +10532,13 @@ getTokenHandout(size, id, mapname)\
\
\
size - OPTIONAL: The size the image should be returned as. If a blank string "", no size adjustment is done. Defaults to "".id - OPTIONAL: The token id of the token for which you want to retrieve the token handout image, defaults to the Current Token.id - OPTIONAL: The token id of the token for which you want to retrieve the token handout image, defaults to the Current Token.mapname - OPTIONAL: The name of the map to find the token. Defaults to the current map.
\
\
Example\
\
- To display the image for the current Token.\
+ To display the image for the current Token.\
<img src='[r:getTokenHandout()]'></img>
\
\
\
@@ -10577,7 +10577,7 @@ getTokenHeight(id, mapname)\
Parameter\
\
\
- id - The token id of the token to check for its height, defaults to the Current Token.id - The token id of the token to check for its height, defaults to the Current Token.mapname - The name of the map to find the token. Defaults to the current map.
\
Result
\
@@ -10613,7 +10613,7 @@ The token's boundary (image) height in pixels.\
\
-getTokenImage.description = Returns the asset id of the image for the for the Current Token .
+getTokenImage.description = Returns the asset id of the image for the for the Current Token .
getTokenImage.summary = \
\
\
@@ -10621,7 +10621,7 @@ getTokenImage.summary = \
\
getTokenImage() Function\
\
- Returns the asset id of the image for the for the Current Token.\
+ Returns the asset id of the image for the for the Current Token.\
\
Usage\
\
@@ -10636,15 +10636,15 @@ getTokenImage(size, id, mapname)\
\
\
size - OPTIONAL: The size in pixels the image should be returned as. If a blank string "", no size adjustment is done. Defaults to "".id - OPTIONAL: The token id of the token for which you want to retrieve the token image, defaults to the Current Token.id - OPTIONAL: The token id of the token for which you want to retrieve the token image, defaults to the Current Token.mapname - OPTIONAL: The name of the map to find the token. Defaults to the current map.
\
\
Examples\
\
- To display the image for the current token.\
+ To display the image for the current token.\
<img src='[r:getTokenImage()]'></img>
\
-To get the image of any token using its id and the token roll option.\
+
To get the image of any token using its id and the token roll option.\
\
[h, token(tokenId): imgAsset = getTokenImage()]
\
\
@@ -10688,7 +10688,7 @@ getTokenLabel.summary = \
\
-getTokenLayoutProps.description = Return the Token Layout scale , xOffset , and yOffset values in either a JSON Object or String Property List .
+getTokenLayoutProps.description = Return the Token Layout scale , xOffset , and yOffset values in either a JSON Object or String Property List .
getTokenLayoutProps.summary = \
\
\
@@ -10697,7 +10697,7 @@ getTokenLayoutProps.summary = \
getTokenLayoutProps() Function\
\
• Introduced in version 1.6.1\
- Return the Token Layout scale, xOffset, and yOffset values in either a JSON Object or String Property List. These values represent the positioning of the token image within the Layout portion of the Config tab in the Edit Token Dialog.\
+ Return the Token Layout scale, xOffset, and yOffset values in either a JSON Object or String Property List. These values represent the positioning of the token image within the Layout portion of the Config tab in the Edit Token Dialog.\
\
Usage\
\
@@ -10712,7 +10712,7 @@ getTokenLayoutProps(delim, id, mapName)\
\
\
delim - The delimiter of the String Property List. If set to json, the function will instead return a Json Object. Defaults to ,.id - The token id of the token to name, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to name, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -10754,7 +10754,7 @@ getTokenMap.summary = \
getTokenMap() Function\
\
• Introduced in version 1.5.11\
- Gets the list of map(s) where a token resides. The list is returned either as a string list, or as a JSON Array.\
+ Gets the list of map(s) where a token resides. The list is returned either as a string list, or as a JSON Array.\
\
Usage\
\
@@ -10782,7 +10782,7 @@ getTokenMap(name/ID, delim)\
\
-getTokenNames.description = Gets a list containing the names of all the tokens on the current map , or all the tokens that match the specified conditions.
+getTokenNames.description = Gets a list containing the names of all the tokens on the current map , or all the tokens that match the specified conditions.
getTokenNames.summary = \
\
\
@@ -10792,11 +10792,11 @@ getTokenNames.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
- Gets a list containing the names of all the tokens on the current map, or all the tokens that match the specified conditions. The type of the value returned depends on the delimiter parameter. This function does not return the IDs of lib:tokens. Note: apparently the order of the list that getTokens() returns is also the z-order of the tokens, where the lowest z-order is the first in the list or array that is returned!\
+ Gets a list containing the names of all the tokens on the current map, or all the tokens that match the specified conditions. The type of the value returned depends on the delimiter parameter. This function does not return the IDs of lib:tokens. Note: apparently the order of the list that getTokens() returns is also the z-order of the tokens, where the lowest z-order is the first in the list or array that is returned!\
\
Usage\
\
@@ -10809,9 +10809,9 @@ getTokenNames(delim, conditions)\
Parameters\
\
\
- delim - The delimiter used to separate the values in the String List that is returned, defaults to ",". If "json" is specified, a JSON Array is returned instead of a String List.conditions - A JSON Object that contains various conditions that the tokens must fullfill. All conditions are optional.\
-setStates - A JSON array of states the token must have or a single state name as a string. Any token which does not contain all of these states in the true condition will be removed from the returned list.unsetStates - A JSON array of states the token must not have or a single state name as a string.npc - If the token must be a NPC, set to true(1) or false(0).pc - If the token must be a PC, set to true(1) or false(0).propertyType - A JSON array of token types or a single token type as a string. Only tokens of a type included in the array will be returned.selected - If the token must be selected, set to true(1) or false(0).impersonated - If the token must be impersonated, set to true(1) or false(0).current - If the token must be the current token, set to true(1) or false(0).owned - A JSON Array containing player names. All tokens that have at least one of the listed players as owner will be returned. Alternatively, a string containing one of the following options:\
+ delim - The delimiter used to separate the values in the String List that is returned, defaults to ",". If "json" is specified, a JSON Array is returned instead of a String List.conditions - A JSON Object that contains various conditions that the tokens must fullfill. All conditions are optional.\
+setStates - A JSON array of states the token must have or a single state name as a string. Any token which does not contain all of these states in the true condition will be removed from the returned list.unsetStates - A JSON array of states the token must not have or a single state name as a string.npc - If the token must be a NPC, set to true(1) or false(0).pc - If the token must be a PC, set to true(1) or false(0).propertyType - A JSON array of token types or a single token type as a string. Only tokens of a type included in the array will be returned.selected - If the token must be selected, set to true(1) or false(0).impersonated - If the token must be impersonated, set to true(1) or false(0).current - If the token must be the current token, set to true(1) or false(0).owned - A JSON Array containing player names. All tokens that have at least one of the listed players as owner will be returned. Alternatively, a string containing one of the following options:\
self - tokens owned by the current playernotself - tokens not owned by the current playerothers - tokens owned by any player, but not owned by the current playerany - tokens owned by any playernone - tokens not owned by any playersingle - tokens owned by a single playermultiple - tokens owned by more than one playerbyall - tokens owned by all playersnotbyall - tokens not owned by all players
visible - If the token is visible in the current client's view. Set to true(1) or false(0).\
- When the visible option is used only tokens on the TOKEN layer and which are shown within the client's current map view will be returned.
- This is not a test of whether or not other tokens on the map out of view are visible to a specific token. See canSeeToken().
- GMs will be able to see all tokens within the current map view. Players (including View as Player) will only get returned those tokens that are shown in their current map view. Tokens returned will also be affected by server settings like Individual Views.
layer - A JSON array of layer names, or a single layer name as a string. Note that a token not on any of the listed layers will be removed from the list returned.mapName - The name of the map to get the tokens from. Defaults to the current map.range - A JSON object with range conditions, all range conditions are optional.\
token - The id or name of the source token that the distance is measured from, defaults to the current token.\
@@ -10839,7 +10839,7 @@ getTokenNames(delim, conditions)\
*You can use the following code to print out the names of all of the tokens on the current map:\
[h: names = getTokenNames()]\
[foreach(name, names, "<br>"): name]
\
-- Find and return a JSON Array containing all NPC tokens' names that are within 2 squares or hexes:
\
+- Find and return a JSON Array containing all NPC tokens' names that are within 2 squares or hexes:
\
[h: cond = '{ range: {upto:2, distancePerCell:0}, npc:1 }']\
[h: names = getTokenNames("json", cond)]
\
- Modifying the above example to exclude dead tokens:
\
@@ -10931,7 +10931,7 @@ getTokenNativeHeight(id, mapname)\
Parameter\
\
\
- id - The token id of the token to check for its height, defaults to the Current Token.id - The token id of the token to check for its height, defaults to the Current Token.mapname - The name of the map to find the token. Defaults to the current map.
\
Result
\
@@ -10989,7 +10989,7 @@ getTokenNativeWidth(id, mapname)\
Parameters\
\
\
- id - The token id of the token to check for its width, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to check for its width, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
Result
\
@@ -11047,7 +11047,7 @@ getTokenOpacity(id, mapname)\
Parameters\
\
\
- id - OPTIONAL: The token id of the token for which you want to retrieve the opacity, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - OPTIONAL: The token id of the token for which you want to retrieve the opacity, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - OPTIONAL: The name of the map to find the token. Defaults to the current map.
\
\
@@ -11074,7 +11074,7 @@ getTokenOpacity(id, mapname)\
\
-getTokenPortrait.description = Returns the asset id of the portrait image for the for the Current Token .
+getTokenPortrait.description = Returns the asset id of the portrait image for the for the Current Token .
getTokenPortrait.summary = \
\
\
@@ -11082,7 +11082,7 @@ getTokenPortrait.summary = \
\
getTokenPortrait() Function\
\
- Returns the asset id of the portrait image for the for the Current Token.\
+ Returns the asset id of the portrait image for the for the Current Token.\
\
Usage\
\
@@ -11097,13 +11097,13 @@ getTokenPortrait(size, id, mapname)\
\
\
size - OPTIONAL: The size the picture should be returned as. If a blank string "", no size adjustment is done. Defaults to "".id - OPTIONAL: The token id of the token for which you want to retrieve the token image, defaults to the Current Token.id - OPTIONAL: The token id of the token for which you want to retrieve the token image, defaults to the Current Token.mapname - OPTIONAL: The name of the map to find the token. Defaults to the current map.
\
\
Examples\
\
- To display the image for the current Token.\
+ To display the image for the current Token.\
<img src='[r:getTokenPortrait()]'></img>
\
\
Version Changes\
@@ -11147,7 +11147,7 @@ getTokenRotation(id, mapname)\
Parameters\
\
\
- id - The token id of the token to retrieve the rotation angle. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to retrieve the rotation angle. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
Result
\
@@ -11166,7 +11166,7 @@ The function returns the token's rotation as a numeric value measured in degrees
[h: switchToken("Troll")]\
[r: token.name] - [r: r = getTokenRotation()]
\
Returns:\
-
\
+\
Relation to Token Facing
When the facing is defined, the relation between a token's rotation and the token's facing can be expressed as\
\
rotation = -(facing + 90)
\
@@ -11199,7 +11199,7 @@ getTokens.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
@@ -11217,9 +11217,9 @@ getTokens(delim, conditions)\
Parameters\
\
\
- delim - The delimiter used to sepearate the values in the String List that is returned, defaults to ",". If "json" is specified, a JSON Array is returned instead of a String List.conditions - A JSON Object that contains various conditions that the tokens must fullfill. All conditions are optional.\
-setStates - A JSON array of states the token must have or a single state name as a string. Any token which does not contain all of these states in the true condition will be removed from the returned list.unsetStates - A JSON array of states the token must not have or a single state name as a string.npc - If the token must be a NPC, set to true(1) or false(0).pc - If the token must be a PC, set to true(1) or false(0).propertyType - A JSON array of token types or a single token type as a string. Only tokens of a type included in the array will be returned.selected - If the token must be selected, set to true(1) or false(0).impersonated - If the token must be impersonated, set to true(1) or false(0).current - If the token must be the current token, set to true(1) or false(0).owned - A JSON Array containing player names. All tokens that have at least one of the listed players as owner will be returned. Alternatively, a string containing one of the following options:\
+ delim - The delimiter used to sepearate the values in the String List that is returned, defaults to ",". If "json" is specified, a JSON Array is returned instead of a String List.conditions - A JSON Object that contains various conditions that the tokens must fullfill. All conditions are optional.\
+setStates - A JSON array of states the token must have or a single state name as a string. Any token which does not contain all of these states in the true condition will be removed from the returned list.unsetStates - A JSON array of states the token must not have or a single state name as a string.npc - If the token must be a NPC, set to true(1) or false(0).pc - If the token must be a PC, set to true(1) or false(0).propertyType - A JSON array of token types or a single token type as a string. Only tokens of a type included in the array will be returned.selected - If the token must be selected, set to true(1) or false(0).impersonated - If the token must be impersonated, set to true(1) or false(0).current - If the token must be the current token, set to true(1) or false(0).owned - A JSON Array containing player names. All tokens that have at least one of the listed players as owner will be returned. Alternatively, a string containing one of the following options:\
self - tokens owned by the current playernotself - tokens not owned by the current playerothers - tokens owned by any player, but not owned by the current playerany - tokens owned by any playernone - tokens not owned by any playersingle - tokens owned by a single playermultiple - tokens owned by more than one playerbyall - tokens owned by all playersnotbyall - tokens not owned by all players
visible - If the token is visible in the current client's view. Set to true(1) or false(0).\
- When the visible option is used only tokens on the TOKEN layer and which are shown within the client's current map view will be returned.
- This is not a test of whether or not other tokens on the map out of view are visible to a specific token. See canSeeToken().
- GMs will be able to see all tokens within the current map view. Players (including View as Player) will only get returned those tokens that are shown in their current map view. Tokens returned will also be affected by server settings like Individual Views.
layer - A JSON array of layer names, or a single layer name as a string. Only tokens on one of the listed layers will be returned. By default, tokens on the Token and Hidden layers are returned.mapName - The name of the map to get the tokens from. Defaults to the current map.range - A JSON object with range conditions, all range conditions are optional.\
token - The id or name of the source token that the distance is measured from, defaults to the current token.\
@@ -11250,7 +11250,7 @@ The movement metric in range specifies the movement metric use, the metric can b
[foreach(id, ids, "<br>"): id]
\
- Find ALL the tokens on ALL the layers on the map:
\
[r:getTokens(",", json.set("{}", "layer", json.append("[]","TOKEN","HIDDEN","OBJECT","BACKGROUND")))]
\
-- Find and return a JSON Array containing all NPC tokens that are with 2 squares or hexes of the selected token:
\
+- Find and return a JSON Array containing all NPC tokens that are with 2 squares or hexes of the selected token:
\
[h: cond = '{ "range": {"upto":2, "distancePerCell":0, "token":"' +getSelected()+ '"}, "npc":1}']\
[h: ids = getTokens("json", cond)]
\
- Modifying the above example to exclude dead tokens:
\
@@ -11337,7 +11337,7 @@ getTokenShape(id, mapname)\
Parameters\
\
\
- id - The token id of the token to check for the shape, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to check for the shape, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
Result
\
@@ -11370,7 +11370,7 @@ The function returns the token's shape as a string value: "TOP_DOWN"\
-getTokenStates.description = Returns the valid states in the campaign settings in either a String List or JSON Array .
+getTokenStates.description = Returns the valid states in the campaign settings in either a String List or JSON Array .
getTokenStates.summary = \
\
\
@@ -11379,7 +11379,7 @@ getTokenStates.summary = \
getTokenStates() Function\
\
• Introduced in version 1.3b51\
- Returns the valid states in the campaign settings in either a String List or JSON Array. Alternatively, if a token id is specified, instead returns the list of the states that are set to true(1) for the token.\
+ Returns the valid states in the campaign settings in either a String List or JSON Array. Alternatively, if a token id is specified, instead returns the list of the states that are set to true(1) for the token.\
\
Usage\
\
@@ -11396,21 +11396,21 @@ getTokenStates(delim, groupName, id, mapname)\
\
delim - Specifies the delimiter used in the string list that is returned, default is ",". If the value is set to json, the function returns a JSON array instead.groupName - Specifies the name of the group to get the states for. If set to "*", get all states.id - The id of the token to get the states set to true(1). If the parameter is not used, instead returns all valid states in the campaign settings. Note: This parameter can only be used in a Trusted Macro.
id - The id of the token to get the states set to true(1). If the parameter is not used, instead returns all valid states in the campaign settings. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map where the token is. Set to the current map by default.
\
\
Example\
\
- To get a String List of the valid Token States in the campaign.\
+ To get a String List of the valid Token States in the campaign.\
[h: states = getTokenStates()]
\
-To get a JSON Array of the valid Token States in the campaign.\
+
To get a JSON Array of the valid Token States in the campaign.\
\
[h: states = getTokenStates("json")]\
-To get a JSON Array of the valid Token States in the Damage group in the campaign in 1.3b55 or later.\
+
To get a JSON Array of the valid Token States in the Damage group in the campaign in 1.3b55 or later.\
\
[h: states = getTokenStates("json", "Damage")]\
-To get a JSON Array of the Token States set to true(1) for the "Dragon" token:\
+
To get a JSON Array of the Token States set to true(1) for the "Dragon" token:\
\
[h: states = getTokenStates("json", "*", "Dragon")]\
\
@@ -11439,7 +11439,7 @@ getTokenVBL.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.1.6\
@@ -11458,7 +11458,7 @@ getTokenVBL.summary = \
Parameters\
\
\
- id - OPTIONAL: The token id of the token for which you want to get the VBL. Defaults to the Current Token.id - OPTIONAL: The token id of the token for which you want to get the VBL. Defaults to the Current Token.
\
\
Example:\
@@ -11476,7 +11476,7 @@ getTokenVBL.summary = \
\
See Also\
\
- \
+ \
\
\
@@ -11503,7 +11503,7 @@ getTokenWidth(id, mapname)\
Parameters\
\
\
- id - The token id of the token to check for its width, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to check for its width, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
Result
\
@@ -11563,7 +11563,7 @@ getTokenX(units, id, mapname)\
\
\
units - If set to false(0), the coordinate is a location on the grid in number of cells. Defaults to true(1), where the coordinate is in number of Pixels (in other words 0:distance in cells, 1: distance in pixels)'.id - The id of the token to move, defaults to the Current Token.id - The id of the token to move, defaults to the Current Token.mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -11595,13 +11595,13 @@ The exception to this is when the token is 'Freesize' AND 'Snapped to Grid' AND
\
Examples\
\
- Moves the Current Token down 5 units, and left 10 units.\
+ Moves the Current Token down 5 units, and left 10 units.\
[h: CurrentX = getTokenX()]\
[h: CurrentY = getTokenY()]\
[h: NewX = CurrentX + 5]\
[h: NewY = CurrentY - 10]\
[h: moveToken(NewX, NewY)]
\
-Moves the Current Token down 5 cells, and left 10 cells.\
+
Moves the Current Token down 5 cells, and left 10 cells.\
\
[h: CurrentX = getTokenX(0)]\
[h: CurrentY = getTokenY(0)]\
@@ -11651,7 +11651,7 @@ getTokenY(units, id, mapname)
\
\
\
units - If set to false(0), the coordinate is a location on the grid in number of cells. Defaults to true(1), where the coordinate is in number of Pixels (in other words 0:distance in cells, 1: distance in pixels)'.id - The id of the token to move, defaults to the Current Token.id - The id of the token to move, defaults to the Current Token.mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -11683,13 +11683,13 @@ The exception to this is when the token is 'Freesize' AND 'Snapped to Grid' AND
\
Examples\
\
- Moves the Current Token down 5 units, and left 10 units.\
+ Moves the Current Token down 5 units, and left 10 units.\
[h: CurrentX = getTokenX()]\
[h: CurrentY = getTokenY()]\
[h: NewX = CurrentX + 5]\
[h: NewY = CurrentY - 10]\
[h: moveToken(NewX, NewY)]
\
-Moves the Current Token down 5 cells, and left 10 cells.\
+
Moves the Current Token down 5 cells, and left 10 cells.\
\
[h: CurrentX = getTokenX(0)]\
[h: CurrentY = getTokenY(0)]\
@@ -11725,7 +11725,7 @@ getVBL.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b90\
@@ -11764,7 +11764,7 @@ getVBL.summary = \
\
See Also\
\
- \
+ \
\
\
@@ -11875,7 +11875,7 @@ centerX=646; centerY=319,\
\
-getVisible.description = Returns true ( 1 ) if the visible to players flag is set on a Token otherwise returns false ( 0 ).
+getVisible.description = Returns true ( 1 ) if the visible to players flag is set on a Token otherwise returns false ( 0 ).
getVisible.summary = \
\
\
@@ -11884,7 +11884,7 @@ getVisible.summary = \
getVisible() Function\
\
• Introduced in version 1.3b40\
- Returns true(1) if the visible to players flag is set on a Token otherwise returns false(0). The visible to players flag has two meanings, on a normal Token players will only be able to see the Token if it is set (when all other things like Fog of War etc are taken into account). If it is a Library Token then it determines if players can call Macros using [macro():].\
+ Returns true(1) if the visible to players flag is set on a Token otherwise returns false(0). The visible to players flag has two meanings, on a normal Token players will only be able to see the Token if it is set (when all other things like Fog of War etc are taken into account). If it is a Library Token then it determines if players can call Macros using [macro():].\
\
Usage\
\
@@ -11898,7 +11898,7 @@ getVisible.summary = \
Parameter\
\
\
- id - The token id of token that has its player visibility checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of token that has its player visibility checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
\
\
\
@@ -11921,7 +11921,7 @@ getVisible.summary = \
\
-getVisibleMapDisplayNames.description = Returns the display names of all of the player visible maps as either a String List or JSON Array .
+getVisibleMapDisplayNames.description = Returns the display names of all of the player visible maps as either a String List or JSON Array .
getVisibleMapDisplayNames.summary = \
\
\
@@ -11930,7 +11930,7 @@ getVisibleMapDisplayNames.summary = \
getVisibleMapNames() Function\
\
• Introduced in version 1.9.0\
- Returns the display names of all of the player visible maps as either a String List or JSON Array.\
+ Returns the display names of all of the player visible maps as either a String List or JSON Array.\
\
Usage\
\
@@ -11944,14 +11944,14 @@ getVisibleMapDisplayNames.summary = \
Parameters\
\
\
- delim - The delimiter to use for the String List. If the value is json then a JSON Array is returned.delim - The delimiter to use for the String List. If the value is json then a JSON Array is returned.
\
\
Examples\
\
- To get the display names of all of the player visible maps in a String List.\
+ To get the display names of all of the player visible maps in a String List.\
[h: maps = getVisibleMapNames()]
\
-To get the display names of all of the player visible maps in a JSON Array\
+
To get the display names of all of the player visible maps in a JSON Array\
\
[h: maps = getVisibleMapNames("json")]\
\
@@ -11965,7 +11965,7 @@ getVisibleMapDisplayNames.summary = \
\
-getVisibleMapNames.description = Returns the names of all of the player visible maps as either a String List or JSON Array .
+getVisibleMapNames.description = Returns the names of all of the player visible maps as either a String List or JSON Array .
getVisibleMapNames.summary = \
\
\
@@ -11974,7 +11974,7 @@ getVisibleMapNames.summary = \
getVisibleMapNames() Function\
\
• Introduced in version 1.3b55\
- Returns the names of all of the player visible maps as either a String List or JSON Array.\
+ Returns the names of all of the player visible maps as either a String List or JSON Array.\
\
Usage\
\
@@ -11988,14 +11988,14 @@ getVisibleMapNames.summary = \
Parameters\
\
\
- delim - The delimiter to use for the String List. If the value is json then a JSON Array is returned.delim - The delimiter to use for the String List. If the value is json then a JSON Array is returned.
\
\
Examples\
\
- To get the names of all of the player visible maps in a String List.\
+ To get the names of all of the player visible maps in a String List.\
[h: maps = getVisibleMapNames()]
\
-To get the names of all of the player visible maps in a JSON Array\
+
To get the names of all of the player visible maps in a JSON Array\
\
[h: maps = getVisibleMapNames("json")]\
\
@@ -12009,7 +12009,7 @@ getVisibleMapNames.summary = \
\
-getVisibleTokenNames.description = Returns a string list or JSON Array of Token:token names for the tokens that are visible to the player.
+getVisibleTokenNames.description = Returns a string list or JSON Array of Token:token names for the tokens that are visible to the player.
getVisibleTokenNames.summary = \
\
\
@@ -12018,8 +12018,8 @@ getVisibleTokenNames.summary = \
getVisibleTokenNames() Function\
\
• Introduced in version 1.3b49\
- Returns a string list or JSON Array of Token:token names for the tokens that are visible to the player. The type of the value returned depends on the delimiter parameter.\
-- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
+ Returns a string list or JSON Array of Token:token names for the tokens that are visible to the player. The type of the value returned depends on the delimiter parameter.\
+- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
\
\
Usage\
@@ -12051,7 +12051,7 @@ getVisibleTokenNames.summary = \
\
-getVisibleTokens.description = Returns a string list or JSON Array of token ids for the tokens that are visible to the player.
+getVisibleTokens.description = Returns a string list or JSON Array of token ids for the tokens that are visible to the player.
getVisibleTokens.summary = \
\
\
@@ -12060,8 +12060,8 @@ getVisibleTokens.summary = \
getVisibleTokens() Function\
\
• Introduced in version 1.3b49\
- Returns a string list or JSON Array of token ids for the tokens that are visible to the player. The type of the value returned depends on the delimiter parameter.\
-- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
+ Returns a string list or JSON Array of token ids for the tokens that are visible to the player. The type of the value returned depends on the delimiter parameter.\
+- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
\
\
Usage\
@@ -12098,7 +12098,7 @@ getVisibleTokens.summary = \
\
-getWithState.description = Gets a list containing the ids of all the tokens on the current map that have the specified token state set.
+getWithState.description = Gets a list containing the ids of all the tokens on the current map that have the specified token state set.
getWithState.summary = \
\
\
@@ -12108,12 +12108,12 @@ getWithState.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
- Gets a list containing the ids of all the tokens on the current map that have the specified token state set. The type of the value returned depends on the delimiter parameter.\
-- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
+ Gets a list containing the ids of all the tokens on the current map that have the specified token state set. The type of the value returned depends on the delimiter parameter.\
+- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
\
\
Usage\
@@ -12127,7 +12127,7 @@ getWithState(state, delim)\
\
Example\
\
- You can use the following code to print out the ids of all of the tokens on the current map with the "Dead" token state set.\
+ You can use the following code to print out the ids of all of the tokens on the current map with the "Dead" token state set.\
[h: ids = getWithState("Dead")]\
[foreach(id, ids, "<br>"): id]\
\
@@ -12145,7 +12145,7 @@ getWithState(state, delim)\
\
-getWithStateNames.description = Gets a list containing the names of all the tokens on the current map that have the specified token state set.
+getWithStateNames.description = Gets a list containing the names of all the tokens on the current map that have the specified token state set.
getWithStateNames.summary = \
\
\
@@ -12155,12 +12155,12 @@ getWithStateNames.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
- Gets a list containing the names of all the tokens on the current map that have the specified token state set. The type of the value returned depends on the delimiter parameter.\
-- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
+ Gets a list containing the names of all the tokens on the current map that have the specified token state set. The type of the value returned depends on the delimiter parameter.\
+- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
\
\
Usage\
@@ -12174,7 +12174,7 @@ getWithStateNames(state, delim)\
\
Example\
\
- You can use the following code to print out the names of all of the tokens on the current map with the "Dead" token state set.\
+ You can use the following code to print out the names of all of the tokens on the current map with the "Dead" token state set.\
[h: names = getWithStateNames("Dead")]\
[foreach(name, names, "<br>"): name]\
\
@@ -12329,7 +12329,7 @@ gt.summary = \
\
-hasImpersonated.description = Returns 1 if there is an impersonated token otherwise returns 0.
+hasImpersonated.description = Returns 1 if there is an impersonated token otherwise returns 0.
hasImpersonated.summary = \
\
\
@@ -12338,7 +12338,7 @@ hasImpersonated.summary = \
hasImpersonated() Function\
\
• Introduced in version 1.3b48\
- Returns 1 if there is an impersonated token otherwise returns 0.\
+ Returns 1 if there is an impersonated token otherwise returns 0.\
\
Usage\
\
@@ -12349,7 +12349,7 @@ hasImpersonated.summary = \
\
-hasLightSource.description = Returns 1 if the Current Token has any light sources that match the criteria passed in or 0 if there are no matches.
+hasLightSource.description = Returns 1 if the Current Token has any light sources that match the criteria passed in or 0 if there are no matches.
hasLightSource.summary = \
\
\
@@ -12358,7 +12358,7 @@ hasLightSource.summary = \
hasLightSource() Function\
\
• Introduced in version 1.3b48\
- Returns 1 if the Current Token has any light sources that match the criteria passed in or 0 if there are no matches. If no arguments are passed to the function then it will return 1 if any light source is on. If only the first argument is passed it will return 1 if any light source of that light source type is on. If both arguments are passed to the function it will return 1 if the light source with the specified name and specified light source type is on.\
+ Returns 1 if the Current Token has any light sources that match the criteria passed in or 0 if there are no matches. If no arguments are passed to the function then it will return 1 if any light source is on. If only the first argument is passed it will return 1 if any light source of that light source type is on. If both arguments are passed to the function it will return 1 if the light source with the specified name and specified light source type is on.\
\
Usage\
\
@@ -12374,8 +12374,8 @@ hasLightSource(type, name, id, mapname)\
\
\
type - The light source type, (e.g. "Generic", "D20"). If "*" is entered, all light sources types are checked. Defaults to "*".name - the name of the light source. If "*" is entered, all light sources names are checked. Defaults to "*".id - The token id of the token which is checked for light sources, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
name - the name of the light source. If "*" is entered, all light sources names are checked. Defaults to "*".id - The token id of the token which is checked for light sources, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -12401,7 +12401,7 @@ hasLightSource(type, name, id, mapname)\
\
-hasMacro.description = Returns true ( 1 ) if a macro button with the specified label exists on the Current Token .
+hasMacro.description = Returns true ( 1 ) if a macro button with the specified label exists on the Current Token .
hasMacro.summary = \
\
\
@@ -12410,7 +12410,7 @@ hasMacro.summary = \
hasMacro() Function\
\
• Introduced in version 1.3b48\
- \
+ \
\
Usage\
\
@@ -12424,7 +12424,7 @@ hasMacro(label, id, mapname)\
\
\
label - The label of the macro to check for.id - The token id of the token that the function is executed on. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token that the function is executed on. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -12443,7 +12443,7 @@ hasMacro(label, id, mapname)\
\
-hasProperty.description = Returns true ( 1 ) if the Token Property with the specified name exists on a Token .
+hasProperty.description = Returns true ( 1 ) if the Token Property with the specified name exists on a Token .
hasProperty.summary = \
\
\
@@ -12452,7 +12452,7 @@ hasProperty.summary = \
hasProperty() Function\
\
• Introduced in version 1.3b48\
- Returns true(1) if the Token Property with the specified name exists on a Token. The function will return true if the token possesses the specified property, even if that property is not defined in the token's current property type.\
+ Returns true(1) if the Token Property with the specified name exists on a Token. The function will return true if the token possesses the specified property, even if that property is not defined in the token's current property type.\
\
Usage\
\
@@ -12465,8 +12465,8 @@ hasProperty(name, id, mapname)\
Parameters\
\
\
- name - The name of the Token Property which is checked for on the token.id - The token id of the token which is checked for the Token Property, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
name - The name of the Token Property which is checked for on the token.id - The token id of the token which is checked for the Token Property, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -12485,7 +12485,7 @@ hasProperty(name, id, mapname)\
\
-hasSight.description = Returns 1 if the Current Token has sight .
+hasSight.description = Returns 1 if the Current Token has sight .
hasSight.summary = \
\
\
@@ -12494,7 +12494,7 @@ hasSight.summary = \
hasSight() Function\
\
• Introduced in version 1.3b48\
- Returns 1 if the Current Token has sight.\
+ Returns 1 if the Current Token has sight.\
\
Usage\
\
@@ -12507,7 +12507,7 @@ hasSight(id, mapname)\
Parameters\
\
\
- id - The id of the token to return the sight. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The id of the token to return the sight. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -12566,7 +12566,7 @@ Returns a number than is between 5 and 50 for the hero
See Also\
\
\
+For another method of rolling dice, see Dice Expressions.\
\
\
@@ -12609,7 +12609,7 @@ Returns a number than is between 5 and 50 for the hero
See Also\
\
\
+For another method of rolling dice, see Dice Expressions.\
\
\
@@ -12624,7 +12624,7 @@ herolab.getImage.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5\
@@ -12658,7 +12658,7 @@ herolab.getImage(index, id)\
See Also\
\
\
\
Version Changes\
@@ -12682,7 +12682,7 @@ herolab.getInfo.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5\
@@ -12719,7 +12719,7 @@ herolab.getInfo(id,field)\
See Also\
\
\
\
Version Changes\
@@ -12743,7 +12743,7 @@ herolab.getMasterName.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5\
@@ -12775,7 +12775,7 @@ herolab.getMasterName(id)\
See Also\
\
\
\
Version Changes\
@@ -12799,7 +12799,7 @@ herolab.getStatBlock.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5\
@@ -12811,7 +12811,7 @@ herolab.getStatBlock.summary = \
herolab.getStatBlock(type)\
herolab.getStatBlock(type,id)
\
\
- Note: The different formats may or may not contain the same information but it does reflects what is stored in the portfolio. If you find missing information, in the XML statblock for instance, you will need to report that to [Wolf Lair].\
+
Note: The different formats may or may not contain the same information but it does reflects what is stored in the portfolio. If you find missing information, in the XML statblock for instance, you will need to report that to [Wolf Lair].\
\
\
Parameters\
@@ -12834,7 +12834,7 @@ herolab.getStatBlock(type,id)\
See Also\
\
\
\
Version Changes\
@@ -12858,7 +12858,7 @@ herolab.hasChanged.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5\
@@ -12890,7 +12890,7 @@ herolab.hasChanged(id)\
See Also\
\
\
\
Version Changes\
@@ -12914,7 +12914,7 @@ herolab.isMinion.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5\
@@ -12951,7 +12951,7 @@ herolab.isMinion(id)\
See Also\
\
\
\
Version Changes\
@@ -12975,7 +12975,7 @@ herolab.refresh.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5\
@@ -13009,7 +13009,7 @@ herolab.refresh(id)\
See Also\
\
\
\
Version Changes\
@@ -13033,7 +13033,7 @@ herolab.XPath.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -13058,7 +13058,7 @@ herolab.XPath(XPath, id, "json")\
\
XPath - The XPath expression to evaluate against the XML statblock.id - The id of the token. Defaults to the Current Token.delim - Coming in 1.8. Custom delimiter for the returned results. Defaults to ", ". If equal to "json", a JSON Array will be returned instead of a String List.delim - Coming in 1.8. Custom delimiter for the returned results. Defaults to ", ". If equal to "json", a JSON Array will be returned instead of a String List.
\
Returns the requested data.\
\
@@ -13073,7 +13073,7 @@ herolab.XPath(XPath, id, "json")\
\
Human Neutral Good 1
\
Changes Coming in 1.8
\
-Sometimes the data desired from herolab contains commas or is otherwise incompatible with the String List format and default (comma) separator. In the following example, the list of spells retrieved includes one called "Delay Poison, Communal" - as we see in the default output, this element would be incompatible with the standard String List format.\
+
Sometimes the data desired from herolab contains commas or is otherwise incompatible with the String List format and default (comma) separator. In the following example, the list of spells retrieved includes one called "Delay Poison, Communal" - as we see in the default output, this element would be incompatible with the standard String List format.\
\
[h: vXPath = "/document/public/character/spellsmemorized/spell[contains(@name,'De')]/@name"]\
Default: [r: herolab.XPath(vXPath)]<br />\
@@ -13094,7 +13094,7 @@ When dealing with more complicated text elements with potential delimiter confli
See Also\
\
\
\
Version Changes\
@@ -13149,7 +13149,7 @@ Returns a number than is between 5 and 50 for the hero
See Also\
\
\
+For another method of rolling dice, see Dice Expressions.\
\
\
@@ -13189,7 +13189,7 @@ hideTextLabels.summary = \
\
• Introduced in version 1.6\
• Last checked for compatibility with version 1.6\
- Disables the display of Text Labels if they are not showing. This can also be set in the View menu.\
+ Disables the display of Text Labels if they are not showing. This can also be set in the View menu.\
\
Usage\
\
@@ -13300,7 +13300,7 @@ This function doesn't have the parentheses limit that the roll option has:\
Parameters\
\
\
- condition - What is tested to determine is the trueExpr or falseExpr will be executed. This follows the standard rules for conditions that can be found in the Branching and Looping article.condition - What is tested to determine is the trueExpr or falseExpr will be executed. This follows the standard rules for conditions that can be found in the Branching and Looping article.trueExpr - A section of code that is returned if condition is true(1).falseExpr - A section of code that is returned if condition is false(0).
\
@@ -13357,7 +13357,7 @@ This function doesn't have the parentheses limit that the roll option has:\
\
- Returns:
property set to 0 \
\
-
Example 5: Usually its better to use the roll option version [if():]. Sometimes it's pretty handy to use the version documented here, since you can easily embed it in loops and expressions.\
+
Example 5: Usually its better to use the roll option version [if():]. Sometimes it's pretty handy to use the version documented here, since you can easily embed it in loops and expressions.\
\
Let's say you want to check if one of a player's tokens has Initiative, you could do it this like this:\
\
@@ -13371,7 +13371,7 @@ This function doesn't have the parentheses limit that the roll option has:\
\
See Also\
\
- \
+ \
\
\
@@ -13386,12 +13386,12 @@ impersonate.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.7.0\
• Last checked for compatibility with version 1.7.0\
- Impersonate changes the impersonated token for the client running the function, replacing any current impersonation. Rather than being used like switchToken() to aid in macro execution, this function is the same as right-clicking a token and selecting 'Impersonate'. The function does not set the Current Token. Use switchToken() for that.\
+ Impersonate changes the impersonated token for the client running the function, replacing any current impersonation. Rather than being used like switchToken() to aid in macro execution, this function is the same as right-clicking a token and selecting 'Impersonate'. The function does not set the Current Token. Use switchToken() for that.\
\
Usage\
\
@@ -13413,7 +13413,7 @@ Nice weather, eh?<br>\
Seen any dragons?\
Output:\
\
-
\
+\
\
See Also\
\
@@ -13430,7 +13430,7 @@ Seen any dragons?\
\
-indexKeyStrProp.description = Returns the key from the specified string property list at the specified index.
+indexKeyStrProp.description = Returns the key from the specified string property list at the specified index.
indexKeyStrProp.summary = \
\
\
@@ -13439,7 +13439,7 @@ indexKeyStrProp.summary = \
indexKeyStrProp() Function\
\
• Introduced in version 1.3b42\
- Returns the key from the specified string property list at the specified index. The index for the string property list starts at 0.\
+ Returns the key from the specified string property list at the specified index. The index for the string property list starts at 0.\
\
Usage\
\
@@ -13485,7 +13485,7 @@ Returns -1.\
\
-indexValueStrProp.description = Returns the value from the specified string property list at the specified index.
+indexValueStrProp.description = Returns the value from the specified string property list at the specified index.
indexValueStrProp.summary = \
\
\
@@ -13494,7 +13494,7 @@ indexValueStrProp.summary = \
indexValueStrProp() Function\
\
• Introduced in version 1.3b42\
- Returns the value from the specified string property list at the specified index. The index for the string property list starts at 0.\
+ Returns the value from the specified string property list at the specified index. The index for the string property list starts at 0.\
\
Usage\
\
@@ -13510,7 +13510,7 @@ Returns "doh".\
\
-initiativeSize.description = Returns the number of tokens in the initiative panel
+initiativeSize.description = Returns the number of tokens in the initiative panel
initiativeSize.summary = \
\
\
@@ -13518,7 +13518,7 @@ initiativeSize.summary = \
\
initiativeSize() Function\
\
- Returns the number of tokens in the initiative panel\
+ Returns the number of tokens in the initiative panel\
\
Usage\
\
@@ -13560,7 +13560,7 @@ Note that there are no built-in mechanisms for input validation for TEXTParameters\
\
\
- 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.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:\
\
@@ -13610,7 +13610,7 @@ Note that there are no built-in mechanisms for input validation for TEXTICONSIZE=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.DELIMITER=, - The delimiter used in the list; defaults to the comma ,. The delimiter cannot contain empty spaces. If set to JSON, a JSON Array should be provided instead.DELIMITER=, - The delimiter used in the list; defaults to the comma ,. The delimiter cannot contain empty spaces. If set to JSON, a JSON Array should be provided instead.
\
\
@@ -13638,7 +13638,7 @@ Note that there are no built-in mechanisms for input validation for TEXTSELECT=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.DELIMITER=, - The delimiter used in the list; defaults to the comma ,. The delimiter cannot contain empty spaces. If set to JSON, a JSON Array should be provided instead.DELIMITER=, - The delimiter used in the list; defaults to the comma ,. The delimiter cannot contain empty spaces. If set to JSON, a JSON Array should be provided instead.\
\
@@ -13662,14 +13662,14 @@ Note that there are no built-in mechanisms for input validation for TEXT\
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.\
+
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.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.WIDTH=nnn - Sets the width of the input box; defaults to WIDTH=14.TYPE=JSON - Result returned in variableName will be a JSON object instead of string property.TEXT\
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.\
+
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\
@@ -13709,7 +13709,7 @@ Note that there are no built-in mechanisms for input validation for TEXTDisplays:\
\
\
@@ -13732,7 +13732,7 @@ Note that there are no built-in mechanisms for input validation for TEXTDisplays:\
\
\
@@ -13752,11 +13752,11 @@ Note that there are no built-in mechanisms for input validation for TEXTDisplays:\
\
\
- 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.\
+
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.\
\
\
Input using using the DELIMITER option for LIST.\
@@ -13791,7 +13791,7 @@ You chose: [r: color] [r: meat] with [r: sauce]\
inptext\
)]\
\
- 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.\
+
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. Dynamic Variable Example, by aliasmask. Uses strformat to create the property names and json.evaluate to put in default values.\
@@ -13916,7 +13916,7 @@ If you really want to go full monty on the tooltip INSIDE the input, here's an e
This is the result:\
\
\
@@ -13942,7 +13942,7 @@ This can simply be done with the <html><img> tags. Howe
[h:input("junk|<html><img src='"+replace(getTokenHandout(), ":", ":")+"' height=90 width=90></img></html>|-|LABEL|SPAN=TRUE")]\
\
\
@@ -13967,7 +13967,7 @@ This can simply be done with the <html><img> tags. Howe
[r,token(me), if(picChoice == 2): "<img src='"+getTokenHandout(picSize)+"'></img>"]\
\
\
@@ -13993,7 +13993,7 @@ This can simply be done with the <html><img> tags. Howe
\
-isBarVisible.description = Returns true ( 1 ) if the specified Token Bar on the Current Token is visible, or false ( 0 ) if it is not.
+isBarVisible.description = Returns true ( 1 ) if the specified Token Bar on the Current Token is visible, or false ( 0 ) if it is not.
isBarVisible.summary = \
\
\
@@ -14002,7 +14002,7 @@ isBarVisible.summary = \
isBarVisible() Function\
\
• Introduced in version 1.3b46\
- Returns true(1) if the specified Token Bar on the Current Token is visible, or false(0) if it is not.\
+ Returns true(1) if the specified Token Bar on the Current Token is visible, or false(0) if it is not.\
\
Usage\
\
@@ -14016,7 +14016,7 @@ isBarVisible(bar, id, mapname)\
\
\
bar - A string that contains the name of the bar that has its visibility checked.id - The token id of the token which has its bar checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token which has its bar checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -14052,10 +14052,10 @@ isBarVisible(bar, id, mapname)\
\
\
- \
- HP and Health Bars\
+ HP and Health Bars\
\
- \
- The
bar.name special variable\
+ The bar.name special variable\
\
\
\
@@ -14220,7 +14220,7 @@ isGm.summary = \
\
-isNPC.description = Returns true ( 1 ) if a Token is a NPC or false ( 0 ) if it is not.
+isNPC.description = Returns true ( 1 ) if a Token is a NPC or false ( 0 ) if it is not.
isNPC.summary = \
\
\
@@ -14229,7 +14229,7 @@ isNPC.summary = \
isNPC() Function\
\
• Introduced in version 1.3b48\
- \
+ \
\
Usage\
\
@@ -14242,7 +14242,7 @@ isNPC(id, mapname)\
Parameter\
\
\
- id - The token id of the token which has its NPC status checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token which has its NPC status checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -14313,7 +14313,7 @@ This function will return 1 even if a registered overlay is hidden using the \
-isOwnedByAll.description = Returns true ( 1 ) if a Token has the Owned by All check box checked.
+isOwnedByAll.description = Returns true ( 1 ) if a Token has the Owned by All check box checked.
isOwnedByAll.summary = \
\
\
@@ -14322,7 +14322,7 @@ isOwnedByAll.summary = \
isOwnedByAll() Function\
\
• Introduced in version 1.3b48\
- \
+ \
\
Usage\
\
@@ -14335,13 +14335,13 @@ isOwnedByAll(id, mapname)\
Parameter\
\
\
- id - The token id of the token which has its Owned by All status checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token which has its Owned by All status checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
Example\
\
- Returns Anyone can edit me if the Current Token has the Owned by All check box checked.\
+ Returns Anyone can edit me if the Current Token has the Owned by All check box checked.\
[r, if(isOwnedByAll()): "Anyone can edit me"]
\
\
See Also\
@@ -14361,7 +14361,7 @@ isOwnedByAll(id, mapname)\
\
-isOwner.description = Returns true ( 1 ) if the given Player is an owner of a specific Token .
+isOwner.description = Returns true ( 1 ) if the given Player is an owner of a specific Token .
isOwner.summary = \
\
\
@@ -14370,7 +14370,7 @@ isOwner.summary = \
isOwner() Function\
\
• Introduced in version 1.3b48\
- \
+ \
\
Usage\
\
@@ -14384,16 +14384,16 @@ isOwner(player, id, mapname)\
Parameters\
\
\
- player - The name of the player to check for ownership, defaults to the Current Player.id - The token id of the token which is checked for ownership, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
player - The name of the player to check for ownership, defaults to the Current Player.id - The token id of the token which is checked for ownership, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
Examples\
\
- Returns You can edit me. if the Current Player is an owner of the Current Token.\
+ Returns You can edit me. if the Current Player is an owner of the Current Token.\
[r, if(isOwner()): "You can edit me."]
\
-Returns Azhrei can edit me. if the given Player is an owner of the given Token.\
+
Returns Azhrei can edit me. if the given Player is an owner of the given Token.\
\
[h: id = getSelected() ]\
[r, if(isOwner("Azhrei", id)): "Azhrei can edit me."]\
@@ -14415,7 +14415,7 @@ isOwner(player, id, mapname)\
\
-isPC.description = Returns true ( 1 ) if a Token is a PC or false ( 0 ) if it is not.
+isPC.description = Returns true ( 1 ) if a Token is a PC or false ( 0 ) if it is not.
isPC.summary = \
\
\
@@ -14424,7 +14424,7 @@ isPC.summary = \
isPC() Function\
\
• Introduced in version 1.3b48\
- \
+ \
\
Usage\
\
@@ -14437,7 +14437,7 @@ isPC(id, mapname)\
Parameter\
\
\
- id - The token id of the token which has its PC status checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token which has its PC status checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -14467,7 +14467,7 @@ isPC(id, mapname)\
\
-isPropertyEmpty.description = Returns true ( 1 ) if the Token Property for a specific Token is empty.
+isPropertyEmpty.description = Returns true ( 1 ) if the Token Property for a specific Token is empty.
isPropertyEmpty.summary = \
\
\
@@ -14476,7 +14476,7 @@ isPropertyEmpty.summary = \
isPropertyEmpty() Function\
\
• Introduced in version 1.3b48\
- Returns true(1) if the Token Property for a specific Token is empty. A Token Property is considered empty if it is NULL; if an empty string ("") has been assigned to it, it is not considered empty.\
+ Returns true(1) if the Token Property for a specific Token is empty. A Token Property is considered empty if it is NULL; if an empty string ("") has been assigned to it, it is not considered empty.\
Note: If the token type sets a default value, this function will still see the property as empty. Try using json.isEmpty().\
\
Usage\
@@ -14491,7 +14491,7 @@ isPropertyEmpty(property, id, mapname)\
\
\
property - The name of the property that has its value checked.id - The token id of the token that has its value checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token that has its value checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -14522,7 +14522,7 @@ isPropertyEmpty(property, id, mapname)\
\
-isSnapToGrid.description = Returns true ( 1 ) if a Token is snapped to grid or false ( 0 ) if it is not.
+isSnapToGrid.description = Returns true ( 1 ) if a Token is snapped to grid or false ( 0 ) if it is not.
isSnapToGrid.summary = \
\
\
@@ -14531,7 +14531,7 @@ isSnapToGrid.summary = \
isSnapToGrid() Function\
\
• Introduced in version 1.3b69\
- \
+ \
\
Usage\
\
@@ -14544,7 +14544,7 @@ isSnapToGrid(id, mapname)\
Parameter\
\
\
- id - The token id of the token which has its snapToGrid status checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token which has its snapToGrid status checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -14571,7 +14571,7 @@ isSnapToGrid(id, mapname)\
\
-isTrusted.description = Returns 1 if this is running as a trusted macro or 0 if it is not.
+isTrusted.description = Returns 1 if this is running as a trusted macro or 0 if it is not.
isTrusted.summary = \
\
\
@@ -14580,7 +14580,7 @@ isTrusted.summary = \
isTrusted() Function\
\
• Introduced in version 1.3b48\
- Returns 1 if this is running as a trusted macro or 0 if it is not.\
+ Returns 1 if this is running as a trusted macro or 0 if it is not.\
\
Usage\
\
@@ -14623,7 +14623,7 @@ isVisible(x,y,id)\
\
x - Then tokens x coordinate. Always in map units, not grid .y - Then tokens x coordinate. Always in map units, not grid .id - The check for visibility is performed from token id. Note: This parameter can only be used in a Trusted Macro.
id - The check for visibility is performed from token id. Note: This parameter can only be used in a Trusted Macro.
\
\
Example\
@@ -14655,7 +14655,7 @@ isVisible(x,y,id)\
\
-json.append.description = Appends values to the end of a JSON Array .
+json.append.description = Appends values to the end of a JSON Array .
json.append.summary = \
\
\
@@ -14664,7 +14664,7 @@ json.append.summary = \
json.append() Function\
\
• Introduced in version 1.3b49\
- Appends values to the end of a JSON Array. An empty string ("") can be used to represent an empty JSON Array to append the values to.\
+ Appends values to the end of a JSON Array. An empty string ("") can be used to represent an empty JSON Array to append the values to.\
\
Usage\
\
@@ -14690,7 +14690,7 @@ json.append.summary = \
\
-json.contains.description = Returns true ( 1 ) if the JSON Object contains the specified key, or if the JSON Array contains the specified value.
+json.contains.description = Returns true ( 1 ) if the JSON Object contains the specified key, or if the JSON Array contains the specified value.
json.contains.summary = \
\
\
@@ -14699,7 +14699,7 @@ json.contains.summary = \
json.contains() Function\
\
• Introduced in version 1.3b49\
- Returns true(1) if the JSON Object contains the specified key, or if the JSON Array contains the specified value.\
+ Returns true(1) if the JSON Object contains the specified key, or if the JSON Array contains the specified value.\
\
Usage\
\
@@ -14713,24 +14713,24 @@ json.contains.summary = \
Parameters\
\
\
- object - The JSON Object to test for the key.object - The JSON Object to test for the key.key - The key to check the object for.array - The JSON Array to test for the value.array - The JSON Array to test for the value.value - The value to check the array for.
\
\
Examples\
\
- Check if the JSON Object a contains the key "b":\
+ Check if the JSON Object a contains the key "b":\
[h:a=json.fromStrProp("a=1;b=44;c=12")]\
[json.contains(a,"b")]\
Returns true(1)\
-
Check if the JSON Object a contains the key "z":\
+
Check if the JSON Object a contains the key "z":\
\
[h:a=json.fromStrProp("a=1;b=44;c=12")]\
[json.contains(a,"z")]\
Returns false(0)\
-
Check if the JSON Array a contains the value "b":\
+
Check if the JSON Array a contains the value "b":\
\
[h:a=json.fromList("1,b,3,d")]\
[json.contains(a,"b")]\
@@ -14746,14 +14746,14 @@ Returns true(1)\
\
\
\
- - 1.3b51 - Added ability for function to work with JSON Arrays.
\
+ - 1.3b51 - Added ability for function to work with JSON Arrays.
\
\
\
\
\
-json.count.description = Returns the number of occurrences of a value in a JSON Array .
+json.count.description = Returns the number of occurrences of a value in a JSON Array .
json.count.summary = \
\
\
@@ -14762,7 +14762,7 @@ json.count.summary = \
json.count() Function\
\
• Introduced in version 1.3b53\
- Returns the number of occurrences of a value in a JSON Array. If the value does not occur in the JSON Array then 0 is returned. The index for the JSON Array starts at 0.\
+ Returns the number of occurrences of a value in a JSON Array. If the value does not occur in the JSON Array then 0 is returned. The index for the JSON Array starts at 0.\
\
Usage\
\
@@ -14776,7 +14776,7 @@ json.count.summary = \
Parameters\
\
\
- array - The JSON Array to search.array - The JSON Array to search.value - The value to count the occurrences of.start - The index to start searching from, if not specified it defaults to 0.
\
@@ -14800,7 +14800,7 @@ Returns 2\
\
-json.difference.description = Returns an array with the differences of all of the JSON Object keys, or JSON Array values.
+json.difference.description = Returns an array with the differences of all of the JSON Object keys, or JSON Array values.
json.difference.summary = \
\
\
@@ -14809,7 +14809,7 @@ json.difference.summary = \
json.difference() Function\
\
• Introduced in version 1.3b53\
- Returns an array with the differences of all of the JSON Object keys, or JSON Array values. Output contains keys or values which exist in the first parameter, but do not exist in any others.\
+ Returns an array with the differences of all of the JSON Object keys, or JSON Array values. Output contains keys or values which exist in the first parameter, but do not exist in any others.\
\
Usage\
\
@@ -14823,8 +14823,8 @@ json.difference.summary = \
Parameter\
\
\
- array - A JSON Array to get the difference of.object - A JSON Object to get the difference of.array - A JSON Array to get the difference of.object - A JSON Object to get the difference of.
\
\
Example\
@@ -14882,7 +14882,7 @@ json.evaluate.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b51\
@@ -14924,7 +14924,7 @@ json.evaluate.summary = \
\
-json.fields.description = Returns the fields (keys) for a JSON Object or the indexes for a JSON Array as a string list.
+json.fields.description = Returns the fields (keys) for a JSON Object or the indexes for a JSON Array as a string list.
json.fields.summary = \
\
\
@@ -14933,8 +14933,8 @@ json.fields.summary = \
json.fields() Function\
\
• Introduced in version 1.3b49\
- Returns the fields (keys) for a JSON Object or the indexes for a JSON Array as a string list. The type of the value returned depends on the delimiter parameter.\
-Note: Because JSON Objects are unordered, json.fields will not reflect the order they were set in.\
+ Returns the fields (keys) for a JSON Object or the indexes for a JSON Array as a string list. The type of the value returned depends on the delimiter parameter.\
+Note: Because JSON Objects are unordered, json.fields will not reflect the order they were set in.\
\
Usage\
\
@@ -14949,7 +14949,7 @@ json.fields.summary = \
\
\
delim =\
-unspecified: a standard string list is returned, with its default "," delimiter."json": a JSON Array is returned."x": a string list is returned with "x" used as a delimiter.
unspecified: a standard string list is returned, with its default "," delimiter."json": a JSON Array is returned."x": a string list is returned with "x" used as a delimiter.
\
\
\
Example\
@@ -14968,7 +14968,7 @@ json.fields.summary = \
\
-json.fromList.description = Returns a JSON Array from a String List .
+json.fromList.description = Returns a JSON Array from a String List .
json.fromList.summary = \
\
\
@@ -14977,7 +14977,7 @@ json.fromList.summary = \
json.fromList() Function\
\
• Introduced in version 1.3b49\
- Returns a JSON Array from a String List.\
+ Returns a JSON Array from a String List.\
\
Usage\
\
@@ -14991,8 +14991,8 @@ json.fromList.summary = \
Parameters\
\
\
- strList - The String List that is converted to a JSON Array.delim - The delimiter used in the String List, defaults to ",".strList - The String List that is converted to a JSON Array.delim - The delimiter used in the String List, defaults to ",".
\
\
Example\
@@ -15009,7 +15009,7 @@ Returns ["a",1,"g",4]
\
\
-json.fromStrProp.description = Creates a json object from a string property list .
+json.fromStrProp.description = Creates a json object from a string property list .
json.fromStrProp.summary = \
\
\
@@ -15018,7 +15018,7 @@ json.fromStrProp.summary = \
json.fromStrProp() Function\
\
• Introduced in version 1.3b49\
- Creates a json object from a string property list.\
+ Creates a json object from a string property list.\
\
Usage\
\
@@ -15043,7 +15043,7 @@ json.fromStrProp(propList,delim)\
\
-json.get.description = Returns the value in a JSON Array at the specified index, returns a slice of a JSON Array from the specified indexes, or returns the value from JSON Object for the specified key.
+json.get.description = Returns the value in a JSON Array at the specified index, returns a slice of a JSON Array from the specified indexes, or returns the value from JSON Object for the specified key.
json.get.summary = \
\
\
@@ -15052,7 +15052,7 @@ json.get.summary = \
json.get() Function\
\
• Introduced in version 1.3b49\
- Returns the value in a JSON Array at the specified index, returns a slice of a JSON Array from the specified indexes, or returns the value from JSON Object for the specified key.\
+ Returns the value in a JSON Array at the specified index, returns a slice of a JSON Array from the specified indexes, or returns the value from JSON Object for the specified key.\
\
Usage\
\
@@ -15069,12 +15069,12 @@ json.get.summary = \
Parameters\
\
\
- array - The JSON Array to retrieve the element from.array - The JSON Array to retrieve the element from.index - The numerical index of the element you want returned.start - The starting index of the element you wish the slice to begin at.end - The ending index of the element you wish the slice to end at.object - The JSON Object to retrieve the element from.key - The name of a field that should be returned. This parameter can exist more than once, if it does then a JSON Object is returned with all the specified elements.object - The JSON Object to retrieve the element from.key - The name of a field that should be returned. This parameter can exist more than once, if it does then a JSON Object is returned with all the specified elements.
\
When extracting slices:
\
Negative numbers can be used as the offsets from the end of the array. -1 is the last element in the array, -2 is the second to last, and so on. If the element specified by the start index and the element specified by the end index are located in reverse order in array (so reading from left to right end comes before start), then the array slice is returned in reverse order compared to array (because fetching from start to end means reading backwards).
\
@@ -15126,8 +15126,8 @@ ERROR b) -- java.lang.ArrayIndexOutOfBoundsException, the last valid index is 2\
\
\
\
- - 1.3b51 - Added ability to return JSON Array slices.
\
- - 1.3b51 - Added ability to return JSON Objects of select fields from other JSON Objects.
\
+ - 1.3b51 - Added ability to return JSON Array slices.
\
+ - 1.3b51 - Added ability to return JSON Objects of select fields from other JSON Objects.
\
\
\
\
@@ -15165,7 +15165,7 @@ Formatting will not appear unless the function is surrounded by the "pre" html t
\
-json.indexOf.description = Returns the index of the first occurrence of a value in the JSON Array .
+json.indexOf.description = Returns the index of the first occurrence of a value in the JSON Array .
json.indexOf.summary = \
\
\
@@ -15174,7 +15174,7 @@ json.indexOf.summary = \
json.indexOf() Function\
\
• Introduced in version 1.3b53\
- Returns the index of the first occurrence of a value in the JSON Array. If the value does not exist in the JSON Array then -1 is returned. All JSON Array indexes start at 0.\
+ Returns the index of the first occurrence of a value in the JSON Array. If the value does not exist in the JSON Array then -1 is returned. All JSON Array indexes start at 0.\
\
Usage\
\
@@ -15188,8 +15188,8 @@ json.indexOf.summary = \
Parameters\
\
\
- array - The JSON Array to search.value - The value to find the index of in the JSON Array.array - The JSON Array to search.value - The value to find the index of in the JSON Array.start - The index to start searching from, if not specified it defaults to 0.
\
\
@@ -15228,7 +15228,7 @@ Returns: 2
\
\
-json.intersection.description = Returns a JSON Array with the intersection of all of the JSON Object keys or JSON Array values.
+json.intersection.description = Returns a JSON Array with the intersection of all of the JSON Object keys or JSON Array values.
json.intersection.summary = \
\
\
@@ -15237,7 +15237,7 @@ json.intersection.summary = \
json.intersection() Function\
\
• Introduced in version 1.3b53\
- Returns a JSON Array with the intersection of all of the JSON Object keys or JSON Array values. A value or key only appears in the output if it exists in all input arrays or objects.\
+ Returns a JSON Array with the intersection of all of the JSON Object keys or JSON Array values. A value or key only appears in the output if it exists in all input arrays or objects.\
This function is useful for removing Token IDs from a saved list which have been deleted from the map by eliminating them using this function, the saved array and getTokens().\
\
Usage\
@@ -15252,8 +15252,8 @@ This function is useful for removing Token IDs from a saved list which have been
Parameters\
\
\
- array - A JSON Array used in the intersection.object - A JSON Object used in the intersection.array - A JSON Array used in the intersection.object - A JSON Object used in the intersection.
\
\
Examples\
@@ -15306,7 +15306,7 @@ json.isEmpty.summary = \
\
-json.isSubset.description = Returns true ( 1 ) if all of the JSON Object keys or JSON Array values are contained within the first JSON Object or JSON Array .
+json.isSubset.description = Returns true ( 1 ) if all of the JSON Object keys or JSON Array values are contained within the first JSON Object or JSON Array .
json.isSubset.summary = \
\
\
@@ -15315,7 +15315,7 @@ json.isSubset.summary = \
json.isSubset() Function\
\
• Introduced in version 1.3b53\
- Returns true(1) if all of the JSON Object keys or JSON Array values are contained within the first JSON Object or JSON Array.\
+ Returns true(1) if all of the JSON Object keys or JSON Array values are contained within the first JSON Object or JSON Array.\
\
Usage\
\
@@ -15329,10 +15329,10 @@ json.isSubset.summary = \
Parameters\
\
\
- firstArray - The JSON Array that must contain all of the values of the subsequent JSON Arrays for this function to return true(1).array - A JSON Array with values that are tested to be within the firstArray.firstObject - The JSON Object that must contain all of the keys of the subsequent JSON Objects for this function to return true(1).object - A JSON Object with keys that are tested to be within the firstObject.firstArray - The JSON Array that must contain all of the values of the subsequent JSON Arrays for this function to return true(1).array - A JSON Array with values that are tested to be within the firstArray.firstObject - The JSON Object that must contain all of the keys of the subsequent JSON Objects for this function to return true(1).object - A JSON Object with keys that are tested to be within the firstObject.
\
\
\
@@ -15347,7 +15347,7 @@ json.isSubset.summary = \
\
-json.length.description = Returns the number of fields in a json object or number of elements in a json array .
+json.length.description = Returns the number of fields in a json object or number of elements in a json array .
json.length.summary = \
\
\
@@ -15356,7 +15356,7 @@ json.length.summary = \
json.length() Function\
\
• Introduced in version 1.3b49\
- Returns the number of fields in a json object or number of elements in a json array.\
+ Returns the number of fields in a json object or number of elements in a json array.\
\
Usage\
\
@@ -15381,7 +15381,7 @@ json.length.summary = \
\
-json.merge.description = Merges multiple JSON Arrays or JSON Objects .
+json.merge.description = Merges multiple JSON Arrays or JSON Objects .
json.merge.summary = \
\
\
@@ -15390,10 +15390,10 @@ json.merge.summary = \
json.merge() Function\
\
• Introduced in version 1.3b53\
- Merges multiple JSON Arrays or JSON Objects.\
-For JSON Arrays the value returned is that of all the JSON Arrays concatenated together.\
+
Merges multiple JSON Arrays or JSON Objects.\
+For JSON Arrays the value returned is that of all the JSON Arrays concatenated together.\
\
-For JSON Objects the value returned is a JSON Object with all of the keys from all of the JSON Objects set, if any key is specified in more than one JSON Object then the value for the last specified JSON Object is used.\
+For JSON Objects the value returned is a JSON Object with all of the keys from all of the JSON Objects set, if any key is specified in more than one JSON Object then the value for the last specified JSON Object is used.\
\
Usage\
\
@@ -15407,20 +15407,20 @@ For Parameters\
\
\
- array - A JSON Array.object - A JSON Object.array - A JSON Array.object - A JSON Object.
\
\
Examples\
\
- Merge three JSON Arrays:\
+ Merge three JSON Arrays:\
[r: json.merge("[1,2]", "[3,4]", "[1,2]")]\
Returns: [1,2,3,4,1,2]\
-
Merge two JSON Objects with no matching keys:\
+
Merge two JSON Objects with no matching keys:\
\
[r: json.merge("{a:1, b:2}", "{c:10, d:7}")]\
Returns: {"a":1,"b":2,"c":10,"d":7} \
-
Merge three JSON Objects with a matching key, a:\
+
Merge three JSON Objects with a matching key, a:\
\
[r: json.merge("{a:1, b:2}", "{c:10, d:7}", "{a:11, z:7}")]\
Returns: {"a":11,"b":2,"c":10,"d":7,"z":7} \
@@ -15433,7 +15433,7 @@ Returns: {"a":11,"b":2,"c":10,"d":7,"z":7} \
\
\
\
- - 1.3b54 - Fixed bug which allows
json.merge() to work correctly with JSON Objects. \
+ - 1.3b54 - Fixed bug which allows
json.merge() to work correctly with JSON Objects. \
\
\
\
@@ -15536,12 +15536,12 @@ json.objrolls.summary = \
\
See Also\
\
- \
+ \
\
\
-json.path.add.description = Add an element to a nested JSON Array .
+json.path.add.description = Add an element to a nested JSON Array .
json.path.add.summary = \
\
\
@@ -15550,7 +15550,7 @@ json.path.add.summary = \
json.path.add() Function\
\
• Introduced in version 1.5.5\
- Add an element to a nested JSON Array. Additional information on how to specify the path is available here.\
+ Add an element to a nested JSON Array. Additional information on how to specify the path is available here.\
\
Usage\
\
@@ -15561,8 +15561,8 @@ json.path.add.summary = \
Parameters\
\
\
- json - The json element in which the JSON Array is nested.path - The path to the JSON Array.json - The json element in which the JSON Array is nested.path - The path to the JSON Array.value - The value to add to the array.
\
\
@@ -15579,7 +15579,7 @@ json.path.add.summary = \
\
-json.path.delete.description = Returns a JSON Array or JSON Object with deleted elements.
+json.path.delete.description = Returns a JSON Array or JSON Object with deleted elements.
json.path.delete.summary = \
\
\
@@ -15588,7 +15588,7 @@ json.path.delete.summary = \
json.path.delete() Function\
\
• Introduced in version 1.5.5\
- Returns a JSON Array or JSON Object with deleted elements. These deletions are specified through the path parameter. Additional information on how to specify the path is availabe here.\
+ Returns a JSON Array or JSON Object with deleted elements. These deletions are specified through the path parameter. Additional information on how to specify the path is availabe here.\
\
Usage\
\
@@ -15622,7 +15622,7 @@ json.path.delete.summary = \
\
-json.path.put.description = Create or update the key with the given value at the given path of a nested JSON Object .
+json.path.put.description = Create or update the key with the given value at the given path of a nested JSON Object .
json.path.put.summary = \
\
\
@@ -15631,7 +15631,7 @@ json.path.put.summary = \
json.path.put() Function\
\
• Introduced in version 1.5.5\
- Create or update the key with the given value at the given path of a nested JSON Object. json.path.put() is only used creating/updating name/value pairs in JSON Objects. See json.path.set() for creating/updated values in arrays. Additional information on how to specify the path is available here.\
+ Create or update the key with the given value at the given path of a nested JSON Object. json.path.put() is only used creating/updating name/value pairs in JSON Objects. See json.path.set() for creating/updated values in arrays. Additional information on how to specify the path is available here.\
\
Usage\
\
@@ -15642,9 +15642,9 @@ json.path.put.summary = \
Parameters\
\
\
- json - The json element in which the JSON Object is nested.path - The path to the JSON Object.key - The key of the JSON Object.json - The json element in which the JSON Object is nested.path - The path to the JSON Object.key - The key of the JSON Object.value - The value to associated with the key.
\
\
@@ -15668,7 +15668,7 @@ json.path.put.summary = \
\
-json.path.read.description = Returns the values in a nested JSON Array or JSON Object corresponding to the provided path.
+json.path.read.description = Returns the values in a nested JSON Array or JSON Object corresponding to the provided path.
json.path.read.summary = \
\
\
@@ -15677,7 +15677,7 @@ json.path.read.summary = \
json.path.read() Function\
\
• Introduced in version 1.5.5\
- Returns the values in a nested JSON Array or JSON Object corresponding to the provided path. It is unnecessary to include the root node operator $ at the beginning of the requested path. To do so, you must escape the dollar sign like this: \$.path.to.read. The json.path functions support both dot, Monsters.Orc.Attacks, and bracket, ['Monsters']['Orc']['Attacks'], notation.\
+ Returns the values in a nested JSON Array or JSON Object corresponding to the provided path. It is unnecessary to include the root node operator $ at the beginning of the requested path. To do so, you must escape the dollar sign like this: \$.path.to.read. The json.path functions support both dot, Monsters.Orc.Attacks, and bracket, ['Monsters']['Orc']['Attacks'], notation.\
For detailed information on how to specify the path, please read the JsonPath ReadMe.\
\
Usage\
@@ -15693,7 +15693,7 @@ json.path.read(json, path, config)\
json - The json data to get the values from.path - The path of the value(s) to retrieve.config - A String containing configuration options separated by a comma. The options can include\
-ALWAYS_RETURN_LIST - Always return the results in a JSON Array, even when the path is definite.AS_PATH_LIST - Return a JSON Array of path strings representing the path of the evaluation hits.DEFAULT_PATH_LEAF_TO_NULL - Return null when the given path almost exists but ends with a JSON Object key that is missing. Without this configuration, a definite path will return an error. With this configuration, an indefinite path will include null in the JSON Array if the key is missing. Without this configuration or if any other kind of nonexistent path structure is provided, an indefinite path will simply not match and return an empty JSON Array or less results in the JSON Array.REQUIRE_PROPERTIES - When an indefinite path is evaluated and ends in a key, all matching JSON Objects must have that key, otherwise an error is returned. This are the cases where DEFAULT_PATH_LEAF_TO_NULL will return null instead.SUPPRESS_EXCEPTIONS - Suppress all exceptions when evaluating paths. If ALWAYS_RETURN_LIST is also used return an empty list. Otherwise return null.
ALWAYS_RETURN_LIST - Always return the results in a JSON Array, even when the path is definite.AS_PATH_LIST - Return a JSON Array of path strings representing the path of the evaluation hits.DEFAULT_PATH_LEAF_TO_NULL - Return null when the given path almost exists but ends with a JSON Object key that is missing. Without this configuration, a definite path will return an error. With this configuration, an indefinite path will include null in the JSON Array if the key is missing. Without this configuration or if any other kind of nonexistent path structure is provided, an indefinite path will simply not match and return an empty JSON Array or less results in the JSON Array.REQUIRE_PROPERTIES - When an indefinite path is evaluated and ends in a key, all matching JSON Objects must have that key, otherwise an error is returned. This are the cases where DEFAULT_PATH_LEAF_TO_NULL will return null instead.SUPPRESS_EXCEPTIONS - Suppress all exceptions when evaluating paths. If ALWAYS_RETURN_LIST is also used return an empty list. Otherwise return null.
\
\
See the Jayway javadoc page for more info.\
\
@@ -15728,7 +15728,7 @@ which returns ["Troll"]. Note the use of bracket notation for the p
\
-json.path.set.description = Change an element in a nested JSON Array .
+json.path.set.description = Change an element in a nested JSON Array .
json.path.set.summary = \
\
\
@@ -15737,7 +15737,7 @@ json.path.set.summary = \
json.path.set() Function\
\
• Introduced in version 1.5.5\
- Change an element in a nested JSON Array. Additional information on how to specify the path is available here.\
+ Change an element in a nested JSON Array. Additional information on how to specify the path is available here.\
\
Usage\
\
@@ -15748,8 +15748,8 @@ json.path.set.summary = \
Parameters\
\
\
- json - The json element in which the JSON Array is nested.path - The path to the element in the JSON Array.json - The json element in which the JSON Array is nested.path - The path to the element in the JSON Array.value - The value to change.
\
\
@@ -15769,7 +15769,7 @@ json.path.set.summary = \
\
-json.remove.description = Removes a field from a JSON Object , or the value at the specified index from a JSON Array .
+json.remove.description = Removes a field from a JSON Object , or the value at the specified index from a JSON Array .
json.remove.summary = \
\
\
@@ -15778,7 +15778,7 @@ json.remove.summary = \
json.remove() Function\
\
• Introduced in version 1.3b49\
- Removes a field from a JSON Object, or the value at the specified index from a JSON Array.\
+ Removes a field from a JSON Object, or the value at the specified index from a JSON Array.\
\
Usage\
\
@@ -15798,7 +15798,7 @@ json.remove.summary = \
\
-json.removeAll.description = Removes all the keys or values from the first JSON Object or JSON Array that occur in the following JSON Objects or JSON Arrays .
+json.removeAll.description = Removes all the keys or values from the first JSON Object or JSON Array that occur in the following JSON Objects or JSON Arrays .
json.removeAll.summary = \
\
\
@@ -15807,7 +15807,7 @@ json.removeAll.summary = \
json.removeAll() Function\
\
• Introduced in version 1.3b53\
- Removes all the keys or values from the first JSON Object or JSON Array that occur in the following JSON Objects or JSON Arrays.\
+ Removes all the keys or values from the first JSON Object or JSON Array that occur in the following JSON Objects or JSON Arrays.\
\
Usage\
\
@@ -15821,10 +15821,10 @@ json.removeAll.summary = \
Parameters\
\
\
- firstArray - The JSON Array to remove the occurrences from.array - The JSON Arrays to get the occurrences from.firstObject - The JSON Object to remove the occurrences from.object - The JSON Objects to get the occurrences from.firstArray - The JSON Array to remove the occurrences from.array - The JSON Arrays to get the occurrences from.firstObject - The JSON Object to remove the occurrences from.object - The JSON Objects to get the occurrences from.
\
\
\
@@ -15894,7 +15894,7 @@ json.removeFirst.summary = \
\
See Also\
\
- \
+ \
\
\
@@ -15971,12 +15971,12 @@ The three parameter version returns a two dimensional array\
\
See Also\
\
- \
+ \
\
\
-json.set.description = Sets the value in at the specified index in a JSON Array or for the specified key in a JSON Object .
+json.set.description = Sets the value in at the specified index in a JSON Array or for the specified key in a JSON Object .
json.set.summary = \
\
\
@@ -15985,7 +15985,7 @@ json.set.summary = \
json.set() Function\
\
• Introduced in version 1.3b49\
- Sets the value in at the specified index in a JSON Array or for the specified key in a JSON Object. You can use an empty string ("") to represent a new JSON Array or JSON Object.\
+ Sets the value in at the specified index in a JSON Array or for the specified key in a JSON Object. You can use an empty string ("") to represent a new JSON Array or JSON Object.\
\
Usage\
\
@@ -16008,9 +16008,9 @@ json.set.summary = \
Parameters\
\
\
- jarr - The JSON Array that has an index's value set.jarr - The JSON Array that has an index's value set.index - The numeric index which has its value set.jobj - The JSON Object that has a key's value set.jobj - The JSON Object that has a key's value set.key - The named key which has its value set.value - The content that is set to the index or key.
\
@@ -16029,7 +16029,7 @@ json.set.summary = \
{"a":5}\
{"a":5, "b":8}\
[8, 3]\
-To save the new value in the JSON Array or JSON Object so that you can reference it later in a macro, you must set the array equal to the result of json.set().\
+
To save the new value in the JSON Array or JSON Object so that you can reference it later in a macro, you must set the array equal to the result of json.set().\
[myArray = json.append("", 1, 2, 3)]\
[myArray = json.set(myArray, 0, 5)]\
[myArray]Returns\
@@ -16092,7 +16092,7 @@ json.sort.summary = \
\
json.sort(array, direction)
\
\
- If you have a JSON Array that contains JSON Objects\
+
If you have a JSON Array that contains JSON Objects\
\
\
json.sort(array, direction, key1, ..., keyN)
\
@@ -16104,15 +16104,15 @@ json.sort.summary = \
array - The JSON array to sort.direction - Defaults to "ascending", acceptable values:\
"ascending""descending""ascend""descend""asc""desc""a""d"
key1, ..., keyN - The keys in the JSON Objects contained within the JSON Array used for sorting. All JSON Objects must contain these fields.key1, ..., keyN - The keys in the JSON Objects contained within the JSON Array used for sorting. All JSON Objects must contain these fields.\
Examples\
\
- Sorting a JSON Array containing numbers.\
+ Sorting a JSON Array containing numbers.\
[json.sort("[1,4,5,6,2,1,9,20,1]")]\
Produces [1,1,1,2,4,5,6,9,20]\
-
Sorting a JSON Array containing strings.\
+
Sorting a JSON Array containing strings.\
\
[json.sort("['Hero', 'Dragon', 'Elf', 'Wolf', 'Mage', 'Eagle', 'Troll']")]\
Produces ["Dragon","Eagle","Elf","Hero","Mage","Troll","Wolf"]\
@@ -16153,7 +16153,7 @@ json.sort.summary = \
\
-json.subset.description = Returns true ( 1 ) if all of the JSON Object keys or JSON Array values are contained within the first JSON Object or JSON Array .
+json.subset.description = Returns true ( 1 ) if all of the JSON Object keys or JSON Array values are contained within the first JSON Object or JSON Array .
json.subset.summary = \
\
\
@@ -16162,7 +16162,7 @@ json.subset.summary = \
json.isSubset() Function\
\
• Introduced in version 1.3b53\
- Returns true(1) if all of the JSON Object keys or JSON Array values are contained within the first JSON Object or JSON Array.\
+ Returns true(1) if all of the JSON Object keys or JSON Array values are contained within the first JSON Object or JSON Array.\
\
Usage\
\
@@ -16176,10 +16176,10 @@ json.subset.summary = \
Parameters\
\
\
- firstArray - The JSON Array that must contain all of the values of the subsequent JSON Arrays for this function to return true(1).array - A JSON Array with values that are tested to be within the firstArray.firstObject - The JSON Object that must contain all of the keys of the subsequent JSON Objects for this function to return true(1).object - A JSON Object with keys that are tested to be within the firstObject.firstArray - The JSON Array that must contain all of the values of the subsequent JSON Arrays for this function to return true(1).array - A JSON Array with values that are tested to be within the firstArray.firstObject - The JSON Object that must contain all of the keys of the subsequent JSON Objects for this function to return true(1).object - A JSON Object with keys that are tested to be within the firstObject.
\
\
\
@@ -16194,7 +16194,7 @@ json.subset.summary = \
\
-json.toList.description = Creates a string list from a JSON Array .
+json.toList.description = Creates a string list from a JSON Array .
json.toList.summary = \
\
\
@@ -16203,7 +16203,7 @@ json.toList.summary = \
json.toList() Function\
\
• Introduced in version 1.3b49\
- Creates a string list from a JSON Array. If the delimiter is not specified then the default value of ',' is used.\
+ Creates a string list from a JSON Array. If the delimiter is not specified then the default value of ',' is used.\
\
Usage\
\
@@ -16236,7 +16236,7 @@ json.toList.summary = \
\
-json.toStrProp.description = Creates a string list from a json object or json array using the specified delimiter in the result.
+json.toStrProp.description = Creates a string list from a json object or json array using the specified delimiter in the result.
json.toStrProp.summary = \
\
\
@@ -16245,7 +16245,7 @@ json.toStrProp.summary = \
json.toStrProp() Function\
\
• Introduced in version 1.3b49\
- Creates a string list from a json object or json array using the specified delimiter in the result. If a delimiter is not provided then the default value of ';' is used.\
+ Creates a string list from a json object or json array using the specified delimiter in the result. If a delimiter is not provided then the default value of ';' is used.\
\
Usage\
\
@@ -16279,7 +16279,7 @@ json.toStrProp.summary = \
\
-json.toVars.description = Creates variables from a from a JSON Object or JSON Array .
+json.toVars.description = Creates variables from a from a JSON Object or JSON Array .
json.toVars.summary = \
\
\
@@ -16288,7 +16288,7 @@ json.toVars.summary = \
json.toVars() Function\
\
• Introduced in version 1.5.5\
- Creates variables from a from a JSON Object or JSON Array. For a JSON object the names of the variables are the keys of the object, while the variables are assigned the values of the object. Characters in key values that are not allowed in MTScript variable names will be replaced with underscores. For a JSON array, only the values are passed in and the variable names will be created from the 2nd parameter suffixed with a number.\
+ Creates variables from a from a JSON Object or JSON Array. For a JSON object the names of the variables are the keys of the object, while the variables are assigned the values of the object. Characters in key values that are not allowed in MTScript variable names will be replaced with underscores. For a JSON array, only the values are passed in and the variable names will be created from the 2nd parameter suffixed with a number.\
\
Usage\
\
@@ -16392,7 +16392,7 @@ json.type.summary = \
Returns a string which contains the type of JSON variable that is passed in.\
Return values are\
\
-ARRAY - The object is a JSON Array.OBJECT - The object is a JSON Object.UNKNOWN - It is neither a JSON Array nor JSON Object.
\
+ARRAY - The object is a JSON Array.OBJECT - The object is a JSON Object.UNKNOWN - It is neither a JSON Array nor JSON Object.
\
\
\
Usage\
@@ -16414,7 +16414,7 @@ UNKNOWN
\
\
-json.union.description = Returns an JSON Array with the union of all of the JSON Object keys, or JSON Array values.
+json.union.description = Returns an JSON Array with the union of all of the JSON Object keys, or JSON Array values.
json.union.summary = \
\
\
@@ -16423,7 +16423,7 @@ json.union.summary = \
json.union() Function\
\
• Introduced in version 1.3b53\
- Returns an JSON Array with the union of all of the JSON Object keys, or JSON Array values. If a value or a key occurs in multiple different objects or arrays, it will only be placed once in the output object or array.\
+ Returns an JSON Array with the union of all of the JSON Object keys, or JSON Array values. If a value or a key occurs in multiple different objects or arrays, it will only be placed once in the output object or array.\
\
Usage\
\
@@ -16437,8 +16437,8 @@ json.union.summary = \
Parameters\
\
\
- array - The JSON Arrays to union.object - The JSON Objects to union.array - The JSON Arrays to union.object - The JSON Objects to union.
\
\
Examples\
@@ -16456,7 +16456,7 @@ json.union.summary = \
\
-json.unique.description = Returns a JSON Array with each value that occurs in the source JSON Array occurring only once.
+json.unique.description = Returns a JSON Array with each value that occurs in the source JSON Array occurring only once.
json.unique.summary = \
\
\
@@ -16465,7 +16465,7 @@ json.unique.summary = \
json.unique() Function\
\
• Introduced in version 1.3b53\
- Returns a JSON Array with each value that occurs in the source JSON Array occurring only once. The relative order of the values in the array may not be preserved.\
+ Returns a JSON Array with each value that occurs in the source JSON Array occurring only once. The relative order of the values in the array may not be preserved.\
\
Usage\
\
@@ -16476,13 +16476,13 @@ json.unique.summary = \
Parameters\
\
\
- array - The JSON Array to return only unique values from.array - The JSON Array to return only unique values from.
\
\
Example\
\
- Lets say you have a JSON Array that contains the following Token names: ["Hero", "Dragon"], and you use getPCNames() to return the names of\
-the PC Tokens, you could use the following code to generate a JSON Array that contains the values in both JSON Arrays with no value present more than once.\
+
Lets say you have a JSON Array that contains the following Token names: ["Hero", "Dragon"], and you use getPCNames() to return the names of\
+the PC Tokens, you could use the following code to generate a JSON Array that contains the values in both JSON Arrays with no value present more than once.\
\
[h: names1 = '["Hero", "Dragon"]']\
[h: names2 = getNPCNames()]\
@@ -16544,7 +16544,7 @@ Returns a number than is between 2 and 20, with a high
\
See Also\
\
- For another method of rolling dice, see Dice Expressions.\
+ For another method of rolling dice, see Dice Expressions.\
\
\
@@ -16589,7 +16589,7 @@ Returns a number than is between 3 and 30, with a low
\
See Also\
\
- For another method of rolling dice, see Dice Expressions.\
+ For another method of rolling dice, see Dice Expressions.\
\
Version Changes\
\
@@ -16705,7 +16705,7 @@ Returns 5\
\
-listAppend.description = Returns a string list with a value appended to the end of the string list .
+listAppend.description = Returns a string list with a value appended to the end of the string list .
listAppend.summary = \
\
\
@@ -16714,7 +16714,7 @@ listAppend.summary = \
listAppend() Function\
\
• Introduced in version 1.3b42\
- Returns a string list with a value appended to the end of the string list.\
+ Returns a string list with a value appended to the end of the string list.\
\
Usage\
\
@@ -16724,7 +16724,7 @@ listAppend.summary = \
\
listAppend(list, value, delim)
\
\
- If delim is not specified then the default value of ',' is used to separate the values in the string list\
+
If delim is not specified then the default value of ',' is used to separate the values in the string list\
\
\
Examples\
@@ -16736,7 +16736,7 @@ Returns This: is: a: test
\
\
-listContains.description = Returns the number of occurrences of a value in a String List .
+listContains.description = Returns the number of occurrences of a value in a String List .
listContains.summary = \
\
\
@@ -16745,7 +16745,7 @@ listContains.summary = \
listContains() Function\
\
• Introduced in version 1.3b42\
- Returns the number of occurrences of a value in a String List.\
+ Returns the number of occurrences of a value in a String List.\
\
Usage\
\
@@ -16757,9 +16757,9 @@ listContains(list, value, delim)\
Parameters\
\
\
- list - The String List that is checked for occurrences of the value.value - The value to search the String List for occurrences.delim - The delimiter that separates the values in the String List; defaults to ",".list - The String List that is checked for occurrences of the value.value - The value to search the String List for occurrences.delim - The delimiter that separates the values in the String List; defaults to ",".
\
\
Examples\
@@ -16778,7 +16778,7 @@ Returns 2
\
\
-listCount.description = Returns the number of items in a string list .
+listCount.description = Returns the number of items in a string list .
listCount.summary = \
\
\
@@ -16787,7 +16787,7 @@ listCount.summary = \
listCount() Function\
\
• Introduced in version 1.3b42\
- Returns the number of items in a string list.\
+ Returns the number of items in a string list.\
\
Usage\
\
@@ -16797,7 +16797,7 @@ listCount.summary = \
\
listCount(list, delim)
\
\
- If delim is not specified then the default value of ',' is used as the value separator in the string list\
+
If delim is not specified then the default value of ',' is used as the value separator in the string list\
\
\
Examples\
@@ -16809,7 +16809,7 @@ Returns 4
\
\
-listDelete.description = Returns a string list with the specified item deleted from it.
+listDelete.description = Returns a string list with the specified item deleted from it.
listDelete.summary = \
\
\
@@ -16818,7 +16818,7 @@ listDelete.summary = \
listDelete() Function\
\
• Introduced in version 1.3b42\
- Returns a string list with the specified item deleted from it. The index for the string list\
+ Returns a string list with the specified item deleted from it. The index for the string list\
\
Usage\
\
@@ -16828,7 +16828,7 @@ listDelete.summary = \
\
listDelete(list, index, delim)
\
\
- If delim is not specified then the default value of ',' is used as the value separator in the string list\
+
If delim is not specified then the default value of ',' is used as the value separator in the string list\
\
\
Example\
@@ -16839,7 +16839,7 @@ Returns This, a, test
\
\
-listFind.description = Returns the index of the first occurrence of a value in a string list .
+listFind.description = Returns the index of the first occurrence of a value in a string list .
listFind.summary = \
\
\
@@ -16848,7 +16848,7 @@ listFind.summary = \
listFind() Function\
\
• Introduced in version 1.3b42\
- Returns the index of the first occurrence of a value in a string list. If the value is not found then -1 is returned.\
+ Returns the index of the first occurrence of a value in a string list. If the value is not found then -1 is returned.\
\
Usage\
\
@@ -16858,7 +16858,7 @@ listFind.summary = \
\
listFind(list, value, delim)
\
\
- If delim is not specified then the default value of ',' is used as the value separator in the string list\
+
If delim is not specified then the default value of ',' is used as the value separator in the string list\
\
\
Examples\
@@ -16913,7 +16913,7 @@ The first argument is the list, returned by \
-listGet.description = Returns the value in the string list at the specified index.
+listGet.description = Returns the value in the string list at the specified index.
listGet.summary = \
\
\
@@ -16922,7 +16922,7 @@ listGet.summary = \
listGet() Function\
\
• Introduced in version 1.3b42\
- Returns the value in the string list at the specified index. The index for a string list starts at 0.\
+ Returns the value in the string list at the specified index. The index for a string list starts at 0.\
\
Usage\
\
@@ -16932,7 +16932,7 @@ listGet.summary = \
\
listGet(list, index, delim)
\
\
- If delim is not specified then the default value of ',' is used as the value separator in the string list\
+
If delim is not specified then the default value of ',' is used as the value separator in the string list\
\
\
Example\
@@ -16944,7 +16944,7 @@ Returns is
\
\
-listInsert.description = Inserts a value into the string list at the specified index.
+listInsert.description = Inserts a value into the string list at the specified index.
listInsert.summary = \
\
\
@@ -16953,7 +16953,7 @@ listInsert.summary = \
listInsert() Function\
\
• Introduced in version 1.3b42\
- Inserts a value into the string list at the specified index. If a delimiter is not specified then the default value of ',' is used. The index for lists starts at 0\
+ Inserts a value into the string list at the specified index. If a delimiter is not specified then the default value of ',' is used. The index for lists starts at 0\
\
Usage\
\
@@ -16973,7 +16973,7 @@ Returns This: is: a: test\
\
-listReplace.description = Replaces the element at the specified index of a String List with a new value.
+listReplace.description = Replaces the element at the specified index of a String List with a new value.
listReplace.summary = \
\
\
@@ -16982,7 +16982,7 @@ listReplace.summary = \
listReplace() Function\
\
• Introduced in version 1.3b42\
- Replaces the element at the specified index of a String List with a new value. If a delimiter is not specified then the default value of "," is used. The index for lists starts at 0.\
+ Replaces the element at the specified index of a String List with a new value. If a delimiter is not specified then the default value of "," is used. The index for lists starts at 0.\
\
Usage\
\
@@ -16996,8 +16996,8 @@ listReplace.summary = \
Examples\
\
Simple example:[r: listReplace("This, isnt, a , test", 1, "is")]Returns This, is, a, Test\
-
Example using a String List with a non-default delimiter:
[r: listReplace("This: isnt: a: test", 1, "is", ":")]Returns This: is: a: test\
-
Example using a String List stored in a variable:
[h: ListVar = "This, is, a, great, test"]\
+Example using a String List with a non-default delimiter:
[r: listReplace("This: isnt: a: test", 1, "is", ":")]Returns This: is: a: test\
+
Example using a String List stored in a variable:
[h: ListVar = "This, is, a, great, test"]\
[h: ListVar = listReplace(ListVar, 3, "silly")]\
[r: ListVar]
\
Returns: This, is, a, silly, test
\
@@ -17110,7 +17110,7 @@ log.debug.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.2\
@@ -17156,7 +17156,7 @@ log.error.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.2\
@@ -17202,7 +17202,7 @@ log.fatal.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.2\
@@ -17248,7 +17248,7 @@ log.getLoggers.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.2\
@@ -17318,7 +17318,7 @@ log.info.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.2\
@@ -17364,7 +17364,7 @@ log.setLevel.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.2\
@@ -17407,11 +17407,11 @@ log.setLevel.summary = \
[r: "Setting <i><b>" + lname + "</b></i> to <b>" + level + "</b>."]\
[h: log.setLevel(lname,level)]\
\
-
\
+\
\
See Also\
\
- \
+ \
\
\
@@ -17426,7 +17426,7 @@ log.trace.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.7\
@@ -17472,7 +17472,7 @@ log.warn.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.2\
@@ -17618,7 +17618,7 @@ lt.summary = \
\
-macroLink.description = Creates the HTML for a link which will run the specified macro when clicked on in a frame , dialog , or the chat window.
+macroLink.description = Creates the HTML for a link which will run the specified macro when clicked on in a frame , dialog , or the chat window.
macroLink.summary = \
\
\
@@ -17627,7 +17627,7 @@ macroLink.summary = \
macroLink() Function\
\
• Introduced in version 1.3b48\
- Creates the HTML for a link which will run the specified macro when clicked on in a frame, dialog, or the chat window. Additionally, if you send the link to the chat window, it will automatically be executed by any recipients as soon as they receive it. This can be useful for popping up or updating frames or dialogs for your players. To auto-execute in the chat window, it must not be hidden by roll options like [h:], but may be hidden by being contained within an HTML comment.
\
+ Creates the HTML for a link which will run the specified macro when clicked on in a frame, dialog, or the chat window. Additionally, if you send the link to the chat window, it will automatically be executed by any recipients as soon as they receive it. This can be useful for popping up or updating frames or dialogs for your players. To auto-execute in the chat window, it must not be hidden by roll options like [h:], but may be hidden by being contained within an HTML comment.
\
Some notes on the auto execution
\
- If you refer to a macro on a lib:token it will automatically execute, however if you refer to a macro on the campaign panel, the macro is NOT automatically executed when sent to the chat.
- It will also not work if the owner of the lib:token is not an (online) GM, though as a general practice its best not to set ownership of lib:tokens at all.
- To prevent the macro from automatically executing you can turn off the 'auto execute' in the edit panel of the macro that you're linking to.
\
\
@@ -17655,24 +17655,24 @@ macroLink.summary = \
\
\
text - is the text to display for the link.macroName - is the name of the macro to run when the link is clicked. The macroName is in the same format that is used for [macro(...): ...] e.g. Test@Lib:test.macroName - is the name of the macro to run when the link is clicked. The macroName is in the same format that is used for [macro(...): ...] e.g. Test@Lib:test.output - contains who the output of the macro should go to, values are (defaults to "none"):\
-"self" - Display only to person who clicked on the link."gm" - Display to GM."all" - everyone (acts like a /say)."none" - discard any output."gm-self" - Display to GM and the person executing the link."list" - Displays to a list of players. When the output is set to "list" then the macro link expects the args parameter to be a JSON Object, that contains a field called mlOutputList which is a JSON Array containing the players to send the output to.
"self" - Display only to person who clicked on the link."gm" - Display to GM."all" - everyone (acts like a /say)."none" - discard any output."gm-self" - Display to GM and the person executing the link."list" - Displays to a list of players. When the output is set to "list" then the macro link expects the args parameter to be a JSON Object, that contains a field called mlOutputList which is a JSON Array containing the players to send the output to.
\
args - Any arguments to be passed to the macro when it is called.target - Which tokens to run the macro on. Target can be one or more of the following separated by commas (defaults to "impersonated"):\
-
\
\
Examples\
\
- * To create a link that will call a macro called Test on the Library Token named Lib:Test that says "Click on me!" and displays the output to the GM.\
+ * To create a link that will call a macro called Test on the Library Token named Lib:Test that says "Click on me!" and displays the output to the GM.\
[r: macroLink("Click on me!", "Test@Lib:Test", "gm", "count=6", "impersonated")]
\
produces this output:<ahref="macro://Test@Lib:Test/gm/impersonated?count=6;">Click on me!</a>
\
- Sending to multiple players and the GM in 1.3b55
\
[h: outputTo = '["Fred", "Barney", "gm"]']\
[h: args = json.set("{}", "mlOutputList", outputTo)]\
[r: macroLink("Click on me!", "Test@Lib:Test", "list", args)]
\
-- Updating a character sheet frame without displaying the link:
\
+- Updating a character sheet frame without displaying the link:
\
Took 4 points of damage.<!-- [r: macroLink("Update Character Sheet", "Update Character Sheet@Lib:Test")] -->
\
- An example of a longer custom macrolink:
\
This is a link that is user created to send several variables to the AttackMacro. Each variable must be separated by a & sign. Spaces within text must be replaced with a + sign. Plus sign can't be sent, you might want to use the html code for plus sign (&27;) instead of +.\
@@ -17714,7 +17714,7 @@ macroLinkText.summary = \
macroLinkText() Function\
\
• Introduced in version 1.3b48\
- Creates the text that would appear in a HTML tag for a link which will run the specified macro when clicked on. This is useful for callbacks in [dialog():] or [frame():]. If you just want to send a click-able link to someone use macroLink().\
+ Creates the text that would appear in a HTML tag for a link which will run the specified macro when clicked on. This is useful for callbacks in [dialog():] or [frame():]. If you just want to send a click-able link to someone use macroLink().\
\
Usage\
\
@@ -17736,21 +17736,21 @@ macroLinkText.summary = \
\
macroName - The name of the macro to run when the link is clicked. The macroName is in the standard macro reference format (e.g. Macro@Lib:Token)output - Who the output of the macro should go to, values are (defaults to none):\
-self - Display only to person who clicked on the link.gm - Display to GM.all - Everyone (acts like a /say)none - Discard any output.gm-self - Display to GM and the person executing the link.list - Displays to a list of players. When the output parameter is "list" then the macro link expects the args parameter to be a JSON Object, that contains a field called mlOutputList which is a JSON Array containing the players to send the output to.
self - Display only to person who clicked on the link.gm - Display to GM.all - Everyone (acts like a /say)none - Discard any output.gm-self - Display to GM and the person executing the link.list - Displays to a list of players. When the output parameter is "list" then the macro link expects the args parameter to be a JSON Object, that contains a field called mlOutputList which is a JSON Array containing the players to send the output to.
\
args - Any arguments to be passed to the macro when it is called.target - Which tokens to run the macro on. Target can be one or more of the following separated by commas (defaults to impersonated):\
-
\
\
Examples\
\
- To create the text that would go inside a form element as the action attribute, and that will call a macro named Test on the Library Token named Lib:Test:\
+ To create the text that would go inside a form element as the action attribute, and that will call a macro named Test on the Library Token named Lib:Test:\
[r: macroLinkText("Test@Lib:Test","", "gm")]\
Returns: macro://Test@Lib:Test/gm/impersonated?\
-
To create the text that would go inside a form element as the action attribute and call the AddWeapon on the Library Token named Lib:PC which will act upon the Current Token:\
+
To create the text that would go inside a form element as the action attribute and call the AddWeapon on the Library Token named Lib:PC which will act upon the Current Token:\
\
[r:macroLinkText('AddWeapon@Lib:PC', 'none', '', currentToken())]\
-Returns: macro://AddWeapon@Lib:PC/none/#ID#? where #ID# is the id of the Current Token.\
+
Returns: macro://AddWeapon@Lib:PC/none/#ID#? where #ID# is the id of the Current Token.\
Sending to multiple players and the GM in 1.3b55\
\
[h: outputTo = '["Fred", "Barney", "gm"]']\
@@ -17852,7 +17852,7 @@ markdownToHTML(string, type)
\
\
Examples\
\
- Retrieve the text stored in the current token's Notes and convert them to HTML for display inside a frame5().\
+ Retrieve the text stored in the current token's Notes and convert them to HTML for display inside a frame5().\
[frame5("Notes", "title=" + token.name): {<br>\
[r: markdownToHTML(getNotes())]\
}]\
@@ -17878,7 +17878,7 @@ matches.summary = \
matches() Function\
\
• Introduced in version 1.3b48\
- Returns 1 if a string matches pattern or 0 if it does not. The pattern can be a regular expression. Matches performs a while string comparison, so the pattern must match the whole of the input string and not only part of it.\
+ Returns 1 if a string matches pattern or 0 if it does not. The pattern can be a regular expression. Matches performs a while string comparison, so the pattern must match the whole of the input string and not only part of it.\
\
Usage\
\
@@ -18200,7 +18200,7 @@ Returns: 8.0\
\
-math.listMax.description = Find the maximum value in a String List .
+math.listMax.description = Find the maximum value in a String List .
math.listMax.summary = \
\
\
@@ -18209,7 +18209,7 @@ math.listMax.summary = \
math.listMax() Function\
\
• Introduced in version 1.7\
- Find the maximum value in a String List. Only allows numeric elements - any non-numeric values will produce an error.\
+ Find the maximum value in a String List. Only allows numeric elements - any non-numeric values will produce an error.\
\
Usage\
\
@@ -18237,7 +18237,7 @@ math.listMax.summary = \
\
-math.listMean.description = Calculates the arithmetic mean of the contents of a String List .
+math.listMean.description = Calculates the arithmetic mean of the contents of a String List .
math.listMean.summary = \
\
\
@@ -18246,7 +18246,7 @@ math.listMean.summary = \
math.listMean() Function\
\
• Introduced in version 1.7\
- Calculates the arithmetic mean of the contents of a String List. Only allows numeric elements - any non-numeric values will produce an error. The mean is equal to the sum of all the list's contents divided by the number of elements.\
+ Calculates the arithmetic mean of the contents of a String List. Only allows numeric elements - any non-numeric values will produce an error. The mean is equal to the sum of all the list's contents divided by the number of elements.\
\
Usage\
\
@@ -18274,7 +18274,7 @@ math.listMean.summary = \
\
-math.listMedian.description = Calculates the Median of the contents of a String List .
+math.listMedian.description = Calculates the Median of the contents of a String List .
math.listMedian.summary = \
\
\
@@ -18283,7 +18283,7 @@ math.listMedian.summary = \
math.listMedian() Function\
\
• Introduced in version 1.7\
- Calculates the Median of the contents of a String List. The median value is is the value where half the numbers in the list are greater than or equal to it, and the other half are less than or equal to it. The median is calculated by sorting the list contents and picking the middle number if the number of elements is odd, or averaging the two in the middle if the number of elements is even. Only allows numeric elements - any non-numeric values will produce an error.\
+ Calculates the Median of the contents of a String List. The median value is is the value where half the numbers in the list are greater than or equal to it, and the other half are less than or equal to it. The median is calculated by sorting the list contents and picking the middle number if the number of elements is odd, or averaging the two in the middle if the number of elements is even. Only allows numeric elements - any non-numeric values will produce an error.\
\
Usage\
\
@@ -18311,7 +18311,7 @@ math.listMedian.summary = \
\
-math.listMin.description = Find the minimum value in a String List .
+math.listMin.description = Find the minimum value in a String List .
math.listMin.summary = \
\
\
@@ -18320,7 +18320,7 @@ math.listMin.summary = \
math.listMin() Function\
\
• Introduced in version 1.7\
- Find the minimum value in a String List. Only allows numeric elements - any non-numeric values will produce an error.\
+ Find the minimum value in a String List. Only allows numeric elements - any non-numeric values will produce an error.\
\
Usage\
\
@@ -18348,7 +18348,7 @@ math.listMin.summary = \
\
-math.listProduct.description = Multiplies together the contents of a String List .
+math.listProduct.description = Multiplies together the contents of a String List .
math.listProduct.summary = \
\
\
@@ -18357,7 +18357,7 @@ math.listProduct.summary = \
math.listProduct() Function\
\
• Introduced in version 1.7\
- Multiplies together the contents of a String List. Only allows numeric elements - any non-numeric values will produce an error.\
+ Multiplies together the contents of a String List. Only allows numeric elements - any non-numeric values will produce an error.\
\
Usage\
\
@@ -18385,7 +18385,7 @@ math.listProduct.summary = \
\
-math.listSum.description = Adds together the contents of a String List .
+math.listSum.description = Adds together the contents of a String List .
math.listSum.summary = \
\
\
@@ -18394,7 +18394,7 @@ math.listSum.summary = \
math.listSum() Function\
\
• Introduced in version 1.7\
- Adds together the contents of a String List. Only allows numeric elements - any non-numeric values will produce an error.\
+ Adds together the contents of a String List. Only allows numeric elements - any non-numeric values will produce an error.\
\
Usage\
\
@@ -18575,7 +18575,7 @@ movedOverDrawing.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.2\
@@ -18681,7 +18681,7 @@ Moved Over: [r: movedOverPoints(jsonArray,lastPath)]\
\
-movedOverToken.description = Is used to check if the location of the target token is in an array of cell coordinates like the one received from getLastPath() or the onTokenMove event's macro.args .
+movedOverToken.description = Is used to check if the location of the target token is in an array of cell coordinates like the one received from getLastPath() or the onTokenMove event's macro.args .
movedOverToken.summary = \
\
\
@@ -18690,7 +18690,7 @@ movedOverToken.summary = \
movedOverToken() Function\
\
• Introduced in version 1.3.b74\
- Is used to check if the location of the target token is in an array of cell coordinates like the one received from getLastPath() or the onTokenMove event's macro.args.\
+ Is used to check if the location of the target token is in an array of cell coordinates like the one received from getLastPath() or the onTokenMove event's macro.args.\
\
\
Usage\
@@ -18795,20 +18795,20 @@ moveToken(x, y, units, id)\
x - The X coordinate to move the token to.y - The Y coordinate to move the token to.units - If set to false(0), the coordinates are a location on the grid in cells. Defaults to true(1), where the coordinates are in Distance Per Cell pixels.id - The id string of the token to move, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The id string of the token to move, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
\
\
\
Examples\
\
- Moves the Current Token down 5 units, and left 10 units.\
+ Moves the Current Token down 5 units, and left 10 units.\
[h: CurrentX = getTokenX()]\
[h: CurrentY = getTokenY()]\
[h: NewX = CurrentX + 5]\
[h: NewY = CurrentY - 10]\
[h: moveToken(NewX, NewY)]
\
-Moves the Current Token down 5 cells, and left 10 cells.\
+
Moves the Current Token down 5 cells, and left 10 cells.\
\
[h: CurrentX = getTokenX(0)]\
[h: CurrentY = getTokenY(0)]\
@@ -18834,7 +18834,7 @@ moveTokenFrom.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b54\
@@ -18852,7 +18852,7 @@ moveTokenFromMap(id, map, x, y, z)\
Parameters\
\
\
- id - The token id or a JSON Array of token ids of the token/s to move.id - The token id or a JSON Array of token ids of the token/s to move.map - A string containing the name of the map that the token is moved from.x - The X coordinate of the current map that the token should be moved to. Defaults to 0.y - The Y coordinate of the current map that the token should be moved to. Defaults to 0.\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b54\
@@ -18899,7 +18899,7 @@ moveTokenFromMap(id, map, x, y, z)\
Parameters\
\
\
- id - The token id or a JSON Array of token ids of the token/s to move.id - The token id or a JSON Array of token ids of the token/s to move.map - A string containing the name of the map that the token is moved from.x - The X coordinate of the current map that the token should be moved to. Defaults to 0.y - The Y coordinate of the current map that the token should be moved to. Defaults to 0.\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b54\
@@ -18946,7 +18946,7 @@ moveTokenToMap(id, map, x, y, z)\
Parameters\
\
\
- id - The token id or a JSON Array of token ids of the token/s to move.id - The token id or a JSON Array of token ids of the token/s to move.map - A string containing the name of the map that the token is moved to.x - The X coordinate of the map that the token should be moved to. Default to 0.y - The Y coordinate of the map that the token should be moved to. Default to 0.
\
-nextInitiative.description = Advances the initiative to the next Token in the Initiative Panel .
+nextInitiative.description = Advances the initiative to the next Token in the Initiative Panel .
nextInitiative.summary = \
\
\
@@ -19058,12 +19058,12 @@ nextInitiative.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b41\
- Advances the initiative to the next Token in the Initiative Panel. Only the GM or a trusted macro can call this function. This function returns the offset into the Initiative Panel (starting at 0) of the Token that will get the Initiative.\
-- Since 1.8: This function triggers the
onInitiativeChangeRequest (and onInitiativeChange) events, so it is possible that the change will be blocked. See the Guide to Initiative Events for more details. This function will return the offset of the token that has initiative after this function completes, whether the change proceeded as requested or not.
\
+ Advances the initiative to the next Token in the Initiative Panel. Only the GM or a trusted macro can call this function. This function returns the offset into the Initiative Panel (starting at 0) of the Token that will get the Initiative.\
+- Since 1.8: This function triggers the
onInitiativeChangeRequest (and onInitiativeChange) events, so it is possible that the change will be blocked. See the Guide to Initiative Events for more details. This function will return the offset of the token that has initiative after this function completes, whether the change proceeded as requested or not.
\
\
Usage\
\
@@ -19143,7 +19143,7 @@ number.summary = \
number() Function\
\
• Introduced in version 1.3b48\
- Returns the value that is passed in as a number. If the value can not be converted to a number then an error will occur. If you are unsure if a value is a number to can use isNumber() before calling this function.\
+ Returns the value that is passed in as a number. If the value can not be converted to a number then an error will occur. If you are unsure if a value is a number to can use isNumber() before calling this function.\
\
Usage\
\
@@ -19164,7 +19164,7 @@ oldFunction.summary = \
\
• Introduced in version 1.3b51\
If a user-defined function redefines a standard MapTool function or another user-defined function -- for instance, a user defines a function called eval(), redefining the standard MapTool eval() -- oldFunction() can be used in the user-defined function to call the original function. When a user-defined function redefines an existing function, it keeps track of the function that it redefined. Due to this tracking, it is possible to redefine a function multiple times and oldFunction() will always reference the previous function in the chain.\
-Note: Do not rely on a specific order in the function chain unless you are sure that the functions will be redefined in that order. Calls to defineFunction() within onCampaignLoad macros on different Library Tokens are not executed in any standard order.\
+Note: Do not rely on a specific order in the function chain unless you are sure that the functions will be redefined in that order. Calls to defineFunction() within onCampaignLoad macros on different Library Tokens are not executed in any standard order.\
\
Usage\
\
@@ -19235,7 +19235,7 @@ Returns a string that is similar to Dice: 5, 4, 19, 6, 3, Maximum: 19\
See Also\
\
- For another method of rolling dice, see Dice Expressions.\
+ For another method of rolling dice, see Dice Expressions.\
\
\
@@ -19314,7 +19314,7 @@ playClip(uri, cycleCount, volume)\
Parameter\
\
\
- uri - The uri/url of the file. For example, http://www.mywebsite/mysong.mp3 or file:/C:/mysong.mp3uri - The uri/url of the file. For example, https://www.mywebsite/mysong.mp3 or file:/C:/mysong.mp3cycleCount - The number of times the audio should play. If set to 0, the file is cached but not played; if set to -1, the file is played continuously. Defaults to 1.volume - The volume the audio is to be played at. Can range from 0 to 1. Defaults to 1.
\
@@ -19325,7 +19325,7 @@ playClip(uri, cycleCount, volume)\
[playClip(macro.args)]
\
To play the song, the GM can then use execLink:\
\
-[H: songUrl = "http://erinmcnamee.com.hostbaby.com/files/07_No_Sorrow__Banish_Misfortune.mp3"]\
+[H: songUrl = "https://erinmcnamee.com.hostbaby.com/files/07_No_Sorrow__Banish_Misfortune.mp3"]\
[H: audioByte = macroLinkText("playSong@Lib:MusicPlayer", "none", songUrl)]\
[H: execLink(audioByte,0,"all")]\
Dropbox URLs
\
@@ -19360,7 +19360,7 @@ playStream(uri, cycleCount, volume, start, stop)
\
Parameter\
\
\
- uri - The uri/url of the file. For example, http://www.mywebsite/mysong.mp3 or file:/C:/mysong.mp3uri - The uri/url of the file. For example, https://www.mywebsite/mysong.mp3 or file:/C:/mysong.mp3cycleCount - The number of times the audio should play. If set to 0, the file is cached but not played; if set to -1, the file is played continuously. Defaults to 1.volume - The volume the audio is to be played at. Can range from 0 to 1. Defaults to 1.start - The time offset in seconds where audio should start playing, or restart from when repeating. Defaults to 0.[playStream(macro.args)]
\
To play the song, the GM can then use execLink:\
\
-[H: songUrl = "http://erinmcnamee.com.hostbaby.com/files/07_No_Sorrow__Banish_Misfortune.mp3"]\
+[H: songUrl = "https://erinmcnamee.com.hostbaby.com/files/07_No_Sorrow__Banish_Misfortune.mp3"]\
[H: audioByte = macroLinkText("playSong@Lib:MusicPlayer", "none", songUrl)]\
[H: execLink(audioByte,0,"all")]\
Alternatively, the GM can use execFunction:\
\
-[H: songUrl = json.append("[]","http://erinmcnamee.com.hostbaby.com/files/07_No_Sorrow__Banish_Misfortune.mp3")]\
+[H: songUrl = json.append("[]","https://erinmcnamee.com.hostbaby.com/files/07_No_Sorrow__Banish_Misfortune.mp3")]\
[H: execFunction("playStream", songUrl, 0, "all")\
Dropbox URLs
\
After creating the dropbox share link you have to replace www.dropbox.com with dl.dropboxusercontent.com. That provides a direct link that playStream can use. Thanks to Full Bleed on the forums for the tip.\
@@ -19490,7 +19490,7 @@ power.summary = \
\
-prevInitiative.description = Restores the initiative to the previous Token in the Initiative Panel , returning to the previous round if necessary.
+prevInitiative.description = Restores the initiative to the previous Token in the Initiative Panel , returning to the previous round if necessary.
prevInitiative.summary = \
\
\
@@ -19500,12 +19500,12 @@ prevInitiative.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.8\
- Restores the initiative to the previous Token in the Initiative Panel, returning to the previous round if necessary. Only the GM or a trusted macro can call this function. This function returns the offset into the Initiative Panel (starting at 0) of the Token that will receive Initiative. Note: neither this function nor the corresponding UI button will allow the Initiative to fall back any further than the first token in the first round.\
-- This function triggers the
onInitiativeChangeRequest (and onInitiativeChange) events, so it is possible that the change will be blocked. See the Guide to Initiative Events for more details. This function will return the offset of the token that has initiative after this function completes, whether the change proceeded as requested or not.
\
+ Restores the initiative to the previous Token in the Initiative Panel, returning to the previous round if necessary. Only the GM or a trusted macro can call this function. This function returns the offset into the Initiative Panel (starting at 0) of the Token that will receive Initiative. Note: neither this function nor the corresponding UI button will allow the Initiative to fall back any further than the first token in the first round.\
+- This function triggers the
onInitiativeChangeRequest (and onInitiativeChange) events, so it is possible that the change will be blocked. See the Guide to Initiative Events for more details. This function will return the offset of the token that has initiative after this function completes, whether the change proceeded as requested or not.
\
\
Usage\
\
@@ -19543,7 +19543,7 @@ refreshDrawing.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -19580,7 +19580,7 @@ refreshDrawing.summary = \
\
-removeAllFromInitiative.description = Removes all of the Tokens from the Initiative Panel .
+removeAllFromInitiative.description = Removes all of the Tokens from the Initiative Panel .
removeAllFromInitiative.summary = \
\
\
@@ -19590,10 +19590,10 @@ removeAllFromInitiative.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
- Removes all of the Tokens from the Initiative Panel. This function returns the number of Tokens that were removed. Only the GM can call this function.\
+ Removes all of the Tokens from the Initiative Panel. This function returns the number of Tokens that were removed. Only the GM can call this function.\
\
Usage\
\
@@ -19604,7 +19604,7 @@ removeAllFromInitiative.summary = \
\
-removeAllNPCsFromInitiative.description = Removes all of the NPC Tokens from the Initiative Panel .
+removeAllNPCsFromInitiative.description = Removes all of the NPC Tokens from the Initiative Panel .
removeAllNPCsFromInitiative.summary = \
\
\
@@ -19614,10 +19614,10 @@ removeAllNPCsFromInitiative.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
- Removes all of the NPC Tokens from the Initiative Panel. This function returns the number of Tokens that were removed. Only the GM can call this function.\
+ Removes all of the NPC Tokens from the Initiative Panel. This function returns the number of Tokens that were removed. Only the GM can call this function.\
\
Usage\
\
@@ -19628,7 +19628,7 @@ removeAllNPCsFromInitiative.summary = \
\
-removeAllPCsFromInitiative.description = Removes all of the PC Tokens from the Initiative Panel .
+removeAllPCsFromInitiative.description = Removes all of the PC Tokens from the Initiative Panel .
removeAllPCsFromInitiative.summary = \
\
\
@@ -19638,10 +19638,10 @@ removeAllPCsFromInitiative.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
- Removes all of the PC Tokens from the Initiative Panel. This function returns the number of Tokens that were removed. Only the GM can call this function.\
+ Removes all of the PC Tokens from the Initiative Panel. This function returns the number of Tokens that were removed. Only the GM can call this function.\
\
Usage\
\
@@ -19652,7 +19652,7 @@ removeAllPCsFromInitiative.summary = \
\
-removeFromInitiative.description = Removes the Current Token from the Initiative Panel .
+removeFromInitiative.description = Removes the Current Token from the Initiative Panel .
removeFromInitiative.summary = \
\
\
@@ -19660,7 +19660,7 @@ removeFromInitiative.summary = \
\
removeFromInitiative() Function\
\
- Removes the Current Token from the Initiative Panel. Additional parameters allow you to specify the token.\
+ Removes the Current Token from the Initiative Panel. Additional parameters allow you to specify the token.\
\
Usage\
\
@@ -19673,14 +19673,14 @@ removeFromInitiative(id, mapname)\
Parameters\
\
\
- id - The token id of the token to be removed from the initiative. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to be removed from the initiative. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.return - Returns 1 if removed from the initiative, 0 if did not.
\
\
Example\
\
- To remove the token with the name "Dragon" in current map from the initiative panel.\
+ To remove the token with the name "Dragon" in current map from the initiative panel.\
[h: removeFromInitiative("Dragon")]\
\
See Also\
@@ -19754,7 +19754,7 @@ removeToken.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b51\
@@ -19795,7 +19795,7 @@ removeTokenFacing.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b51\
@@ -19839,7 +19839,7 @@ replace.summary = \
replace() Function\
\
• Introduced in version 1.3b48\
- Returns the string with the occurrences of a pattern replaced by the specified value. If the number of times to perform the replacement is not specified then all occurrences of the pattern are replaced. Pattern can be a regular expression. This means if the pattern string contains any regular expression special characters they must be escaped.\
+ Returns the string with the occurrences of a pattern replaced by the specified value. If the number of times to perform the replacement is not specified then all occurrences of the pattern are replaced. Pattern can be a regular expression. This means if the pattern string contains any regular expression special characters they must be escaped.\
\
Usage\
\
@@ -19913,7 +19913,7 @@ Returns a number than is between 25 and 50.
\
\
See Also\
\
- For another method of rolling dice, see Dice Expressions.\
+ For another method of rolling dice, see Dice Expressions.\
\
\
@@ -19960,7 +19960,7 @@ May return 5 [2, 1, 2, 4] - the first die produced a 2, which was r
\
See Also\
\
- For another method of rolling dice, see Dice Expressions.\
+ For another method of rolling dice, see Dice Expressions.\
\
\
@@ -19992,13 +19992,13 @@ resetFrame.summary = \
\
See Also\
\
- [frame():],\
+ \
\
\
-resetProperty.description = Resets the specified Token Property on a specific Token so that it is empty and will return the default value when queried (if it has one).
+resetProperty.description = Resets the specified Token Property on a specific Token so that it is empty and will return the default value when queried (if it has one).
resetProperty.summary = \
\
\
@@ -20007,7 +20007,7 @@ resetProperty.summary = \
resetProperty() Function\
\
• Introduced in version 1.3b48\
- Resets the specified Token Property on a specific Token so that it is empty and will return the default value when queried (if it has one).\
+ Resets the specified Token Property on a specific Token so that it is empty and will return the default value when queried (if it has one).\
\
Usage\
\
@@ -20021,7 +20021,7 @@ resetProperty(property, id, mapname)\
\
\
property - The name of the property to reset.id - The token id of the token which has its property reset, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token which has its property reset, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -20039,7 +20039,7 @@ resetProperty(property, id, mapname)\
\
\
- 1.3b51 - Added
id parameter option. \
- - 1.3b68 - Token Property is now deleted from Token
\
+ - 1.3b68 - Token Property is now deleted from Token
\
- 1.5.4 - Added
mapname parameter option. \
\
\
@@ -20047,7 +20047,7 @@ resetProperty(property, id, mapname)\
\
-resetSize.description = Resets the Size of a Token to the default for grid type of the map it occupies.
+resetSize.description = Resets the Size of a Token to the default for grid type of the map it occupies.
resetSize.summary = \
\
\
@@ -20057,11 +20057,11 @@ resetSize.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
- Resets the Size of a Token to the default for grid type of the map it occupies. See setSize() for details about the default size for different grid types.\
+ Resets the Size of a Token to the default for grid type of the map it occupies. See setSize() for details about the default size for different grid types.\
\
Usage\
\
@@ -20074,7 +20074,7 @@ resetSize(id, mapname)\
Parameters\
\
\
- id - The token id of the token to reset, defaults to the Current Token.id - The token id of the token to reset, defaults to the Current Token.mapName - Optional map name to find the token. Defaults to current map.
\
\
@@ -20116,7 +20116,7 @@ resetTablePicks.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.6.0\
@@ -20135,8 +20135,8 @@ resetTablePicks(tableName, entriesToReset, "json")\
\
\
tableName - A string containing the name of the Table.entriesToReset - Since 1.8. Identifies specific entries to be reset. Can be a String List using the provided delim (defaults to "," if no delim provided), or a JSON Array if delim is "json".delim - Since 1.8. Custom delimiter for the `entriesToReset` param. Defaults to ",". Should be "json" if entriesToReset is a JSON Array instead of a String List.entriesToReset - Since 1.8. Identifies specific entries to be reset. Can be a String List using the provided delim (defaults to "," if no delim provided), or a JSON Array if delim is "json".delim - Since 1.8. Custom delimiter for the `entriesToReset` param. Defaults to ",". Should be "json" if entriesToReset is a JSON Array instead of a String List.
\
\
Examples\
@@ -20154,7 +20154,7 @@ resetTablePicks(tableName, entriesToReset, "json")\
If this table is set to Pick Once, then the Ace and Two of Clubs can be reset with any of:\
[h:resetTablePicks("Standard", "0,1")]\
[h:resetTablePicks("Standard", "0@1", "@")]\
-[h:resetTablePicks("Standard", json.append("", 0, 1), "json")]Note that entries on Pick Once tables are identified by list index (starting at 0), and not by range as in normal tables. Take care to properly identify entries when resetting. For more info, see Introduction to Tables and the table() function.\
+[h:resetTablePicks("Standard", json.append("", 0, 1), "json")]Note that entries on Pick Once tables are identified by list index (starting at 0), and not by range as in normal tables. Take care to properly identify entries when resetting. For more info, see Introduction to Tables and the table() function.\
\
See Also\
\
@@ -20184,7 +20184,7 @@ REST.delete.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -20251,7 +20251,7 @@ Note the 204 - No Content status and thus no "body" element in the JSON. If the
See Also\
\
\
\
Version Changes\
@@ -20275,7 +20275,7 @@ REST.get.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -20365,7 +20365,7 @@ See this See Also\
\
\
\
\
@@ -20381,7 +20381,7 @@ REST.patch.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -20450,7 +20450,7 @@ REST.patch(url, payload, mediaType, headers, getFullResponse)\
See Also\
\
\
\
\
@@ -20466,7 +20466,7 @@ REST.post.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -20539,7 +20539,7 @@ REST.post(url, payload, mediaType, headers, getFullResponse)\
See Also\
\
\
\
\
@@ -20555,7 +20555,7 @@ REST.put.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -20610,7 +20610,7 @@ REST.put(url, payload, mediaType, headers, getFullResponse)\
See Also\
\
\
\
\
@@ -20626,7 +20626,7 @@ restoreFoW.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.1.3\
@@ -20660,7 +20660,7 @@ restoreFoW(mapname)\
\
See Also\
\
- \
+ \
\
\
@@ -20674,7 +20674,7 @@ return.summary = \
return() Function\
\
• Introduced in version 1.5.0\
- Is used to conditionally return from the execution of a macro like an abort, but not stopping further macro execution. Optionally also returning a value by automatically assigning macro.return. If the first argument to return() is 0 then the return is happening. If the first argument to return() is non zero then the macro continues. The optional second argument of return() defines if there is a value that should be returned to a calling macro. Any other output is discarded when using return().\
+ Is used to conditionally return from the execution of a macro like an abort, but not stopping further macro execution. Optionally also returning a value by automatically assigning macro.return. If the first argument to return() is 0 then the return is happening. If the first argument to return() is non zero then the macro continues. The optional second argument of return() defines if there is a value that should be returned to a calling macro. Any other output is discarded when using return().\
Common uses for this function are\
\
- Ending a macro with or without a return value to stop the further execution of the following lines in the current macro.
- The macro has conditions and based on these you want to return different values and not continue further in the current macro.
\
@@ -20777,12 +20777,12 @@ roll.summary = \
[h: listOfRolls = listAppend(listOfRolls, r)]\
}]\
You rolled [r: listSort(listOfRolls, "N-")] = [r: sum].Rolls 5 times a d6 and returns these as sorted list as well as the total.\
-
- See also[count():], listAppend() and listSort().
\
+- See also[count():], listAppend() and listSort().
\
\
\
See Also\
\
- For another method of rolling dice, see Dice Expressions.\
+ For another method of rolling dice, see Dice Expressions.\
\
\
@@ -20820,7 +20820,7 @@ Returns a number that is between 40 and 115 (and no longer 5 to 100 as with a re
\
See Also\
\
- The corresponding dice roll expression is XdYaZlW. For other methods of rolling dice, see Dice Expressions.\
+ The corresponding dice roll expression is XdYaZlW. For other methods of rolling dice, see Dice Expressions.\
\
\
@@ -20858,7 +20858,7 @@ Returns a number that is between 35 and 90 (and no longer 5 to 100 as with a reg
\
See Also\
\
- The corresponding dice roll expression is XdYaZuW. For other methods of rolling dice, see Dice Expressions.\
+ The corresponding dice roll expression is XdYaZuW. For other methods of rolling dice, see Dice Expressions.\
\
\
@@ -20896,7 +20896,7 @@ Returns a number that is between 15 and 90 (and no longer 5 to 100 as with a reg
\
See Also\
\
- The corresponding dice roll expression is XdYsZlW. For other methods of rolling dice, see Dice Expressions.\
+ The corresponding dice roll expression is XdYsZlW. For other methods of rolling dice, see Dice Expressions.\
\
\
@@ -20934,7 +20934,7 @@ Returns a number that is between -10 and 70 (and no longer 5 to 100 as with a re
\
See Also\
\
- The corresponding dice roll expression is XdYsZuW. For other methods of rolling dice, see Dice Expressions.\
+ The corresponding dice roll expression is XdYsZuW. For other methods of rolling dice, see Dice Expressions.\
\
\
@@ -20971,7 +20971,7 @@ Returns a number that is between 35 and 100 (and no longer down to 5 as with a r
\
See Also\
\
- The corresponding dice roll expression is XdYlZ. For other methods of rolling dice, see Dice Expressions.\
+ The corresponding dice roll expression is XdYlZ. For other methods of rolling dice, see Dice Expressions.\
\
\
@@ -21008,7 +21008,7 @@ Returns a number that is between 5 and 80 (and no longer up to 100 as with a reg
\
See Also\
\
- The corresponding dice roll expression is XdYuZ. For other methods of rolling dice, see Dice Expressions.\
+ The corresponding dice roll expression is XdYuZ. For other methods of rolling dice, see Dice Expressions.\
\
\
@@ -21129,18 +21129,18 @@ selectTokens.summary = \
\
id - the id string or token name of a specific token to select (the examples below use token names, but IDs are also permitted); if left blank all visible tokens are selected.add - if the value of add is true(1), the selections will be added to the current set of selected tokens; if the value is false(0) currently selected tokens will be deselected before new tokens are selected. Defaults to false.tokens - a String List of tokens to select.delim - Specifies the delimiter used in the string list that is supplied. If the delimiter is "json", then the value for tokens may be a JSON Array instead. Note: if using a JSON Array or String List, both add and delim must be specified.tokens - a String List of tokens to select.delim - Specifies the delimiter used in the string list that is supplied. If the delimiter is "json", then the value for tokens may be a JSON Array instead. Note: if using a JSON Array or String List, both add and delim must be specified.
\
\
Example\
\
To select a single token with the name "Adventurer":\
[h:selectTokens("Adventurer")]\
-To select a list of Tokens using a String List, replacing the current selection\
+
To select a list of Tokens using a String List, replacing the current selection\
\
[h:selectTokens("Adventurer, Orc 2, Goblin 1", 0, ",")]\
-To select a list of Tokens using a JSON Array, adding the specified tokens to the current set of selected Tokens:\
+
To select a list of Tokens using a JSON Array, adding the specified tokens to the current set of selected Tokens:\
\
[h:selectTokens("['Adventurer', 'Orc 2', 'Goblin 1']", 1, "json")]\
\
@@ -21171,7 +21171,7 @@ sendDrawingToBack.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.1.7\
@@ -21207,7 +21207,7 @@ sendDrawingToBack.summary = \
\
-sendToBack.description = Adjust the z-order (or draw order) of the Token so that it is drawn before all other Tokens on the same Map Layer , this has the effect of making the Token appear to be in back of the other Tokens as it will be obscured by other Tokens on the same Map Layer in the same location.
+sendToBack.description = Adjust the z-order (or draw order) of the Token so that it is drawn before all other Tokens on the same Map Layer , this has the effect of making the Token appear to be in back of the other Tokens as it will be obscured by other Tokens on the same Map Layer in the same location.
sendToBack.summary = \
\
\
@@ -21216,7 +21216,7 @@ sendToBack.summary = \
sendToBack() Function\
\
• Introduced in version 1.3b48\
- Adjust the z-order (or draw order) of the Token so that it is drawn before all other Tokens on the same Map Layer, this has the effect of making the Token appear to be in back of the other Tokens as it will be obscured by other Tokens on the same Map Layer in the same location.\
+ Adjust the z-order (or draw order) of the Token so that it is drawn before all other Tokens on the same Map Layer, this has the effect of making the Token appear to be in back of the other Tokens as it will be obscured by other Tokens on the same Map Layer in the same location.\
\
Usage\
\
@@ -21229,13 +21229,13 @@ sendToBack(id, mapname)\
Parameter\
\
\
- id - The token id or name of the token that has its z-order changed, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id or name of the token that has its z-order changed, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
Examples\
\
- Sends the Current Token to the lowest z-order.\
+ Sends the Current Token to the lowest z-order.\
[h: sendToBack()]
\
Sends all of the selected tokens to the lowest z-order.\
\
@@ -21316,7 +21316,7 @@ This function is rarely used because a simple assignment to a variable name can
\
-setAllStates.description = Sets all of the States of a Token to on ( true ( 1 )) or off ( false ( 0 )).
+setAllStates.description = Sets all of the States of a Token to on ( true ( 1 )) or off ( false ( 0 )).
setAllStates.summary = \
\
\
@@ -21325,7 +21325,7 @@ setAllStates.summary = \
setAllSates() Function\
\
• Introduced in version 1.3b40\
- \
+ \
\
Usage\
\
@@ -21339,21 +21339,21 @@ setAllStates(value, id, mapname)\
\
\
value - If all states should be set on or off, true(1) or false(0).id - The id of the token that should have its States set. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The id of the token that should have its States set. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
Examples\
\
- Set all Token States on\
+ Set all Token States on\
[h: setAllStates(1)]
\
-Set all Token States off\
+
Set all Token States off\
\
[h: setAllStates(0)]
\
\
See Also\
\
- \
+ \
\
Version Changes\
\
@@ -21388,7 +21388,7 @@ setAlwaysVisible.summary = \
\
\
value - The value of the setting to set, true(1) or false(0).id - OPTIONAL: The token id of the token for which you want to set this setting, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - OPTIONAL: The token id of the token for which you want to set this setting, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
\
\
Example\
@@ -21403,7 +21403,7 @@ setAlwaysVisible.summary = \
\
-setBar.description = Sets the value of the specified bar for the Current Token and makes the bar visible.
+setBar.description = Sets the value of the specified bar for the Current Token and makes the bar visible.
setBar.summary = \
\
\
@@ -21413,11 +21413,11 @@ setBar.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b42\
- Sets the value of the specified bar for the Current Token and makes the bar visible. The value to set is between 0 and 1 for 0% to 100% respectively.\
+ Sets the value of the specified bar for the Current Token and makes the bar visible. The value to set is between 0 and 1 for 0% to 100% respectively.\
\
Usage\
\
@@ -21432,7 +21432,7 @@ setBar(name, pct/100, id, mapname)\
\
name - The name of the bar.value - The value of the bar. Should be between 0 and 1.id - The token id of the token which has its bar set, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token which has its bar set, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -21462,17 +21462,17 @@ setBar(name, pct/100, id, mapname)\
\
\
- \
- HP and Health Bars\
+ HP and Health Bars\
\
- \
- The
bar.name special variable\
+ The bar.name special variable\
\
\
\
\
-setBarVisible.description = Sets if the specified bar for the Current Token is visible or not.
+setBarVisible.description = Sets if the specified bar for the Current Token is visible or not.
setBarVisible.summary = \
\
\
@@ -21481,7 +21481,7 @@ setBarVisible.summary = \
setBarVisible() Function\
\
• Introduced in version 1.3b46\
- Sets if the specified bar for the Current Token is visible or not. If the value is non zero then the bar is visible, if it is 0 it is not visible.\
+ Sets if the specified bar for the Current Token is visible or not. If the value is non zero then the bar is visible, if it is 0 it is not visible.\
\
Usage\
\
@@ -21496,15 +21496,15 @@ setBarVisible(name, value, id, mapname)\
\
bar - A string that contains the name of the bar that has its visibility set.value - The visibility value of the bar, either 0 or 1.id - The token id of the token which has its bar visibility set, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token which has its bar visibility set, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
Examples\
\
- Make "health" bar for the Current Token visible.\
+ Make "health" bar for the Current Token visible.\
[h: setBarVisible("Health", 1)]\
-Hide "health" bar for the Current Token.\
+
Hide "health" bar for the Current Token.\
\
[h: setBarVisible("Health", 0)]\
\
@@ -21526,17 +21526,17 @@ setBarVisible(name, value, id, mapname)\
\
\
- \
- HP and Health Bars\
+ HP and Health Bars\
\
- \
- The
bar.name special variable\
+ The bar.name special variable\
\
\
\
\
-setCurrentInitiative.description = Gives the Initiative to the Token at the specified offset in the Initiative Panel .
+setCurrentInitiative.description = Gives the Initiative to the Token at the specified offset in the Initiative Panel .
setCurrentInitiative.summary = \
\
\
@@ -21544,7 +21544,7 @@ setCurrentInitiative.summary = \
\
setCurrentInitiative() Function\
\
- Gives the Initiative to the Token at the specified offset in the Initiative Panel. Offsets start at 0.\
+ Gives the Initiative to the Token at the specified offset in the Initiative Panel. Offsets start at 0.\
To clear, specify a number that is not a valid token offset, like -1.\
\
Usage\
@@ -21555,7 +21555,7 @@ To clear, specify a number that is not a valid token offset, like -1.
\
\
Examples\
\
- Give Initiative to the 4th Token.\
+ Give Initiative to the 4th Token.\
[h: setCurrentInitiative(3)]
\
Clear current initiative (any number that is not a valid token offset will work).\
\
@@ -21578,7 +21578,7 @@ setCurrentMap.summary = \
WARNING: This function changes an internal variable used by MapTool to keep track of which map is current and this change takes place immediately. However, changes to tokens are queued up and only occur when the macro finishes execution (well, sort of). The end result is that if a token is being modified on map "A" and your macro calls setCurrentMap() to switch to map "B", when the macro finishes and the token changes are executed they will be processing a token on map B! If there was no such token on map B a new one will be created, thus mysteriously duplicating tokens!\
Therefore, do NOT modify any token properties, states, names, notes, or any other token-specific values after calling setCurrentMap(). Or make sure that the first thing your macro does is call setCurrentMap() so that all tokens accessed later will be on the map that is current when the macro finishes.\
\
-Search http://forums.rptools.net/ for setCurrentMap to find some discussion threads on this topic.\
+Search https://forums.rptools.net/ for setCurrentMap to find some discussion threads on this topic.\
\
Usage\
\
@@ -21617,7 +21617,7 @@ setDrawingEraser.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -21668,12 +21668,12 @@ setDrawingLayer.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.1.7\
For a specified drawing, set the layer of the map to which the drawing belongs.\
-The Map Layer is one of:\
+
The Map Layer is one of:\
\
TOKENGM also known as HiddenOBJECTBACKGROUND
\
\
@@ -21721,7 +21721,7 @@ setDrawingOpacity.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -21770,7 +21770,7 @@ setDrawingProperties.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -21819,7 +21819,7 @@ setFillColor.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -21871,7 +21871,7 @@ setGMName.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b49\
@@ -21889,13 +21889,13 @@ setGMName(name, id, mapname)\
\
\
name - A string that is set as the GM Name on the token.id - The token id of the token that has its GM Name set. Defaults to the Current Token.id - The token id of the token that has its GM Name set. Defaults to the Current Token.mapname - The name of the map to find the token. Defaults to the current map.
\
\
Examples\
\
- Sets the GM Name of the Current Token to New GM Name.\
+ Sets the GM Name of the Current Token to New GM Name.\
[h: setGMName("New GM Name")]\
Sets the GM Name of all selected tokens to New GM Name.\
\
@@ -21923,7 +21923,7 @@ setGMName(name, id, mapname)\
\
-setGMNotes.description = Sets the GM notes of the Current Token .
+setGMNotes.description = Sets the GM notes of the Current Token .
setGMNotes.summary = \
\
\
@@ -21933,11 +21933,11 @@ setGMNotes.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
- Sets the GM notes of the Current Token.\
+ Sets the GM notes of the Current Token.\
\
Usage\
\
@@ -21951,14 +21951,14 @@ setGMNotes(notes, id, mapname)\
\
\
notes - The GM notes to set on the token.id - The token id of the token to set the GM notes on. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to set the GM notes on. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
\
-setHalo.description = Sets the Halo color of a Token .
+setHalo.description = Sets the Halo color of a Token .
setHalo.summary = \
\
\
@@ -21967,7 +21967,7 @@ setHalo.summary = \
setHalo() Function\
\
• Introduced in version 1.3b49\
- \
+ \
\
Usage\
\
@@ -21981,25 +21981,25 @@ setHalo.summary = \
Parameters\
\
\
- color - The color to set the Halo to, valid values are:\
+ color - The color to set the Halo to, valid values are:\
"Black""Green""Yellow""Orange""Red""Cyan""Magenta""White"- A hexadecimal color value in the format
"#RRGGBB" "None"
id - The token id of the token that has its Halo set by this function. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token that has its Halo set by this function. Note: This parameter can only be used in a Trusted Macro.
\
\
Examples\
\
- To remove the Halo from the Current Token.\
+ To remove the Halo from the Current Token.\
[h: setHalo("None")]\
-To set the Halo for the Current Token to red.\
+
To set the Halo for the Current Token to red.\
\
[h: setHalo("Red")]\
-To set the Halo from the Current Token to a custom color\
+
To set the Halo from the Current Token to a custom color\
\
[h: setHalo("#33AAFF")]\
\
See Also\
\
- \
-setHasSight.description = Enables/disables sight for the Current Token .
+setHasSight.description = Enables/disables sight for the Current Token .
setHasSight.summary = \
\
\
@@ -22022,7 +22022,7 @@ setHasSight.summary = \
setHasSight() Function\
\
• Introduced in version 1.3b48\
- Enables/disables sight for the Current Token. If the argument is 0 (false) sight will be disabled on the Current Token. If it is non-zero (true) sight is enabled.\
+ Enables/disables sight for the Current Token. If the argument is 0 (false) sight will be disabled on the Current Token. If it is non-zero (true) sight is enabled.\
\
Usage\
\
@@ -22036,13 +22036,13 @@ setHasSight(state, id, mapname)\
\
\
state - Boolean - true to enable sight, false to disableid - The id of the token to set the sight of. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The id of the token to set the sight of. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
Example\
\
- Enables sight for Current Token\
+ Enables sight for Current Token\
[h: setHasSight(1)]
\
Returns: Empty String.\
\
@@ -22060,7 +22060,7 @@ Returns: Empty String.
\
\
-setInitiative.description = Sets the Initiative of the Current Token .
+setInitiative.description = Sets the Initiative of the Current Token .
setInitiative.summary = \
\
\
@@ -22069,7 +22069,7 @@ setInitiative.summary = \
setInitiative() Function\
\
• Introduced in version 1.3b41\
- Sets the Initiative of the Current Token.\
+ Sets the Initiative of the Current Token.\
\
Usage\
\
@@ -22080,7 +22080,7 @@ setInitiative(value, id, mapname)\
\
\
value - The initiative value to set. If included, the initiative will be set even if the token is already on the initiative list.id - The token id of the token to have its initiative set. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to have its initiative set. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -22103,7 +22103,7 @@ setInitiative(value, id, mapname)\
\
-setInitiativeHold.description = Sets if the Current Token is on hold in the Initiative Panel .
+setInitiativeHold.description = Sets if the Current Token is on hold in the Initiative Panel .
setInitiativeHold.summary = \
\
\
@@ -22112,7 +22112,7 @@ setInitiativeHold.summary = \
setInitiativeHold() Function\
\
• Introduced in version 1.3b41\
- Sets if the Current Token is on hold in the Initiative Panel. If the value passed is non zero then the Current Token is placed on hold, if it is 0 it is removed from on hold.\
+ Sets if the Current Token is on hold in the Initiative Panel. If the value passed is non zero then the Current Token is placed on hold, if it is 0 it is removed from on hold.\
\
Usage\
\
@@ -22126,7 +22126,7 @@ setInitiativeHold(value, id, mapname)\
\
\
value - The initiative hold value to set.id - The token id of the token to set the initiative hold. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to set the initiative hold. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -22144,7 +22144,7 @@ setInitiativeHold(value, id, mapname)\
\
-setInitiativeRound.description = Sets the current round number in the Initiative Panel .
+setInitiativeRound.description = Sets the current round number in the Initiative Panel .
setInitiativeRound.summary = \
\
\
@@ -22154,10 +22154,10 @@ setInitiativeRound.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
- Sets the current round number in the Initiative Panel.\
+ Sets the current round number in the Initiative Panel.\
\
Usage\
\
@@ -22168,7 +22168,7 @@ setInitiativeRound.summary = \
\
-setLabel.description = Sets the Token Label of a specific Token .
+setLabel.description = Sets the Token Label of a specific Token .
setLabel.summary = \
\
\
@@ -22177,7 +22177,7 @@ setLabel.summary = \
setLabel() Function\
\
• Introduced in version 1.3b48\
- Sets the Token Label of a specific Token.\
+ Sets the Token Label of a specific Token.\
\
Usage\
\
@@ -22191,8 +22191,8 @@ setLabel.summary = \
Parameters\
\
\
- label - The string that the Token Label is set to.id - The token id of the token that has its label set, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
label - The string that the Token Label is set to.id - The token id of the token that has its label set, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
\
\
\
@@ -22215,7 +22215,7 @@ setLabel.summary = \
\
-setLayer.description = Sets the Map Layer that a Token is on.
+setLayer.description = Sets the Map Layer that a Token is on.
setLayer.summary = \
\
\
@@ -22225,12 +22225,12 @@ setLayer.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
- Sets the Map Layer that a Token is on.\
-The Map Layer is one of:\
+
Sets the Map Layer that a Token is on.\
+The Map Layer is one of:\
\
TOKENGM also known as HiddenOBJECTBACKGROUND
\
\
@@ -22247,8 +22247,8 @@ setLayer(layer, id, forceshape, mapname)\
Parameters\
\
\
- layer - The layer to move the Token to.id - The token id of the token which has its layer set, defaults to the Current Token.layer - The layer to move the Token to.id - The token id of the token which has its layer set, defaults to the Current Token.forceshape - If true(1), change the token shape type to TOP_DOWN if the layer is OBJECT, and to a shape reflecting its image if the layer is TOKEN. Defaults to true(1).mapname - The name of the map to find the token. Defaults to the current map.
\
@@ -22283,7 +22283,7 @@ setLayer(layer, id, forceshape, mapname)\
\
-setLibProperty.description = Sets the Token Property on a Library Token . if the name of the Library Token is not specified then the Token Property is set on the Library Token that the macro is running from.
+setLibProperty.description = Sets the Token Property on a Library Token . if the name of the Library Token is not specified then the Token Property is set on the Library Token that the macro is running from.
setLibProperty.summary = \
\
\
@@ -22292,7 +22292,7 @@ setLibProperty.summary = \
setLibProperty() Function\
\
• Introduced in version 1.3b48\
- Sets the Token Property on a Library Token. if the name of the Library Token is not specified then the Token Property is set on the Library Token that the macro is running from.\
+ Sets the Token Property on a Library Token. if the name of the Library Token is not specified then the Token Property is set on the Library Token that the macro is running from.\
\
Usage\
\
@@ -22303,9 +22303,9 @@ setLibProperty(name, value, libName)\
\
Examples\
\
- Set a property on the Library Token that the macro is running from.\
+ Set a property on the Library Token that the macro is running from.\
[h: setLibProperty("defaultStrength", 10)]\
-Set a property on a specifig Library Token.\
+
Set a property on a specifig Library Token.\
\
[h: setLibProperty("defaultStrength", 10, "Lib:Character")]\
Known Bug: note that using setLibProperty during onCampaignLoad and not being on the map where the lib resides, will result in a duplicate of that lib on the current map!\
@@ -22313,7 +22313,7 @@ Known Bug: note that using setLibProperty during onCampaignLoad and not being on
\
-setLight.description = Sets the light sources of the Current Token .
+setLight.description = Sets the light sources of the Current Token .
setLight.summary = \
\
\
@@ -22322,7 +22322,7 @@ setLight.summary = \
setLight() Function\
\
• Introduced in version 1.3b48\
- Sets the light sources of the Current Token. If the value is false(0) then the light source is turned off; otherwise, it is turned on.\
+ Sets the light sources of the Current Token. If the value is false(0) then the light source is turned off; otherwise, it is turned on.\
\
Usage\
\
@@ -22336,9 +22336,9 @@ setLight(type, name, value, id, mapname)\
\
\
type - The light source type, (e.g. "Generic", "D20").name - The name of the light source.name - The name of the light source.value - If true(1) sets the light on, if false(0) turns it off.id - The token id of the token to change the light sources, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to change the light sources, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -22374,7 +22374,7 @@ setLineCap.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -22415,7 +22415,7 @@ setLineCap.summary = \
\
-setMacroCommand.description = Sets the command that will be run when the Macro Button is pressed.
+setMacroCommand.description = Sets the command that will be run when the Macro Button is pressed.
setMacroCommand.summary = \
\
\
@@ -22425,11 +22425,11 @@ setMacroCommand.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
- Sets the command that will be run when the Macro Button is pressed. Note because of the way the parser interprets values within [] you may have to use the encode() and decode() functions with the string.\
+ Sets the command that will be run when the Macro Button is pressed. Note because of the way the parser interprets values within [] you may have to use the encode() and decode() functions with the string.\
\
Usage\
\
@@ -22469,7 +22469,7 @@ setMacroCommand(index, command, id, mapname)\
\
-setMacroProps.description = Sets the properties for the specified Macro Button on the Current Token .
+setMacroProps.description = Sets the properties for the specified Macro Button on the Current Token .
setMacroProps.summary = \
\
\
@@ -22478,7 +22478,7 @@ setMacroProps.summary = \
setMacroProps() Function\
\
• Introduced in version 1.3b48\
- Sets the properties for the specified Macro Button on the Current Token . The properties are passed to this function as a String Property List. This function accepts either a Macro Button Index or the label of a Macro Button. If it is a label then all of Macro Buttons on the Current Token with a matching label are changed.\
+ Sets the properties for the specified Macro Button on the Current Token . The properties are passed to this function as a String Property List. This function accepts either a Macro Button Index or the label of a Macro Button. If it is a label then all of Macro Buttons on the Current Token with a matching label are changed.\
\
Usage\
\
@@ -22500,11 +22500,11 @@ setMacroProps(label, props, delim, id, mapname)\
\
index - The index of the macro button.label - The label of the macro button.props - A String Property List or JSON Object containing the properties for the button.\
-applyToSelected - Should the macro be applied to the selected tokens.autoExecute - If the macro will be automatically executed when the button is clicked, accepts true(1) or false(0).color - The name of the color for the button.command - The command for the macro (only when using JSON version of function).fontColor - The name of the font color for the button.fontSize - The size of the font for the button.includeLabel - If the label will be output when the button is clicked. Accepts true(1) or false(0).group - The name of the group that the button belongs to.sortBy - The sort by value of the macro button.label - The label for the button.maxWidth - The maximum width of the button.minWidth - The minimum width of the button.playerEditable - Is the button player editable, accepts true(1) or false(0).tooltip - The tool tip for the macro button.compare - Takes a JSON Array which can contain one or more of the following keywords (only usable with JSON version of the function).\
+ props - A String Property List or JSON Object containing the properties for the button.\
+applyToSelected - Should the macro be applied to the selected tokens.autoExecute - If the macro will be automatically executed when the button is clicked, accepts true(1) or false(0).color - The name of the color for the button.command - The command for the macro (only when using JSON version of function).fontColor - The name of the font color for the button.fontSize - The size of the font for the button.includeLabel - If the label will be output when the button is clicked. Accepts true(1) or false(0).group - The name of the group that the button belongs to.sortBy - The sort by value of the macro button.label - The label for the button.maxWidth - The maximum width of the button.minWidth - The minimum width of the button.playerEditable - Is the button player editable, accepts true(1) or false(0).tooltip - The tool tip for the macro button.compare - Takes a JSON Array which can contain one or more of the following keywords (only usable with JSON version of the function).\
applyToSelected - Use the macro applyToSelected for common macro comparisons.autoExecute - Use the macro autoExec for common macro comparisons.command - Use the macro command for common macro comparisons.group - Use the macro group for common macro comparisons.includeLabel - Use the macro includeLabel for common macro comparisons.sortPrefix - Use the macro sortPrefix for common macro comparisons.
delim - The delimiter used in the String Property List that is sent to the props parameter, defaults to ";" and can be omitted if you are sending a JSON Object to the props parameter. If you are sending a JSON Object to the props parameter, and using the id parameter, you can set this to "json".id - The token id of the token that the macro button is located on. Note: This parameter can only be used in a Trusted Macro.
delim - The delimiter used in the String Property List that is sent to the props parameter, defaults to ";" and can be omitted if you are sending a JSON Object to the props parameter. If you are sending a JSON Object to the props parameter, and using the id parameter, you can set this to "json".id - The token id of the token that the macro button is located on. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -22550,7 +22550,7 @@ setMapDisplayName.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.9.0\
@@ -22596,7 +22596,7 @@ setMapName.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.0.1\
@@ -22636,7 +22636,7 @@ setMapVisible.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.0.1\
@@ -22668,7 +22668,7 @@ setMapVisible(visible, mapName)\
\
-setMaxLoopIterations.description = Sets the max amount of loops (in [count():] , [foreach():] , [for():] , [while():] ) that are allowed.
+setMaxLoopIterations.description = Sets the max amount of loops (in [count():] , [foreach():] , [for():] , [while():] ) that are allowed.
setMaxLoopIterations.summary = \
\
\
@@ -22677,7 +22677,7 @@ setMaxLoopIterations.summary = \
setMaxLoopIterations() Function\
\
• Introduced in version 1.4.0.2\
- Sets the max amount of loops (in [count():], [foreach():], [for():], [while():]) that are allowed. The current allowed min is 10,000. Note that this settings lasts only for the current session.\
+ Sets the max amount of loops (in [count():], [foreach():], [for():], [while():]) that are allowed. The current allowed min is 10,000. Note that this settings lasts only for the current session.\
\
Usage\
\
@@ -22743,7 +22743,7 @@ setMaxRecursionDepth.summary = \
\
-setName.description = Sets the name of a Token .
+setName.description = Sets the name of a Token .
setName.summary = \
\
\
@@ -22752,7 +22752,7 @@ setName.summary = \
setName() Function\
\
• Introduced in version 1.3b40\
- Sets the name of a Token.\
+ Sets the name of a Token.\
\
Usage\
\
@@ -22766,7 +22766,7 @@ setName(name, id, mapname)\
\
\
name - The name to set on the current token.id - The token id of the token which has its name set. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token which has its name set. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -22785,7 +22785,7 @@ setName(name, id, mapname)\
\
-setNotes.description = Sets the notes of the Current Token .
+setNotes.description = Sets the notes of the Current Token .
setNotes.summary = \
\
\
@@ -22794,7 +22794,7 @@ setNotes.summary = \
setNotes() Function\
\
• Introduced in version 1.3b48\
- Sets the notes of the Current Token.\
+ Sets the notes of the Current Token.\
\
Usage\
\
@@ -22809,7 +22809,7 @@ setNotes(notes, id, mapname)\
\
\
notes - The notes to set on the token.id - The token id of the token to set the notes on. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to set the notes on. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -22822,7 +22822,7 @@ See also getNotes\
\
-setNPC.description = Sets a Token to a NPC Token .
+setNPC.description = Sets a Token to a NPC Token .
setNPC.summary = \
\
\
@@ -22832,11 +22832,11 @@ setNPC.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
- \
+ \
\
Usage\
\
@@ -22849,7 +22849,7 @@ setNPC(id, mapname)\
Parameter\
\
\
- id - The token id of the token which has its NPC status set, defaults to the Current Token.id - The token id of the token which has its NPC status set, defaults to the Current Token.mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -22897,7 +22897,7 @@ setOwnedByAll(owned, id, mapname)\
\
\
owned - The value of the setting to set, true(1) or false(0).id - The token id of the token which has its Owned by All status set, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token which has its Owned by All status set, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -22925,7 +22925,7 @@ setOwnedByAll(owned, id, mapname)\
\
-setOwner.description = Changes the owners of a token (default is the Current Token ) when given a String owner name or JSON Array of owner names.
+setOwner.description = Changes the owners of a token (default is the Current Token ) when given a String owner name or JSON Array of owner names.
setOwner.summary = \
\
\
@@ -22934,7 +22934,7 @@ setOwner.summary = \
setOwner() Function\
\
• Introduced in version 1.3b48?\
- Changes the owners of a token (default is the Current Token) when given a String owner name or JSON Array of owner names. All other owners are removed.\
+ Changes the owners of a token (default is the Current Token) when given a String owner name or JSON Array of owner names. All other owners are removed.\
\
Usage\
\
@@ -22950,33 +22950,33 @@ setOwner(ownerNames, id, mapname)\
Parameters\
\
\
- ownerName - The player name to set the ownership on the token. Ownership is not constrained to the client names currently connected, but only currently connected clients appear in the Token Editor Dialog. This parameter is a String. An empty string here is treated as an empty JSON array (see next parameter).ownerNames - The player names to set the ownership on the token. Ownership is not constrained to the client names currently connected, but only currently connected clients appear in the Token Editor Dialog. This parameter is a JSON Array.id - The token id of the token which has its owners changed, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
ownerName - The player name to set the ownership on the token. Ownership is not constrained to the client names currently connected, but only currently connected clients appear in the Token Editor Dialog. This parameter is a String. An empty string here is treated as an empty JSON array (see next parameter).ownerNames - The player names to set the ownership on the token. Ownership is not constrained to the client names currently connected, but only currently connected clients appear in the Token Editor Dialog. This parameter is a JSON Array.id - The token id of the token which has its owners changed, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
Examples\
\
- To change the owners of the Current Token to a single user use:\
+ To change the owners of the Current Token to a single user use:\
[h: setOwner("Frank")]\
-To change the owners of the Current Token to a list of three players use:\
+
To change the owners of the Current Token to a list of three players use:\
\
[h: setOwner("['Peter', 'Paul', 'Mary']")]\
or:\
\
[h: list = json.append("[]", "Peter", "Paul", "Mary")]\
[h: setOwner(list)]\
-To make all current players owners of the Current Token use:\
+
To make all current players owners of the Current Token use:\
\
[h: setOwner(getAllPlayerNames("json"))]\
-To remove all owners of the Current Token use:\
+
To remove all owners of the Current Token use:\
\
[h: setOwner("")]\
or:\
\
[h: setOwner("[]")]\
-To display the current owners of the Current Token as checkboxes, then accept the user's changes to apply back onto the token, use the following. Note that this example does not provide for adding owners to the list, only removing them. (Adding owners would require the use of getAllPlayerNames() and would make this example even more complex.)\
+
To display the current owners of the Current Token as checkboxes, then accept the user's changes to apply back onto the token, use the following. Note that this example does not provide for adding owners to the list, only removing them. (Adding owners would require the use of getAllPlayerNames() and would make this example even more complex.)\
\
[h: names = getOwners("json")]\
[h: input = "tab0 | OwnerList || TAB"]\
@@ -23010,7 +23010,7 @@ setOwner(ownerNames, id, mapname)\
\
-setOwnerOnlyVisible.description = Sets the Visible to Owners Only flag on a Token if the value passed in is non-zero( true ( 1 )), otherwise resets it to false ( 0 ).
+setOwnerOnlyVisible.description = Sets the Visible to Owners Only flag on a Token if the value passed in is non-zero( true ( 1 )), otherwise resets it to false ( 0 ).
setOwnerOnlyVisible.summary = \
\
\
@@ -23020,11 +23020,11 @@ setOwnerOnlyVisible.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b74\
- Sets the Visible to Owners Only flag on a Token if the value passed in is non-zero(true(1)), otherwise resets it to false(0).\
+ Sets the Visible to Owners Only flag on a Token if the value passed in is non-zero(true(1)), otherwise resets it to false(0).\
\
Usage\
\
@@ -23039,7 +23039,7 @@ setOwnerOnlyVisible.summary = \
\
\
visible - The state of owner only visibility, true(1) or false(0).id - The token id of the token which has its owner only visibility set, defaults to the Current Token.id - The token id of the token which has its owner only visibility set, defaults to the Current Token.
\
\
\
@@ -23052,7 +23052,7 @@ setOwnerOnlyVisible.summary = \
\
-setPC.description = Sets a Token to a PC Token .
+setPC.description = Sets a Token to a PC Token .
setPC.summary = \
\
\
@@ -23062,11 +23062,11 @@ setPC.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
- \
+ \
\
Usage\
\
@@ -23079,7 +23079,7 @@ setPC(id, mapname)\
Parameter\
\
\
- id - The token id of the token which has its PC status set, defaults to the Current Token.id - The token id of the token which has its PC status set, defaults to the Current Token.mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -23114,7 +23114,7 @@ setPenColor.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -23163,7 +23163,7 @@ setPenWidth.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -23203,7 +23203,7 @@ Regardless of the set width, a line will only be visible if it has a visible col
\
-setProperty.description = Sets the value of a Token Property on the Current Token (unless trusted, in which case a Token ID can be supplied to indicate which token is to be affected).
+setProperty.description = Sets the value of a Token Property on the Current Token (unless trusted, in which case a Token ID can be supplied to indicate which token is to be affected).
setProperty.summary = \
\
\
@@ -23212,7 +23212,7 @@ setProperty.summary = \
setProperty() Function\
\
• Introduced in version 1.3b48\
- Sets the value of a Token Property on the Current Token (unless trusted, in which case a Token ID can be supplied to indicate which token is to be affected).\
+ Sets the value of a Token Property on the Current Token (unless trusted, in which case a Token ID can be supplied to indicate which token is to be affected).\
Note that if there is not already an existing property by the name listed in the macro, setProperty will create a new Token Property with that name. Any created Property will not be visible in the Properties tab of the Edit Token window but can still be used like normal. It's value can be retrieved with the getProperty command.\
\
Usage\
@@ -23228,13 +23228,13 @@ setProperty(property, value, id, mapname)\
\
property - A string containing the name of the property that has its value set.value - The value that the property is set to.id - The token id of the token which has its property set, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token which has its property set, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
Examples\
\
- Sets a property named Health to the value of 10 on the Current Token.\
+ Sets a property named Health to the value of 10 on the Current Token.\
[h: setProperty("Health", 10)]\
Sets a property named Fatigue to the value of 5 on the selected token.\
\
@@ -23264,7 +23264,7 @@ setProperty(property, value, id, mapname)\
\
-setPropertyType.description = Sets the Property Type of a Token .
+setPropertyType.description = Sets the Property Type of a Token .
setPropertyType.summary = \
\
\
@@ -23273,7 +23273,7 @@ setPropertyType.summary = \
setPropertyType() Function\
\
• Introduced in version 1.3b48\
- Sets the Property Type of a Token.\
+ Sets the Property Type of a Token.\
\
Usage\
\
@@ -23287,7 +23287,7 @@ setPropertyType(type, id, mapname)\
\
\
type - The property type to set on the token.id - The token id of the token which has its property type set, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token which has its property type set, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -23312,7 +23312,7 @@ setPropertyType(type, id, mapname)\
\
-setSightType.description = Sets the type of sight that the Current Token has.
+setSightType.description = Sets the type of sight that the Current Token has.
setSightType.summary = \
\
\
@@ -23321,7 +23321,7 @@ setSightType.summary = \
setSightType() Function\
\
• Introduced in version 1.3b48\
- Sets the type of sight that the Current Token has.\
+ Sets the type of sight that the Current Token has.\
\
Usage\
\
@@ -23335,7 +23335,7 @@ setSightType(type, id, mapname)\
\
\
type - The type of sight to set.id - The id of the token to set the sight. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The id of the token to set the sight. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -23353,7 +23353,7 @@ setSightType(type, id, mapname)\
\
-setSize.description = Sets the size of a Token with one of the defined sizes according to each Grid Type.
+setSize.description = Sets the size of a Token with one of the defined sizes according to each Grid Type.
setSize.summary = \
\
\
@@ -23363,11 +23363,11 @@ setSize.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
- Sets the size of a Token with one of the defined sizes according to each Grid Type. The sizes can be found on the Token Size page.\
+ Sets the size of a Token with one of the defined sizes according to each Grid Type. The sizes can be found on the Token Size page.\
\
Usage\
\
@@ -23380,8 +23380,8 @@ setSize(size, id, mapname)\
Parameters\
\
\
- size - The Token Size to set the token to.id - The token id of the token which will have its Token Size set. Defaults to the Current Token.size - The Token Size to set the token to.id - The token id of the token which will have its Token Size set. Defaults to the Current Token.mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -23412,7 +23412,7 @@ setSize(size, id, mapname)\
\
-setSpeech.description = Sets the Speech value from the Current Token .
+setSpeech.description = Sets the Speech value from the Current Token .
setSpeech.summary = \
\
\
@@ -23421,7 +23421,7 @@ setSpeech.summary = \
setSpeech() Function\
\
• Introduced in version 1.3b48\
- Sets the Speech value from the Current Token.\
+ Sets the Speech value from the Current Token.\
\
Usage\
\
@@ -23432,7 +23432,7 @@ setSpeech.summary = \
\
-setState.description = Sets the value of the State on Token .
+setState.description = Sets the value of the State on Token .
setState.summary = \
\
\
@@ -23441,7 +23441,7 @@ setState.summary = \
setState() Function\
\
• Introduced in version 1.3b40\
- Sets the value of the State on Token. If The value is false(0) then the State is unset if it is non-zero(true(1)) then it is set.\
+ Sets the value of the State on Token. If The value is false(0) then the State is unset if it is non-zero(true(1)) then it is set.\
\
Usage\
\
@@ -23456,21 +23456,21 @@ setState(state, value, id, mapname)\
\
state - The name of the state to set on the token.value - The value of the state to set, true(1) or false(0).id - The id of the token to have the State set. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The id of the token to have the State set. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
Examples\
\
- To set the "Dead" Token State on the Current Token\
+ To set the "Dead" Token State on the Current Token\
[h: setState("Dead", 1)]\
-To reset the "Dead" Token State on the Current Token\
+
To reset the "Dead" Token State on the Current Token\
\
[h: setState("Dead", 0)]\
\
See Also\
\
- State,\
+ \
\
@@ -23486,7 +23486,7 @@ setState(state, value, id, mapname)\
\
-setStrProp.description = Returns a String Property List with the key set to the value passed in.
+setStrProp.description = Returns a String Property List with the key set to the value passed in.
setStrProp.summary = \
\
\
@@ -23495,7 +23495,7 @@ setStrProp.summary = \
setStrProp() Function\
\
• Introduced in version 1.3b42\
- Returns a String Property List with the key set to the value passed in.\
+ Returns a String Property List with the key set to the value passed in.\
\
Usage\
\
@@ -23506,19 +23506,19 @@ setStrProp.summary = \
Parameters\
\
\
- propList - The String Property List affected by this function.key - The key in the specified String Property List that will have its value set.propList - The String Property List affected by this function.key - The key in the specified String Property List that will have its value set.value - The value that the specified key will be set to.
\
\
Examples\
\
- Add a new key to an existing String Property List:\
+ Add a new key to an existing String Property List:\
[h: weapon = "name=longsword; damage=1d8; maxdamage=8"]\
[h: weapon = setStrProp(weapon, "value", 10)]\
[r: weapon]
\
Returns "name=longsword ; damage=1d8 ; maxdamage=8 ; value=10 ; "\
-
Change the value of a key in an existing String Property List:\
+
Change the value of a key in an existing String Property List:\
\
[h: weapon = "name=longsword; damage=1d8; maxdamage=8"]\
[h: weapon = setStrProp(weapon, "damage", "1d6")]\
@@ -23544,7 +23544,7 @@ setTableAccess.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.0.1\
@@ -23592,7 +23592,7 @@ setTableEntry.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.0.1\
@@ -23620,7 +23620,7 @@ setTableEntry(tableName, roll, result, imageId)\
See Also\
\
\
\
\
@@ -23636,7 +23636,7 @@ setTableImage.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.0.1\
@@ -23678,7 +23678,7 @@ setTablePickOnce.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.6.0\
@@ -23720,7 +23720,7 @@ setTableRoll.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.0.1\
@@ -23767,7 +23767,7 @@ setTableVisible.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.0.1\
@@ -23815,7 +23815,7 @@ setTerrainModifier.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.2\
@@ -23902,7 +23902,7 @@ setTokenDrawOrder(z, id, mapname)\
\
\
z - The Z coordinate to set the draw order to.id - The id of the token to move, defaults to the Current Token.id - The id of the token to move, defaults to the Current Token.mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -23936,7 +23936,7 @@ setTokenFacing.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b51\
@@ -23987,7 +23987,7 @@ setTokenGMName.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b40\
@@ -24008,7 +24008,7 @@ setTokenGMName.summary = \
\
-setTokenHandout.description = Sets the handout image for the for the Current Token .
+setTokenHandout.description = Sets the handout image for the for the Current Token .
setTokenHandout.summary = \
\
\
@@ -24017,7 +24017,7 @@ setTokenHandout.summary = \
setTokenHandout() Function\
\
• Introduced in version 1.3b77\
- Sets the handout image for the for the Current Token. The image can come from several sources. It can be an asset id (like from tblImage() orgetTokenImage().) or a Image Token.\
+ Sets the handout image for the for the Current Token. The image can come from several sources. It can be an asset id (like from tblImage() orgetTokenImage().) or a Image Token.\
\
Usage\
\
@@ -24035,7 +24035,7 @@ setTokenHandout(tokenImageName, id, mapname)\
Parameters\
\
\
- id - OPTIONAL: The token id of the token for which you want to set the handout, defaults to the Current Token.id - OPTIONAL: The token id of the token for which you want to set the handout, defaults to the Current Token.mapname - OPTIONAL: The name of the map to find the token. Defaults to the current map.
\
\
@@ -24075,7 +24075,7 @@ setTokenHeight(size, id, mapname)\
\
\
size - grid size of the tokenid - The token id of the token to set its height. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to set its height. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -24103,7 +24103,7 @@ setTokenHeight(size, id, mapname)\
\
-setTokenImage.description = Sets the image for the for the Current Token .
+setTokenImage.description = Sets the image for the for the Current Token .
setTokenImage.summary = \
\
\
@@ -24112,7 +24112,7 @@ setTokenImage.summary = \
setTokenImage() Function\
\
• Introduced in version 1.3b48\
- Sets the image for the for the Current Token. The function accepts an Asset ID or an Image Token name. You can get Asset IDs from macro functions such as tblImage() or getTokenImage(). Image Tokens are special tokens whose name starts with "image:".\
+ Sets the image for the for the Current Token. The function accepts an Asset ID or an Image Token name. You can get Asset IDs from macro functions such as tblImage() or getTokenImage(). Image Tokens are special tokens whose name starts with "image:".\
\
Usage\
\
@@ -24132,7 +24132,7 @@ setTokenImage(imageToken, id, mapname)\
\
assetId - The Asset ID for an image.imageToken - The name of an image token e.g. "image:myimage"id - OPTIONAL: The token id of the token for which you want to set the image, defaults to the Current Token.id - OPTIONAL: The token id of the token for which you want to set the image, defaults to the Current Token.mapname - OPTIONAL: The name of the map to find the token. Defaults to the current map.
\
\
@@ -24215,7 +24215,7 @@ setLayoutProps(scale, xOffset, yOffset, id, mapName)\
scale - The scale of the token layout. If an empty string, the scale is not changed.xOffset - The xOffset of the token layout. If an empty string, the xOffset is not changed. Negative values shift the image left.yOffset - The yOffset of the token layout. If an empty string, the yOffset is not changed. Negative values shift the image up.id - The token id of the token to name, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to name, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.The xOffset and yOffset values must be integers.\
@@ -24261,7 +24261,7 @@ setTokenOpacity(value, id, mapname)\
\
\
value - The value of the opacity to set, ranging from 0.0 (completely transparent) to 1.0 (completely opaque). This must be a floating point value with leading zero if less than 1.0.id - OPTIONAL: The token id of the token for which you want to retrieve the opacity, defaults to the Current Token.id - OPTIONAL: The token id of the token for which you want to retrieve the opacity, defaults to the Current Token.mapname - OPTIONAL: The name of the map to find the token. Defaults to the current map.
\
Returns\
@@ -24291,7 +24291,7 @@ The opacity value that was set.\
\
-setTokenPortrait.description = Sets the portrait image for the for the Current Token .
+setTokenPortrait.description = Sets the portrait image for the for the Current Token .
setTokenPortrait.summary = \
\
\
@@ -24300,7 +24300,7 @@ setTokenPortrait.summary = \
setTokenPortrait() Function\
\
• Introduced in version 1.3b77\
- Sets the portrait image for the for the Current Token. The image can come from several sources. It can be an asset id (like from tblImage() or getTokenImage()), or a Image Token.\
+ Sets the portrait image for the for the Current Token. The image can come from several sources. It can be an asset id (like from tblImage() or getTokenImage()), or a Image Token.\
\
Usage\
\
@@ -24318,7 +24318,7 @@ setTokenPortrait(tokenImageName, id, mapname)\
Parameters\
\
\
- id - OPTIONAL: The token id of the token for which you want to set the portrait, defaults to the Current Token.id - OPTIONAL: The token id of the token for which you want to set the portrait, defaults to the Current Token.mapname - OPTIONAL: The name of the map to find the token. Defaults to the current map.
\
\
@@ -24359,7 +24359,7 @@ setTokenShape(shape, id, mapname)\
\
\
shape - String value: "TOP_DOWN", "CIRCLE", "SQUARE", "FIGURE".id - The token id of the token to set to a new shape, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to set to a new shape, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
Result
\
@@ -24401,7 +24401,7 @@ The function returns the token's shape as a string value: "TOP_DOWN"\
-setTokenSnapToGrid.description = Sets the "snap to" behaviour for the Current Token or a specified token.
+setTokenSnapToGrid.description = Sets the "snap to" behaviour for the Current Token or a specified token.
setTokenSnapToGrid.summary = \
\
\
@@ -24410,7 +24410,7 @@ setTokenSnapToGrid.summary = \
setTokenSnapToGrid() Function\
\
• Introduced in version 1.4\
- Sets the "snap to" behaviour for the Current Token or a specified token.\
+ Sets the "snap to" behaviour for the Current Token or a specified token.\
\
Usage\
\
@@ -24464,7 +24464,7 @@ setTokenVBL.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.1.6\
@@ -24486,7 +24486,7 @@ setTokenVBL.summary = \
\
\
vbl - A JSON object containing the vbl to be added to the token. Use getTokenVBL() to get VBL from another token.id - OPTIONAL: The token id of the token for which you want to set this setting, defaults to the Current Token.id - OPTIONAL: The token id of the token for which you want to set this setting, defaults to the Current Token.
\
\
Example\
@@ -24498,14 +24498,14 @@ setTokenVBL.summary = \
\
[r: finalVblData = "{'shape':'none'}"]\
[r: setTokenVBL(finalVblData)]
\
-
Auto-generate VBL for the Current Token\
+
Auto-generate VBL for the Current Token\
\
[h: options = json.set("{}", "shape", "auto", "sensitivity", 10, "inverse", 0, "level", 2, "method", "DOUGLAS_PEUCKER_SIMPLIFIER", "r", 0, "g", 0, "b", 0, "a", 255)]\
[h: setTokenVBL(options)]
\
\
See Also\
\
- \
+ \
\
Version Changes\
\
@@ -24542,7 +24542,7 @@ setTokenWidth(size, id, mapname)\
\
\
size - grid size of the tokenid - The token id of the token to set its width. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to set its width. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -24613,7 +24613,7 @@ setViewArea.summary = \
\
-setVisible.description = Sets the Visible to Players flag on a Token if the value passed in is non-zero( true ( 1 )), otherwise resets it to false ( 0 ).
+setVisible.description = Sets the Visible to Players flag on a Token if the value passed in is non-zero( true ( 1 )), otherwise resets it to false ( 0 ).
setVisible.summary = \
\
\
@@ -24623,11 +24623,11 @@ setVisible.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b40\
- Sets the Visible to Players flag on a Token if the value passed in is non-zero(true(1)), otherwise resets it to false(0). The Visible to Players flag has two meanings, on a normal Token players will only be able to see the Token if it is set (when all other things like Fog of War etc are taken into account). If it is a Library Token then it determines if players can call Category:Macros using the [macro(...): ...] roll option.\
+ Sets the Visible to Players flag on a Token if the value passed in is non-zero(true(1)), otherwise resets it to false(0). The Visible to Players flag has two meanings, on a normal Token players will only be able to see the Token if it is set (when all other things like Fog of War etc are taken into account). If it is a Library Token then it determines if players can call Category:Macros using the [macro(...): ...] roll option.\
\
Usage\
\
@@ -24642,7 +24642,7 @@ setVisible.summary = \
\
\
visible - The state of visibility, true(1) or false(0).id - The token id of the token which has its player visibility set, defaults to the Current Token.id - The token id of the token which has its player visibility set, defaults to the Current Token.
\
\
\
@@ -24723,7 +24723,7 @@ showTextLabels.summary = \
\
• Introduced in version 1.6\
• Last checked for compatibility with version 1.6\
- Enables the display of Text Labels if they are not showing. This can also be set in the View menu.\
+ Enables the display of Text Labels if they are not showing. This can also be set in the View menu.\
\
Usage\
\
@@ -24754,7 +24754,7 @@ showTextLabels.summary = \
\
-sortInitiative.description = Sorts the Initiative Panel Tokens and returns the number of Tokens in the Initiative Panel .
+sortInitiative.description = Sorts the Initiative Panel Tokens and returns the number of Tokens in the Initiative Panel .
sortInitiative.summary = \
\
\
@@ -24764,11 +24764,11 @@ sortInitiative.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b41\
- Sorts the Initiative Panel Tokens and returns the number of Tokens in the Initiative Panel.\
+ Sorts the Initiative Panel Tokens and returns the number of Tokens in the Initiative Panel.\
- The Default sort order is descending, with any non-numeric values coming after any numbers, and any blank values coming last.
- Since 1.8: If the
reverseOrder parameter is 1, this order is reversed - blank values come first, and any non-numeric strings (in ascending lexical order) come before numbers (in ascending order).
\
\
Usage\
@@ -24792,7 +24792,7 @@ sortInitiative(reverseOrder)\
Reverse Order\
Command\
sortInitiative()
sortInitiative(0)sortInitiative(1)Result\
- 
\
+\
\
\
@@ -24986,7 +24986,7 @@ sr4.summary = \
\
See Also\
\
- For another method of rolling dice, see Dice Expressions.\
+ For another method of rolling dice, see Dice Expressions.\
\
\
@@ -25022,7 +25022,7 @@ sr4e.summary = \
\
See Also\
\
- For another method of rolling dice, see Dice Expressions.\
+ For another method of rolling dice, see Dice Expressions.\
\
\
@@ -25208,10 +25208,10 @@ strfind.summary = \
strfind() Function\
\
• Introduced in version 1.3b48\
- Finds and extracts substrings from a string. strfind() is used to match a pattern against an input string and extract all of the capture groups. The function returns an id which can be used with other functions to extract the information. The supplied pattern is a regular expression.\
+ Finds and extracts substrings from a string. strfind() is used to match a pattern against an input string and extract all of the capture groups. The function returns an id which can be used with other functions to extract the information. The supplied pattern is a regular expression.\
Functions related to strfind():\
\
-- getFindCount(id)
- getGroupCount(id)
- getGroup(id, matchNo, groupNo)
- getGroupStart(id, matchNo, groupNo)
- getGroupEnd(id, matchNo, groupNo)
\
+- getFindCount(id)
- getGroupCount(id)
- getGroup(id, matchNo, groupNo)
- getGroupStart(id, matchNo, groupNo)
- getGroupEnd(id, matchNo, groupNo)
\
Both matchNo and groupNo start at 1, the special group number 0 returns the whole pattern match.\
\
Groups are the regex capture groups, designated by the parts in "(" parenthesis ")". Group 1 returns the string that matches the first regex statement in (), 2 returns the second, etc.\
@@ -25447,7 +25447,7 @@ string.summary = \
\
-stringToList.description = Converts a string into a string list using a pattern to determine separator between elements.
+stringToList.description = Converts a string into a string list using a pattern to determine separator between elements.
stringToList.summary = \
\
\
@@ -25456,7 +25456,7 @@ stringToList.summary = \
stringToList() Function\
\
• Introduced in version 1.3b48\
- Converts a string into a string list using a pattern to determine separator between elements. The specified delimiter is used to separate the elements in the Macros:string list if it is specified, otherwise the default value of "," is used. Pattern can be a regular expression.\
+ Converts a string into a string list using a pattern to determine separator between elements. The specified delimiter is used to separate the elements in the Macros:string list if it is specified, otherwise the default value of "," is used. Pattern can be a regular expression.\
\
Usage\
\
@@ -25656,7 +25656,7 @@ Returns a number than is between 0 and 12, which is th
\
See Also\
\
- For another method of rolling dice, see Dice Expressions.\
+ For another method of rolling dice, see Dice Expressions.\
\
\
@@ -25697,7 +25697,7 @@ Returns:"14"
\
-switchToken.description = Changes the Current Token for the remainder of the Macro.
+switchToken.description = Changes the Current Token for the remainder of the Macro.
switchToken.summary = \
\
\
@@ -25707,12 +25707,12 @@ switchToken.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
- Changes the Current Token for the remainder of the Macro.\
-In practice, "the remainder of the Macro" is the same as the variable scope. Thus, if a macro is running as a user defined function (see defineFunction() ) with a new scope, switchToken will only apply until the end of the current macro. Once control passes back to the calling macro, the Current Token reverts back to what it was before the external macro was called ( as a function ).\
+
Changes the Current Token for the remainder of the Macro.\
+In practice, "the remainder of the Macro" is the same as the variable scope. Thus, if a macro is running as a user defined function (see defineFunction() ) with a new scope, switchToken will only apply until the end of the current macro. Once control passes back to the calling macro, the Current Token reverts back to what it was before the external macro was called ( as a function ).\
If a defineFunction() does not create a new variable scope for the called macro, then effects of switchToken persist when control passes back to the calling macro.
\
Note: You cannot switch to a token on a different map.\
\
@@ -25749,8 +25749,8 @@ tbl(name, row)\
Parameters\
\
\
- name - A string containing the name of the table.row - The row of the table that should be returned.name - A string containing the name of the table.row - The row of the table that should be returned.
\
\
Examples\
@@ -25776,12 +25776,12 @@ tbl(name, row)\
\
See Also\
\
- tableImage()
There is a tool available to import tables from excel. You can find more about this here\
+ tableImage()
There is a tool available to import tables from excel. You can find more about this here\
\
\
-tableImage.description = Gets the image asset value from the specified table .
+tableImage.description = Gets the image asset value from the specified table .
tableImage.summary = \
\
\
@@ -25790,7 +25790,7 @@ tableImage.summary = \
tableImage() Function\
\
• Introduced in version 1.3b40\
- Gets the image asset value from the specified table. If the row is not specified then the default roll for the table is used.\
+ Gets the image asset value from the specified table. If the row is not specified then the default roll for the table is used.\
\
Usage\
\
@@ -25806,16 +25806,16 @@ tblImage(name, row, size)\
Parameters\
\
\
- name - A string containing the name of the table.row - The row of the table that should have the image asset returned.name - A string containing the name of the table.row - The row of the table that should have the image asset returned.size - The size the image asset returned should be. If the image is not square, this will be the size of the height.
\
\
Examples\
\
- Example 1: Display a random image from table "tbl1" using default roll:\
+ Example 1: Display a random image from table "tbl1" using default roll:\
<image src='[r: tableImage("tbl1")]'></image>\
-Example 1: Display the first image from table "tbl1":\
+
Example 1: Display the first image from table "tbl1":\
\
<image src='[r: tableImage("tbl1", 1)]'></image>\
Example 2: Display one of the first four images, resized to 40 pixels tall, from "tbl1", chosed randomly:\
@@ -25856,8 +25856,8 @@ tbl(name, row)\
Parameters\
\
\
- name - A string containing the name of the table.row - The row of the table that should be returned.name - A string containing the name of the table.row - The row of the table that should be returned.
\
\
Examples\
@@ -25883,12 +25883,12 @@ tbl(name, row)\
\
See Also\
\
- tableImage()
There is a tool available to import tables from excel. You can find more about this here\
+ tableImage()
There is a tool available to import tables from excel. You can find more about this here\
\
\
-tblImage.description = Gets the image asset value from the specified table .
+tblImage.description = Gets the image asset value from the specified table .
tblImage.summary = \
\
\
@@ -25897,7 +25897,7 @@ tblImage.summary = \
tableImage() Function\
\
• Introduced in version 1.3b40\
- Gets the image asset value from the specified table. If the row is not specified then the default roll for the table is used.\
+ Gets the image asset value from the specified table. If the row is not specified then the default roll for the table is used.\
\
Usage\
\
@@ -25913,16 +25913,16 @@ tblImage(name, row, size)\
Parameters\
\
\
- name - A string containing the name of the table.row - The row of the table that should have the image asset returned.name - A string containing the name of the table.row - The row of the table that should have the image asset returned.size - The size the image asset returned should be. If the image is not square, this will be the size of the height.
\
\
Examples\
\
- Example 1: Display a random image from table "tbl1" using default roll:\
+ Example 1: Display a random image from table "tbl1" using default roll:\
<image src='[r: tableImage("tbl1")]'></image>\
-Example 1: Display the first image from table "tbl1":\
+
Example 1: Display the first image from table "tbl1":\
\
<image src='[r: tableImage("tbl1", 1)]'></image>\
Example 2: Display one of the first four images, resized to 40 pixels tall, from "tbl1", chosed randomly:\
@@ -25949,7 +25949,7 @@ toggleFoW.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.1.3\
@@ -25980,7 +25980,7 @@ toggleFoW.summary = \
\
See Also\
\
- \
+ \
\
\
@@ -25995,7 +25995,7 @@ transferVBL.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.2.0\
@@ -26018,7 +26018,7 @@ transferVBL(value, delete, id)\
value - The value of the setting to set:\
0 transfer normal (blue) VBL to token (yellow) VBL1 transfer token (yellow) VBL to normal (blue) VBL
delete - Defines if the transferred VBL is deleted from the source.id - OPTIONAL: The token id of the token for which you want to set this setting, defaults to the Current Token.id - OPTIONAL: The token id of the token for which you want to set this setting, defaults to the Current Token.\
Examples\
@@ -26053,7 +26053,7 @@ transferVBL(value, delete, id)\
\
See Also\
\
- \
+ \
\
Version Changes\
\
@@ -26146,7 +26146,7 @@ Returns a number than is between 0 and 5.
\
\
See Also\
\
- For another method of rolling dice, see Dice Expressions.\
+ For another method of rolling dice, see Dice Expressions.\
\
\
@@ -26189,7 +26189,7 @@ Returns a number than is between 0 and 5.\
\
See Also\
\
- For another method of rolling dice, see Dice Expressions.\
+ For another method of rolling dice, see Dice Expressions.\
\
\
@@ -26225,7 +26225,7 @@ This Is a Test\
\
-varsFromStrProp.description = Creates variables from a string property list with the values assigned to variables with the names of the keys in the string property list .
+varsFromStrProp.description = Creates variables from a string property list with the values assigned to variables with the names of the keys in the string property list .
varsFromStrProp.summary = \
\
\
@@ -26234,7 +26234,7 @@ varsFromStrProp.summary = \
varsFromStrProp() Function\
\
• Introduced in version 1.3b42\
- Creates variables from a string property list with the values assigned to variables with the names of the keys in the string property list. The function returns the number of variables that were created.\
+ Creates variables from a string property list with the values assigned to variables with the names of the keys in the string property list. The function returns the number of variables that were created.\
\
Usage\
\
player - The player for which you want to retrieve the owned tokens, defaults to the current player.delim - the delimiter used to separate the values in the string list which defaults to "," if not specified.delim - the delimiter used to separate the values in the string list which defaults to "," if not specified.mapname - The name of the map to find the tokens. Defaults to the current map.To display the ids of all of the tokens on the current map by the Player use.\
\
[h: ids = getOwned(getPlayerName())]\
[foreach(id, ids, "<br>"): id]\ @@ -8663,7 +8663,7 @@ getOwned(player, delim, mapname)\
\
@@ -8673,12 +8673,12 @@ getOwnedNames.summary = \
\
\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b48
\
- Returns a list containing the names of the tokens on the current map that are owned by the specified player. The type of the value returned depends on the delimiter parameter.\
-\
Usage\
@@ -8693,13 +8693,13 @@ getOwnedNames(player, delim, mapname)\
\
- If the delimiter is not specified then a string list is returned with the default value of
","is used. - If the delimiter
jsonthen a json array is returned. - Otherwise a string list is returned with the delimiter passed in.
Returns a list containing the names of the tokens on the current map that are owned by the specified player. The type of the value returned depends on the delimiter parameter.\
+
\
- If the delimiter is not specified then a string list is returned with the default value of
","is used. - If the delimiter
jsonthen a json array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
Usage\
@@ -8693,13 +8693,13 @@ getOwnedNames(player, delim, mapname)\
\
\
player - The player for which you want to retrieve the owned tokens, defaults to the current player.delim - the delimiter used to separate the values in the string list which defaults to "," if not specified.delim - the delimiter used to separate the values in the string list which defaults to "," if not specified.mapname - The name of the map to find the tokens. Defaults to the current map.
\
\
Examples\
\
- To display the ids of all of the tokens on the current map by the Player use.\
+ To display the ids of all of the tokens on the current map by the Player use.\
[h: names = getOwnedNames(getPlayerName())]\
[foreach(name, names, "<br>"): name]
\
\
@@ -8721,7 +8721,7 @@ getOwnedNames(player, delim, mapname)\
\
-getOwnerOnlyVisible.description = Returns true ( 1 ) if the Visible to Owners Only flag is set on a Token otherwise returns false ( 0 ).
+getOwnerOnlyVisible.description = Returns true ( 1 ) if the Visible to Owners Only flag is set on a Token otherwise returns false ( 0 ).
getOwnerOnlyVisible.summary = \
\
\
@@ -8730,7 +8730,7 @@ getOwnerOnlyVisible.summary = \
getOwnerOnlyVisible() Function\
\
• Introduced in version 1.3b74\
- \
+ \
\
Usage\
\
@@ -8744,7 +8744,7 @@ getOwnerOnlyVisible.summary = \
Parameter\
\
\
- id - The token id of token that has its player visibility checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of token that has its player visibility checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
\
\
\
@@ -8757,7 +8757,7 @@ getOwnerOnlyVisible.summary = \
\
-getOwners.description = Returns a String List or JSON Array containing the names of the owners of a Token .
+getOwners.description = Returns a String List or JSON Array containing the names of the owners of a Token .
getOwners.summary = \
\
\
@@ -8766,7 +8766,7 @@ getOwners.summary = \
getOwners() Function\
\
• Introduced in version 1.3b48\
- Returns a String List or JSON Array containing the names of the owners of a Token. The type of the value returned depends on the delimiter parameter.\
+ Returns a String List or JSON Array containing the names of the owners of a Token. The type of the value returned depends on the delimiter parameter.\
\
Usage\
\
@@ -8780,14 +8780,14 @@ getOwners(delim, id, mapname)\
Parameters\
\
\
- delim - The delimiter used to separate the values in the String List, defaults to ",". If set to "json", this function will return a JSON Array instead of a String List.id - The token id of the token which has its owners returned, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
delim - The delimiter used to separate the values in the String List, defaults to ",". If set to "json", this function will return a JSON Array instead of a String List.id - The token id of the token which has its owners returned, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
Example\
\
- To display the owners of the Current Token use.\
+ To display the owners of the Current Token use.\
[h: names = getOwners()]\
[foreach(name, names, "<br>"): name]
\
\
@@ -8809,7 +8809,7 @@ getOwners(delim, id, mapname)\
\
-getPC.description = Returns a list containing the ids of the PC tokens on the current map .
+getPC.description = Returns a list containing the ids of the PC tokens on the current map .
getPC.summary = \
\
\
@@ -8819,12 +8819,12 @@ getPC.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
- Returns a list containing the ids of the PC tokens on the current map. The type of the value returned depends on the delimiter parameter.\
-- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
+ Returns a list containing the ids of the PC tokens on the current map. The type of the value returned depends on the delimiter parameter.\
+- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
\
\
Usage\
@@ -8833,19 +8833,19 @@ getPC.summary = \
getPC()\
getPC(delim)
\
\
- delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
+
delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
\
\
Example\
\
- To display the ids of all of the PC tokens on the current map use.\
+ To display the ids of all of the PC tokens on the current map use.\
[h: ids = getPC()]\
[foreach(id, ids, "<br>"): id]
\
\
See Also\
\
\
- [foreach():]\
+ [foreach():]\
\
\
Version Changes\
@@ -8859,7 +8859,7 @@ getPC(delim)\
\
-getPCNames.description = Returns a list containing the names of the PC tokens on the current map .
+getPCNames.description = Returns a list containing the names of the PC tokens on the current map .
getPCNames.summary = \
\
\
@@ -8869,12 +8869,12 @@ getPCNames.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
- Returns a list containing the names of the PC tokens on the current map. The type of the value returned depends on the delimiter parameter.\
-- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
+ Returns a list containing the names of the PC tokens on the current map. The type of the value returned depends on the delimiter parameter.\
+- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
\
\
Usage\
@@ -8883,19 +8883,19 @@ getPCNames.summary = \
getPCNames()\
getPCNames(delim)
\
\
- delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
+
delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
\
\
Example\
\
- To display the names of all of the PC tokens on the current map use.\
+ To display the names of all of the PC tokens on the current map use.\
[h: names = getPCNames()]\
[foreach(name, names, "<br>"): name]
\
\
See Also\
\
\
- [foreach():]\
+ [foreach():]\
\
\
Version Changes\
@@ -8909,7 +8909,7 @@ getPCNames(delim)\
\
-getPCs.description = Returns a list containing the ids of the PC tokens on the current map .
+getPCs.description = Returns a list containing the ids of the PC tokens on the current map .
getPCs.summary = \
\
\
@@ -8919,12 +8919,12 @@ getPCs.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
- Returns a list containing the ids of the PC tokens on the current map. The type of the value returned depends on the delimiter parameter.\
-- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
+ Returns a list containing the ids of the PC tokens on the current map. The type of the value returned depends on the delimiter parameter.\
+- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
\
\
Usage\
@@ -8933,19 +8933,19 @@ getPCs.summary = \
getPC()\
getPC(delim)
\
\
- delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
+
delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
\
\
Example\
\
- To display the ids of all of the PC tokens on the current map use.\
+ To display the ids of all of the PC tokens on the current map use.\
[h: ids = getPC()]\
[foreach(id, ids, "<br>"): id]
\
\
See Also\
\
\
- [foreach():]\
+ [foreach():]\
\
\
Version Changes\
@@ -8969,7 +8969,7 @@ getPenColor.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -9016,7 +9016,7 @@ getPenWidth.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -9054,7 +9054,7 @@ A drawing will have a line width, even if the line itself is not displayed. See
\
-getPlayerName.description = Returns the name of the player for the Client that it executes on.
+getPlayerName.description = Returns the name of the player for the Client that it executes on.
getPlayerName.summary = \
\
\
@@ -9063,7 +9063,7 @@ getPlayerName.summary = \
getPlayerName() Function\
\
• Introduced in version 1.3b48\
- Returns the name of the player for the Client that it executes on.\
+ Returns the name of the player for the Client that it executes on.\
\
Usage\
\
@@ -9082,7 +9082,7 @@ getPlayerName.summary = \
\
-getProperty.description = Returns the value of a Token Property on a Token .
+getProperty.description = Returns the value of a Token Property on a Token .
getProperty.summary = \
\
\
@@ -9091,8 +9091,8 @@ getProperty.summary = \
getProperty() Function\
\
• Introduced in version 1.3b48\
- Returns the value of a Token Property on a Token.\
-If the Token Property is empty (NULL) or not defined, an empty string ("") is returned.\
+ Returns the value of a Token Property on a Token.\
+If the Token Property is empty (NULL) or not defined, an empty string ("") is returned.\
\
Usage\
\
@@ -9106,7 +9106,7 @@ getProperty(property, id, mapname)\
\
\
property - The property that has its value returned. For referencing the literal name of the property (for instance, if you wish to get the property Constitution configured in Campaign Properties), enclose the property name in quotes. If using a variable whose value is the name of the property, do not enclose the variable name in quotes.id - The token id or name of the token that has its property value returned, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id or name of the token that has its property value returned, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -9145,7 +9145,7 @@ The value of property 'Constitution' is 12.
\
\
-getPropertyDefault.description = Returns the default value of a token property for the Current Token .
+getPropertyDefault.description = Returns the default value of a token property for the Current Token .
getPropertyDefault.summary = \
\
\
@@ -9154,7 +9154,7 @@ getPropertyDefault.summary = \
getPropertyDefault() Function\
\
• Introduced in version 1.3b48\
- Returns the default value of a token property for the Current Token. If the default value contains nothing then an empty string ("") is returned.\
+ Returns the default value of a token property for the Current Token. If the default value contains nothing then an empty string ("") is returned.\
\
Usage\
\
@@ -9167,13 +9167,13 @@ getPropertyDefault(name, propType)\
\
\
name - The name of the property to get the default value of.propType - The token type to get the property from. Defaults to the token type of the Current Token.propType - The token type to get the property from. Defaults to the token type of the Current Token.
\
\
\
-getPropertyNames.description = Returns a String List or JSON Array containing the names of the Token Properties for the Current Token .
+getPropertyNames.description = Returns a String List or JSON Array containing the names of the Token Properties for the Current Token .
getPropertyNames.summary = \
\
\
@@ -9182,7 +9182,7 @@ getPropertyNames.summary = \
getPropertyNames() Function\
\
• Introduced in version 1.3b48\
- Returns a String List or JSON Array containing the names of the Token Properties for the Current Token. The type of the value returned depends on the delimiter parameter. All names returned will be in lower case. Use getPropertyNamesRaw() to get the names as they are shown in Campaign Properties.\
+ Returns a String List or JSON Array containing the names of the Token Properties for the Current Token. The type of the value returned depends on the delimiter parameter. All names returned will be in lower case. Use getPropertyNamesRaw() to get the names as they are shown in Campaign Properties.\
\
When a token is added to a campaign it inherits the currently defined properties of the current campaign. These properties are persistent in the token even if the properties are subsequently removed from the campaign. Properties that have been removed from the campaign are no longer editable via the Edit Token dialog but they are still present on the token and may be read and set with getProperty() and setProperty() respectively. To get all properties defined on a token, including those removed from the campaign, use getPropertyNames(). To see only the currently defined properties for the campaign, use getAllPropertyNames().\
\
@@ -9198,14 +9198,14 @@ getPropertyNames(delim, id, mapname)\
Parameters\
\
\
- delim - The delimiter used to separate the values in the String List, defaults to ",". Returns a JSON Array if set to "json".id - The token id of the token which has its property names returned, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
delim - The delimiter used to separate the values in the String List, defaults to ",". Returns a JSON Array if set to "json".id - The token id of the token which has its property names returned, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
Example\
\
- To display the names of all of the properties on the current token use.\
+ To display the names of all of the properties on the current token use.\
[h: names = getPropertyNames()]\
[foreach(name, names, "<br>"): name]
\
\
@@ -9225,7 +9225,7 @@ getPropertyNames(delim, id, mapname)\
\
-getPropertyNamesRaw.description = Returns a String List or JSON Array containing the names of the Token Properties on a Token .
+getPropertyNamesRaw.description = Returns a String List or JSON Array containing the names of the Token Properties on a Token .
getPropertyNamesRaw.summary = \
\
\
@@ -9234,8 +9234,8 @@ getPropertyNamesRaw.summary = \
getPropertyNamesRaw() Function\
\
• Introduced in version 1.3b64\
- Returns a String List or JSON Array containing the names of the Token Properties on a Token. The type of the value returned depends on the delimiter parameter.\
-The difference between this function and getPropertyNames() is that getPropertyNames() returns all the property names in lower case (see this forum thread to get the reason why it was created).\
+ Returns a String List or JSON Array containing the names of the Token Properties on a Token. The type of the value returned depends on the delimiter parameter.\
+The difference between this function and getPropertyNames() is that getPropertyNames() returns all the property names in lower case (see this forum thread to get the reason why it was created).\
\
Usage\
\
@@ -9249,14 +9249,14 @@ getPropertyNamesRaw(delim, id, mapname)\
Parameters\
\
\
- delim - The delimiter used to separate the values in the String List, defaults to ",". Returns a JSON Array if set to "json".id - The token id of the token which has its property names returned, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
delim - The delimiter used to separate the values in the String List, defaults to ",". Returns a JSON Array if set to "json".id - The token id of the token which has its property names returned, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
Example\
\
- To display the names of all of the properties on the current token use.\
+ To display the names of all of the properties on the current token use.\
[h: names = getPropertyNamesRaw()]\
[foreach(name, names, "<br>"): name]
\
\
@@ -9279,7 +9279,7 @@ getPropertyNamesRaw(delim, id, mapname)\
\
-getPropertyType.description = Returns the Property Type of a Token .
+getPropertyType.description = Returns the Property Type of a Token .
getPropertyType.summary = \
\
\
@@ -9288,7 +9288,7 @@ getPropertyType.summary = \
getPropertyType() Function\
\
• Introduced in version 1.3b48\
- Returns the Property Type of a Token.\
+ Returns the Property Type of a Token.\
\
Usage\
\
@@ -9301,7 +9301,7 @@ getPropertyType(id, mapname)\
Parameter\
\
\
- id - The token id of the token which has its Property Type returned, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token which has its Property Type returned, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -9326,7 +9326,7 @@ getPropertyType(id, mapname)\
\
-getRawProperty.description = Gets the unevaluated value of a token property , returns "" if the property is empty.
+getRawProperty.description = Gets the unevaluated value of a token property , returns "" if the property is empty.
getRawProperty.summary = \
\
\
@@ -9335,7 +9335,7 @@ getRawProperty.summary = \
getRawProperty() Function\
\
• Introduced in version 1.3b51\
- Gets the unevaluated value of a token property, returns "" if the property is empty. This will not return the property's default value.\
+ Gets the unevaluated value of a token property, returns "" if the property is empty. This will not return the property's default value.\
\
Usage\
\
@@ -9394,13 +9394,13 @@ getRecursionDepth.summary = \
\
See Also\
\
- \
+ \
\
\
-getRolled.description = Returns a JSON Array of all the raw, i.e. unmodified, dice rolls that have occurred within the current macro context.
+getRolled.description = Returns a JSON Array of all the raw, i.e. unmodified, dice rolls that have occurred within the current macro context.
getRolled.summary = \
\
\
@@ -9409,7 +9409,7 @@ getRolled.summary = \
getRolled() Function\
\
• Introduced in version 1.5.2\
- Returns a JSON Array of all the raw, i.e. unmodified, dice rolls that have occurred within the current macro context.\
+ Returns a JSON Array of all the raw, i.e. unmodified, dice rolls that have occurred within the current macro context.\
\
Usage\
\
@@ -9446,7 +9446,7 @@ Get Rolled: [9,6,5,1]\
\
-getSelected.description = Returns a list containing the ids of the selected tokens on the current map .
+getSelected.description = Returns a list containing the ids of the selected tokens on the current map .
getSelected.summary = \
\
\
@@ -9455,8 +9455,8 @@ getSelected.summary = \
getSelected() Function\
\
• Introduced in version 1.3b48\
- Returns a list containing the ids of the selected tokens on the current map. The type of the value returned depends on the delimiter parameter.\
-- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
+ Returns a list containing the ids of the selected tokens on the current map. The type of the value returned depends on the delimiter parameter.\
+- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
\
\
Usage\
@@ -9465,12 +9465,12 @@ getSelected.summary = \
getSelected()\
getSelected(delim)
\
\
- delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
+
delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
\
\
Example\
\
- To display the ids of all of the selected tokens on the current map use.\
+ To display the ids of all of the selected tokens on the current map use.\
[h: ids = getSelected()]\
[foreach(id, ids, "<br>"): id]
\
\
@@ -9489,7 +9489,7 @@ getSelected(delim)\
\
-getSelectedNames.description = Returns a list containing the names of the selected tokens on the current map .
+getSelectedNames.description = Returns a list containing the names of the selected tokens on the current map .
getSelectedNames.summary = \
\
\
@@ -9498,8 +9498,8 @@ getSelectedNames.summary = \
getSelectedNames() Function\
\
• Introduced in version 1.3b48\
- Returns a list containing the names of the selected tokens on the current map. The type of the value returned depends on the delimiter parameter.\
-- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
+ Returns a list containing the names of the selected tokens on the current map. The type of the value returned depends on the delimiter parameter.\
+- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
\
\
Usage\
@@ -9508,12 +9508,12 @@ getSelectedNames.summary = \
getSelectedNames()\
getSelectedNames(delim)
\
\
- delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
+
delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
\
\
Example\
\
- To display the names of all of the selected tokens on the current map use.\
+ To display the names of all of the selected tokens on the current map use.\
[h: names = getSelectedNames()]\
[foreach(name, names, "<br>"): name]
\
\
@@ -9532,7 +9532,7 @@ getSelectedNames(delim)\
\
-getSightType.description = Returns the type of sight that the Current Token has.
+getSightType.description = Returns the type of sight that the Current Token has.
getSightType.summary = \
\
\
@@ -9541,7 +9541,7 @@ getSightType.summary = \
getSightType() Function\
\
• Introduced in version 1.3b48\
- Returns the type of sight that the Current Token has. When no sight type is set, returns an empty string.\
+ Returns the type of sight that the Current Token has. When no sight type is set, returns an empty string.\
\
Usage\
\
@@ -9554,7 +9554,7 @@ getSightType(mapname)\
Parameters\
\
\
- id - The id of the token to have the State set. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The id of the token to have the State set. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -9573,7 +9573,7 @@ getSightType(mapname)\
\
-getSize.description = Returns the Size of a Token .
+getSize.description = Returns the Size of a Token .
getSize.summary = \
\
\
@@ -9582,7 +9582,7 @@ getSize.summary = \
getSize() Function\
\
• Introduced in version 1.3b48\
- Returns the Size of a Token.\
+ Returns the Size of a Token.\
The sizes returned are:\
\
FineDiminutiveTinySmallMediumLargeHugeGargantuanColossal
\
@@ -9599,7 +9599,7 @@ getSize(id, mapname)\
Parameter\
\
\
- id - The token id of the token which has its Size returned, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token which has its Size returned, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -9648,7 +9648,7 @@ getSoundProperties(uri)\
Parameter\
\
\
- uri - The uri/url of the audio source to edit. If set to "*", a JSON Array containing the properties of all audio sources is returned. Defaults to "*".uri - The uri/url of the audio source to edit. If set to "*", a JSON Array containing the properties of all audio sources is returned. Defaults to "*".
\
Properties returned for streams: nicknames, uri, cycleCount, volume, startTime, stopTime, currentTime, totalTime, bufferTime, currentCount, status.\
\
@@ -9669,7 +9669,7 @@ getSoundProperties(uri)\
\
-getSpeech.description = Returns the Speech value from the Current Token .
+getSpeech.description = Returns the Speech value from the Current Token .
getSpeech.summary = \
\
\
@@ -9678,7 +9678,7 @@ getSpeech.summary = \
getSpeech() Function\
\
• Introduced in version 1.3b48\
- Returns the Speech value from the Current Token.\
+ Returns the Speech value from the Current Token.\
\
Usage\
\
@@ -9689,7 +9689,7 @@ getSpeech.summary = \
\
-getSpeechNames.description = Returns a list containing the speech names of the Current Token .
+getSpeechNames.description = Returns a list containing the speech names of the Current Token .
getSpeechNames.summary = \
\
\
@@ -9698,8 +9698,8 @@ getSpeechNames.summary = \
getSpeechNames() Function\
\
• Introduced in version 1.3b48\
- Returns a list containing the speech names of the Current Token. The type of the value returned depends on the delimiter parameter.\
-- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
+ Returns a list containing the speech names of the Current Token. The type of the value returned depends on the delimiter parameter.\
+- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
\
\
Usage\
@@ -9708,12 +9708,12 @@ getSpeechNames.summary = \
getSpeechNames()\
getSpeechNames(delim)
\
\
- delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
+
delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
\
\
Example\
\
- To display the names of all of the speech values for the Current Token use.\
+ To display the names of all of the speech values for the Current Token use.\
[h: names = getSpeech()]\
[foreach(name, names, "<br>"): name]
\
\
@@ -9731,7 +9731,7 @@ getSpeechNames(delim)\
\
-getState.description = Checks whether the specified State is active on a token, returning true ( 1 ) or false ( 0 ).
+getState.description = Checks whether the specified State is active on a token, returning true ( 1 ) or false ( 0 ).
getState.summary = \
\
\
@@ -9740,7 +9740,7 @@ getState.summary = \
getState() Function\
\
• Introduced in version 1.3b40\
- \
+ \
\
Usage\
\
@@ -9754,7 +9754,7 @@ getState(state, id, mapname)\
\
\
state - The name of the state to check for.id - The token id of the token to check for the state. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to check for the state. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -9768,7 +9768,7 @@ getState(state, id, mapname)\
\
See Also\
\
- \
+ \
\
Version Changes\
\
@@ -9782,7 +9782,7 @@ getState(state, id, mapname)\
\
-getStateImage.description = Gets the asset id for the image of a state, the state must be one of the image types for this to work.
+getStateImage.description = Gets the asset id for the image of a state, the state must be one of the image types for this to work.
getStateImage.summary = \
\
\
@@ -9791,7 +9791,7 @@ getStateImage.summary = \
getStateImage() Function\
\
• Introduced in version 1.3b40\
- Gets the asset id for the image of a state, the state must be one of the image types for this to work.\
+ Gets the asset id for the image of a state, the state must be one of the image types for this to work.\
\
Usage\
\
@@ -9811,7 +9811,7 @@ getStateImage.summary = \
\
Example\
\
- To display the image for the "Dead" token state use.\
+ To display the image for the "Dead" token state use.\
<img src='[r:getStateImage("Dead")]'></img>\
\
\
@@ -9838,7 +9838,7 @@ getSoundProperties(uri)\
Parameter\
\
\
- uri - The uri/url of the audio source to edit. If set to "*", a JSON Array containing the properties of all audio sources is returned. Defaults to "*".uri - The uri/url of the audio source to edit. If set to "*", a JSON Array containing the properties of all audio sources is returned. Defaults to "*".
\
Properties returned for streams: nicknames, uri, cycleCount, volume, startTime, stopTime, currentTime, totalTime, bufferTime, currentCount, status.\
\
@@ -9859,7 +9859,7 @@ getSoundProperties(uri)\
\
-getStrProp.description = Returns the value associated with a key from the specified string property list .
+getStrProp.description = Returns the value associated with a key from the specified string property list .
getStrProp.summary = \
\
\
@@ -9868,7 +9868,7 @@ getStrProp.summary = \
getStrProp() Function\
\
• Introduced in version 1.3b42\
- Returns the value associated with a key from the specified string property list.\
+ Returns the value associated with a key from the specified string property list.\
\
Usage\
\
@@ -9889,16 +9889,16 @@ getStrProp(propList, key, default, delim)\
\
Example\
\
- To get the name from a weapon string property list\
+ To get the name from a weapon string property list\
[h: weapon = "name=longsword; damage=1d8; maxdamage=8"]\
Name of Weapon: [r: getStrProp(weapon, "name")]
\
Returns Name of Weapon: longsword.\
-
To get the minimum damage from a weapon string property list with a default value should the key not exist\
+
To get the minimum damage from a weapon string property list with a default value should the key not exist\
\
[h: weapon = "name=longsword; damage=1d8; maxdamage=8"]\
Minimum damage of Weapon: [r: getStrProp(weapon, "mindamage", 1)]
\
Returns Minimum damage of Weapon: 1.\
-
To get the damage from a weapon string property list where the field delimiter is a colon. The default is 1d3 (note that a default value must be provided in order to specify the delimiter).\
+
To get the damage from a weapon string property list where the field delimiter is a colon. The default is 1d3 (note that a default value must be provided in order to specify the delimiter).\
\
[h: weapon = "name=longsword: damage=1d8: maxdamage=8"]\
Damage of Weapon: [r: getStrProp(weapon, "damage", "1d3", ":")]
\
@@ -9965,7 +9965,7 @@ getTableEntry.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.4\
@@ -10002,7 +10002,7 @@ getTableEntry.summary = \
\
-getTableImage.description = Gets the asset id for the image of the current row for the given table.
+getTableImage.description = Gets the asset id for the image of the current row for the given table.
getTableImage.summary = \
\
\
@@ -10012,11 +10012,11 @@ getTableImage.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
- Gets the asset id for the image of the current row for the given table. See setTableRoll() to learn how to set the current row.\
+ Gets the asset id for the image of the current row for the given table. See setTableRoll() to learn how to set the current row.\
\
Usage\
\
@@ -10050,7 +10050,7 @@ getTableNames.summary = \
getTableNames()\
getTableNames(delim)
\
\
- If delim is specified then it is used to separate the values in the list; if it is not specified then it defaults to ",". When delim is the string "json" the return value will be in the form of a JSON Array.\
+
If delim is specified then it is used to separate the values in the list; if it is not specified then it defaults to ",". When delim is the string "json" the return value will be in the form of a JSON Array.\
\
\
Examples\
@@ -10065,7 +10065,7 @@ getTableNames(delim)\
\
See Also\
\
- \
+ \
\
\
@@ -10080,7 +10080,7 @@ getTablePickOnce.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.6.0\
@@ -10121,7 +10121,7 @@ getTablePicksLeft.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.6.0\
@@ -10163,7 +10163,7 @@ getTableRoll.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.0.1\
@@ -10240,7 +10240,7 @@ getTerrainModifier.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.2\
@@ -10309,7 +10309,7 @@ getTextLabelStatus.summary = \
\
• Introduced in version 1.6\
• Last checked for compatibility with version 1.6\
- Get the display status for Text Labels. This is also shown in the View menu.\
+ Get the display status for Text Labels. This is also shown in the View menu.\
\
Usage\
\
@@ -10362,7 +10362,7 @@ getTokenDrawOrder(id, mapname)\
Parameter\
\
\
- id - The id of the token to move, defaults to the Current Token.id - The id of the token to move, defaults to the Current Token.mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -10408,7 +10408,7 @@ getTokenFacing(id, mapname)\
Parameters\
\
\
- id - The id of the token to get the facing from, defaults to the current token. Note: This parameter can only be used in a Trusted Macro.
id - The id of the token to get the facing from, defaults to the current token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
Returns\
@@ -10432,7 +10432,7 @@ The angle in degrees or "" if no facing has been set\
Returns:\
\
\
- \
+ \
\
\
\
@@ -10469,7 +10469,7 @@ getTokenGMName.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b40\
@@ -10509,7 +10509,7 @@ getTokenHalo.summary = \
\
-getTokenHandout.description = Returns the asset id of the handout image for the for the Current Token .
+getTokenHandout.description = Returns the asset id of the handout image for the for the Current Token .
getTokenHandout.summary = \
\
\
@@ -10517,7 +10517,7 @@ getTokenHandout.summary = \
\
getTokenHandout() Function\
\
- Returns the asset id of the handout image for the for the Current Token.\
+ Returns the asset id of the handout image for the for the Current Token.\
\
Usage\
\
@@ -10532,13 +10532,13 @@ getTokenHandout(size, id, mapname)\
\
\
size - OPTIONAL: The size the image should be returned as. If a blank string "", no size adjustment is done. Defaults to "".id - OPTIONAL: The token id of the token for which you want to retrieve the token handout image, defaults to the Current Token.id - OPTIONAL: The token id of the token for which you want to retrieve the token handout image, defaults to the Current Token.mapname - OPTIONAL: The name of the map to find the token. Defaults to the current map.
\
\
Example\
\
- To display the image for the current Token.\
+ To display the image for the current Token.\
<img src='[r:getTokenHandout()]'></img>
\
\
\
@@ -10577,7 +10577,7 @@ getTokenHeight(id, mapname)\
Parameter\
\
\
- id - The token id of the token to check for its height, defaults to the Current Token.id - The token id of the token to check for its height, defaults to the Current Token.mapname - The name of the map to find the token. Defaults to the current map.
\
Result
\
@@ -10613,7 +10613,7 @@ The token's boundary (image) height in pixels.\
\
-getTokenImage.description = Returns the asset id of the image for the for the Current Token .
+getTokenImage.description = Returns the asset id of the image for the for the Current Token .
getTokenImage.summary = \
\
\
@@ -10621,7 +10621,7 @@ getTokenImage.summary = \
\
getTokenImage() Function\
\
- Returns the asset id of the image for the for the Current Token.\
+ Returns the asset id of the image for the for the Current Token.\
\
Usage\
\
@@ -10636,15 +10636,15 @@ getTokenImage(size, id, mapname)\
\
\
size - OPTIONAL: The size in pixels the image should be returned as. If a blank string "", no size adjustment is done. Defaults to "".id - OPTIONAL: The token id of the token for which you want to retrieve the token image, defaults to the Current Token.id - OPTIONAL: The token id of the token for which you want to retrieve the token image, defaults to the Current Token.mapname - OPTIONAL: The name of the map to find the token. Defaults to the current map.
\
\
Examples\
\
- To display the image for the current token.\
+ To display the image for the current token.\
<img src='[r:getTokenImage()]'></img>
\
-To get the image of any token using its id and the token roll option.\
+
To get the image of any token using its id and the token roll option.\
\
[h, token(tokenId): imgAsset = getTokenImage()]
\
\
@@ -10688,7 +10688,7 @@ getTokenLabel.summary = \
\
-getTokenLayoutProps.description = Return the Token Layout scale , xOffset , and yOffset values in either a JSON Object or String Property List .
+getTokenLayoutProps.description = Return the Token Layout scale , xOffset , and yOffset values in either a JSON Object or String Property List .
getTokenLayoutProps.summary = \
\
\
@@ -10697,7 +10697,7 @@ getTokenLayoutProps.summary = \
getTokenLayoutProps() Function\
\
• Introduced in version 1.6.1\
- Return the Token Layout scale, xOffset, and yOffset values in either a JSON Object or String Property List. These values represent the positioning of the token image within the Layout portion of the Config tab in the Edit Token Dialog.\
+ Return the Token Layout scale, xOffset, and yOffset values in either a JSON Object or String Property List. These values represent the positioning of the token image within the Layout portion of the Config tab in the Edit Token Dialog.\
\
Usage\
\
@@ -10712,7 +10712,7 @@ getTokenLayoutProps(delim, id, mapName)\
\
\
delim - The delimiter of the String Property List. If set to json, the function will instead return a Json Object. Defaults to ,.id - The token id of the token to name, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to name, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -10754,7 +10754,7 @@ getTokenMap.summary = \
getTokenMap() Function\
\
• Introduced in version 1.5.11\
- Gets the list of map(s) where a token resides. The list is returned either as a string list, or as a JSON Array.\
+ Gets the list of map(s) where a token resides. The list is returned either as a string list, or as a JSON Array.\
\
Usage\
\
@@ -10782,7 +10782,7 @@ getTokenMap(name/ID, delim)\
\
-getTokenNames.description = Gets a list containing the names of all the tokens on the current map , or all the tokens that match the specified conditions.
+getTokenNames.description = Gets a list containing the names of all the tokens on the current map , or all the tokens that match the specified conditions.
getTokenNames.summary = \
\
\
@@ -10792,11 +10792,11 @@ getTokenNames.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
- Gets a list containing the names of all the tokens on the current map, or all the tokens that match the specified conditions. The type of the value returned depends on the delimiter parameter. This function does not return the IDs of lib:tokens. Note: apparently the order of the list that getTokens() returns is also the z-order of the tokens, where the lowest z-order is the first in the list or array that is returned!\
+ Gets a list containing the names of all the tokens on the current map, or all the tokens that match the specified conditions. The type of the value returned depends on the delimiter parameter. This function does not return the IDs of lib:tokens. Note: apparently the order of the list that getTokens() returns is also the z-order of the tokens, where the lowest z-order is the first in the list or array that is returned!\
\
Usage\
\
@@ -10809,9 +10809,9 @@ getTokenNames(delim, conditions)\
Parameters\
\
\
- delim - The delimiter used to separate the values in the String List that is returned, defaults to ",". If "json" is specified, a JSON Array is returned instead of a String List.conditions - A JSON Object that contains various conditions that the tokens must fullfill. All conditions are optional.\
-setStates - A JSON array of states the token must have or a single state name as a string. Any token which does not contain all of these states in the true condition will be removed from the returned list.unsetStates - A JSON array of states the token must not have or a single state name as a string.npc - If the token must be a NPC, set to true(1) or false(0).pc - If the token must be a PC, set to true(1) or false(0).propertyType - A JSON array of token types or a single token type as a string. Only tokens of a type included in the array will be returned.selected - If the token must be selected, set to true(1) or false(0).impersonated - If the token must be impersonated, set to true(1) or false(0).current - If the token must be the current token, set to true(1) or false(0).owned - A JSON Array containing player names. All tokens that have at least one of the listed players as owner will be returned. Alternatively, a string containing one of the following options:\
+ delim - The delimiter used to separate the values in the String List that is returned, defaults to ",". If "json" is specified, a JSON Array is returned instead of a String List.conditions - A JSON Object that contains various conditions that the tokens must fullfill. All conditions are optional.\
+setStates - A JSON array of states the token must have or a single state name as a string. Any token which does not contain all of these states in the true condition will be removed from the returned list.unsetStates - A JSON array of states the token must not have or a single state name as a string.npc - If the token must be a NPC, set to true(1) or false(0).pc - If the token must be a PC, set to true(1) or false(0).propertyType - A JSON array of token types or a single token type as a string. Only tokens of a type included in the array will be returned.selected - If the token must be selected, set to true(1) or false(0).impersonated - If the token must be impersonated, set to true(1) or false(0).current - If the token must be the current token, set to true(1) or false(0).owned - A JSON Array containing player names. All tokens that have at least one of the listed players as owner will be returned. Alternatively, a string containing one of the following options:\
self - tokens owned by the current playernotself - tokens not owned by the current playerothers - tokens owned by any player, but not owned by the current playerany - tokens owned by any playernone - tokens not owned by any playersingle - tokens owned by a single playermultiple - tokens owned by more than one playerbyall - tokens owned by all playersnotbyall - tokens not owned by all players
visible - If the token is visible in the current client's view. Set to true(1) or false(0).\
- When the visible option is used only tokens on the TOKEN layer and which are shown within the client's current map view will be returned.
- This is not a test of whether or not other tokens on the map out of view are visible to a specific token. See canSeeToken().
- GMs will be able to see all tokens within the current map view. Players (including View as Player) will only get returned those tokens that are shown in their current map view. Tokens returned will also be affected by server settings like Individual Views.
layer - A JSON array of layer names, or a single layer name as a string. Note that a token not on any of the listed layers will be removed from the list returned.mapName - The name of the map to get the tokens from. Defaults to the current map.range - A JSON object with range conditions, all range conditions are optional.\
token - The id or name of the source token that the distance is measured from, defaults to the current token.\
@@ -10839,7 +10839,7 @@ getTokenNames(delim, conditions)\
*You can use the following code to print out the names of all of the tokens on the current map:\
[h: names = getTokenNames()]\
[foreach(name, names, "<br>"): name]
\
-- Find and return a JSON Array containing all NPC tokens' names that are within 2 squares or hexes:
\
+- Find and return a JSON Array containing all NPC tokens' names that are within 2 squares or hexes:
\
[h: cond = '{ range: {upto:2, distancePerCell:0}, npc:1 }']\
[h: names = getTokenNames("json", cond)]
\
- Modifying the above example to exclude dead tokens:
\
@@ -10931,7 +10931,7 @@ getTokenNativeHeight(id, mapname)\
Parameter\
\
\
- id - The token id of the token to check for its height, defaults to the Current Token.id - The token id of the token to check for its height, defaults to the Current Token.mapname - The name of the map to find the token. Defaults to the current map.
\
Result
\
@@ -10989,7 +10989,7 @@ getTokenNativeWidth(id, mapname)\
Parameters\
\
\
- id - The token id of the token to check for its width, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to check for its width, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
Result
\
@@ -11047,7 +11047,7 @@ getTokenOpacity(id, mapname)\
Parameters\
\
\
- id - OPTIONAL: The token id of the token for which you want to retrieve the opacity, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - OPTIONAL: The token id of the token for which you want to retrieve the opacity, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - OPTIONAL: The name of the map to find the token. Defaults to the current map.
\
\
@@ -11074,7 +11074,7 @@ getTokenOpacity(id, mapname)\
\
-getTokenPortrait.description = Returns the asset id of the portrait image for the for the Current Token .
+getTokenPortrait.description = Returns the asset id of the portrait image for the for the Current Token .
getTokenPortrait.summary = \
\
\
@@ -11082,7 +11082,7 @@ getTokenPortrait.summary = \
\
getTokenPortrait() Function\
\
- Returns the asset id of the portrait image for the for the Current Token.\
+ Returns the asset id of the portrait image for the for the Current Token.\
\
Usage\
\
@@ -11097,13 +11097,13 @@ getTokenPortrait(size, id, mapname)\
\
\
size - OPTIONAL: The size the picture should be returned as. If a blank string "", no size adjustment is done. Defaults to "".id - OPTIONAL: The token id of the token for which you want to retrieve the token image, defaults to the Current Token.id - OPTIONAL: The token id of the token for which you want to retrieve the token image, defaults to the Current Token.mapname - OPTIONAL: The name of the map to find the token. Defaults to the current map.
\
\
Examples\
\
- To display the image for the current Token.\
+ To display the image for the current Token.\
<img src='[r:getTokenPortrait()]'></img>
\
\
Version Changes\
@@ -11147,7 +11147,7 @@ getTokenRotation(id, mapname)\
Parameters\
\
\
- id - The token id of the token to retrieve the rotation angle. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to retrieve the rotation angle. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
Result
\
@@ -11166,7 +11166,7 @@ The function returns the token's rotation as a numeric value measured in degrees
[h: switchToken("Troll")]\
[r: token.name] - [r: r = getTokenRotation()]
\
Returns:\
-\
+\
Relation to Token Facing
When the facing is defined, the relation between a token's rotation and the token's facing can be expressed as\
\
rotation = -(facing + 90)
\
@@ -11199,7 +11199,7 @@ getTokens.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
@@ -11217,9 +11217,9 @@ getTokens(delim, conditions)\
Parameters\
\
\
- delim - The delimiter used to sepearate the values in the String List that is returned, defaults to ",". If "json" is specified, a JSON Array is returned instead of a String List.conditions - A JSON Object that contains various conditions that the tokens must fullfill. All conditions are optional.\
-setStates - A JSON array of states the token must have or a single state name as a string. Any token which does not contain all of these states in the true condition will be removed from the returned list.unsetStates - A JSON array of states the token must not have or a single state name as a string.npc - If the token must be a NPC, set to true(1) or false(0).pc - If the token must be a PC, set to true(1) or false(0).propertyType - A JSON array of token types or a single token type as a string. Only tokens of a type included in the array will be returned.selected - If the token must be selected, set to true(1) or false(0).impersonated - If the token must be impersonated, set to true(1) or false(0).current - If the token must be the current token, set to true(1) or false(0).owned - A JSON Array containing player names. All tokens that have at least one of the listed players as owner will be returned. Alternatively, a string containing one of the following options:\
+ delim - The delimiter used to sepearate the values in the String List that is returned, defaults to ",". If "json" is specified, a JSON Array is returned instead of a String List.conditions - A JSON Object that contains various conditions that the tokens must fullfill. All conditions are optional.\
+setStates - A JSON array of states the token must have or a single state name as a string. Any token which does not contain all of these states in the true condition will be removed from the returned list.unsetStates - A JSON array of states the token must not have or a single state name as a string.npc - If the token must be a NPC, set to true(1) or false(0).pc - If the token must be a PC, set to true(1) or false(0).propertyType - A JSON array of token types or a single token type as a string. Only tokens of a type included in the array will be returned.selected - If the token must be selected, set to true(1) or false(0).impersonated - If the token must be impersonated, set to true(1) or false(0).current - If the token must be the current token, set to true(1) or false(0).owned - A JSON Array containing player names. All tokens that have at least one of the listed players as owner will be returned. Alternatively, a string containing one of the following options:\
self - tokens owned by the current playernotself - tokens not owned by the current playerothers - tokens owned by any player, but not owned by the current playerany - tokens owned by any playernone - tokens not owned by any playersingle - tokens owned by a single playermultiple - tokens owned by more than one playerbyall - tokens owned by all playersnotbyall - tokens not owned by all players
visible - If the token is visible in the current client's view. Set to true(1) or false(0).\
- When the visible option is used only tokens on the TOKEN layer and which are shown within the client's current map view will be returned.
- This is not a test of whether or not other tokens on the map out of view are visible to a specific token. See canSeeToken().
- GMs will be able to see all tokens within the current map view. Players (including View as Player) will only get returned those tokens that are shown in their current map view. Tokens returned will also be affected by server settings like Individual Views.
layer - A JSON array of layer names, or a single layer name as a string. Only tokens on one of the listed layers will be returned. By default, tokens on the Token and Hidden layers are returned.mapName - The name of the map to get the tokens from. Defaults to the current map.range - A JSON object with range conditions, all range conditions are optional.\
token - The id or name of the source token that the distance is measured from, defaults to the current token.\
@@ -11250,7 +11250,7 @@ The movement metric in range specifies the movement metric use, the metric can b
[foreach(id, ids, "<br>"): id]
\
- Find ALL the tokens on ALL the layers on the map:
\
[r:getTokens(",", json.set("{}", "layer", json.append("[]","TOKEN","HIDDEN","OBJECT","BACKGROUND")))]
\
-- Find and return a JSON Array containing all NPC tokens that are with 2 squares or hexes of the selected token:
\
+- Find and return a JSON Array containing all NPC tokens that are with 2 squares or hexes of the selected token:
\
[h: cond = '{ "range": {"upto":2, "distancePerCell":0, "token":"' +getSelected()+ '"}, "npc":1}']\
[h: ids = getTokens("json", cond)]
\
- Modifying the above example to exclude dead tokens:
\
@@ -11337,7 +11337,7 @@ getTokenShape(id, mapname)\
Parameters\
\
\
- id - The token id of the token to check for the shape, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to check for the shape, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
Result
\
@@ -11370,7 +11370,7 @@ The function returns the token's shape as a string value: "TOP_DOWN"\
-getTokenStates.description = Returns the valid states in the campaign settings in either a String List or JSON Array .
+getTokenStates.description = Returns the valid states in the campaign settings in either a String List or JSON Array .
getTokenStates.summary = \
\
\
@@ -11379,7 +11379,7 @@ getTokenStates.summary = \
getTokenStates() Function\
\
• Introduced in version 1.3b51\
- Returns the valid states in the campaign settings in either a String List or JSON Array. Alternatively, if a token id is specified, instead returns the list of the states that are set to true(1) for the token.\
+ Returns the valid states in the campaign settings in either a String List or JSON Array. Alternatively, if a token id is specified, instead returns the list of the states that are set to true(1) for the token.\
\
Usage\
\
@@ -11396,21 +11396,21 @@ getTokenStates(delim, groupName, id, mapname)\
\
delim - Specifies the delimiter used in the string list that is returned, default is ",". If the value is set to json, the function returns a JSON array instead.groupName - Specifies the name of the group to get the states for. If set to "*", get all states.id - The id of the token to get the states set to true(1). If the parameter is not used, instead returns all valid states in the campaign settings. Note: This parameter can only be used in a Trusted Macro.
id - The id of the token to get the states set to true(1). If the parameter is not used, instead returns all valid states in the campaign settings. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map where the token is. Set to the current map by default.
\
\
Example\
\
- To get a String List of the valid Token States in the campaign.\
+ To get a String List of the valid Token States in the campaign.\
[h: states = getTokenStates()]
\
-To get a JSON Array of the valid Token States in the campaign.\
+
To get a JSON Array of the valid Token States in the campaign.\
\
[h: states = getTokenStates("json")]\
-To get a JSON Array of the valid Token States in the Damage group in the campaign in 1.3b55 or later.\
+
To get a JSON Array of the valid Token States in the Damage group in the campaign in 1.3b55 or later.\
\
[h: states = getTokenStates("json", "Damage")]\
-To get a JSON Array of the Token States set to true(1) for the "Dragon" token:\
+
To get a JSON Array of the Token States set to true(1) for the "Dragon" token:\
\
[h: states = getTokenStates("json", "*", "Dragon")]\
\
@@ -11439,7 +11439,7 @@ getTokenVBL.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.1.6\
@@ -11458,7 +11458,7 @@ getTokenVBL.summary = \
Parameters\
\
\
- id - OPTIONAL: The token id of the token for which you want to get the VBL. Defaults to the Current Token.id - OPTIONAL: The token id of the token for which you want to get the VBL. Defaults to the Current Token.
\
\
Example:\
@@ -11476,7 +11476,7 @@ getTokenVBL.summary = \
\
See Also\
\
- \
+ \
\
\
@@ -11503,7 +11503,7 @@ getTokenWidth(id, mapname)\
Parameters\
\
\
- id - The token id of the token to check for its width, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to check for its width, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
Result
\
@@ -11563,7 +11563,7 @@ getTokenX(units, id, mapname)\
\
\
units - If set to false(0), the coordinate is a location on the grid in number of cells. Defaults to true(1), where the coordinate is in number of Pixels (in other words 0:distance in cells, 1: distance in pixels)'.id - The id of the token to move, defaults to the Current Token.id - The id of the token to move, defaults to the Current Token.mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -11595,13 +11595,13 @@ The exception to this is when the token is 'Freesize' AND 'Snapped to Grid' AND
\
Examples\
\
- Moves the Current Token down 5 units, and left 10 units.\
+ Moves the Current Token down 5 units, and left 10 units.\
[h: CurrentX = getTokenX()]\
[h: CurrentY = getTokenY()]\
[h: NewX = CurrentX + 5]\
[h: NewY = CurrentY - 10]\
[h: moveToken(NewX, NewY)]
\
-Moves the Current Token down 5 cells, and left 10 cells.\
+
Moves the Current Token down 5 cells, and left 10 cells.\
\
[h: CurrentX = getTokenX(0)]\
[h: CurrentY = getTokenY(0)]\
@@ -11651,7 +11651,7 @@ getTokenY(units, id, mapname)
\
\
\
units - If set to false(0), the coordinate is a location on the grid in number of cells. Defaults to true(1), where the coordinate is in number of Pixels (in other words 0:distance in cells, 1: distance in pixels)'.id - The id of the token to move, defaults to the Current Token.id - The id of the token to move, defaults to the Current Token.mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -11683,13 +11683,13 @@ The exception to this is when the token is 'Freesize' AND 'Snapped to Grid' AND
\
Examples\
\
- Moves the Current Token down 5 units, and left 10 units.\
+ Moves the Current Token down 5 units, and left 10 units.\
[h: CurrentX = getTokenX()]\
[h: CurrentY = getTokenY()]\
[h: NewX = CurrentX + 5]\
[h: NewY = CurrentY - 10]\
[h: moveToken(NewX, NewY)]
\
-Moves the Current Token down 5 cells, and left 10 cells.\
+
Moves the Current Token down 5 cells, and left 10 cells.\
\
[h: CurrentX = getTokenX(0)]\
[h: CurrentY = getTokenY(0)]\
@@ -11725,7 +11725,7 @@ getVBL.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b90\
@@ -11764,7 +11764,7 @@ getVBL.summary = \
\
See Also\
\
- \
+ \
\
\
@@ -11875,7 +11875,7 @@ centerX=646; centerY=319,\
\
-getVisible.description = Returns true ( 1 ) if the visible to players flag is set on a Token otherwise returns false ( 0 ).
+getVisible.description = Returns true ( 1 ) if the visible to players flag is set on a Token otherwise returns false ( 0 ).
getVisible.summary = \
\
\
@@ -11884,7 +11884,7 @@ getVisible.summary = \
getVisible() Function\
\
• Introduced in version 1.3b40\
- Returns true(1) if the visible to players flag is set on a Token otherwise returns false(0). The visible to players flag has two meanings, on a normal Token players will only be able to see the Token if it is set (when all other things like Fog of War etc are taken into account). If it is a Library Token then it determines if players can call Macros using [macro():].\
+ Returns true(1) if the visible to players flag is set on a Token otherwise returns false(0). The visible to players flag has two meanings, on a normal Token players will only be able to see the Token if it is set (when all other things like Fog of War etc are taken into account). If it is a Library Token then it determines if players can call Macros using [macro():].\
\
Usage\
\
@@ -11898,7 +11898,7 @@ getVisible.summary = \
Parameter\
\
\
- id - The token id of token that has its player visibility checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of token that has its player visibility checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
\
\
\
@@ -11921,7 +11921,7 @@ getVisible.summary = \
\
-getVisibleMapDisplayNames.description = Returns the display names of all of the player visible maps as either a String List or JSON Array .
+getVisibleMapDisplayNames.description = Returns the display names of all of the player visible maps as either a String List or JSON Array .
getVisibleMapDisplayNames.summary = \
\
\
@@ -11930,7 +11930,7 @@ getVisibleMapDisplayNames.summary = \
getVisibleMapNames() Function\
\
• Introduced in version 1.9.0\
- Returns the display names of all of the player visible maps as either a String List or JSON Array.\
+ Returns the display names of all of the player visible maps as either a String List or JSON Array.\
\
Usage\
\
@@ -11944,14 +11944,14 @@ getVisibleMapDisplayNames.summary = \
Parameters\
\
\
- delim - The delimiter to use for the String List. If the value is json then a JSON Array is returned.delim - The delimiter to use for the String List. If the value is json then a JSON Array is returned.
\
\
Examples\
\
- To get the display names of all of the player visible maps in a String List.\
+ To get the display names of all of the player visible maps in a String List.\
[h: maps = getVisibleMapNames()]
\
-To get the display names of all of the player visible maps in a JSON Array\
+
To get the display names of all of the player visible maps in a JSON Array\
\
[h: maps = getVisibleMapNames("json")]\
\
@@ -11965,7 +11965,7 @@ getVisibleMapDisplayNames.summary = \
\
-getVisibleMapNames.description = Returns the names of all of the player visible maps as either a String List or JSON Array .
+getVisibleMapNames.description = Returns the names of all of the player visible maps as either a String List or JSON Array .
getVisibleMapNames.summary = \
\
\
@@ -11974,7 +11974,7 @@ getVisibleMapNames.summary = \
getVisibleMapNames() Function\
\
• Introduced in version 1.3b55\
- Returns the names of all of the player visible maps as either a String List or JSON Array.\
+ Returns the names of all of the player visible maps as either a String List or JSON Array.\
\
Usage\
\
@@ -11988,14 +11988,14 @@ getVisibleMapNames.summary = \
Parameters\
\
\
- delim - The delimiter to use for the String List. If the value is json then a JSON Array is returned.delim - The delimiter to use for the String List. If the value is json then a JSON Array is returned.
\
\
Examples\
\
- To get the names of all of the player visible maps in a String List.\
+ To get the names of all of the player visible maps in a String List.\
[h: maps = getVisibleMapNames()]
\
-To get the names of all of the player visible maps in a JSON Array\
+
To get the names of all of the player visible maps in a JSON Array\
\
[h: maps = getVisibleMapNames("json")]\
\
@@ -12009,7 +12009,7 @@ getVisibleMapNames.summary = \
\
-getVisibleTokenNames.description = Returns a string list or JSON Array of Token:token names for the tokens that are visible to the player.
+getVisibleTokenNames.description = Returns a string list or JSON Array of Token:token names for the tokens that are visible to the player.
getVisibleTokenNames.summary = \
\
\
@@ -12018,8 +12018,8 @@ getVisibleTokenNames.summary = \
getVisibleTokenNames() Function\
\
• Introduced in version 1.3b49\
- Returns a string list or JSON Array of Token:token names for the tokens that are visible to the player. The type of the value returned depends on the delimiter parameter.\
-- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
+ Returns a string list or JSON Array of Token:token names for the tokens that are visible to the player. The type of the value returned depends on the delimiter parameter.\
+- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
\
\
Usage\
@@ -12051,7 +12051,7 @@ getVisibleTokenNames.summary = \
\
-getVisibleTokens.description = Returns a string list or JSON Array of token ids for the tokens that are visible to the player.
+getVisibleTokens.description = Returns a string list or JSON Array of token ids for the tokens that are visible to the player.
getVisibleTokens.summary = \
\
\
@@ -12060,8 +12060,8 @@ getVisibleTokens.summary = \
getVisibleTokens() Function\
\
• Introduced in version 1.3b49\
- Returns a string list or JSON Array of token ids for the tokens that are visible to the player. The type of the value returned depends on the delimiter parameter.\
-- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
+ Returns a string list or JSON Array of token ids for the tokens that are visible to the player. The type of the value returned depends on the delimiter parameter.\
+- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
\
\
Usage\
@@ -12098,7 +12098,7 @@ getVisibleTokens.summary = \
\
-getWithState.description = Gets a list containing the ids of all the tokens on the current map that have the specified token state set.
+getWithState.description = Gets a list containing the ids of all the tokens on the current map that have the specified token state set.
getWithState.summary = \
\
\
@@ -12108,12 +12108,12 @@ getWithState.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
- Gets a list containing the ids of all the tokens on the current map that have the specified token state set. The type of the value returned depends on the delimiter parameter.\
-- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
+ Gets a list containing the ids of all the tokens on the current map that have the specified token state set. The type of the value returned depends on the delimiter parameter.\
+- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
\
\
Usage\
@@ -12127,7 +12127,7 @@ getWithState(state, delim)\
\
Example\
\
- You can use the following code to print out the ids of all of the tokens on the current map with the "Dead" token state set.\
+ You can use the following code to print out the ids of all of the tokens on the current map with the "Dead" token state set.\
[h: ids = getWithState("Dead")]\
[foreach(id, ids, "<br>"): id]\
\
@@ -12145,7 +12145,7 @@ getWithState(state, delim)\
\
-getWithStateNames.description = Gets a list containing the names of all the tokens on the current map that have the specified token state set.
+getWithStateNames.description = Gets a list containing the names of all the tokens on the current map that have the specified token state set.
getWithStateNames.summary = \
\
\
@@ -12155,12 +12155,12 @@ getWithStateNames.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
- Gets a list containing the names of all the tokens on the current map that have the specified token state set. The type of the value returned depends on the delimiter parameter.\
-- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
+ Gets a list containing the names of all the tokens on the current map that have the specified token state set. The type of the value returned depends on the delimiter parameter.\
+- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
\
\
Usage\
@@ -12174,7 +12174,7 @@ getWithStateNames(state, delim)\
\
Example\
\
- You can use the following code to print out the names of all of the tokens on the current map with the "Dead" token state set.\
+ You can use the following code to print out the names of all of the tokens on the current map with the "Dead" token state set.\
[h: names = getWithStateNames("Dead")]\
[foreach(name, names, "<br>"): name]\
\
@@ -12329,7 +12329,7 @@ gt.summary = \
\
-hasImpersonated.description = Returns 1 if there is an impersonated token otherwise returns 0.
+hasImpersonated.description = Returns 1 if there is an impersonated token otherwise returns 0.
hasImpersonated.summary = \
\
\
@@ -12338,7 +12338,7 @@ hasImpersonated.summary = \
hasImpersonated() Function\
\
• Introduced in version 1.3b48\
- Returns 1 if there is an impersonated token otherwise returns 0.\
+ Returns 1 if there is an impersonated token otherwise returns 0.\
\
Usage\
\
@@ -12349,7 +12349,7 @@ hasImpersonated.summary = \
\
-hasLightSource.description = Returns 1 if the Current Token has any light sources that match the criteria passed in or 0 if there are no matches.
+hasLightSource.description = Returns 1 if the Current Token has any light sources that match the criteria passed in or 0 if there are no matches.
hasLightSource.summary = \
\
\
@@ -12358,7 +12358,7 @@ hasLightSource.summary = \
hasLightSource() Function\
\
• Introduced in version 1.3b48\
- Returns 1 if the Current Token has any light sources that match the criteria passed in or 0 if there are no matches. If no arguments are passed to the function then it will return 1 if any light source is on. If only the first argument is passed it will return 1 if any light source of that light source type is on. If both arguments are passed to the function it will return 1 if the light source with the specified name and specified light source type is on.\
+ Returns 1 if the Current Token has any light sources that match the criteria passed in or 0 if there are no matches. If no arguments are passed to the function then it will return 1 if any light source is on. If only the first argument is passed it will return 1 if any light source of that light source type is on. If both arguments are passed to the function it will return 1 if the light source with the specified name and specified light source type is on.\
\
Usage\
\
@@ -12374,8 +12374,8 @@ hasLightSource(type, name, id, mapname)\
\
\
type - The light source type, (e.g. "Generic", "D20"). If "*" is entered, all light sources types are checked. Defaults to "*".name - the name of the light source. If "*" is entered, all light sources names are checked. Defaults to "*".id - The token id of the token which is checked for light sources, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
name - the name of the light source. If "*" is entered, all light sources names are checked. Defaults to "*".id - The token id of the token which is checked for light sources, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -12401,7 +12401,7 @@ hasLightSource(type, name, id, mapname)\
\
-hasMacro.description = Returns true ( 1 ) if a macro button with the specified label exists on the Current Token .
+hasMacro.description = Returns true ( 1 ) if a macro button with the specified label exists on the Current Token .
hasMacro.summary = \
\
\
@@ -12410,7 +12410,7 @@ hasMacro.summary = \
hasMacro() Function\
\
• Introduced in version 1.3b48\
- \
+ \
\
Usage\
\
@@ -12424,7 +12424,7 @@ hasMacro(label, id, mapname)\
\
\
label - The label of the macro to check for.id - The token id of the token that the function is executed on. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token that the function is executed on. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -12443,7 +12443,7 @@ hasMacro(label, id, mapname)\
\
-hasProperty.description = Returns true ( 1 ) if the Token Property with the specified name exists on a Token .
+hasProperty.description = Returns true ( 1 ) if the Token Property with the specified name exists on a Token .
hasProperty.summary = \
\
\
@@ -12452,7 +12452,7 @@ hasProperty.summary = \
hasProperty() Function\
\
• Introduced in version 1.3b48\
- Returns true(1) if the Token Property with the specified name exists on a Token. The function will return true if the token possesses the specified property, even if that property is not defined in the token's current property type.\
+ Returns true(1) if the Token Property with the specified name exists on a Token. The function will return true if the token possesses the specified property, even if that property is not defined in the token's current property type.\
\
Usage\
\
@@ -12465,8 +12465,8 @@ hasProperty(name, id, mapname)\
Parameters\
\
\
- name - The name of the Token Property which is checked for on the token.id - The token id of the token which is checked for the Token Property, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
name - The name of the Token Property which is checked for on the token.id - The token id of the token which is checked for the Token Property, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -12485,7 +12485,7 @@ hasProperty(name, id, mapname)\
\
-hasSight.description = Returns 1 if the Current Token has sight .
+hasSight.description = Returns 1 if the Current Token has sight .
hasSight.summary = \
\
\
@@ -12494,7 +12494,7 @@ hasSight.summary = \
hasSight() Function\
\
• Introduced in version 1.3b48\
- Returns 1 if the Current Token has sight.\
+ Returns 1 if the Current Token has sight.\
\
Usage\
\
@@ -12507,7 +12507,7 @@ hasSight(id, mapname)\
Parameters\
\
\
- id - The id of the token to return the sight. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The id of the token to return the sight. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -12566,7 +12566,7 @@ Returns a number than is between 5 and 50 for the hero
See Also\
\
\
+For another method of rolling dice, see Dice Expressions.\
\
\
@@ -12609,7 +12609,7 @@ Returns a number than is between 5 and 50 for the hero
See Also\
\
\
+For another method of rolling dice, see Dice Expressions.\
\
\
@@ -12624,7 +12624,7 @@ herolab.getImage.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5\
@@ -12658,7 +12658,7 @@ herolab.getImage(index, id)\
See Also\
\
\
\
Version Changes\
@@ -12682,7 +12682,7 @@ herolab.getInfo.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5\
@@ -12719,7 +12719,7 @@ herolab.getInfo(id,field)\
See Also\
\
\
\
Version Changes\
@@ -12743,7 +12743,7 @@ herolab.getMasterName.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5\
@@ -12775,7 +12775,7 @@ herolab.getMasterName(id)\
See Also\
\
\
\
Version Changes\
@@ -12799,7 +12799,7 @@ herolab.getStatBlock.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5\
@@ -12811,7 +12811,7 @@ herolab.getStatBlock.summary = \
herolab.getStatBlock(type)\
herolab.getStatBlock(type,id)
\
\
- Note: The different formats may or may not contain the same information but it does reflects what is stored in the portfolio. If you find missing information, in the XML statblock for instance, you will need to report that to [Wolf Lair].\
+
Note: The different formats may or may not contain the same information but it does reflects what is stored in the portfolio. If you find missing information, in the XML statblock for instance, you will need to report that to [Wolf Lair].\
\
\
Parameters\
@@ -12834,7 +12834,7 @@ herolab.getStatBlock(type,id)\
See Also\
\
\
\
Version Changes\
@@ -12858,7 +12858,7 @@ herolab.hasChanged.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5\
@@ -12890,7 +12890,7 @@ herolab.hasChanged(id)\
See Also\
\
\
\
Version Changes\
@@ -12914,7 +12914,7 @@ herolab.isMinion.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5\
@@ -12951,7 +12951,7 @@ herolab.isMinion(id)\
See Also\
\
\
\
Version Changes\
@@ -12975,7 +12975,7 @@ herolab.refresh.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5\
@@ -13009,7 +13009,7 @@ herolab.refresh(id)\
See Also\
\
\
\
Version Changes\
@@ -13033,7 +13033,7 @@ herolab.XPath.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -13058,7 +13058,7 @@ herolab.XPath(XPath, id, "json")\
\
XPath - The XPath expression to evaluate against the XML statblock.id - The id of the token. Defaults to the Current Token.delim - Coming in 1.8. Custom delimiter for the returned results. Defaults to ", ". If equal to "json", a JSON Array will be returned instead of a String List.delim - Coming in 1.8. Custom delimiter for the returned results. Defaults to ", ". If equal to "json", a JSON Array will be returned instead of a String List.
\
Returns the requested data.\
\
@@ -13073,7 +13073,7 @@ herolab.XPath(XPath, id, "json")\
\
Human Neutral Good 1
\
Changes Coming in 1.8
\
-Sometimes the data desired from herolab contains commas or is otherwise incompatible with the String List format and default (comma) separator. In the following example, the list of spells retrieved includes one called "Delay Poison, Communal" - as we see in the default output, this element would be incompatible with the standard String List format.\
+
Sometimes the data desired from herolab contains commas or is otherwise incompatible with the String List format and default (comma) separator. In the following example, the list of spells retrieved includes one called "Delay Poison, Communal" - as we see in the default output, this element would be incompatible with the standard String List format.\
\
[h: vXPath = "/document/public/character/spellsmemorized/spell[contains(@name,'De')]/@name"]\
Default: [r: herolab.XPath(vXPath)]<br />\
@@ -13094,7 +13094,7 @@ When dealing with more complicated text elements with potential delimiter confli
See Also\
\
\
\
Version Changes\
@@ -13149,7 +13149,7 @@ Returns a number than is between 5 and 50 for the hero
See Also\
\
\
+For another method of rolling dice, see Dice Expressions.\
\
\
@@ -13189,7 +13189,7 @@ hideTextLabels.summary = \
\
• Introduced in version 1.6\
• Last checked for compatibility with version 1.6\
- Disables the display of Text Labels if they are not showing. This can also be set in the View menu.\
+ Disables the display of Text Labels if they are not showing. This can also be set in the View menu.\
\
Usage\
\
@@ -13300,7 +13300,7 @@ This function doesn't have the parentheses limit that the roll option has:\
Parameters\
\
\
- condition - What is tested to determine is the trueExpr or falseExpr will be executed. This follows the standard rules for conditions that can be found in the Branching and Looping article.condition - What is tested to determine is the trueExpr or falseExpr will be executed. This follows the standard rules for conditions that can be found in the Branching and Looping article.trueExpr - A section of code that is returned if condition is true(1).falseExpr - A section of code that is returned if condition is false(0).
\
@@ -13357,7 +13357,7 @@ This function doesn't have the parentheses limit that the roll option has:\
\
- Returns:
property set to 0 \
\
-
Example 5: Usually its better to use the roll option version [if():]. Sometimes it's pretty handy to use the version documented here, since you can easily embed it in loops and expressions.\
+
Example 5: Usually its better to use the roll option version [if():]. Sometimes it's pretty handy to use the version documented here, since you can easily embed it in loops and expressions.\
\
Let's say you want to check if one of a player's tokens has Initiative, you could do it this like this:\
\
@@ -13371,7 +13371,7 @@ This function doesn't have the parentheses limit that the roll option has:\
\
See Also\
\
- \
+ \
\
\
@@ -13386,12 +13386,12 @@ impersonate.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.7.0\
• Last checked for compatibility with version 1.7.0\
- Impersonate changes the impersonated token for the client running the function, replacing any current impersonation. Rather than being used like switchToken() to aid in macro execution, this function is the same as right-clicking a token and selecting 'Impersonate'. The function does not set the Current Token. Use switchToken() for that.\
+ Impersonate changes the impersonated token for the client running the function, replacing any current impersonation. Rather than being used like switchToken() to aid in macro execution, this function is the same as right-clicking a token and selecting 'Impersonate'. The function does not set the Current Token. Use switchToken() for that.\
\
Usage\
\
@@ -13413,7 +13413,7 @@ Nice weather, eh?<br>\
Seen any dragons?\
Output:\
\
-\
+\
\
See Also\
\
@@ -13430,7 +13430,7 @@ Seen any dragons?\
\
-indexKeyStrProp.description = Returns the key from the specified string property list at the specified index.
+indexKeyStrProp.description = Returns the key from the specified string property list at the specified index.
indexKeyStrProp.summary = \
\
\
@@ -13439,7 +13439,7 @@ indexKeyStrProp.summary = \
indexKeyStrProp() Function\
\
• Introduced in version 1.3b42\
- Returns the key from the specified string property list at the specified index. The index for the string property list starts at 0.\
+ Returns the key from the specified string property list at the specified index. The index for the string property list starts at 0.\
\
Usage\
\
@@ -13485,7 +13485,7 @@ Returns -1.\
\
-indexValueStrProp.description = Returns the value from the specified string property list at the specified index.
+indexValueStrProp.description = Returns the value from the specified string property list at the specified index.
indexValueStrProp.summary = \
\
\
@@ -13494,7 +13494,7 @@ indexValueStrProp.summary = \
indexValueStrProp() Function\
\
• Introduced in version 1.3b42\
- Returns the value from the specified string property list at the specified index. The index for the string property list starts at 0.\
+ Returns the value from the specified string property list at the specified index. The index for the string property list starts at 0.\
\
Usage\
\
@@ -13510,7 +13510,7 @@ Returns "doh".\
\
-initiativeSize.description = Returns the number of tokens in the initiative panel
+initiativeSize.description = Returns the number of tokens in the initiative panel
initiativeSize.summary = \
\
\
@@ -13518,7 +13518,7 @@ initiativeSize.summary = \
\
initiativeSize() Function\
\
- Returns the number of tokens in the initiative panel\
+ Returns the number of tokens in the initiative panel\
\
Usage\
\
@@ -13560,7 +13560,7 @@ Note that there are no built-in mechanisms for input validation for TEXTParameters\
\
\
- 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.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:\
\
@@ -13610,7 +13610,7 @@ Note that there are no built-in mechanisms for input validation for TEXTICONSIZE=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.DELIMITER=, - The delimiter used in the list; defaults to the comma ,. The delimiter cannot contain empty spaces. If set to JSON, a JSON Array should be provided instead.DELIMITER=, - The delimiter used in the list; defaults to the comma ,. The delimiter cannot contain empty spaces. If set to JSON, a JSON Array should be provided instead.
\
\
@@ -13638,7 +13638,7 @@ Note that there are no built-in mechanisms for input validation for TEXTSELECT=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.DELIMITER=, - The delimiter used in the list; defaults to the comma ,. The delimiter cannot contain empty spaces. If set to JSON, a JSON Array should be provided instead.DELIMITER=, - The delimiter used in the list; defaults to the comma ,. The delimiter cannot contain empty spaces. If set to JSON, a JSON Array should be provided instead.\
\
@@ -13662,14 +13662,14 @@ Note that there are no built-in mechanisms for input validation for TEXT\
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.\
+
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.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.WIDTH=nnn - Sets the width of the input box; defaults to WIDTH=14.TYPE=JSON - Result returned in variableName will be a JSON object instead of string property.TEXT\
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.\
+
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\
@@ -13709,7 +13709,7 @@ Note that there are no built-in mechanisms for input validation for TEXTDisplays:\
\
\
@@ -13732,7 +13732,7 @@ Note that there are no built-in mechanisms for input validation for TEXTDisplays:\
\
\
@@ -13752,11 +13752,11 @@ Note that there are no built-in mechanisms for input validation for TEXTDisplays:\
\
\
- 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.\
+
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.\
\
\
Input using using the DELIMITER option for LIST.\
@@ -13791,7 +13791,7 @@ You chose: [r: color] [r: meat] with [r: sauce]\
inptext\
)]\
\
- 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.\
+
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. Dynamic Variable Example, by aliasmask. Uses strformat to create the property names and json.evaluate to put in default values.\
@@ -13916,7 +13916,7 @@ If you really want to go full monty on the tooltip INSIDE the input, here's an e
This is the result:\
\
\
@@ -13942,7 +13942,7 @@ This can simply be done with the <html><img> tags. Howe
[h:input("junk|<html><img src='"+replace(getTokenHandout(), ":", ":")+"' height=90 width=90></img></html>|-|LABEL|SPAN=TRUE")]\
\
\
@@ -13967,7 +13967,7 @@ This can simply be done with the <html><img> tags. Howe
[r,token(me), if(picChoice == 2): "<img src='"+getTokenHandout(picSize)+"'></img>"]\
\
\
@@ -13993,7 +13993,7 @@ This can simply be done with the <html><img> tags. Howe
\
-isBarVisible.description = Returns true ( 1 ) if the specified Token Bar on the Current Token is visible, or false ( 0 ) if it is not.
+isBarVisible.description = Returns true ( 1 ) if the specified Token Bar on the Current Token is visible, or false ( 0 ) if it is not.
isBarVisible.summary = \
\
\
@@ -14002,7 +14002,7 @@ isBarVisible.summary = \
isBarVisible() Function\
\
• Introduced in version 1.3b46\
- Returns true(1) if the specified Token Bar on the Current Token is visible, or false(0) if it is not.\
+ Returns true(1) if the specified Token Bar on the Current Token is visible, or false(0) if it is not.\
\
Usage\
\
@@ -14016,7 +14016,7 @@ isBarVisible(bar, id, mapname)\
\
\
bar - A string that contains the name of the bar that has its visibility checked.id - The token id of the token which has its bar checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token which has its bar checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -14052,10 +14052,10 @@ isBarVisible(bar, id, mapname)\
\
\
- \
- HP and Health Bars\
+ HP and Health Bars\
\
- \
- The
bar.name special variable\
+ The bar.name special variable\
\
\
\
@@ -14220,7 +14220,7 @@ isGm.summary = \
\
-isNPC.description = Returns true ( 1 ) if a Token is a NPC or false ( 0 ) if it is not.
+isNPC.description = Returns true ( 1 ) if a Token is a NPC or false ( 0 ) if it is not.
isNPC.summary = \
\
\
@@ -14229,7 +14229,7 @@ isNPC.summary = \
isNPC() Function\
\
• Introduced in version 1.3b48\
- \
+ \
\
Usage\
\
@@ -14242,7 +14242,7 @@ isNPC(id, mapname)\
Parameter\
\
\
- id - The token id of the token which has its NPC status checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token which has its NPC status checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -14313,7 +14313,7 @@ This function will return 1 even if a registered overlay is hidden using the \
-isOwnedByAll.description = Returns true ( 1 ) if a Token has the Owned by All check box checked.
+isOwnedByAll.description = Returns true ( 1 ) if a Token has the Owned by All check box checked.
isOwnedByAll.summary = \
\
\
@@ -14322,7 +14322,7 @@ isOwnedByAll.summary = \
isOwnedByAll() Function\
\
• Introduced in version 1.3b48\
- \
+ \
\
Usage\
\
@@ -14335,13 +14335,13 @@ isOwnedByAll(id, mapname)\
Parameter\
\
\
- id - The token id of the token which has its Owned by All status checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token which has its Owned by All status checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
Example\
\
- Returns Anyone can edit me if the Current Token has the Owned by All check box checked.\
+ Returns Anyone can edit me if the Current Token has the Owned by All check box checked.\
[r, if(isOwnedByAll()): "Anyone can edit me"]
\
\
See Also\
@@ -14361,7 +14361,7 @@ isOwnedByAll(id, mapname)\
\
-isOwner.description = Returns true ( 1 ) if the given Player is an owner of a specific Token .
+isOwner.description = Returns true ( 1 ) if the given Player is an owner of a specific Token .
isOwner.summary = \
\
\
@@ -14370,7 +14370,7 @@ isOwner.summary = \
isOwner() Function\
\
• Introduced in version 1.3b48\
- \
+ \
\
Usage\
\
@@ -14384,16 +14384,16 @@ isOwner(player, id, mapname)\
Parameters\
\
\
- player - The name of the player to check for ownership, defaults to the Current Player.id - The token id of the token which is checked for ownership, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
player - The name of the player to check for ownership, defaults to the Current Player.id - The token id of the token which is checked for ownership, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
Examples\
\
- Returns You can edit me. if the Current Player is an owner of the Current Token.\
+ Returns You can edit me. if the Current Player is an owner of the Current Token.\
[r, if(isOwner()): "You can edit me."]
\
-Returns Azhrei can edit me. if the given Player is an owner of the given Token.\
+
Returns Azhrei can edit me. if the given Player is an owner of the given Token.\
\
[h: id = getSelected() ]\
[r, if(isOwner("Azhrei", id)): "Azhrei can edit me."]\
@@ -14415,7 +14415,7 @@ isOwner(player, id, mapname)\
\
-isPC.description = Returns true ( 1 ) if a Token is a PC or false ( 0 ) if it is not.
+isPC.description = Returns true ( 1 ) if a Token is a PC or false ( 0 ) if it is not.
isPC.summary = \
\
\
@@ -14424,7 +14424,7 @@ isPC.summary = \
isPC() Function\
\
• Introduced in version 1.3b48\
- \
+ \
\
Usage\
\
@@ -14437,7 +14437,7 @@ isPC(id, mapname)\
Parameter\
\
\
- id - The token id of the token which has its PC status checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token which has its PC status checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -14467,7 +14467,7 @@ isPC(id, mapname)\
\
-isPropertyEmpty.description = Returns true ( 1 ) if the Token Property for a specific Token is empty.
+isPropertyEmpty.description = Returns true ( 1 ) if the Token Property for a specific Token is empty.
isPropertyEmpty.summary = \
\
\
@@ -14476,7 +14476,7 @@ isPropertyEmpty.summary = \
isPropertyEmpty() Function\
\
• Introduced in version 1.3b48\
- Returns true(1) if the Token Property for a specific Token is empty. A Token Property is considered empty if it is NULL; if an empty string ("") has been assigned to it, it is not considered empty.\
+ Returns true(1) if the Token Property for a specific Token is empty. A Token Property is considered empty if it is NULL; if an empty string ("") has been assigned to it, it is not considered empty.\
Note: If the token type sets a default value, this function will still see the property as empty. Try using json.isEmpty().\
\
Usage\
@@ -14491,7 +14491,7 @@ isPropertyEmpty(property, id, mapname)\
\
\
property - The name of the property that has its value checked.id - The token id of the token that has its value checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token that has its value checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -14522,7 +14522,7 @@ isPropertyEmpty(property, id, mapname)\
\
-isSnapToGrid.description = Returns true ( 1 ) if a Token is snapped to grid or false ( 0 ) if it is not.
+isSnapToGrid.description = Returns true ( 1 ) if a Token is snapped to grid or false ( 0 ) if it is not.
isSnapToGrid.summary = \
\
\
@@ -14531,7 +14531,7 @@ isSnapToGrid.summary = \
isSnapToGrid() Function\
\
• Introduced in version 1.3b69\
- \
+ \
\
Usage\
\
@@ -14544,7 +14544,7 @@ isSnapToGrid(id, mapname)\
Parameter\
\
\
- id - The token id of the token which has its snapToGrid status checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token which has its snapToGrid status checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -14571,7 +14571,7 @@ isSnapToGrid(id, mapname)\
\
-isTrusted.description = Returns 1 if this is running as a trusted macro or 0 if it is not.
+isTrusted.description = Returns 1 if this is running as a trusted macro or 0 if it is not.
isTrusted.summary = \
\
\
@@ -14580,7 +14580,7 @@ isTrusted.summary = \
isTrusted() Function\
\
• Introduced in version 1.3b48\
- Returns 1 if this is running as a trusted macro or 0 if it is not.\
+ Returns 1 if this is running as a trusted macro or 0 if it is not.\
\
Usage\
\
@@ -14623,7 +14623,7 @@ isVisible(x,y,id)\
\
x - Then tokens x coordinate. Always in map units, not grid .y - Then tokens x coordinate. Always in map units, not grid .id - The check for visibility is performed from token id. Note: This parameter can only be used in a Trusted Macro.
id - The check for visibility is performed from token id. Note: This parameter can only be used in a Trusted Macro.
\
\
Example\
@@ -14655,7 +14655,7 @@ isVisible(x,y,id)\
\
-json.append.description = Appends values to the end of a JSON Array .
+json.append.description = Appends values to the end of a JSON Array .
json.append.summary = \
\
\
@@ -14664,7 +14664,7 @@ json.append.summary = \
json.append() Function\
\
• Introduced in version 1.3b49\
- Appends values to the end of a JSON Array. An empty string ("") can be used to represent an empty JSON Array to append the values to.\
+ Appends values to the end of a JSON Array. An empty string ("") can be used to represent an empty JSON Array to append the values to.\
\
Usage\
\
@@ -14690,7 +14690,7 @@ json.append.summary = \
\
-json.contains.description = Returns true ( 1 ) if the JSON Object contains the specified key, or if the JSON Array contains the specified value.
+json.contains.description = Returns true ( 1 ) if the JSON Object contains the specified key, or if the JSON Array contains the specified value.
json.contains.summary = \
\
\
@@ -14699,7 +14699,7 @@ json.contains.summary = \
json.contains() Function\
\
• Introduced in version 1.3b49\
- Returns true(1) if the JSON Object contains the specified key, or if the JSON Array contains the specified value.\
+ Returns true(1) if the JSON Object contains the specified key, or if the JSON Array contains the specified value.\
\
Usage\
\
@@ -14713,24 +14713,24 @@ json.contains.summary = \
Parameters\
\
\
- object - The JSON Object to test for the key.object - The JSON Object to test for the key.key - The key to check the object for.array - The JSON Array to test for the value.array - The JSON Array to test for the value.value - The value to check the array for.
\
\
Examples\
\
- Check if the JSON Object a contains the key "b":\
+ Check if the JSON Object a contains the key "b":\
[h:a=json.fromStrProp("a=1;b=44;c=12")]\
[json.contains(a,"b")]\
Returns true(1)\
-
Check if the JSON Object a contains the key "z":\
+
Check if the JSON Object a contains the key "z":\
\
[h:a=json.fromStrProp("a=1;b=44;c=12")]\
[json.contains(a,"z")]\
Returns false(0)\
-
Check if the JSON Array a contains the value "b":\
+
Check if the JSON Array a contains the value "b":\
\
[h:a=json.fromList("1,b,3,d")]\
[json.contains(a,"b")]\
@@ -14746,14 +14746,14 @@ Returns true(1)\
\
\
\
- - 1.3b51 - Added ability for function to work with JSON Arrays.
\
+ - 1.3b51 - Added ability for function to work with JSON Arrays.
\
\
\
\
\
-json.count.description = Returns the number of occurrences of a value in a JSON Array .
+json.count.description = Returns the number of occurrences of a value in a JSON Array .
json.count.summary = \
\
\
@@ -14762,7 +14762,7 @@ json.count.summary = \
json.count() Function\
\
• Introduced in version 1.3b53\
- Returns the number of occurrences of a value in a JSON Array. If the value does not occur in the JSON Array then 0 is returned. The index for the JSON Array starts at 0.\
+ Returns the number of occurrences of a value in a JSON Array. If the value does not occur in the JSON Array then 0 is returned. The index for the JSON Array starts at 0.\
\
Usage\
\
@@ -14776,7 +14776,7 @@ json.count.summary = \
Parameters\
\
\
- array - The JSON Array to search.array - The JSON Array to search.value - The value to count the occurrences of.start - The index to start searching from, if not specified it defaults to 0.
\
@@ -14800,7 +14800,7 @@ Returns 2\
\
-json.difference.description = Returns an array with the differences of all of the JSON Object keys, or JSON Array values.
+json.difference.description = Returns an array with the differences of all of the JSON Object keys, or JSON Array values.
json.difference.summary = \
\
\
@@ -14809,7 +14809,7 @@ json.difference.summary = \
json.difference() Function\
\
• Introduced in version 1.3b53\
- Returns an array with the differences of all of the JSON Object keys, or JSON Array values. Output contains keys or values which exist in the first parameter, but do not exist in any others.\
+ Returns an array with the differences of all of the JSON Object keys, or JSON Array values. Output contains keys or values which exist in the first parameter, but do not exist in any others.\
\
Usage\
\
@@ -14823,8 +14823,8 @@ json.difference.summary = \
Parameter\
\
\
- array - A JSON Array to get the difference of.object - A JSON Object to get the difference of.array - A JSON Array to get the difference of.object - A JSON Object to get the difference of.
\
\
Example\
@@ -14882,7 +14882,7 @@ json.evaluate.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b51\
@@ -14924,7 +14924,7 @@ json.evaluate.summary = \
\
-json.fields.description = Returns the fields (keys) for a JSON Object or the indexes for a JSON Array as a string list.
+json.fields.description = Returns the fields (keys) for a JSON Object or the indexes for a JSON Array as a string list.
json.fields.summary = \
\
\
@@ -14933,8 +14933,8 @@ json.fields.summary = \
json.fields() Function\
\
• Introduced in version 1.3b49\
- Returns the fields (keys) for a JSON Object or the indexes for a JSON Array as a string list. The type of the value returned depends on the delimiter parameter.\
-Note: Because JSON Objects are unordered, json.fields will not reflect the order they were set in.\
+ Returns the fields (keys) for a JSON Object or the indexes for a JSON Array as a string list. The type of the value returned depends on the delimiter parameter.\
+Note: Because JSON Objects are unordered, json.fields will not reflect the order they were set in.\
\
Usage\
\
@@ -14949,7 +14949,7 @@ json.fields.summary = \
\
\
delim =\
-unspecified: a standard string list is returned, with its default "," delimiter."json": a JSON Array is returned."x": a string list is returned with "x" used as a delimiter.
unspecified: a standard string list is returned, with its default "," delimiter."json": a JSON Array is returned."x": a string list is returned with "x" used as a delimiter.
\
\
\
Example\
@@ -14968,7 +14968,7 @@ json.fields.summary = \
\
-json.fromList.description = Returns a JSON Array from a String List .
+json.fromList.description = Returns a JSON Array from a String List .
json.fromList.summary = \
\
\
@@ -14977,7 +14977,7 @@ json.fromList.summary = \
json.fromList() Function\
\
• Introduced in version 1.3b49\
- Returns a JSON Array from a String List.\
+ Returns a JSON Array from a String List.\
\
Usage\
\
@@ -14991,8 +14991,8 @@ json.fromList.summary = \
Parameters\
\
\
- strList - The String List that is converted to a JSON Array.delim - The delimiter used in the String List, defaults to ",".strList - The String List that is converted to a JSON Array.delim - The delimiter used in the String List, defaults to ",".
\
\
Example\
@@ -15009,7 +15009,7 @@ Returns ["a",1,"g",4]
\
\
-json.fromStrProp.description = Creates a json object from a string property list .
+json.fromStrProp.description = Creates a json object from a string property list .
json.fromStrProp.summary = \
\
\
@@ -15018,7 +15018,7 @@ json.fromStrProp.summary = \
json.fromStrProp() Function\
\
• Introduced in version 1.3b49\
- Creates a json object from a string property list.\
+ Creates a json object from a string property list.\
\
Usage\
\
@@ -15043,7 +15043,7 @@ json.fromStrProp(propList,delim)\
\
-json.get.description = Returns the value in a JSON Array at the specified index, returns a slice of a JSON Array from the specified indexes, or returns the value from JSON Object for the specified key.
+json.get.description = Returns the value in a JSON Array at the specified index, returns a slice of a JSON Array from the specified indexes, or returns the value from JSON Object for the specified key.
json.get.summary = \
\
\
@@ -15052,7 +15052,7 @@ json.get.summary = \
json.get() Function\
\
• Introduced in version 1.3b49\
- Returns the value in a JSON Array at the specified index, returns a slice of a JSON Array from the specified indexes, or returns the value from JSON Object for the specified key.\
+ Returns the value in a JSON Array at the specified index, returns a slice of a JSON Array from the specified indexes, or returns the value from JSON Object for the specified key.\
\
Usage\
\
@@ -15069,12 +15069,12 @@ json.get.summary = \
Parameters\
\
\
- array - The JSON Array to retrieve the element from.array - The JSON Array to retrieve the element from.index - The numerical index of the element you want returned.start - The starting index of the element you wish the slice to begin at.end - The ending index of the element you wish the slice to end at.object - The JSON Object to retrieve the element from.key - The name of a field that should be returned. This parameter can exist more than once, if it does then a JSON Object is returned with all the specified elements.object - The JSON Object to retrieve the element from.key - The name of a field that should be returned. This parameter can exist more than once, if it does then a JSON Object is returned with all the specified elements.
\
When extracting slices:
\
Negative numbers can be used as the offsets from the end of the array. -1 is the last element in the array, -2 is the second to last, and so on. If the element specified by the start index and the element specified by the end index are located in reverse order in array (so reading from left to right end comes before start), then the array slice is returned in reverse order compared to array (because fetching from start to end means reading backwards).
\
@@ -15126,8 +15126,8 @@ ERROR b) -- java.lang.ArrayIndexOutOfBoundsException, the last valid index is 2\
\
\
\
- - 1.3b51 - Added ability to return JSON Array slices.
\
- - 1.3b51 - Added ability to return JSON Objects of select fields from other JSON Objects.
\
+ - 1.3b51 - Added ability to return JSON Array slices.
\
+ - 1.3b51 - Added ability to return JSON Objects of select fields from other JSON Objects.
\
\
\
\
@@ -15165,7 +15165,7 @@ Formatting will not appear unless the function is surrounded by the "pre" html t
\
-json.indexOf.description = Returns the index of the first occurrence of a value in the JSON Array .
+json.indexOf.description = Returns the index of the first occurrence of a value in the JSON Array .
json.indexOf.summary = \
\
\
@@ -15174,7 +15174,7 @@ json.indexOf.summary = \
json.indexOf() Function\
\
• Introduced in version 1.3b53\
- Returns the index of the first occurrence of a value in the JSON Array. If the value does not exist in the JSON Array then -1 is returned. All JSON Array indexes start at 0.\
+ Returns the index of the first occurrence of a value in the JSON Array. If the value does not exist in the JSON Array then -1 is returned. All JSON Array indexes start at 0.\
\
Usage\
\
@@ -15188,8 +15188,8 @@ json.indexOf.summary = \
Parameters\
\
\
- array - The JSON Array to search.value - The value to find the index of in the JSON Array.array - The JSON Array to search.value - The value to find the index of in the JSON Array.start - The index to start searching from, if not specified it defaults to 0.
\
\
@@ -15228,7 +15228,7 @@ Returns: 2
\
\
-json.intersection.description = Returns a JSON Array with the intersection of all of the JSON Object keys or JSON Array values.
+json.intersection.description = Returns a JSON Array with the intersection of all of the JSON Object keys or JSON Array values.
json.intersection.summary = \
\
\
@@ -15237,7 +15237,7 @@ json.intersection.summary = \
json.intersection() Function\
\
• Introduced in version 1.3b53\
- Returns a JSON Array with the intersection of all of the JSON Object keys or JSON Array values. A value or key only appears in the output if it exists in all input arrays or objects.\
+ Returns a JSON Array with the intersection of all of the JSON Object keys or JSON Array values. A value or key only appears in the output if it exists in all input arrays or objects.\
This function is useful for removing Token IDs from a saved list which have been deleted from the map by eliminating them using this function, the saved array and getTokens().\
\
Usage\
@@ -15252,8 +15252,8 @@ This function is useful for removing Token IDs from a saved list which have been
Parameters\
\
\
- array - A JSON Array used in the intersection.object - A JSON Object used in the intersection.array - A JSON Array used in the intersection.object - A JSON Object used in the intersection.
\
\
Examples\
@@ -15306,7 +15306,7 @@ json.isEmpty.summary = \
\
-json.isSubset.description = Returns true ( 1 ) if all of the JSON Object keys or JSON Array values are contained within the first JSON Object or JSON Array .
+json.isSubset.description = Returns true ( 1 ) if all of the JSON Object keys or JSON Array values are contained within the first JSON Object or JSON Array .
json.isSubset.summary = \
\
\
@@ -15315,7 +15315,7 @@ json.isSubset.summary = \
json.isSubset() Function\
\
• Introduced in version 1.3b53\
- Returns true(1) if all of the JSON Object keys or JSON Array values are contained within the first JSON Object or JSON Array.\
+ Returns true(1) if all of the JSON Object keys or JSON Array values are contained within the first JSON Object or JSON Array.\
\
Usage\
\
@@ -15329,10 +15329,10 @@ json.isSubset.summary = \
Parameters\
\
\
- firstArray - The JSON Array that must contain all of the values of the subsequent JSON Arrays for this function to return true(1).array - A JSON Array with values that are tested to be within the firstArray.firstObject - The JSON Object that must contain all of the keys of the subsequent JSON Objects for this function to return true(1).object - A JSON Object with keys that are tested to be within the firstObject.firstArray - The JSON Array that must contain all of the values of the subsequent JSON Arrays for this function to return true(1).array - A JSON Array with values that are tested to be within the firstArray.firstObject - The JSON Object that must contain all of the keys of the subsequent JSON Objects for this function to return true(1).object - A JSON Object with keys that are tested to be within the firstObject.
\
\
\
@@ -15347,7 +15347,7 @@ json.isSubset.summary = \
\
-json.length.description = Returns the number of fields in a json object or number of elements in a json array .
+json.length.description = Returns the number of fields in a json object or number of elements in a json array .
json.length.summary = \
\
\
@@ -15356,7 +15356,7 @@ json.length.summary = \
json.length() Function\
\
• Introduced in version 1.3b49\
- Returns the number of fields in a json object or number of elements in a json array.\
+ Returns the number of fields in a json object or number of elements in a json array.\
\
Usage\
\
@@ -15381,7 +15381,7 @@ json.length.summary = \
\
-json.merge.description = Merges multiple JSON Arrays or JSON Objects .
+json.merge.description = Merges multiple JSON Arrays or JSON Objects .
json.merge.summary = \
\
\
@@ -15390,10 +15390,10 @@ json.merge.summary = \
json.merge() Function\
\
• Introduced in version 1.3b53\
- Merges multiple JSON Arrays or JSON Objects.\
-For JSON Arrays the value returned is that of all the JSON Arrays concatenated together.\
+
Merges multiple JSON Arrays or JSON Objects.\
+For JSON Arrays the value returned is that of all the JSON Arrays concatenated together.\
\
-For JSON Objects the value returned is a JSON Object with all of the keys from all of the JSON Objects set, if any key is specified in more than one JSON Object then the value for the last specified JSON Object is used.\
+For JSON Objects the value returned is a JSON Object with all of the keys from all of the JSON Objects set, if any key is specified in more than one JSON Object then the value for the last specified JSON Object is used.\
\
Usage\
\
@@ -15407,20 +15407,20 @@ For Parameters\
\
\
- array - A JSON Array.object - A JSON Object.array - A JSON Array.object - A JSON Object.
\
\
Examples\
\
- Merge three JSON Arrays:\
+ Merge three JSON Arrays:\
[r: json.merge("[1,2]", "[3,4]", "[1,2]")]\
Returns: [1,2,3,4,1,2]\
-
Merge two JSON Objects with no matching keys:\
+
Merge two JSON Objects with no matching keys:\
\
[r: json.merge("{a:1, b:2}", "{c:10, d:7}")]\
Returns: {"a":1,"b":2,"c":10,"d":7} \
-
Merge three JSON Objects with a matching key, a:\
+
Merge three JSON Objects with a matching key, a:\
\
[r: json.merge("{a:1, b:2}", "{c:10, d:7}", "{a:11, z:7}")]\
Returns: {"a":11,"b":2,"c":10,"d":7,"z":7} \
@@ -15433,7 +15433,7 @@ Returns: {"a":11,"b":2,"c":10,"d":7,"z":7} \
\
\
\
- - 1.3b54 - Fixed bug which allows
json.merge() to work correctly with JSON Objects. \
+ - 1.3b54 - Fixed bug which allows
json.merge() to work correctly with JSON Objects. \
\
\
\
@@ -15536,12 +15536,12 @@ json.objrolls.summary = \
\
See Also\
\
- \
+ \
\
\
-json.path.add.description = Add an element to a nested JSON Array .
+json.path.add.description = Add an element to a nested JSON Array .
json.path.add.summary = \
\
\
@@ -15550,7 +15550,7 @@ json.path.add.summary = \
json.path.add() Function\
\
• Introduced in version 1.5.5\
- Add an element to a nested JSON Array. Additional information on how to specify the path is available here.\
+ Add an element to a nested JSON Array. Additional information on how to specify the path is available here.\
\
Usage\
\
@@ -15561,8 +15561,8 @@ json.path.add.summary = \
Parameters\
\
\
- json - The json element in which the JSON Array is nested.path - The path to the JSON Array.json - The json element in which the JSON Array is nested.path - The path to the JSON Array.value - The value to add to the array.
\
\
@@ -15579,7 +15579,7 @@ json.path.add.summary = \
\
-json.path.delete.description = Returns a JSON Array or JSON Object with deleted elements.
+json.path.delete.description = Returns a JSON Array or JSON Object with deleted elements.
json.path.delete.summary = \
\
\
@@ -15588,7 +15588,7 @@ json.path.delete.summary = \
json.path.delete() Function\
\
• Introduced in version 1.5.5\
- Returns a JSON Array or JSON Object with deleted elements. These deletions are specified through the path parameter. Additional information on how to specify the path is availabe here.\
+ Returns a JSON Array or JSON Object with deleted elements. These deletions are specified through the path parameter. Additional information on how to specify the path is availabe here.\
\
Usage\
\
@@ -15622,7 +15622,7 @@ json.path.delete.summary = \
\
-json.path.put.description = Create or update the key with the given value at the given path of a nested JSON Object .
+json.path.put.description = Create or update the key with the given value at the given path of a nested JSON Object .
json.path.put.summary = \
\
\
@@ -15631,7 +15631,7 @@ json.path.put.summary = \
json.path.put() Function\
\
• Introduced in version 1.5.5\
- Create or update the key with the given value at the given path of a nested JSON Object. json.path.put() is only used creating/updating name/value pairs in JSON Objects. See json.path.set() for creating/updated values in arrays. Additional information on how to specify the path is available here.\
+ Create or update the key with the given value at the given path of a nested JSON Object. json.path.put() is only used creating/updating name/value pairs in JSON Objects. See json.path.set() for creating/updated values in arrays. Additional information on how to specify the path is available here.\
\
Usage\
\
@@ -15642,9 +15642,9 @@ json.path.put.summary = \
Parameters\
\
\
- json - The json element in which the JSON Object is nested.path - The path to the JSON Object.key - The key of the JSON Object.json - The json element in which the JSON Object is nested.path - The path to the JSON Object.key - The key of the JSON Object.value - The value to associated with the key.
\
\
@@ -15668,7 +15668,7 @@ json.path.put.summary = \
\
-json.path.read.description = Returns the values in a nested JSON Array or JSON Object corresponding to the provided path.
+json.path.read.description = Returns the values in a nested JSON Array or JSON Object corresponding to the provided path.
json.path.read.summary = \
\
\
@@ -15677,7 +15677,7 @@ json.path.read.summary = \
json.path.read() Function\
\
• Introduced in version 1.5.5\
- Returns the values in a nested JSON Array or JSON Object corresponding to the provided path. It is unnecessary to include the root node operator $ at the beginning of the requested path. To do so, you must escape the dollar sign like this: \$.path.to.read. The json.path functions support both dot, Monsters.Orc.Attacks, and bracket, ['Monsters']['Orc']['Attacks'], notation.\
+ Returns the values in a nested JSON Array or JSON Object corresponding to the provided path. It is unnecessary to include the root node operator $ at the beginning of the requested path. To do so, you must escape the dollar sign like this: \$.path.to.read. The json.path functions support both dot, Monsters.Orc.Attacks, and bracket, ['Monsters']['Orc']['Attacks'], notation.\
For detailed information on how to specify the path, please read the JsonPath ReadMe.\
\
Usage\
@@ -15693,7 +15693,7 @@ json.path.read(json, path, config)\
json - The json data to get the values from.path - The path of the value(s) to retrieve.config - A String containing configuration options separated by a comma. The options can include\
-ALWAYS_RETURN_LIST - Always return the results in a JSON Array, even when the path is definite.AS_PATH_LIST - Return a JSON Array of path strings representing the path of the evaluation hits.DEFAULT_PATH_LEAF_TO_NULL - Return null when the given path almost exists but ends with a JSON Object key that is missing. Without this configuration, a definite path will return an error. With this configuration, an indefinite path will include null in the JSON Array if the key is missing. Without this configuration or if any other kind of nonexistent path structure is provided, an indefinite path will simply not match and return an empty JSON Array or less results in the JSON Array.REQUIRE_PROPERTIES - When an indefinite path is evaluated and ends in a key, all matching JSON Objects must have that key, otherwise an error is returned. This are the cases where DEFAULT_PATH_LEAF_TO_NULL will return null instead.SUPPRESS_EXCEPTIONS - Suppress all exceptions when evaluating paths. If ALWAYS_RETURN_LIST is also used return an empty list. Otherwise return null.
ALWAYS_RETURN_LIST - Always return the results in a JSON Array, even when the path is definite.AS_PATH_LIST - Return a JSON Array of path strings representing the path of the evaluation hits.DEFAULT_PATH_LEAF_TO_NULL - Return null when the given path almost exists but ends with a JSON Object key that is missing. Without this configuration, a definite path will return an error. With this configuration, an indefinite path will include null in the JSON Array if the key is missing. Without this configuration or if any other kind of nonexistent path structure is provided, an indefinite path will simply not match and return an empty JSON Array or less results in the JSON Array.REQUIRE_PROPERTIES - When an indefinite path is evaluated and ends in a key, all matching JSON Objects must have that key, otherwise an error is returned. This are the cases where DEFAULT_PATH_LEAF_TO_NULL will return null instead.SUPPRESS_EXCEPTIONS - Suppress all exceptions when evaluating paths. If ALWAYS_RETURN_LIST is also used return an empty list. Otherwise return null.
\
\
See the Jayway javadoc page for more info.\
\
@@ -15728,7 +15728,7 @@ which returns ["Troll"]. Note the use of bracket notation for the p
\
-json.path.set.description = Change an element in a nested JSON Array .
+json.path.set.description = Change an element in a nested JSON Array .
json.path.set.summary = \
\
\
@@ -15737,7 +15737,7 @@ json.path.set.summary = \
json.path.set() Function\
\
• Introduced in version 1.5.5\
- Change an element in a nested JSON Array. Additional information on how to specify the path is available here.\
+ Change an element in a nested JSON Array. Additional information on how to specify the path is available here.\
\
Usage\
\
@@ -15748,8 +15748,8 @@ json.path.set.summary = \
Parameters\
\
\
- json - The json element in which the JSON Array is nested.path - The path to the element in the JSON Array.json - The json element in which the JSON Array is nested.path - The path to the element in the JSON Array.value - The value to change.
\
\
@@ -15769,7 +15769,7 @@ json.path.set.summary = \
\
-json.remove.description = Removes a field from a JSON Object , or the value at the specified index from a JSON Array .
+json.remove.description = Removes a field from a JSON Object , or the value at the specified index from a JSON Array .
json.remove.summary = \
\
\
@@ -15778,7 +15778,7 @@ json.remove.summary = \
json.remove() Function\
\
• Introduced in version 1.3b49\
- Removes a field from a JSON Object, or the value at the specified index from a JSON Array.\
+ Removes a field from a JSON Object, or the value at the specified index from a JSON Array.\
\
Usage\
\
@@ -15798,7 +15798,7 @@ json.remove.summary = \
\
-json.removeAll.description = Removes all the keys or values from the first JSON Object or JSON Array that occur in the following JSON Objects or JSON Arrays .
+json.removeAll.description = Removes all the keys or values from the first JSON Object or JSON Array that occur in the following JSON Objects or JSON Arrays .
json.removeAll.summary = \
\
\
@@ -15807,7 +15807,7 @@ json.removeAll.summary = \
json.removeAll() Function\
\
• Introduced in version 1.3b53\
- Removes all the keys or values from the first JSON Object or JSON Array that occur in the following JSON Objects or JSON Arrays.\
+ Removes all the keys or values from the first JSON Object or JSON Array that occur in the following JSON Objects or JSON Arrays.\
\
Usage\
\
@@ -15821,10 +15821,10 @@ json.removeAll.summary = \
Parameters\
\
\
- firstArray - The JSON Array to remove the occurrences from.array - The JSON Arrays to get the occurrences from.firstObject - The JSON Object to remove the occurrences from.object - The JSON Objects to get the occurrences from.firstArray - The JSON Array to remove the occurrences from.array - The JSON Arrays to get the occurrences from.firstObject - The JSON Object to remove the occurrences from.object - The JSON Objects to get the occurrences from.
\
\
\
@@ -15894,7 +15894,7 @@ json.removeFirst.summary = \
\
See Also\
\
- \
+ \
\
\
@@ -15971,12 +15971,12 @@ The three parameter version returns a two dimensional array\
\
See Also\
\
- \
+ \
\
\
-json.set.description = Sets the value in at the specified index in a JSON Array or for the specified key in a JSON Object .
+json.set.description = Sets the value in at the specified index in a JSON Array or for the specified key in a JSON Object .
json.set.summary = \
\
\
@@ -15985,7 +15985,7 @@ json.set.summary = \
json.set() Function\
\
• Introduced in version 1.3b49\
- Sets the value in at the specified index in a JSON Array or for the specified key in a JSON Object. You can use an empty string ("") to represent a new JSON Array or JSON Object.\
+ Sets the value in at the specified index in a JSON Array or for the specified key in a JSON Object. You can use an empty string ("") to represent a new JSON Array or JSON Object.\
\
Usage\
\
@@ -16008,9 +16008,9 @@ json.set.summary = \
Parameters\
\
\
- jarr - The JSON Array that has an index's value set.jarr - The JSON Array that has an index's value set.index - The numeric index which has its value set.jobj - The JSON Object that has a key's value set.jobj - The JSON Object that has a key's value set.key - The named key which has its value set.value - The content that is set to the index or key.
\
@@ -16029,7 +16029,7 @@ json.set.summary = \
{"a":5}\
{"a":5, "b":8}\
[8, 3]\
-To save the new value in the JSON Array or JSON Object so that you can reference it later in a macro, you must set the array equal to the result of json.set().\
+
To save the new value in the JSON Array or JSON Object so that you can reference it later in a macro, you must set the array equal to the result of json.set().\
[myArray = json.append("", 1, 2, 3)]\
[myArray = json.set(myArray, 0, 5)]\
[myArray]Returns\
@@ -16092,7 +16092,7 @@ json.sort.summary = \
\
json.sort(array, direction)
\
\
- If you have a JSON Array that contains JSON Objects\
+
If you have a JSON Array that contains JSON Objects\
\
\
json.sort(array, direction, key1, ..., keyN)
\
@@ -16104,15 +16104,15 @@ json.sort.summary = \
array - The JSON array to sort.direction - Defaults to "ascending", acceptable values:\
"ascending""descending""ascend""descend""asc""desc""a""d"
key1, ..., keyN - The keys in the JSON Objects contained within the JSON Array used for sorting. All JSON Objects must contain these fields.key1, ..., keyN - The keys in the JSON Objects contained within the JSON Array used for sorting. All JSON Objects must contain these fields.\
Examples\
\
- Sorting a JSON Array containing numbers.\
+ Sorting a JSON Array containing numbers.\
[json.sort("[1,4,5,6,2,1,9,20,1]")]\
Produces [1,1,1,2,4,5,6,9,20]\
-
Sorting a JSON Array containing strings.\
+
Sorting a JSON Array containing strings.\
\
[json.sort("['Hero', 'Dragon', 'Elf', 'Wolf', 'Mage', 'Eagle', 'Troll']")]\
Produces ["Dragon","Eagle","Elf","Hero","Mage","Troll","Wolf"]\
@@ -16153,7 +16153,7 @@ json.sort.summary = \
\
-json.subset.description = Returns true ( 1 ) if all of the JSON Object keys or JSON Array values are contained within the first JSON Object or JSON Array .
+json.subset.description = Returns true ( 1 ) if all of the JSON Object keys or JSON Array values are contained within the first JSON Object or JSON Array .
json.subset.summary = \
\
\
@@ -16162,7 +16162,7 @@ json.subset.summary = \
json.isSubset() Function\
\
• Introduced in version 1.3b53\
- Returns true(1) if all of the JSON Object keys or JSON Array values are contained within the first JSON Object or JSON Array.\
+ Returns true(1) if all of the JSON Object keys or JSON Array values are contained within the first JSON Object or JSON Array.\
\
Usage\
\
@@ -16176,10 +16176,10 @@ json.subset.summary = \
Parameters\
\
\
- firstArray - The JSON Array that must contain all of the values of the subsequent JSON Arrays for this function to return true(1).array - A JSON Array with values that are tested to be within the firstArray.firstObject - The JSON Object that must contain all of the keys of the subsequent JSON Objects for this function to return true(1).object - A JSON Object with keys that are tested to be within the firstObject.firstArray - The JSON Array that must contain all of the values of the subsequent JSON Arrays for this function to return true(1).array - A JSON Array with values that are tested to be within the firstArray.firstObject - The JSON Object that must contain all of the keys of the subsequent JSON Objects for this function to return true(1).object - A JSON Object with keys that are tested to be within the firstObject.
\
\
\
@@ -16194,7 +16194,7 @@ json.subset.summary = \
\
-json.toList.description = Creates a string list from a JSON Array .
+json.toList.description = Creates a string list from a JSON Array .
json.toList.summary = \
\
\
@@ -16203,7 +16203,7 @@ json.toList.summary = \
json.toList() Function\
\
• Introduced in version 1.3b49\
- Creates a string list from a JSON Array. If the delimiter is not specified then the default value of ',' is used.\
+ Creates a string list from a JSON Array. If the delimiter is not specified then the default value of ',' is used.\
\
Usage\
\
@@ -16236,7 +16236,7 @@ json.toList.summary = \
\
-json.toStrProp.description = Creates a string list from a json object or json array using the specified delimiter in the result.
+json.toStrProp.description = Creates a string list from a json object or json array using the specified delimiter in the result.
json.toStrProp.summary = \
\
\
@@ -16245,7 +16245,7 @@ json.toStrProp.summary = \
json.toStrProp() Function\
\
• Introduced in version 1.3b49\
- Creates a string list from a json object or json array using the specified delimiter in the result. If a delimiter is not provided then the default value of ';' is used.\
+ Creates a string list from a json object or json array using the specified delimiter in the result. If a delimiter is not provided then the default value of ';' is used.\
\
Usage\
\
@@ -16279,7 +16279,7 @@ json.toStrProp.summary = \
\
-json.toVars.description = Creates variables from a from a JSON Object or JSON Array .
+json.toVars.description = Creates variables from a from a JSON Object or JSON Array .
json.toVars.summary = \
\
\
@@ -16288,7 +16288,7 @@ json.toVars.summary = \
json.toVars() Function\
\
• Introduced in version 1.5.5\
- Creates variables from a from a JSON Object or JSON Array. For a JSON object the names of the variables are the keys of the object, while the variables are assigned the values of the object. Characters in key values that are not allowed in MTScript variable names will be replaced with underscores. For a JSON array, only the values are passed in and the variable names will be created from the 2nd parameter suffixed with a number.\
+ Creates variables from a from a JSON Object or JSON Array. For a JSON object the names of the variables are the keys of the object, while the variables are assigned the values of the object. Characters in key values that are not allowed in MTScript variable names will be replaced with underscores. For a JSON array, only the values are passed in and the variable names will be created from the 2nd parameter suffixed with a number.\
\
Usage\
\
@@ -16392,7 +16392,7 @@ json.type.summary = \
Returns a string which contains the type of JSON variable that is passed in.\
Return values are\
\
-ARRAY - The object is a JSON Array.OBJECT - The object is a JSON Object.UNKNOWN - It is neither a JSON Array nor JSON Object.
\
+ARRAY - The object is a JSON Array.OBJECT - The object is a JSON Object.UNKNOWN - It is neither a JSON Array nor JSON Object.
\
\
\
Usage\
@@ -16414,7 +16414,7 @@ UNKNOWN
\
\
-json.union.description = Returns an JSON Array with the union of all of the JSON Object keys, or JSON Array values.
+json.union.description = Returns an JSON Array with the union of all of the JSON Object keys, or JSON Array values.
json.union.summary = \
\
\
@@ -16423,7 +16423,7 @@ json.union.summary = \
json.union() Function\
\
• Introduced in version 1.3b53\
- Returns an JSON Array with the union of all of the JSON Object keys, or JSON Array values. If a value or a key occurs in multiple different objects or arrays, it will only be placed once in the output object or array.\
+ Returns an JSON Array with the union of all of the JSON Object keys, or JSON Array values. If a value or a key occurs in multiple different objects or arrays, it will only be placed once in the output object or array.\
\
Usage\
\
@@ -16437,8 +16437,8 @@ json.union.summary = \
Parameters\
\
\
- array - The JSON Arrays to union.object - The JSON Objects to union.array - The JSON Arrays to union.object - The JSON Objects to union.
\
\
Examples\
@@ -16456,7 +16456,7 @@ json.union.summary = \
\
-json.unique.description = Returns a JSON Array with each value that occurs in the source JSON Array occurring only once.
+json.unique.description = Returns a JSON Array with each value that occurs in the source JSON Array occurring only once.
json.unique.summary = \
\
\
@@ -16465,7 +16465,7 @@ json.unique.summary = \
json.unique() Function\
\
• Introduced in version 1.3b53\
- Returns a JSON Array with each value that occurs in the source JSON Array occurring only once. The relative order of the values in the array may not be preserved.\
+ Returns a JSON Array with each value that occurs in the source JSON Array occurring only once. The relative order of the values in the array may not be preserved.\
\
Usage\
\
@@ -16476,13 +16476,13 @@ json.unique.summary = \
Parameters\
\
\
- array - The JSON Array to return only unique values from.array - The JSON Array to return only unique values from.
\
\
Example\
\
- Lets say you have a JSON Array that contains the following Token names: ["Hero", "Dragon"], and you use getPCNames() to return the names of\
-the PC Tokens, you could use the following code to generate a JSON Array that contains the values in both JSON Arrays with no value present more than once.\
+
Lets say you have a JSON Array that contains the following Token names: ["Hero", "Dragon"], and you use getPCNames() to return the names of\
+the PC Tokens, you could use the following code to generate a JSON Array that contains the values in both JSON Arrays with no value present more than once.\
\
[h: names1 = '["Hero", "Dragon"]']\
[h: names2 = getNPCNames()]\
@@ -16544,7 +16544,7 @@ Returns a number than is between 2 and 20, with a high
\
See Also\
\
- For another method of rolling dice, see Dice Expressions.\
+ For another method of rolling dice, see Dice Expressions.\
\
\
@@ -16589,7 +16589,7 @@ Returns a number than is between 3 and 30, with a low
\
See Also\
\
- For another method of rolling dice, see Dice Expressions.\
+ For another method of rolling dice, see Dice Expressions.\
\
Version Changes\
\
@@ -16705,7 +16705,7 @@ Returns 5\
\
-listAppend.description = Returns a string list with a value appended to the end of the string list .
+listAppend.description = Returns a string list with a value appended to the end of the string list .
listAppend.summary = \
\
\
@@ -16714,7 +16714,7 @@ listAppend.summary = \
listAppend() Function\
\
• Introduced in version 1.3b42\
- Returns a string list with a value appended to the end of the string list.\
+ Returns a string list with a value appended to the end of the string list.\
\
Usage\
\
@@ -16724,7 +16724,7 @@ listAppend.summary = \
\
listAppend(list, value, delim)
\
\
- If delim is not specified then the default value of ',' is used to separate the values in the string list\
+
If delim is not specified then the default value of ',' is used to separate the values in the string list\
\
\
Examples\
@@ -16736,7 +16736,7 @@ Returns This: is: a: test
\
\
-listContains.description = Returns the number of occurrences of a value in a String List .
+listContains.description = Returns the number of occurrences of a value in a String List .
listContains.summary = \
\
\
@@ -16745,7 +16745,7 @@ listContains.summary = \
listContains() Function\
\
• Introduced in version 1.3b42\
- Returns the number of occurrences of a value in a String List.\
+ Returns the number of occurrences of a value in a String List.\
\
Usage\
\
@@ -16757,9 +16757,9 @@ listContains(list, value, delim)\
Parameters\
\
\
- list - The String List that is checked for occurrences of the value.value - The value to search the String List for occurrences.delim - The delimiter that separates the values in the String List; defaults to ",".list - The String List that is checked for occurrences of the value.value - The value to search the String List for occurrences.delim - The delimiter that separates the values in the String List; defaults to ",".
\
\
Examples\
@@ -16778,7 +16778,7 @@ Returns 2
\
\
-listCount.description = Returns the number of items in a string list .
+listCount.description = Returns the number of items in a string list .
listCount.summary = \
\
\
@@ -16787,7 +16787,7 @@ listCount.summary = \
listCount() Function\
\
• Introduced in version 1.3b42\
- Returns the number of items in a string list.\
+ Returns the number of items in a string list.\
\
Usage\
\
@@ -16797,7 +16797,7 @@ listCount.summary = \
\
listCount(list, delim)
\
\
- If delim is not specified then the default value of ',' is used as the value separator in the string list\
+
If delim is not specified then the default value of ',' is used as the value separator in the string list\
\
\
Examples\
@@ -16809,7 +16809,7 @@ Returns 4
\
\
-listDelete.description = Returns a string list with the specified item deleted from it.
+listDelete.description = Returns a string list with the specified item deleted from it.
listDelete.summary = \
\
\
@@ -16818,7 +16818,7 @@ listDelete.summary = \
listDelete() Function\
\
• Introduced in version 1.3b42\
- Returns a string list with the specified item deleted from it. The index for the string list\
+ Returns a string list with the specified item deleted from it. The index for the string list\
\
Usage\
\
@@ -16828,7 +16828,7 @@ listDelete.summary = \
\
listDelete(list, index, delim)
\
\
- If delim is not specified then the default value of ',' is used as the value separator in the string list\
+
If delim is not specified then the default value of ',' is used as the value separator in the string list\
\
\
Example\
@@ -16839,7 +16839,7 @@ Returns This, a, test
\
\
-listFind.description = Returns the index of the first occurrence of a value in a string list .
+listFind.description = Returns the index of the first occurrence of a value in a string list .
listFind.summary = \
\
\
@@ -16848,7 +16848,7 @@ listFind.summary = \
listFind() Function\
\
• Introduced in version 1.3b42\
- Returns the index of the first occurrence of a value in a string list. If the value is not found then -1 is returned.\
+ Returns the index of the first occurrence of a value in a string list. If the value is not found then -1 is returned.\
\
Usage\
\
@@ -16858,7 +16858,7 @@ listFind.summary = \
\
listFind(list, value, delim)
\
\
- If delim is not specified then the default value of ',' is used as the value separator in the string list\
+
If delim is not specified then the default value of ',' is used as the value separator in the string list\
\
\
Examples\
@@ -16913,7 +16913,7 @@ The first argument is the list, returned by \
-listGet.description = Returns the value in the string list at the specified index.
+listGet.description = Returns the value in the string list at the specified index.
listGet.summary = \
\
\
@@ -16922,7 +16922,7 @@ listGet.summary = \
listGet() Function\
\
• Introduced in version 1.3b42\
- Returns the value in the string list at the specified index. The index for a string list starts at 0.\
+ Returns the value in the string list at the specified index. The index for a string list starts at 0.\
\
Usage\
\
@@ -16932,7 +16932,7 @@ listGet.summary = \
\
listGet(list, index, delim)
\
\
- If delim is not specified then the default value of ',' is used as the value separator in the string list\
+
If delim is not specified then the default value of ',' is used as the value separator in the string list\
\
\
Example\
@@ -16944,7 +16944,7 @@ Returns is
\
\
-listInsert.description = Inserts a value into the string list at the specified index.
+listInsert.description = Inserts a value into the string list at the specified index.
listInsert.summary = \
\
\
@@ -16953,7 +16953,7 @@ listInsert.summary = \
listInsert() Function\
\
• Introduced in version 1.3b42\
- Inserts a value into the string list at the specified index. If a delimiter is not specified then the default value of ',' is used. The index for lists starts at 0\
+ Inserts a value into the string list at the specified index. If a delimiter is not specified then the default value of ',' is used. The index for lists starts at 0\
\
Usage\
\
@@ -16973,7 +16973,7 @@ Returns This: is: a: test\
\
-listReplace.description = Replaces the element at the specified index of a String List with a new value.
+listReplace.description = Replaces the element at the specified index of a String List with a new value.
listReplace.summary = \
\
\
@@ -16982,7 +16982,7 @@ listReplace.summary = \
listReplace() Function\
\
• Introduced in version 1.3b42\
- Replaces the element at the specified index of a String List with a new value. If a delimiter is not specified then the default value of "," is used. The index for lists starts at 0.\
+ Replaces the element at the specified index of a String List with a new value. If a delimiter is not specified then the default value of "," is used. The index for lists starts at 0.\
\
Usage\
\
@@ -16996,8 +16996,8 @@ listReplace.summary = \
Examples\
\
Simple example:[r: listReplace("This, isnt, a , test", 1, "is")]Returns This, is, a, Test\
-
Example using a String List with a non-default delimiter:
[r: listReplace("This: isnt: a: test", 1, "is", ":")]Returns This: is: a: test\
-
Example using a String List stored in a variable:
[h: ListVar = "This, is, a, great, test"]\
+Example using a String List with a non-default delimiter:
[r: listReplace("This: isnt: a: test", 1, "is", ":")]Returns This: is: a: test\
+
Example using a String List stored in a variable:
[h: ListVar = "This, is, a, great, test"]\
[h: ListVar = listReplace(ListVar, 3, "silly")]\
[r: ListVar]
\
Returns: This, is, a, silly, test
\
@@ -17110,7 +17110,7 @@ log.debug.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.2\
@@ -17156,7 +17156,7 @@ log.error.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.2\
@@ -17202,7 +17202,7 @@ log.fatal.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.2\
@@ -17248,7 +17248,7 @@ log.getLoggers.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.2\
@@ -17318,7 +17318,7 @@ log.info.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.2\
@@ -17364,7 +17364,7 @@ log.setLevel.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.2\
@@ -17407,11 +17407,11 @@ log.setLevel.summary = \
[r: "Setting <i><b>" + lname + "</b></i> to <b>" + level + "</b>."]\
[h: log.setLevel(lname,level)]\
\
-\
+\
\
See Also\
\
- \
+ \
\
\
@@ -17426,7 +17426,7 @@ log.trace.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.7\
@@ -17472,7 +17472,7 @@ log.warn.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.2\
@@ -17618,7 +17618,7 @@ lt.summary = \
\
-macroLink.description = Creates the HTML for a link which will run the specified macro when clicked on in a frame , dialog , or the chat window.
+macroLink.description = Creates the HTML for a link which will run the specified macro when clicked on in a frame , dialog , or the chat window.
macroLink.summary = \
\
\
@@ -17627,7 +17627,7 @@ macroLink.summary = \
macroLink() Function\
\
• Introduced in version 1.3b48\
- Creates the HTML for a link which will run the specified macro when clicked on in a frame, dialog, or the chat window. Additionally, if you send the link to the chat window, it will automatically be executed by any recipients as soon as they receive it. This can be useful for popping up or updating frames or dialogs for your players. To auto-execute in the chat window, it must not be hidden by roll options like [h:], but may be hidden by being contained within an HTML comment.
\
+ Creates the HTML for a link which will run the specified macro when clicked on in a frame, dialog, or the chat window. Additionally, if you send the link to the chat window, it will automatically be executed by any recipients as soon as they receive it. This can be useful for popping up or updating frames or dialogs for your players. To auto-execute in the chat window, it must not be hidden by roll options like [h:], but may be hidden by being contained within an HTML comment.
\
Some notes on the auto execution
\
- If you refer to a macro on a lib:token it will automatically execute, however if you refer to a macro on the campaign panel, the macro is NOT automatically executed when sent to the chat.
- It will also not work if the owner of the lib:token is not an (online) GM, though as a general practice its best not to set ownership of lib:tokens at all.
- To prevent the macro from automatically executing you can turn off the 'auto execute' in the edit panel of the macro that you're linking to.
\
\
@@ -17655,24 +17655,24 @@ macroLink.summary = \
\
\
text - is the text to display for the link.macroName - is the name of the macro to run when the link is clicked. The macroName is in the same format that is used for [macro(...): ...] e.g. Test@Lib:test.macroName - is the name of the macro to run when the link is clicked. The macroName is in the same format that is used for [macro(...): ...] e.g. Test@Lib:test.output - contains who the output of the macro should go to, values are (defaults to "none"):\
-"self" - Display only to person who clicked on the link."gm" - Display to GM."all" - everyone (acts like a /say)."none" - discard any output."gm-self" - Display to GM and the person executing the link."list" - Displays to a list of players. When the output is set to "list" then the macro link expects the args parameter to be a JSON Object, that contains a field called mlOutputList which is a JSON Array containing the players to send the output to.
"self" - Display only to person who clicked on the link."gm" - Display to GM."all" - everyone (acts like a /say)."none" - discard any output."gm-self" - Display to GM and the person executing the link."list" - Displays to a list of players. When the output is set to "list" then the macro link expects the args parameter to be a JSON Object, that contains a field called mlOutputList which is a JSON Array containing the players to send the output to.
\
args - Any arguments to be passed to the macro when it is called.target - Which tokens to run the macro on. Target can be one or more of the following separated by commas (defaults to "impersonated"):\
-
\
\
Examples\
\
- * To create a link that will call a macro called Test on the Library Token named Lib:Test that says "Click on me!" and displays the output to the GM.\
+ * To create a link that will call a macro called Test on the Library Token named Lib:Test that says "Click on me!" and displays the output to the GM.\
[r: macroLink("Click on me!", "Test@Lib:Test", "gm", "count=6", "impersonated")]
\
produces this output:<ahref="macro://Test@Lib:Test/gm/impersonated?count=6;">Click on me!</a>
\
- Sending to multiple players and the GM in 1.3b55
\
[h: outputTo = '["Fred", "Barney", "gm"]']\
[h: args = json.set("{}", "mlOutputList", outputTo)]\
[r: macroLink("Click on me!", "Test@Lib:Test", "list", args)]
\
-- Updating a character sheet frame without displaying the link:
\
+- Updating a character sheet frame without displaying the link:
\
Took 4 points of damage.<!-- [r: macroLink("Update Character Sheet", "Update Character Sheet@Lib:Test")] -->
\
- An example of a longer custom macrolink:
\
This is a link that is user created to send several variables to the AttackMacro. Each variable must be separated by a & sign. Spaces within text must be replaced with a + sign. Plus sign can't be sent, you might want to use the html code for plus sign (&27;) instead of +.\
@@ -17714,7 +17714,7 @@ macroLinkText.summary = \
macroLinkText() Function\
\
• Introduced in version 1.3b48\
- Creates the text that would appear in a HTML tag for a link which will run the specified macro when clicked on. This is useful for callbacks in [dialog():] or [frame():]. If you just want to send a click-able link to someone use macroLink().\
+ Creates the text that would appear in a HTML tag for a link which will run the specified macro when clicked on. This is useful for callbacks in [dialog():] or [frame():]. If you just want to send a click-able link to someone use macroLink().\
\
Usage\
\
@@ -17736,21 +17736,21 @@ macroLinkText.summary = \
\
macroName - The name of the macro to run when the link is clicked. The macroName is in the standard macro reference format (e.g. Macro@Lib:Token)output - Who the output of the macro should go to, values are (defaults to none):\
-self - Display only to person who clicked on the link.gm - Display to GM.all - Everyone (acts like a /say)none - Discard any output.gm-self - Display to GM and the person executing the link.list - Displays to a list of players. When the output parameter is "list" then the macro link expects the args parameter to be a JSON Object, that contains a field called mlOutputList which is a JSON Array containing the players to send the output to.
self - Display only to person who clicked on the link.gm - Display to GM.all - Everyone (acts like a /say)none - Discard any output.gm-self - Display to GM and the person executing the link.list - Displays to a list of players. When the output parameter is "list" then the macro link expects the args parameter to be a JSON Object, that contains a field called mlOutputList which is a JSON Array containing the players to send the output to.
\
args - Any arguments to be passed to the macro when it is called.target - Which tokens to run the macro on. Target can be one or more of the following separated by commas (defaults to impersonated):\
-
\
\
Examples\
\
- To create the text that would go inside a form element as the action attribute, and that will call a macro named Test on the Library Token named Lib:Test:\
+ To create the text that would go inside a form element as the action attribute, and that will call a macro named Test on the Library Token named Lib:Test:\
[r: macroLinkText("Test@Lib:Test","", "gm")]\
Returns: macro://Test@Lib:Test/gm/impersonated?\
-
To create the text that would go inside a form element as the action attribute and call the AddWeapon on the Library Token named Lib:PC which will act upon the Current Token:\
+
To create the text that would go inside a form element as the action attribute and call the AddWeapon on the Library Token named Lib:PC which will act upon the Current Token:\
\
[r:macroLinkText('AddWeapon@Lib:PC', 'none', '', currentToken())]\
-Returns: macro://AddWeapon@Lib:PC/none/#ID#? where #ID# is the id of the Current Token.\
+
Returns: macro://AddWeapon@Lib:PC/none/#ID#? where #ID# is the id of the Current Token.\
Sending to multiple players and the GM in 1.3b55\
\
[h: outputTo = '["Fred", "Barney", "gm"]']\
@@ -17852,7 +17852,7 @@ markdownToHTML(string, type)
\
\
Examples\
\
- Retrieve the text stored in the current token's Notes and convert them to HTML for display inside a frame5().\
+ Retrieve the text stored in the current token's Notes and convert them to HTML for display inside a frame5().\
[frame5("Notes", "title=" + token.name): {<br>\
[r: markdownToHTML(getNotes())]\
}]\
@@ -17878,7 +17878,7 @@ matches.summary = \
matches() Function\
\
• Introduced in version 1.3b48\
- Returns 1 if a string matches pattern or 0 if it does not. The pattern can be a regular expression. Matches performs a while string comparison, so the pattern must match the whole of the input string and not only part of it.\
+ Returns 1 if a string matches pattern or 0 if it does not. The pattern can be a regular expression. Matches performs a while string comparison, so the pattern must match the whole of the input string and not only part of it.\
\
Usage\
\
@@ -18200,7 +18200,7 @@ Returns: 8.0\
\
-math.listMax.description = Find the maximum value in a String List .
+math.listMax.description = Find the maximum value in a String List .
math.listMax.summary = \
\
\
@@ -18209,7 +18209,7 @@ math.listMax.summary = \
math.listMax() Function\
\
• Introduced in version 1.7\
- Find the maximum value in a String List. Only allows numeric elements - any non-numeric values will produce an error.\
+ Find the maximum value in a String List. Only allows numeric elements - any non-numeric values will produce an error.\
\
Usage\
\
@@ -18237,7 +18237,7 @@ math.listMax.summary = \
\
-math.listMean.description = Calculates the arithmetic mean of the contents of a String List .
+math.listMean.description = Calculates the arithmetic mean of the contents of a String List .
math.listMean.summary = \
\
\
@@ -18246,7 +18246,7 @@ math.listMean.summary = \
math.listMean() Function\
\
• Introduced in version 1.7\
- Calculates the arithmetic mean of the contents of a String List. Only allows numeric elements - any non-numeric values will produce an error. The mean is equal to the sum of all the list's contents divided by the number of elements.\
+ Calculates the arithmetic mean of the contents of a String List. Only allows numeric elements - any non-numeric values will produce an error. The mean is equal to the sum of all the list's contents divided by the number of elements.\
\
Usage\
\
@@ -18274,7 +18274,7 @@ math.listMean.summary = \
\
-math.listMedian.description = Calculates the Median of the contents of a String List .
+math.listMedian.description = Calculates the Median of the contents of a String List .
math.listMedian.summary = \
\
\
@@ -18283,7 +18283,7 @@ math.listMedian.summary = \
math.listMedian() Function\
\
• Introduced in version 1.7\
- Calculates the Median of the contents of a String List. The median value is is the value where half the numbers in the list are greater than or equal to it, and the other half are less than or equal to it. The median is calculated by sorting the list contents and picking the middle number if the number of elements is odd, or averaging the two in the middle if the number of elements is even. Only allows numeric elements - any non-numeric values will produce an error.\
+ Calculates the Median of the contents of a String List. The median value is is the value where half the numbers in the list are greater than or equal to it, and the other half are less than or equal to it. The median is calculated by sorting the list contents and picking the middle number if the number of elements is odd, or averaging the two in the middle if the number of elements is even. Only allows numeric elements - any non-numeric values will produce an error.\
\
Usage\
\
@@ -18311,7 +18311,7 @@ math.listMedian.summary = \
\
-math.listMin.description = Find the minimum value in a String List .
+math.listMin.description = Find the minimum value in a String List .
math.listMin.summary = \
\
\
@@ -18320,7 +18320,7 @@ math.listMin.summary = \
math.listMin() Function\
\
• Introduced in version 1.7\
- Find the minimum value in a String List. Only allows numeric elements - any non-numeric values will produce an error.\
+ Find the minimum value in a String List. Only allows numeric elements - any non-numeric values will produce an error.\
\
Usage\
\
@@ -18348,7 +18348,7 @@ math.listMin.summary = \
\
-math.listProduct.description = Multiplies together the contents of a String List .
+math.listProduct.description = Multiplies together the contents of a String List .
math.listProduct.summary = \
\
\
@@ -18357,7 +18357,7 @@ math.listProduct.summary = \
math.listProduct() Function\
\
• Introduced in version 1.7\
- Multiplies together the contents of a String List. Only allows numeric elements - any non-numeric values will produce an error.\
+ Multiplies together the contents of a String List. Only allows numeric elements - any non-numeric values will produce an error.\
\
Usage\
\
@@ -18385,7 +18385,7 @@ math.listProduct.summary = \
\
-math.listSum.description = Adds together the contents of a String List .
+math.listSum.description = Adds together the contents of a String List .
math.listSum.summary = \
\
\
@@ -18394,7 +18394,7 @@ math.listSum.summary = \
math.listSum() Function\
\
• Introduced in version 1.7\
- Adds together the contents of a String List. Only allows numeric elements - any non-numeric values will produce an error.\
+ Adds together the contents of a String List. Only allows numeric elements - any non-numeric values will produce an error.\
\
Usage\
\
@@ -18575,7 +18575,7 @@ movedOverDrawing.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.2\
@@ -18681,7 +18681,7 @@ Moved Over: [r: movedOverPoints(jsonArray,lastPath)]\
\
-movedOverToken.description = Is used to check if the location of the target token is in an array of cell coordinates like the one received from getLastPath() or the onTokenMove event's macro.args .
+movedOverToken.description = Is used to check if the location of the target token is in an array of cell coordinates like the one received from getLastPath() or the onTokenMove event's macro.args .
movedOverToken.summary = \
\
\
@@ -18690,7 +18690,7 @@ movedOverToken.summary = \
movedOverToken() Function\
\
• Introduced in version 1.3.b74\
- Is used to check if the location of the target token is in an array of cell coordinates like the one received from getLastPath() or the onTokenMove event's macro.args.\
+ Is used to check if the location of the target token is in an array of cell coordinates like the one received from getLastPath() or the onTokenMove event's macro.args.\
\
\
Usage\
@@ -18795,20 +18795,20 @@ moveToken(x, y, units, id)\
x - The X coordinate to move the token to.y - The Y coordinate to move the token to.units - If set to false(0), the coordinates are a location on the grid in cells. Defaults to true(1), where the coordinates are in Distance Per Cell pixels.id - The id string of the token to move, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The id string of the token to move, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
\
\
\
Examples\
\
- Moves the Current Token down 5 units, and left 10 units.\
+ Moves the Current Token down 5 units, and left 10 units.\
[h: CurrentX = getTokenX()]\
[h: CurrentY = getTokenY()]\
[h: NewX = CurrentX + 5]\
[h: NewY = CurrentY - 10]\
[h: moveToken(NewX, NewY)]
\
-Moves the Current Token down 5 cells, and left 10 cells.\
+
Moves the Current Token down 5 cells, and left 10 cells.\
\
[h: CurrentX = getTokenX(0)]\
[h: CurrentY = getTokenY(0)]\
@@ -18834,7 +18834,7 @@ moveTokenFrom.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b54\
@@ -18852,7 +18852,7 @@ moveTokenFromMap(id, map, x, y, z)\
Parameters\
\
\
- id - The token id or a JSON Array of token ids of the token/s to move.id - The token id or a JSON Array of token ids of the token/s to move.map - A string containing the name of the map that the token is moved from.x - The X coordinate of the current map that the token should be moved to. Defaults to 0.y - The Y coordinate of the current map that the token should be moved to. Defaults to 0.\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b54\
@@ -18899,7 +18899,7 @@ moveTokenFromMap(id, map, x, y, z)\
Parameters\
\
\
- id - The token id or a JSON Array of token ids of the token/s to move.id - The token id or a JSON Array of token ids of the token/s to move.map - A string containing the name of the map that the token is moved from.x - The X coordinate of the current map that the token should be moved to. Defaults to 0.y - The Y coordinate of the current map that the token should be moved to. Defaults to 0.\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b54\
@@ -18946,7 +18946,7 @@ moveTokenToMap(id, map, x, y, z)\
Parameters\
\
\
- id - The token id or a JSON Array of token ids of the token/s to move.id - The token id or a JSON Array of token ids of the token/s to move.map - A string containing the name of the map that the token is moved to.x - The X coordinate of the map that the token should be moved to. Default to 0.y - The Y coordinate of the map that the token should be moved to. Default to 0.
\
-nextInitiative.description = Advances the initiative to the next Token in the Initiative Panel .
+nextInitiative.description = Advances the initiative to the next Token in the Initiative Panel .
nextInitiative.summary = \
\
\
@@ -19058,12 +19058,12 @@ nextInitiative.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b41\
- Advances the initiative to the next Token in the Initiative Panel. Only the GM or a trusted macro can call this function. This function returns the offset into the Initiative Panel (starting at 0) of the Token that will get the Initiative.\
-- Since 1.8: This function triggers the
onInitiativeChangeRequest (and onInitiativeChange) events, so it is possible that the change will be blocked. See the Guide to Initiative Events for more details. This function will return the offset of the token that has initiative after this function completes, whether the change proceeded as requested or not.
\
+ Advances the initiative to the next Token in the Initiative Panel. Only the GM or a trusted macro can call this function. This function returns the offset into the Initiative Panel (starting at 0) of the Token that will get the Initiative.\
+- Since 1.8: This function triggers the
onInitiativeChangeRequest (and onInitiativeChange) events, so it is possible that the change will be blocked. See the Guide to Initiative Events for more details. This function will return the offset of the token that has initiative after this function completes, whether the change proceeded as requested or not.
\
\
Usage\
\
@@ -19143,7 +19143,7 @@ number.summary = \
number() Function\
\
• Introduced in version 1.3b48\
- Returns the value that is passed in as a number. If the value can not be converted to a number then an error will occur. If you are unsure if a value is a number to can use isNumber() before calling this function.\
+ Returns the value that is passed in as a number. If the value can not be converted to a number then an error will occur. If you are unsure if a value is a number to can use isNumber() before calling this function.\
\
Usage\
\
@@ -19164,7 +19164,7 @@ oldFunction.summary = \
\
• Introduced in version 1.3b51\
If a user-defined function redefines a standard MapTool function or another user-defined function -- for instance, a user defines a function called eval(), redefining the standard MapTool eval() -- oldFunction() can be used in the user-defined function to call the original function. When a user-defined function redefines an existing function, it keeps track of the function that it redefined. Due to this tracking, it is possible to redefine a function multiple times and oldFunction() will always reference the previous function in the chain.\
-Note: Do not rely on a specific order in the function chain unless you are sure that the functions will be redefined in that order. Calls to defineFunction() within onCampaignLoad macros on different Library Tokens are not executed in any standard order.\
+Note: Do not rely on a specific order in the function chain unless you are sure that the functions will be redefined in that order. Calls to defineFunction() within onCampaignLoad macros on different Library Tokens are not executed in any standard order.\
\
Usage\
\
@@ -19235,7 +19235,7 @@ Returns a string that is similar to Dice: 5, 4, 19, 6, 3, Maximum: 19\
See Also\
\
- For another method of rolling dice, see Dice Expressions.\
+ For another method of rolling dice, see Dice Expressions.\
\
\
@@ -19314,7 +19314,7 @@ playClip(uri, cycleCount, volume)\
Parameter\
\
\
- uri - The uri/url of the file. For example, http://www.mywebsite/mysong.mp3 or file:/C:/mysong.mp3uri - The uri/url of the file. For example, https://www.mywebsite/mysong.mp3 or file:/C:/mysong.mp3cycleCount - The number of times the audio should play. If set to 0, the file is cached but not played; if set to -1, the file is played continuously. Defaults to 1.volume - The volume the audio is to be played at. Can range from 0 to 1. Defaults to 1.
\
@@ -19325,7 +19325,7 @@ playClip(uri, cycleCount, volume)\
[playClip(macro.args)]
\
To play the song, the GM can then use execLink:\
\
-[H: songUrl = "http://erinmcnamee.com.hostbaby.com/files/07_No_Sorrow__Banish_Misfortune.mp3"]\
+[H: songUrl = "https://erinmcnamee.com.hostbaby.com/files/07_No_Sorrow__Banish_Misfortune.mp3"]\
[H: audioByte = macroLinkText("playSong@Lib:MusicPlayer", "none", songUrl)]\
[H: execLink(audioByte,0,"all")]\
Dropbox URLs
\
@@ -19360,7 +19360,7 @@ playStream(uri, cycleCount, volume, start, stop)
\
Parameter\
\
\
- uri - The uri/url of the file. For example, http://www.mywebsite/mysong.mp3 or file:/C:/mysong.mp3uri - The uri/url of the file. For example, https://www.mywebsite/mysong.mp3 or file:/C:/mysong.mp3cycleCount - The number of times the audio should play. If set to 0, the file is cached but not played; if set to -1, the file is played continuously. Defaults to 1.volume - The volume the audio is to be played at. Can range from 0 to 1. Defaults to 1.start - The time offset in seconds where audio should start playing, or restart from when repeating. Defaults to 0.[playStream(macro.args)]
\
To play the song, the GM can then use execLink:\
\
-[H: songUrl = "http://erinmcnamee.com.hostbaby.com/files/07_No_Sorrow__Banish_Misfortune.mp3"]\
+[H: songUrl = "https://erinmcnamee.com.hostbaby.com/files/07_No_Sorrow__Banish_Misfortune.mp3"]\
[H: audioByte = macroLinkText("playSong@Lib:MusicPlayer", "none", songUrl)]\
[H: execLink(audioByte,0,"all")]\
Alternatively, the GM can use execFunction:\
\
-[H: songUrl = json.append("[]","http://erinmcnamee.com.hostbaby.com/files/07_No_Sorrow__Banish_Misfortune.mp3")]\
+[H: songUrl = json.append("[]","https://erinmcnamee.com.hostbaby.com/files/07_No_Sorrow__Banish_Misfortune.mp3")]\
[H: execFunction("playStream", songUrl, 0, "all")\
Dropbox URLs
\
After creating the dropbox share link you have to replace www.dropbox.com with dl.dropboxusercontent.com. That provides a direct link that playStream can use. Thanks to Full Bleed on the forums for the tip.\
@@ -19490,7 +19490,7 @@ power.summary = \
\
-prevInitiative.description = Restores the initiative to the previous Token in the Initiative Panel , returning to the previous round if necessary.
+prevInitiative.description = Restores the initiative to the previous Token in the Initiative Panel , returning to the previous round if necessary.
prevInitiative.summary = \
\
\
@@ -19500,12 +19500,12 @@ prevInitiative.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.8\
- Restores the initiative to the previous Token in the Initiative Panel, returning to the previous round if necessary. Only the GM or a trusted macro can call this function. This function returns the offset into the Initiative Panel (starting at 0) of the Token that will receive Initiative. Note: neither this function nor the corresponding UI button will allow the Initiative to fall back any further than the first token in the first round.\
-- This function triggers the
onInitiativeChangeRequest (and onInitiativeChange) events, so it is possible that the change will be blocked. See the Guide to Initiative Events for more details. This function will return the offset of the token that has initiative after this function completes, whether the change proceeded as requested or not.
\
+ Restores the initiative to the previous Token in the Initiative Panel, returning to the previous round if necessary. Only the GM or a trusted macro can call this function. This function returns the offset into the Initiative Panel (starting at 0) of the Token that will receive Initiative. Note: neither this function nor the corresponding UI button will allow the Initiative to fall back any further than the first token in the first round.\
+- This function triggers the
onInitiativeChangeRequest (and onInitiativeChange) events, so it is possible that the change will be blocked. See the Guide to Initiative Events for more details. This function will return the offset of the token that has initiative after this function completes, whether the change proceeded as requested or not.
\
\
Usage\
\
@@ -19543,7 +19543,7 @@ refreshDrawing.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -19580,7 +19580,7 @@ refreshDrawing.summary = \
\
-removeAllFromInitiative.description = Removes all of the Tokens from the Initiative Panel .
+removeAllFromInitiative.description = Removes all of the Tokens from the Initiative Panel .
removeAllFromInitiative.summary = \
\
\
@@ -19590,10 +19590,10 @@ removeAllFromInitiative.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
- Removes all of the Tokens from the Initiative Panel. This function returns the number of Tokens that were removed. Only the GM can call this function.\
+ Removes all of the Tokens from the Initiative Panel. This function returns the number of Tokens that were removed. Only the GM can call this function.\
\
Usage\
\
@@ -19604,7 +19604,7 @@ removeAllFromInitiative.summary = \
\
-removeAllNPCsFromInitiative.description = Removes all of the NPC Tokens from the Initiative Panel .
+removeAllNPCsFromInitiative.description = Removes all of the NPC Tokens from the Initiative Panel .
removeAllNPCsFromInitiative.summary = \
\
\
@@ -19614,10 +19614,10 @@ removeAllNPCsFromInitiative.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
- Removes all of the NPC Tokens from the Initiative Panel. This function returns the number of Tokens that were removed. Only the GM can call this function.\
+ Removes all of the NPC Tokens from the Initiative Panel. This function returns the number of Tokens that were removed. Only the GM can call this function.\
\
Usage\
\
@@ -19628,7 +19628,7 @@ removeAllNPCsFromInitiative.summary = \
\
-removeAllPCsFromInitiative.description = Removes all of the PC Tokens from the Initiative Panel .
+removeAllPCsFromInitiative.description = Removes all of the PC Tokens from the Initiative Panel .
removeAllPCsFromInitiative.summary = \
\
\
@@ -19638,10 +19638,10 @@ removeAllPCsFromInitiative.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
- Removes all of the PC Tokens from the Initiative Panel. This function returns the number of Tokens that were removed. Only the GM can call this function.\
+ Removes all of the PC Tokens from the Initiative Panel. This function returns the number of Tokens that were removed. Only the GM can call this function.\
\
Usage\
\
@@ -19652,7 +19652,7 @@ removeAllPCsFromInitiative.summary = \
\
-removeFromInitiative.description = Removes the Current Token from the Initiative Panel .
+removeFromInitiative.description = Removes the Current Token from the Initiative Panel .
removeFromInitiative.summary = \
\
\
@@ -19660,7 +19660,7 @@ removeFromInitiative.summary = \
\
removeFromInitiative() Function\
\
- Removes the Current Token from the Initiative Panel. Additional parameters allow you to specify the token.\
+ Removes the Current Token from the Initiative Panel. Additional parameters allow you to specify the token.\
\
Usage\
\
@@ -19673,14 +19673,14 @@ removeFromInitiative(id, mapname)\
Parameters\
\
\
- id - The token id of the token to be removed from the initiative. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to be removed from the initiative. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.return - Returns 1 if removed from the initiative, 0 if did not.
\
\
Example\
\
- To remove the token with the name "Dragon" in current map from the initiative panel.\
+ To remove the token with the name "Dragon" in current map from the initiative panel.\
[h: removeFromInitiative("Dragon")]\
\
See Also\
@@ -19754,7 +19754,7 @@ removeToken.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b51\
@@ -19795,7 +19795,7 @@ removeTokenFacing.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b51\
@@ -19839,7 +19839,7 @@ replace.summary = \
replace() Function\
\
• Introduced in version 1.3b48\
- Returns the string with the occurrences of a pattern replaced by the specified value. If the number of times to perform the replacement is not specified then all occurrences of the pattern are replaced. Pattern can be a regular expression. This means if the pattern string contains any regular expression special characters they must be escaped.\
+ Returns the string with the occurrences of a pattern replaced by the specified value. If the number of times to perform the replacement is not specified then all occurrences of the pattern are replaced. Pattern can be a regular expression. This means if the pattern string contains any regular expression special characters they must be escaped.\
\
Usage\
\
@@ -19913,7 +19913,7 @@ Returns a number than is between 25 and 50.
\
\
See Also\
\
- For another method of rolling dice, see Dice Expressions.\
+ For another method of rolling dice, see Dice Expressions.\
\
\
@@ -19960,7 +19960,7 @@ May return 5 [2, 1, 2, 4] - the first die produced a 2, which was r
\
See Also\
\
- For another method of rolling dice, see Dice Expressions.\
+ For another method of rolling dice, see Dice Expressions.\
\
\
@@ -19992,13 +19992,13 @@ resetFrame.summary = \
\
See Also\
\
- [frame():],\
+ \
\
\
-resetProperty.description = Resets the specified Token Property on a specific Token so that it is empty and will return the default value when queried (if it has one).
+resetProperty.description = Resets the specified Token Property on a specific Token so that it is empty and will return the default value when queried (if it has one).
resetProperty.summary = \
\
\
@@ -20007,7 +20007,7 @@ resetProperty.summary = \
resetProperty() Function\
\
• Introduced in version 1.3b48\
- Resets the specified Token Property on a specific Token so that it is empty and will return the default value when queried (if it has one).\
+ Resets the specified Token Property on a specific Token so that it is empty and will return the default value when queried (if it has one).\
\
Usage\
\
@@ -20021,7 +20021,7 @@ resetProperty(property, id, mapname)\
\
\
property - The name of the property to reset.id - The token id of the token which has its property reset, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token which has its property reset, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -20039,7 +20039,7 @@ resetProperty(property, id, mapname)\
\
\
- 1.3b51 - Added
id parameter option. \
- - 1.3b68 - Token Property is now deleted from Token
\
+ - 1.3b68 - Token Property is now deleted from Token
\
- 1.5.4 - Added
mapname parameter option. \
\
\
@@ -20047,7 +20047,7 @@ resetProperty(property, id, mapname)\
\
-resetSize.description = Resets the Size of a Token to the default for grid type of the map it occupies.
+resetSize.description = Resets the Size of a Token to the default for grid type of the map it occupies.
resetSize.summary = \
\
\
@@ -20057,11 +20057,11 @@ resetSize.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
- Resets the Size of a Token to the default for grid type of the map it occupies. See setSize() for details about the default size for different grid types.\
+ Resets the Size of a Token to the default for grid type of the map it occupies. See setSize() for details about the default size for different grid types.\
\
Usage\
\
@@ -20074,7 +20074,7 @@ resetSize(id, mapname)\
Parameters\
\
\
- id - The token id of the token to reset, defaults to the Current Token.id - The token id of the token to reset, defaults to the Current Token.mapName - Optional map name to find the token. Defaults to current map.
\
\
@@ -20116,7 +20116,7 @@ resetTablePicks.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.6.0\
@@ -20135,8 +20135,8 @@ resetTablePicks(tableName, entriesToReset, "json")\
\
\
tableName - A string containing the name of the Table.entriesToReset - Since 1.8. Identifies specific entries to be reset. Can be a String List using the provided delim (defaults to "," if no delim provided), or a JSON Array if delim is "json".delim - Since 1.8. Custom delimiter for the `entriesToReset` param. Defaults to ",". Should be "json" if entriesToReset is a JSON Array instead of a String List.entriesToReset - Since 1.8. Identifies specific entries to be reset. Can be a String List using the provided delim (defaults to "," if no delim provided), or a JSON Array if delim is "json".delim - Since 1.8. Custom delimiter for the `entriesToReset` param. Defaults to ",". Should be "json" if entriesToReset is a JSON Array instead of a String List.
\
\
Examples\
@@ -20154,7 +20154,7 @@ resetTablePicks(tableName, entriesToReset, "json")\
If this table is set to Pick Once, then the Ace and Two of Clubs can be reset with any of:\
[h:resetTablePicks("Standard", "0,1")]\
[h:resetTablePicks("Standard", "0@1", "@")]\
-[h:resetTablePicks("Standard", json.append("", 0, 1), "json")]Note that entries on Pick Once tables are identified by list index (starting at 0), and not by range as in normal tables. Take care to properly identify entries when resetting. For more info, see Introduction to Tables and the table() function.\
+[h:resetTablePicks("Standard", json.append("", 0, 1), "json")]Note that entries on Pick Once tables are identified by list index (starting at 0), and not by range as in normal tables. Take care to properly identify entries when resetting. For more info, see Introduction to Tables and the table() function.\
\
See Also\
\
@@ -20184,7 +20184,7 @@ REST.delete.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -20251,7 +20251,7 @@ Note the 204 - No Content status and thus no "body" element in the JSON. If the
See Also\
\
\
\
Version Changes\
@@ -20275,7 +20275,7 @@ REST.get.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -20365,7 +20365,7 @@ See this See Also\
\
\
\
\
@@ -20381,7 +20381,7 @@ REST.patch.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -20450,7 +20450,7 @@ REST.patch(url, payload, mediaType, headers, getFullResponse)\
See Also\
\
\
\
\
@@ -20466,7 +20466,7 @@ REST.post.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -20539,7 +20539,7 @@ REST.post(url, payload, mediaType, headers, getFullResponse)\
See Also\
\
\
\
\
@@ -20555,7 +20555,7 @@ REST.put.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -20610,7 +20610,7 @@ REST.put(url, payload, mediaType, headers, getFullResponse)\
See Also\
\
\
\
\
@@ -20626,7 +20626,7 @@ restoreFoW.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.1.3\
@@ -20660,7 +20660,7 @@ restoreFoW(mapname)\
\
See Also\
\
- \
+ \
\
\
@@ -20674,7 +20674,7 @@ return.summary = \
return() Function\
\
• Introduced in version 1.5.0\
- Is used to conditionally return from the execution of a macro like an abort, but not stopping further macro execution. Optionally also returning a value by automatically assigning macro.return. If the first argument to return() is 0 then the return is happening. If the first argument to return() is non zero then the macro continues. The optional second argument of return() defines if there is a value that should be returned to a calling macro. Any other output is discarded when using return().\
+ Is used to conditionally return from the execution of a macro like an abort, but not stopping further macro execution. Optionally also returning a value by automatically assigning macro.return. If the first argument to return() is 0 then the return is happening. If the first argument to return() is non zero then the macro continues. The optional second argument of return() defines if there is a value that should be returned to a calling macro. Any other output is discarded when using return().\
Common uses for this function are\
\
- Ending a macro with or without a return value to stop the further execution of the following lines in the current macro.
- The macro has conditions and based on these you want to return different values and not continue further in the current macro.
\
@@ -20777,12 +20777,12 @@ roll.summary = \
[h: listOfRolls = listAppend(listOfRolls, r)]\
}]\
You rolled [r: listSort(listOfRolls, "N-")] = [r: sum].Rolls 5 times a d6 and returns these as sorted list as well as the total.\
-
- See also[count():], listAppend() and listSort().
\
+- See also[count():], listAppend() and listSort().
\
\
\
See Also\
\
- For another method of rolling dice, see Dice Expressions.\
+ For another method of rolling dice, see Dice Expressions.\
\
\
@@ -20820,7 +20820,7 @@ Returns a number that is between 40 and 115 (and no longer 5 to 100 as with a re
\
See Also\
\
- The corresponding dice roll expression is XdYaZlW. For other methods of rolling dice, see Dice Expressions.\
+ The corresponding dice roll expression is XdYaZlW. For other methods of rolling dice, see Dice Expressions.\
\
\
@@ -20858,7 +20858,7 @@ Returns a number that is between 35 and 90 (and no longer 5 to 100 as with a reg
\
See Also\
\
- The corresponding dice roll expression is XdYaZuW. For other methods of rolling dice, see Dice Expressions.\
+ The corresponding dice roll expression is XdYaZuW. For other methods of rolling dice, see Dice Expressions.\
\
\
@@ -20896,7 +20896,7 @@ Returns a number that is between 15 and 90 (and no longer 5 to 100 as with a reg
\
See Also\
\
- The corresponding dice roll expression is XdYsZlW. For other methods of rolling dice, see Dice Expressions.\
+ The corresponding dice roll expression is XdYsZlW. For other methods of rolling dice, see Dice Expressions.\
\
\
@@ -20934,7 +20934,7 @@ Returns a number that is between -10 and 70 (and no longer 5 to 100 as with a re
\
See Also\
\
- The corresponding dice roll expression is XdYsZuW. For other methods of rolling dice, see Dice Expressions.\
+ The corresponding dice roll expression is XdYsZuW. For other methods of rolling dice, see Dice Expressions.\
\
\
@@ -20971,7 +20971,7 @@ Returns a number that is between 35 and 100 (and no longer down to 5 as with a r
\
See Also\
\
- The corresponding dice roll expression is XdYlZ. For other methods of rolling dice, see Dice Expressions.\
+ The corresponding dice roll expression is XdYlZ. For other methods of rolling dice, see Dice Expressions.\
\
\
@@ -21008,7 +21008,7 @@ Returns a number that is between 5 and 80 (and no longer up to 100 as with a reg
\
See Also\
\
- The corresponding dice roll expression is XdYuZ. For other methods of rolling dice, see Dice Expressions.\
+ The corresponding dice roll expression is XdYuZ. For other methods of rolling dice, see Dice Expressions.\
\
\
@@ -21129,18 +21129,18 @@ selectTokens.summary = \
\
id - the id string or token name of a specific token to select (the examples below use token names, but IDs are also permitted); if left blank all visible tokens are selected.add - if the value of add is true(1), the selections will be added to the current set of selected tokens; if the value is false(0) currently selected tokens will be deselected before new tokens are selected. Defaults to false.tokens - a String List of tokens to select.delim - Specifies the delimiter used in the string list that is supplied. If the delimiter is "json", then the value for tokens may be a JSON Array instead. Note: if using a JSON Array or String List, both add and delim must be specified.tokens - a String List of tokens to select.delim - Specifies the delimiter used in the string list that is supplied. If the delimiter is "json", then the value for tokens may be a JSON Array instead. Note: if using a JSON Array or String List, both add and delim must be specified.
\
\
Example\
\
To select a single token with the name "Adventurer":\
[h:selectTokens("Adventurer")]\
-To select a list of Tokens using a String List, replacing the current selection\
+
To select a list of Tokens using a String List, replacing the current selection\
\
[h:selectTokens("Adventurer, Orc 2, Goblin 1", 0, ",")]\
-To select a list of Tokens using a JSON Array, adding the specified tokens to the current set of selected Tokens:\
+
To select a list of Tokens using a JSON Array, adding the specified tokens to the current set of selected Tokens:\
\
[h:selectTokens("['Adventurer', 'Orc 2', 'Goblin 1']", 1, "json")]\
\
@@ -21171,7 +21171,7 @@ sendDrawingToBack.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.1.7\
@@ -21207,7 +21207,7 @@ sendDrawingToBack.summary = \
\
-sendToBack.description = Adjust the z-order (or draw order) of the Token so that it is drawn before all other Tokens on the same Map Layer , this has the effect of making the Token appear to be in back of the other Tokens as it will be obscured by other Tokens on the same Map Layer in the same location.
+sendToBack.description = Adjust the z-order (or draw order) of the Token so that it is drawn before all other Tokens on the same Map Layer , this has the effect of making the Token appear to be in back of the other Tokens as it will be obscured by other Tokens on the same Map Layer in the same location.
sendToBack.summary = \
\
\
@@ -21216,7 +21216,7 @@ sendToBack.summary = \
sendToBack() Function\
\
• Introduced in version 1.3b48\
- Adjust the z-order (or draw order) of the Token so that it is drawn before all other Tokens on the same Map Layer, this has the effect of making the Token appear to be in back of the other Tokens as it will be obscured by other Tokens on the same Map Layer in the same location.\
+ Adjust the z-order (or draw order) of the Token so that it is drawn before all other Tokens on the same Map Layer, this has the effect of making the Token appear to be in back of the other Tokens as it will be obscured by other Tokens on the same Map Layer in the same location.\
\
Usage\
\
@@ -21229,13 +21229,13 @@ sendToBack(id, mapname)\
Parameter\
\
\
- id - The token id or name of the token that has its z-order changed, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id or name of the token that has its z-order changed, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
Examples\
\
- Sends the Current Token to the lowest z-order.\
+ Sends the Current Token to the lowest z-order.\
[h: sendToBack()]
\
Sends all of the selected tokens to the lowest z-order.\
\
@@ -21316,7 +21316,7 @@ This function is rarely used because a simple assignment to a variable name can
\
-setAllStates.description = Sets all of the States of a Token to on ( true ( 1 )) or off ( false ( 0 )).
+setAllStates.description = Sets all of the States of a Token to on ( true ( 1 )) or off ( false ( 0 )).
setAllStates.summary = \
\
\
@@ -21325,7 +21325,7 @@ setAllStates.summary = \
setAllSates() Function\
\
• Introduced in version 1.3b40\
- \
+ \
\
Usage\
\
@@ -21339,21 +21339,21 @@ setAllStates(value, id, mapname)\
\
\
value - If all states should be set on or off, true(1) or false(0).id - The id of the token that should have its States set. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The id of the token that should have its States set. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
Examples\
\
- Set all Token States on\
+ Set all Token States on\
[h: setAllStates(1)]
\
-Set all Token States off\
+
Set all Token States off\
\
[h: setAllStates(0)]
\
\
See Also\
\
- \
+ \
\
Version Changes\
\
@@ -21388,7 +21388,7 @@ setAlwaysVisible.summary = \
\
\
value - The value of the setting to set, true(1) or false(0).id - OPTIONAL: The token id of the token for which you want to set this setting, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - OPTIONAL: The token id of the token for which you want to set this setting, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
\
\
Example\
@@ -21403,7 +21403,7 @@ setAlwaysVisible.summary = \
\
-setBar.description = Sets the value of the specified bar for the Current Token and makes the bar visible.
+setBar.description = Sets the value of the specified bar for the Current Token and makes the bar visible.
setBar.summary = \
\
\
@@ -21413,11 +21413,11 @@ setBar.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b42\
- Sets the value of the specified bar for the Current Token and makes the bar visible. The value to set is between 0 and 1 for 0% to 100% respectively.\
+ Sets the value of the specified bar for the Current Token and makes the bar visible. The value to set is between 0 and 1 for 0% to 100% respectively.\
\
Usage\
\
@@ -21432,7 +21432,7 @@ setBar(name, pct/100, id, mapname)\
\
name - The name of the bar.value - The value of the bar. Should be between 0 and 1.id - The token id of the token which has its bar set, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token which has its bar set, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -21462,17 +21462,17 @@ setBar(name, pct/100, id, mapname)\
\
\
- \
- HP and Health Bars\
+ HP and Health Bars\
\
- \
- The
bar.name special variable\
+ The bar.name special variable\
\
\
\
\
-setBarVisible.description = Sets if the specified bar for the Current Token is visible or not.
+setBarVisible.description = Sets if the specified bar for the Current Token is visible or not.
setBarVisible.summary = \
\
\
@@ -21481,7 +21481,7 @@ setBarVisible.summary = \
setBarVisible() Function\
\
• Introduced in version 1.3b46\
- Sets if the specified bar for the Current Token is visible or not. If the value is non zero then the bar is visible, if it is 0 it is not visible.\
+ Sets if the specified bar for the Current Token is visible or not. If the value is non zero then the bar is visible, if it is 0 it is not visible.\
\
Usage\
\
@@ -21496,15 +21496,15 @@ setBarVisible(name, value, id, mapname)\
\
bar - A string that contains the name of the bar that has its visibility set.value - The visibility value of the bar, either 0 or 1.id - The token id of the token which has its bar visibility set, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token which has its bar visibility set, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
Examples\
\
- Make "health" bar for the Current Token visible.\
+ Make "health" bar for the Current Token visible.\
[h: setBarVisible("Health", 1)]\
-Hide "health" bar for the Current Token.\
+
Hide "health" bar for the Current Token.\
\
[h: setBarVisible("Health", 0)]\
\
@@ -21526,17 +21526,17 @@ setBarVisible(name, value, id, mapname)\
\
\
- \
- HP and Health Bars\
+ HP and Health Bars\
\
- \
- The
bar.name special variable\
+ The bar.name special variable\
\
\
\
\
-setCurrentInitiative.description = Gives the Initiative to the Token at the specified offset in the Initiative Panel .
+setCurrentInitiative.description = Gives the Initiative to the Token at the specified offset in the Initiative Panel .
setCurrentInitiative.summary = \
\
\
@@ -21544,7 +21544,7 @@ setCurrentInitiative.summary = \
\
setCurrentInitiative() Function\
\
- Gives the Initiative to the Token at the specified offset in the Initiative Panel. Offsets start at 0.\
+ Gives the Initiative to the Token at the specified offset in the Initiative Panel. Offsets start at 0.\
To clear, specify a number that is not a valid token offset, like -1.\
\
Usage\
@@ -21555,7 +21555,7 @@ To clear, specify a number that is not a valid token offset, like -1.
\
\
Examples\
\
- Give Initiative to the 4th Token.\
+ Give Initiative to the 4th Token.\
[h: setCurrentInitiative(3)]
\
Clear current initiative (any number that is not a valid token offset will work).\
\
@@ -21578,7 +21578,7 @@ setCurrentMap.summary = \
WARNING: This function changes an internal variable used by MapTool to keep track of which map is current and this change takes place immediately. However, changes to tokens are queued up and only occur when the macro finishes execution (well, sort of). The end result is that if a token is being modified on map "A" and your macro calls setCurrentMap() to switch to map "B", when the macro finishes and the token changes are executed they will be processing a token on map B! If there was no such token on map B a new one will be created, thus mysteriously duplicating tokens!\
Therefore, do NOT modify any token properties, states, names, notes, or any other token-specific values after calling setCurrentMap(). Or make sure that the first thing your macro does is call setCurrentMap() so that all tokens accessed later will be on the map that is current when the macro finishes.\
\
-Search http://forums.rptools.net/ for setCurrentMap to find some discussion threads on this topic.\
+Search https://forums.rptools.net/ for setCurrentMap to find some discussion threads on this topic.\
\
Usage\
\
@@ -21617,7 +21617,7 @@ setDrawingEraser.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -21668,12 +21668,12 @@ setDrawingLayer.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.1.7\
For a specified drawing, set the layer of the map to which the drawing belongs.\
-The Map Layer is one of:\
+
The Map Layer is one of:\
\
TOKENGM also known as HiddenOBJECTBACKGROUND
\
\
@@ -21721,7 +21721,7 @@ setDrawingOpacity.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -21770,7 +21770,7 @@ setDrawingProperties.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -21819,7 +21819,7 @@ setFillColor.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -21871,7 +21871,7 @@ setGMName.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b49\
@@ -21889,13 +21889,13 @@ setGMName(name, id, mapname)\
\
\
name - A string that is set as the GM Name on the token.id - The token id of the token that has its GM Name set. Defaults to the Current Token.id - The token id of the token that has its GM Name set. Defaults to the Current Token.mapname - The name of the map to find the token. Defaults to the current map.
\
\
Examples\
\
- Sets the GM Name of the Current Token to New GM Name.\
+ Sets the GM Name of the Current Token to New GM Name.\
[h: setGMName("New GM Name")]\
Sets the GM Name of all selected tokens to New GM Name.\
\
@@ -21923,7 +21923,7 @@ setGMName(name, id, mapname)\
\
-setGMNotes.description = Sets the GM notes of the Current Token .
+setGMNotes.description = Sets the GM notes of the Current Token .
setGMNotes.summary = \
\
\
@@ -21933,11 +21933,11 @@ setGMNotes.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
- Sets the GM notes of the Current Token.\
+ Sets the GM notes of the Current Token.\
\
Usage\
\
@@ -21951,14 +21951,14 @@ setGMNotes(notes, id, mapname)\
\
\
notes - The GM notes to set on the token.id - The token id of the token to set the GM notes on. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to set the GM notes on. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
\
-setHalo.description = Sets the Halo color of a Token .
+setHalo.description = Sets the Halo color of a Token .
setHalo.summary = \
\
\
@@ -21967,7 +21967,7 @@ setHalo.summary = \
setHalo() Function\
\
• Introduced in version 1.3b49\
- \
+ \
\
Usage\
\
@@ -21981,25 +21981,25 @@ setHalo.summary = \
Parameters\
\
\
- color - The color to set the Halo to, valid values are:\
+ color - The color to set the Halo to, valid values are:\
"Black""Green""Yellow""Orange""Red""Cyan""Magenta""White"- A hexadecimal color value in the format
"#RRGGBB" "None"
id - The token id of the token that has its Halo set by this function. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token that has its Halo set by this function. Note: This parameter can only be used in a Trusted Macro.
\
\
Examples\
\
- To remove the Halo from the Current Token.\
+ To remove the Halo from the Current Token.\
[h: setHalo("None")]\
-To set the Halo for the Current Token to red.\
+
To set the Halo for the Current Token to red.\
\
[h: setHalo("Red")]\
-To set the Halo from the Current Token to a custom color\
+
To set the Halo from the Current Token to a custom color\
\
[h: setHalo("#33AAFF")]\
\
See Also\
\
- \
-setHasSight.description = Enables/disables sight for the Current Token .
+setHasSight.description = Enables/disables sight for the Current Token .
setHasSight.summary = \
\
\
@@ -22022,7 +22022,7 @@ setHasSight.summary = \
setHasSight() Function\
\
• Introduced in version 1.3b48\
- Enables/disables sight for the Current Token. If the argument is 0 (false) sight will be disabled on the Current Token. If it is non-zero (true) sight is enabled.\
+ Enables/disables sight for the Current Token. If the argument is 0 (false) sight will be disabled on the Current Token. If it is non-zero (true) sight is enabled.\
\
Usage\
\
@@ -22036,13 +22036,13 @@ setHasSight(state, id, mapname)\
\
\
state - Boolean - true to enable sight, false to disableid - The id of the token to set the sight of. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The id of the token to set the sight of. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
Example\
\
- Enables sight for Current Token\
+ Enables sight for Current Token\
[h: setHasSight(1)]
\
Returns: Empty String.\
\
@@ -22060,7 +22060,7 @@ Returns: Empty String.
\
\
-setInitiative.description = Sets the Initiative of the Current Token .
+setInitiative.description = Sets the Initiative of the Current Token .
setInitiative.summary = \
\
\
@@ -22069,7 +22069,7 @@ setInitiative.summary = \
setInitiative() Function\
\
• Introduced in version 1.3b41\
- Sets the Initiative of the Current Token.\
+ Sets the Initiative of the Current Token.\
\
Usage\
\
@@ -22080,7 +22080,7 @@ setInitiative(value, id, mapname)\
\
\
value - The initiative value to set. If included, the initiative will be set even if the token is already on the initiative list.id - The token id of the token to have its initiative set. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to have its initiative set. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -22103,7 +22103,7 @@ setInitiative(value, id, mapname)\
\
-setInitiativeHold.description = Sets if the Current Token is on hold in the Initiative Panel .
+setInitiativeHold.description = Sets if the Current Token is on hold in the Initiative Panel .
setInitiativeHold.summary = \
\
\
@@ -22112,7 +22112,7 @@ setInitiativeHold.summary = \
setInitiativeHold() Function\
\
• Introduced in version 1.3b41\
- Sets if the Current Token is on hold in the Initiative Panel. If the value passed is non zero then the Current Token is placed on hold, if it is 0 it is removed from on hold.\
+ Sets if the Current Token is on hold in the Initiative Panel. If the value passed is non zero then the Current Token is placed on hold, if it is 0 it is removed from on hold.\
\
Usage\
\
@@ -22126,7 +22126,7 @@ setInitiativeHold(value, id, mapname)\
\
\
value - The initiative hold value to set.id - The token id of the token to set the initiative hold. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to set the initiative hold. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -22144,7 +22144,7 @@ setInitiativeHold(value, id, mapname)\
\
-setInitiativeRound.description = Sets the current round number in the Initiative Panel .
+setInitiativeRound.description = Sets the current round number in the Initiative Panel .
setInitiativeRound.summary = \
\
\
@@ -22154,10 +22154,10 @@ setInitiativeRound.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
- Sets the current round number in the Initiative Panel.\
+ Sets the current round number in the Initiative Panel.\
\
Usage\
\
@@ -22168,7 +22168,7 @@ setInitiativeRound.summary = \
\
-setLabel.description = Sets the Token Label of a specific Token .
+setLabel.description = Sets the Token Label of a specific Token .
setLabel.summary = \
\
\
@@ -22177,7 +22177,7 @@ setLabel.summary = \
setLabel() Function\
\
• Introduced in version 1.3b48\
- Sets the Token Label of a specific Token.\
+ Sets the Token Label of a specific Token.\
\
Usage\
\
@@ -22191,8 +22191,8 @@ setLabel.summary = \
Parameters\
\
\
- label - The string that the Token Label is set to.id - The token id of the token that has its label set, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
label - The string that the Token Label is set to.id - The token id of the token that has its label set, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
\
\
\
@@ -22215,7 +22215,7 @@ setLabel.summary = \
\
-setLayer.description = Sets the Map Layer that a Token is on.
+setLayer.description = Sets the Map Layer that a Token is on.
setLayer.summary = \
\
\
@@ -22225,12 +22225,12 @@ setLayer.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
- Sets the Map Layer that a Token is on.\
-The Map Layer is one of:\
+
Sets the Map Layer that a Token is on.\
+The Map Layer is one of:\
\
TOKENGM also known as HiddenOBJECTBACKGROUND
\
\
@@ -22247,8 +22247,8 @@ setLayer(layer, id, forceshape, mapname)\
Parameters\
\
\
- layer - The layer to move the Token to.id - The token id of the token which has its layer set, defaults to the Current Token.layer - The layer to move the Token to.id - The token id of the token which has its layer set, defaults to the Current Token.forceshape - If true(1), change the token shape type to TOP_DOWN if the layer is OBJECT, and to a shape reflecting its image if the layer is TOKEN. Defaults to true(1).mapname - The name of the map to find the token. Defaults to the current map.
\
@@ -22283,7 +22283,7 @@ setLayer(layer, id, forceshape, mapname)\
\
-setLibProperty.description = Sets the Token Property on a Library Token . if the name of the Library Token is not specified then the Token Property is set on the Library Token that the macro is running from.
+setLibProperty.description = Sets the Token Property on a Library Token . if the name of the Library Token is not specified then the Token Property is set on the Library Token that the macro is running from.
setLibProperty.summary = \
\
\
@@ -22292,7 +22292,7 @@ setLibProperty.summary = \
setLibProperty() Function\
\
• Introduced in version 1.3b48\
- Sets the Token Property on a Library Token. if the name of the Library Token is not specified then the Token Property is set on the Library Token that the macro is running from.\
+ Sets the Token Property on a Library Token. if the name of the Library Token is not specified then the Token Property is set on the Library Token that the macro is running from.\
\
Usage\
\
@@ -22303,9 +22303,9 @@ setLibProperty(name, value, libName)\
\
Examples\
\
- Set a property on the Library Token that the macro is running from.\
+ Set a property on the Library Token that the macro is running from.\
[h: setLibProperty("defaultStrength", 10)]\
-Set a property on a specifig Library Token.\
+
Set a property on a specifig Library Token.\
\
[h: setLibProperty("defaultStrength", 10, "Lib:Character")]\
Known Bug: note that using setLibProperty during onCampaignLoad and not being on the map where the lib resides, will result in a duplicate of that lib on the current map!\
@@ -22313,7 +22313,7 @@ Known Bug: note that using setLibProperty during onCampaignLoad and not being on
\
-setLight.description = Sets the light sources of the Current Token .
+setLight.description = Sets the light sources of the Current Token .
setLight.summary = \
\
\
@@ -22322,7 +22322,7 @@ setLight.summary = \
setLight() Function\
\
• Introduced in version 1.3b48\
- Sets the light sources of the Current Token. If the value is false(0) then the light source is turned off; otherwise, it is turned on.\
+ Sets the light sources of the Current Token. If the value is false(0) then the light source is turned off; otherwise, it is turned on.\
\
Usage\
\
@@ -22336,9 +22336,9 @@ setLight(type, name, value, id, mapname)\
\
\
type - The light source type, (e.g. "Generic", "D20").name - The name of the light source.name - The name of the light source.value - If true(1) sets the light on, if false(0) turns it off.id - The token id of the token to change the light sources, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to change the light sources, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -22374,7 +22374,7 @@ setLineCap.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -22415,7 +22415,7 @@ setLineCap.summary = \
\
-setMacroCommand.description = Sets the command that will be run when the Macro Button is pressed.
+setMacroCommand.description = Sets the command that will be run when the Macro Button is pressed.
setMacroCommand.summary = \
\
\
@@ -22425,11 +22425,11 @@ setMacroCommand.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
- Sets the command that will be run when the Macro Button is pressed. Note because of the way the parser interprets values within [] you may have to use the encode() and decode() functions with the string.\
+ Sets the command that will be run when the Macro Button is pressed. Note because of the way the parser interprets values within [] you may have to use the encode() and decode() functions with the string.\
\
Usage\
\
@@ -22469,7 +22469,7 @@ setMacroCommand(index, command, id, mapname)\
\
-setMacroProps.description = Sets the properties for the specified Macro Button on the Current Token .
+setMacroProps.description = Sets the properties for the specified Macro Button on the Current Token .
setMacroProps.summary = \
\
\
@@ -22478,7 +22478,7 @@ setMacroProps.summary = \
setMacroProps() Function\
\
• Introduced in version 1.3b48\
- Sets the properties for the specified Macro Button on the Current Token . The properties are passed to this function as a String Property List. This function accepts either a Macro Button Index or the label of a Macro Button. If it is a label then all of Macro Buttons on the Current Token with a matching label are changed.\
+ Sets the properties for the specified Macro Button on the Current Token . The properties are passed to this function as a String Property List. This function accepts either a Macro Button Index or the label of a Macro Button. If it is a label then all of Macro Buttons on the Current Token with a matching label are changed.\
\
Usage\
\
@@ -22500,11 +22500,11 @@ setMacroProps(label, props, delim, id, mapname)\
\
index - The index of the macro button.label - The label of the macro button.props - A String Property List or JSON Object containing the properties for the button.\
-applyToSelected - Should the macro be applied to the selected tokens.autoExecute - If the macro will be automatically executed when the button is clicked, accepts true(1) or false(0).color - The name of the color for the button.command - The command for the macro (only when using JSON version of function).fontColor - The name of the font color for the button.fontSize - The size of the font for the button.includeLabel - If the label will be output when the button is clicked. Accepts true(1) or false(0).group - The name of the group that the button belongs to.sortBy - The sort by value of the macro button.label - The label for the button.maxWidth - The maximum width of the button.minWidth - The minimum width of the button.playerEditable - Is the button player editable, accepts true(1) or false(0).tooltip - The tool tip for the macro button.compare - Takes a JSON Array which can contain one or more of the following keywords (only usable with JSON version of the function).\
+ props - A String Property List or JSON Object containing the properties for the button.\
+applyToSelected - Should the macro be applied to the selected tokens.autoExecute - If the macro will be automatically executed when the button is clicked, accepts true(1) or false(0).color - The name of the color for the button.command - The command for the macro (only when using JSON version of function).fontColor - The name of the font color for the button.fontSize - The size of the font for the button.includeLabel - If the label will be output when the button is clicked. Accepts true(1) or false(0).group - The name of the group that the button belongs to.sortBy - The sort by value of the macro button.label - The label for the button.maxWidth - The maximum width of the button.minWidth - The minimum width of the button.playerEditable - Is the button player editable, accepts true(1) or false(0).tooltip - The tool tip for the macro button.compare - Takes a JSON Array which can contain one or more of the following keywords (only usable with JSON version of the function).\
applyToSelected - Use the macro applyToSelected for common macro comparisons.autoExecute - Use the macro autoExec for common macro comparisons.command - Use the macro command for common macro comparisons.group - Use the macro group for common macro comparisons.includeLabel - Use the macro includeLabel for common macro comparisons.sortPrefix - Use the macro sortPrefix for common macro comparisons.
delim - The delimiter used in the String Property List that is sent to the props parameter, defaults to ";" and can be omitted if you are sending a JSON Object to the props parameter. If you are sending a JSON Object to the props parameter, and using the id parameter, you can set this to "json".id - The token id of the token that the macro button is located on. Note: This parameter can only be used in a Trusted Macro.
delim - The delimiter used in the String Property List that is sent to the props parameter, defaults to ";" and can be omitted if you are sending a JSON Object to the props parameter. If you are sending a JSON Object to the props parameter, and using the id parameter, you can set this to "json".id - The token id of the token that the macro button is located on. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -22550,7 +22550,7 @@ setMapDisplayName.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.9.0\
@@ -22596,7 +22596,7 @@ setMapName.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.0.1\
@@ -22636,7 +22636,7 @@ setMapVisible.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.0.1\
@@ -22668,7 +22668,7 @@ setMapVisible(visible, mapName)\
\
-setMaxLoopIterations.description = Sets the max amount of loops (in [count():] , [foreach():] , [for():] , [while():] ) that are allowed.
+setMaxLoopIterations.description = Sets the max amount of loops (in [count():] , [foreach():] , [for():] , [while():] ) that are allowed.
setMaxLoopIterations.summary = \
\
\
@@ -22677,7 +22677,7 @@ setMaxLoopIterations.summary = \
setMaxLoopIterations() Function\
\
• Introduced in version 1.4.0.2\
- Sets the max amount of loops (in [count():], [foreach():], [for():], [while():]) that are allowed. The current allowed min is 10,000. Note that this settings lasts only for the current session.\
+ Sets the max amount of loops (in [count():], [foreach():], [for():], [while():]) that are allowed. The current allowed min is 10,000. Note that this settings lasts only for the current session.\
\
Usage\
\
@@ -22743,7 +22743,7 @@ setMaxRecursionDepth.summary = \
\
-setName.description = Sets the name of a Token .
+setName.description = Sets the name of a Token .
setName.summary = \
\
\
@@ -22752,7 +22752,7 @@ setName.summary = \
setName() Function\
\
• Introduced in version 1.3b40\
- Sets the name of a Token.\
+ Sets the name of a Token.\
\
Usage\
\
@@ -22766,7 +22766,7 @@ setName(name, id, mapname)\
\
\
name - The name to set on the current token.id - The token id of the token which has its name set. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token which has its name set. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -22785,7 +22785,7 @@ setName(name, id, mapname)\
\
-setNotes.description = Sets the notes of the Current Token .
+setNotes.description = Sets the notes of the Current Token .
setNotes.summary = \
\
\
@@ -22794,7 +22794,7 @@ setNotes.summary = \
setNotes() Function\
\
• Introduced in version 1.3b48\
- Sets the notes of the Current Token.\
+ Sets the notes of the Current Token.\
\
Usage\
\
@@ -22809,7 +22809,7 @@ setNotes(notes, id, mapname)\
\
\
notes - The notes to set on the token.id - The token id of the token to set the notes on. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to set the notes on. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -22822,7 +22822,7 @@ See also getNotes\
\
-setNPC.description = Sets a Token to a NPC Token .
+setNPC.description = Sets a Token to a NPC Token .
setNPC.summary = \
\
\
@@ -22832,11 +22832,11 @@ setNPC.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
- \
+ \
\
Usage\
\
@@ -22849,7 +22849,7 @@ setNPC(id, mapname)\
Parameter\
\
\
- id - The token id of the token which has its NPC status set, defaults to the Current Token.id - The token id of the token which has its NPC status set, defaults to the Current Token.mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -22897,7 +22897,7 @@ setOwnedByAll(owned, id, mapname)\
\
\
owned - The value of the setting to set, true(1) or false(0).id - The token id of the token which has its Owned by All status set, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token which has its Owned by All status set, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -22925,7 +22925,7 @@ setOwnedByAll(owned, id, mapname)\
\
-setOwner.description = Changes the owners of a token (default is the Current Token ) when given a String owner name or JSON Array of owner names.
+setOwner.description = Changes the owners of a token (default is the Current Token ) when given a String owner name or JSON Array of owner names.
setOwner.summary = \
\
\
@@ -22934,7 +22934,7 @@ setOwner.summary = \
setOwner() Function\
\
• Introduced in version 1.3b48?\
- Changes the owners of a token (default is the Current Token) when given a String owner name or JSON Array of owner names. All other owners are removed.\
+ Changes the owners of a token (default is the Current Token) when given a String owner name or JSON Array of owner names. All other owners are removed.\
\
Usage\
\
@@ -22950,33 +22950,33 @@ setOwner(ownerNames, id, mapname)\
Parameters\
\
\
- ownerName - The player name to set the ownership on the token. Ownership is not constrained to the client names currently connected, but only currently connected clients appear in the Token Editor Dialog. This parameter is a String. An empty string here is treated as an empty JSON array (see next parameter).ownerNames - The player names to set the ownership on the token. Ownership is not constrained to the client names currently connected, but only currently connected clients appear in the Token Editor Dialog. This parameter is a JSON Array.id - The token id of the token which has its owners changed, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
ownerName - The player name to set the ownership on the token. Ownership is not constrained to the client names currently connected, but only currently connected clients appear in the Token Editor Dialog. This parameter is a String. An empty string here is treated as an empty JSON array (see next parameter).ownerNames - The player names to set the ownership on the token. Ownership is not constrained to the client names currently connected, but only currently connected clients appear in the Token Editor Dialog. This parameter is a JSON Array.id - The token id of the token which has its owners changed, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
Examples\
\
- To change the owners of the Current Token to a single user use:\
+ To change the owners of the Current Token to a single user use:\
[h: setOwner("Frank")]\
-To change the owners of the Current Token to a list of three players use:\
+
To change the owners of the Current Token to a list of three players use:\
\
[h: setOwner("['Peter', 'Paul', 'Mary']")]\
or:\
\
[h: list = json.append("[]", "Peter", "Paul", "Mary")]\
[h: setOwner(list)]\
-To make all current players owners of the Current Token use:\
+
To make all current players owners of the Current Token use:\
\
[h: setOwner(getAllPlayerNames("json"))]\
-To remove all owners of the Current Token use:\
+
To remove all owners of the Current Token use:\
\
[h: setOwner("")]\
or:\
\
[h: setOwner("[]")]\
-To display the current owners of the Current Token as checkboxes, then accept the user's changes to apply back onto the token, use the following. Note that this example does not provide for adding owners to the list, only removing them. (Adding owners would require the use of getAllPlayerNames() and would make this example even more complex.)\
+
To display the current owners of the Current Token as checkboxes, then accept the user's changes to apply back onto the token, use the following. Note that this example does not provide for adding owners to the list, only removing them. (Adding owners would require the use of getAllPlayerNames() and would make this example even more complex.)\
\
[h: names = getOwners("json")]\
[h: input = "tab0 | OwnerList || TAB"]\
@@ -23010,7 +23010,7 @@ setOwner(ownerNames, id, mapname)\
\
-setOwnerOnlyVisible.description = Sets the Visible to Owners Only flag on a Token if the value passed in is non-zero( true ( 1 )), otherwise resets it to false ( 0 ).
+setOwnerOnlyVisible.description = Sets the Visible to Owners Only flag on a Token if the value passed in is non-zero( true ( 1 )), otherwise resets it to false ( 0 ).
setOwnerOnlyVisible.summary = \
\
\
@@ -23020,11 +23020,11 @@ setOwnerOnlyVisible.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b74\
- Sets the Visible to Owners Only flag on a Token if the value passed in is non-zero(true(1)), otherwise resets it to false(0).\
+ Sets the Visible to Owners Only flag on a Token if the value passed in is non-zero(true(1)), otherwise resets it to false(0).\
\
Usage\
\
@@ -23039,7 +23039,7 @@ setOwnerOnlyVisible.summary = \
\
\
visible - The state of owner only visibility, true(1) or false(0).id - The token id of the token which has its owner only visibility set, defaults to the Current Token.id - The token id of the token which has its owner only visibility set, defaults to the Current Token.
\
\
\
@@ -23052,7 +23052,7 @@ setOwnerOnlyVisible.summary = \
\
-setPC.description = Sets a Token to a PC Token .
+setPC.description = Sets a Token to a PC Token .
setPC.summary = \
\
\
@@ -23062,11 +23062,11 @@ setPC.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
- \
+ \
\
Usage\
\
@@ -23079,7 +23079,7 @@ setPC(id, mapname)\
Parameter\
\
\
- id - The token id of the token which has its PC status set, defaults to the Current Token.id - The token id of the token which has its PC status set, defaults to the Current Token.mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -23114,7 +23114,7 @@ setPenColor.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -23163,7 +23163,7 @@ setPenWidth.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -23203,7 +23203,7 @@ Regardless of the set width, a line will only be visible if it has a visible col
\
-setProperty.description = Sets the value of a Token Property on the Current Token (unless trusted, in which case a Token ID can be supplied to indicate which token is to be affected).
+setProperty.description = Sets the value of a Token Property on the Current Token (unless trusted, in which case a Token ID can be supplied to indicate which token is to be affected).
setProperty.summary = \
\
\
@@ -23212,7 +23212,7 @@ setProperty.summary = \
setProperty() Function\
\
• Introduced in version 1.3b48\
- Sets the value of a Token Property on the Current Token (unless trusted, in which case a Token ID can be supplied to indicate which token is to be affected).\
+ Sets the value of a Token Property on the Current Token (unless trusted, in which case a Token ID can be supplied to indicate which token is to be affected).\
Note that if there is not already an existing property by the name listed in the macro, setProperty will create a new Token Property with that name. Any created Property will not be visible in the Properties tab of the Edit Token window but can still be used like normal. It's value can be retrieved with the getProperty command.\
\
Usage\
@@ -23228,13 +23228,13 @@ setProperty(property, value, id, mapname)\
\
property - A string containing the name of the property that has its value set.value - The value that the property is set to.id - The token id of the token which has its property set, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token which has its property set, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
Examples\
\
- Sets a property named Health to the value of 10 on the Current Token.\
+ Sets a property named Health to the value of 10 on the Current Token.\
[h: setProperty("Health", 10)]\
Sets a property named Fatigue to the value of 5 on the selected token.\
\
@@ -23264,7 +23264,7 @@ setProperty(property, value, id, mapname)\
\
-setPropertyType.description = Sets the Property Type of a Token .
+setPropertyType.description = Sets the Property Type of a Token .
setPropertyType.summary = \
\
\
@@ -23273,7 +23273,7 @@ setPropertyType.summary = \
setPropertyType() Function\
\
• Introduced in version 1.3b48\
- Sets the Property Type of a Token.\
+ Sets the Property Type of a Token.\
\
Usage\
\
@@ -23287,7 +23287,7 @@ setPropertyType(type, id, mapname)\
\
\
type - The property type to set on the token.id - The token id of the token which has its property type set, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token which has its property type set, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -23312,7 +23312,7 @@ setPropertyType(type, id, mapname)\
\
-setSightType.description = Sets the type of sight that the Current Token has.
+setSightType.description = Sets the type of sight that the Current Token has.
setSightType.summary = \
\
\
@@ -23321,7 +23321,7 @@ setSightType.summary = \
setSightType() Function\
\
• Introduced in version 1.3b48\
- Sets the type of sight that the Current Token has.\
+ Sets the type of sight that the Current Token has.\
\
Usage\
\
@@ -23335,7 +23335,7 @@ setSightType(type, id, mapname)\
\
\
type - The type of sight to set.id - The id of the token to set the sight. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The id of the token to set the sight. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -23353,7 +23353,7 @@ setSightType(type, id, mapname)\
\
-setSize.description = Sets the size of a Token with one of the defined sizes according to each Grid Type.
+setSize.description = Sets the size of a Token with one of the defined sizes according to each Grid Type.
setSize.summary = \
\
\
@@ -23363,11 +23363,11 @@ setSize.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
- Sets the size of a Token with one of the defined sizes according to each Grid Type. The sizes can be found on the Token Size page.\
+ Sets the size of a Token with one of the defined sizes according to each Grid Type. The sizes can be found on the Token Size page.\
\
Usage\
\
@@ -23380,8 +23380,8 @@ setSize(size, id, mapname)\
Parameters\
\
\
- size - The Token Size to set the token to.id - The token id of the token which will have its Token Size set. Defaults to the Current Token.size - The Token Size to set the token to.id - The token id of the token which will have its Token Size set. Defaults to the Current Token.mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -23412,7 +23412,7 @@ setSize(size, id, mapname)\
\
-setSpeech.description = Sets the Speech value from the Current Token .
+setSpeech.description = Sets the Speech value from the Current Token .
setSpeech.summary = \
\
\
@@ -23421,7 +23421,7 @@ setSpeech.summary = \
setSpeech() Function\
\
• Introduced in version 1.3b48\
- Sets the Speech value from the Current Token.\
+ Sets the Speech value from the Current Token.\
\
Usage\
\
@@ -23432,7 +23432,7 @@ setSpeech.summary = \
\
-setState.description = Sets the value of the State on Token .
+setState.description = Sets the value of the State on Token .
setState.summary = \
\
\
@@ -23441,7 +23441,7 @@ setState.summary = \
setState() Function\
\
• Introduced in version 1.3b40\
- Sets the value of the State on Token. If The value is false(0) then the State is unset if it is non-zero(true(1)) then it is set.\
+ Sets the value of the State on Token. If The value is false(0) then the State is unset if it is non-zero(true(1)) then it is set.\
\
Usage\
\
@@ -23456,21 +23456,21 @@ setState(state, value, id, mapname)\
\
state - The name of the state to set on the token.value - The value of the state to set, true(1) or false(0).id - The id of the token to have the State set. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The id of the token to have the State set. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
Examples\
\
- To set the "Dead" Token State on the Current Token\
+ To set the "Dead" Token State on the Current Token\
[h: setState("Dead", 1)]\
-To reset the "Dead" Token State on the Current Token\
+
To reset the "Dead" Token State on the Current Token\
\
[h: setState("Dead", 0)]\
\
See Also\
\
- State,\
+ \
\
@@ -23486,7 +23486,7 @@ setState(state, value, id, mapname)\
\
-setStrProp.description = Returns a String Property List with the key set to the value passed in.
+setStrProp.description = Returns a String Property List with the key set to the value passed in.
setStrProp.summary = \
\
\
@@ -23495,7 +23495,7 @@ setStrProp.summary = \
setStrProp() Function\
\
• Introduced in version 1.3b42\
- Returns a String Property List with the key set to the value passed in.\
+ Returns a String Property List with the key set to the value passed in.\
\
Usage\
\
@@ -23506,19 +23506,19 @@ setStrProp.summary = \
Parameters\
\
\
- propList - The String Property List affected by this function.key - The key in the specified String Property List that will have its value set.propList - The String Property List affected by this function.key - The key in the specified String Property List that will have its value set.value - The value that the specified key will be set to.
\
\
Examples\
\
- Add a new key to an existing String Property List:\
+ Add a new key to an existing String Property List:\
[h: weapon = "name=longsword; damage=1d8; maxdamage=8"]\
[h: weapon = setStrProp(weapon, "value", 10)]\
[r: weapon]
\
Returns "name=longsword ; damage=1d8 ; maxdamage=8 ; value=10 ; "\
-
Change the value of a key in an existing String Property List:\
+
Change the value of a key in an existing String Property List:\
\
[h: weapon = "name=longsword; damage=1d8; maxdamage=8"]\
[h: weapon = setStrProp(weapon, "damage", "1d6")]\
@@ -23544,7 +23544,7 @@ setTableAccess.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.0.1\
@@ -23592,7 +23592,7 @@ setTableEntry.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.0.1\
@@ -23620,7 +23620,7 @@ setTableEntry(tableName, roll, result, imageId)\
See Also\
\
\
\
\
@@ -23636,7 +23636,7 @@ setTableImage.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.0.1\
@@ -23678,7 +23678,7 @@ setTablePickOnce.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.6.0\
@@ -23720,7 +23720,7 @@ setTableRoll.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.0.1\
@@ -23767,7 +23767,7 @@ setTableVisible.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.0.1\
@@ -23815,7 +23815,7 @@ setTerrainModifier.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.2\
@@ -23902,7 +23902,7 @@ setTokenDrawOrder(z, id, mapname)\
\
\
z - The Z coordinate to set the draw order to.id - The id of the token to move, defaults to the Current Token.id - The id of the token to move, defaults to the Current Token.mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -23936,7 +23936,7 @@ setTokenFacing.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b51\
@@ -23987,7 +23987,7 @@ setTokenGMName.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b40\
@@ -24008,7 +24008,7 @@ setTokenGMName.summary = \
\
-setTokenHandout.description = Sets the handout image for the for the Current Token .
+setTokenHandout.description = Sets the handout image for the for the Current Token .
setTokenHandout.summary = \
\
\
@@ -24017,7 +24017,7 @@ setTokenHandout.summary = \
setTokenHandout() Function\
\
• Introduced in version 1.3b77\
- Sets the handout image for the for the Current Token. The image can come from several sources. It can be an asset id (like from tblImage() orgetTokenImage().) or a Image Token.\
+ Sets the handout image for the for the Current Token. The image can come from several sources. It can be an asset id (like from tblImage() orgetTokenImage().) or a Image Token.\
\
Usage\
\
@@ -24035,7 +24035,7 @@ setTokenHandout(tokenImageName, id, mapname)\
Parameters\
\
\
- id - OPTIONAL: The token id of the token for which you want to set the handout, defaults to the Current Token.id - OPTIONAL: The token id of the token for which you want to set the handout, defaults to the Current Token.mapname - OPTIONAL: The name of the map to find the token. Defaults to the current map.
\
\
@@ -24075,7 +24075,7 @@ setTokenHeight(size, id, mapname)\
\
\
size - grid size of the tokenid - The token id of the token to set its height. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to set its height. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -24103,7 +24103,7 @@ setTokenHeight(size, id, mapname)\
\
-setTokenImage.description = Sets the image for the for the Current Token .
+setTokenImage.description = Sets the image for the for the Current Token .
setTokenImage.summary = \
\
\
@@ -24112,7 +24112,7 @@ setTokenImage.summary = \
setTokenImage() Function\
\
• Introduced in version 1.3b48\
- Sets the image for the for the Current Token. The function accepts an Asset ID or an Image Token name. You can get Asset IDs from macro functions such as tblImage() or getTokenImage(). Image Tokens are special tokens whose name starts with "image:".\
+ Sets the image for the for the Current Token. The function accepts an Asset ID or an Image Token name. You can get Asset IDs from macro functions such as tblImage() or getTokenImage(). Image Tokens are special tokens whose name starts with "image:".\
\
Usage\
\
@@ -24132,7 +24132,7 @@ setTokenImage(imageToken, id, mapname)\
\
assetId - The Asset ID for an image.imageToken - The name of an image token e.g. "image:myimage"id - OPTIONAL: The token id of the token for which you want to set the image, defaults to the Current Token.id - OPTIONAL: The token id of the token for which you want to set the image, defaults to the Current Token.mapname - OPTIONAL: The name of the map to find the token. Defaults to the current map.
\
\
@@ -24215,7 +24215,7 @@ setLayoutProps(scale, xOffset, yOffset, id, mapName)\
scale - The scale of the token layout. If an empty string, the scale is not changed.xOffset - The xOffset of the token layout. If an empty string, the xOffset is not changed. Negative values shift the image left.yOffset - The yOffset of the token layout. If an empty string, the yOffset is not changed. Negative values shift the image up.id - The token id of the token to name, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to name, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.The xOffset and yOffset values must be integers.\
@@ -24261,7 +24261,7 @@ setTokenOpacity(value, id, mapname)\
\
\
value - The value of the opacity to set, ranging from 0.0 (completely transparent) to 1.0 (completely opaque). This must be a floating point value with leading zero if less than 1.0.id - OPTIONAL: The token id of the token for which you want to retrieve the opacity, defaults to the Current Token.id - OPTIONAL: The token id of the token for which you want to retrieve the opacity, defaults to the Current Token.mapname - OPTIONAL: The name of the map to find the token. Defaults to the current map.
\
Returns\
@@ -24291,7 +24291,7 @@ The opacity value that was set.\
\
-setTokenPortrait.description = Sets the portrait image for the for the Current Token .
+setTokenPortrait.description = Sets the portrait image for the for the Current Token .
setTokenPortrait.summary = \
\
\
@@ -24300,7 +24300,7 @@ setTokenPortrait.summary = \
setTokenPortrait() Function\
\
• Introduced in version 1.3b77\
- Sets the portrait image for the for the Current Token. The image can come from several sources. It can be an asset id (like from tblImage() or getTokenImage()), or a Image Token.\
+ Sets the portrait image for the for the Current Token. The image can come from several sources. It can be an asset id (like from tblImage() or getTokenImage()), or a Image Token.\
\
Usage\
\
@@ -24318,7 +24318,7 @@ setTokenPortrait(tokenImageName, id, mapname)\
Parameters\
\
\
- id - OPTIONAL: The token id of the token for which you want to set the portrait, defaults to the Current Token.id - OPTIONAL: The token id of the token for which you want to set the portrait, defaults to the Current Token.mapname - OPTIONAL: The name of the map to find the token. Defaults to the current map.
\
\
@@ -24359,7 +24359,7 @@ setTokenShape(shape, id, mapname)\
\
\
shape - String value: "TOP_DOWN", "CIRCLE", "SQUARE", "FIGURE".id - The token id of the token to set to a new shape, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to set to a new shape, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
Result
\
@@ -24401,7 +24401,7 @@ The function returns the token's shape as a string value: "TOP_DOWN"\
-setTokenSnapToGrid.description = Sets the "snap to" behaviour for the Current Token or a specified token.
+setTokenSnapToGrid.description = Sets the "snap to" behaviour for the Current Token or a specified token.
setTokenSnapToGrid.summary = \
\
\
@@ -24410,7 +24410,7 @@ setTokenSnapToGrid.summary = \
setTokenSnapToGrid() Function\
\
• Introduced in version 1.4\
- Sets the "snap to" behaviour for the Current Token or a specified token.\
+ Sets the "snap to" behaviour for the Current Token or a specified token.\
\
Usage\
\
@@ -24464,7 +24464,7 @@ setTokenVBL.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.1.6\
@@ -24486,7 +24486,7 @@ setTokenVBL.summary = \
\
\
vbl - A JSON object containing the vbl to be added to the token. Use getTokenVBL() to get VBL from another token.id - OPTIONAL: The token id of the token for which you want to set this setting, defaults to the Current Token.id - OPTIONAL: The token id of the token for which you want to set this setting, defaults to the Current Token.
\
\
Example\
@@ -24498,14 +24498,14 @@ setTokenVBL.summary = \
\
[r: finalVblData = "{'shape':'none'}"]\
[r: setTokenVBL(finalVblData)]
\
-
Auto-generate VBL for the Current Token\
+
Auto-generate VBL for the Current Token\
\
[h: options = json.set("{}", "shape", "auto", "sensitivity", 10, "inverse", 0, "level", 2, "method", "DOUGLAS_PEUCKER_SIMPLIFIER", "r", 0, "g", 0, "b", 0, "a", 255)]\
[h: setTokenVBL(options)]
\
\
See Also\
\
- \
+ \
\
Version Changes\
\
@@ -24542,7 +24542,7 @@ setTokenWidth(size, id, mapname)\
\
\
size - grid size of the tokenid - The token id of the token to set its width. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to set its width. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -24613,7 +24613,7 @@ setViewArea.summary = \
\
-setVisible.description = Sets the Visible to Players flag on a Token if the value passed in is non-zero( true ( 1 )), otherwise resets it to false ( 0 ).
+setVisible.description = Sets the Visible to Players flag on a Token if the value passed in is non-zero( true ( 1 )), otherwise resets it to false ( 0 ).
setVisible.summary = \
\
\
@@ -24623,11 +24623,11 @@ setVisible.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b40\
- Sets the Visible to Players flag on a Token if the value passed in is non-zero(true(1)), otherwise resets it to false(0). The Visible to Players flag has two meanings, on a normal Token players will only be able to see the Token if it is set (when all other things like Fog of War etc are taken into account). If it is a Library Token then it determines if players can call Category:Macros using the [macro(...): ...] roll option.\
+ Sets the Visible to Players flag on a Token if the value passed in is non-zero(true(1)), otherwise resets it to false(0). The Visible to Players flag has two meanings, on a normal Token players will only be able to see the Token if it is set (when all other things like Fog of War etc are taken into account). If it is a Library Token then it determines if players can call Category:Macros using the [macro(...): ...] roll option.\
\
Usage\
\
@@ -24642,7 +24642,7 @@ setVisible.summary = \
\
\
visible - The state of visibility, true(1) or false(0).id - The token id of the token which has its player visibility set, defaults to the Current Token.id - The token id of the token which has its player visibility set, defaults to the Current Token.
\
\
\
@@ -24723,7 +24723,7 @@ showTextLabels.summary = \
\
• Introduced in version 1.6\
• Last checked for compatibility with version 1.6\
- Enables the display of Text Labels if they are not showing. This can also be set in the View menu.\
+ Enables the display of Text Labels if they are not showing. This can also be set in the View menu.\
\
Usage\
\
@@ -24754,7 +24754,7 @@ showTextLabels.summary = \
\
-sortInitiative.description = Sorts the Initiative Panel Tokens and returns the number of Tokens in the Initiative Panel .
+sortInitiative.description = Sorts the Initiative Panel Tokens and returns the number of Tokens in the Initiative Panel .
sortInitiative.summary = \
\
\
@@ -24764,11 +24764,11 @@ sortInitiative.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b41\
- Sorts the Initiative Panel Tokens and returns the number of Tokens in the Initiative Panel.\
+ Sorts the Initiative Panel Tokens and returns the number of Tokens in the Initiative Panel.\
- The Default sort order is descending, with any non-numeric values coming after any numbers, and any blank values coming last.
- Since 1.8: If the
reverseOrder parameter is 1, this order is reversed - blank values come first, and any non-numeric strings (in ascending lexical order) come before numbers (in ascending order).
\
\
Usage\
@@ -24792,7 +24792,7 @@ sortInitiative(reverseOrder)\
Reverse Order\
Command\
sortInitiative()
sortInitiative(0)sortInitiative(1)Result\
-
\
+\
\
\
@@ -24986,7 +24986,7 @@ sr4.summary = \
\
See Also\
\
- For another method of rolling dice, see Dice Expressions.\
+ For another method of rolling dice, see Dice Expressions.\
\
\
@@ -25022,7 +25022,7 @@ sr4e.summary = \
\
See Also\
\
- For another method of rolling dice, see Dice Expressions.\
+ For another method of rolling dice, see Dice Expressions.\
\
\
@@ -25208,10 +25208,10 @@ strfind.summary = \
strfind() Function\
\
• Introduced in version 1.3b48\
- Finds and extracts substrings from a string. strfind() is used to match a pattern against an input string and extract all of the capture groups. The function returns an id which can be used with other functions to extract the information. The supplied pattern is a regular expression.\
+ Finds and extracts substrings from a string. strfind() is used to match a pattern against an input string and extract all of the capture groups. The function returns an id which can be used with other functions to extract the information. The supplied pattern is a regular expression.\
Functions related to strfind():\
\
-- getFindCount(id)
- getGroupCount(id)
- getGroup(id, matchNo, groupNo)
- getGroupStart(id, matchNo, groupNo)
- getGroupEnd(id, matchNo, groupNo)
\
+- getFindCount(id)
- getGroupCount(id)
- getGroup(id, matchNo, groupNo)
- getGroupStart(id, matchNo, groupNo)
- getGroupEnd(id, matchNo, groupNo)
\
Both matchNo and groupNo start at 1, the special group number 0 returns the whole pattern match.\
\
Groups are the regex capture groups, designated by the parts in "(" parenthesis ")". Group 1 returns the string that matches the first regex statement in (), 2 returns the second, etc.\
@@ -25447,7 +25447,7 @@ string.summary = \
\
-stringToList.description = Converts a string into a string list using a pattern to determine separator between elements.
+stringToList.description = Converts a string into a string list using a pattern to determine separator between elements.
stringToList.summary = \
\
\
@@ -25456,7 +25456,7 @@ stringToList.summary = \
stringToList() Function\
\
• Introduced in version 1.3b48\
- Converts a string into a string list using a pattern to determine separator between elements. The specified delimiter is used to separate the elements in the Macros:string list if it is specified, otherwise the default value of "," is used. Pattern can be a regular expression.\
+ Converts a string into a string list using a pattern to determine separator between elements. The specified delimiter is used to separate the elements in the Macros:string list if it is specified, otherwise the default value of "," is used. Pattern can be a regular expression.\
\
Usage\
\
@@ -25656,7 +25656,7 @@ Returns a number than is between 0 and 12, which is th
\
See Also\
\
- For another method of rolling dice, see Dice Expressions.\
+ For another method of rolling dice, see Dice Expressions.\
\
\
@@ -25697,7 +25697,7 @@ Returns:"14"
\
-switchToken.description = Changes the Current Token for the remainder of the Macro.
+switchToken.description = Changes the Current Token for the remainder of the Macro.
switchToken.summary = \
\
\
@@ -25707,12 +25707,12 @@ switchToken.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
- Changes the Current Token for the remainder of the Macro.\
-In practice, "the remainder of the Macro" is the same as the variable scope. Thus, if a macro is running as a user defined function (see defineFunction() ) with a new scope, switchToken will only apply until the end of the current macro. Once control passes back to the calling macro, the Current Token reverts back to what it was before the external macro was called ( as a function ).\
+
Changes the Current Token for the remainder of the Macro.\
+In practice, "the remainder of the Macro" is the same as the variable scope. Thus, if a macro is running as a user defined function (see defineFunction() ) with a new scope, switchToken will only apply until the end of the current macro. Once control passes back to the calling macro, the Current Token reverts back to what it was before the external macro was called ( as a function ).\
If a defineFunction() does not create a new variable scope for the called macro, then effects of switchToken persist when control passes back to the calling macro.
\
Note: You cannot switch to a token on a different map.\
\
@@ -25749,8 +25749,8 @@ tbl(name, row)\
Parameters\
\
\
- name - A string containing the name of the table.row - The row of the table that should be returned.name - A string containing the name of the table.row - The row of the table that should be returned.
\
\
Examples\
@@ -25776,12 +25776,12 @@ tbl(name, row)\
\
See Also\
\
- tableImage()
There is a tool available to import tables from excel. You can find more about this here\
+ tableImage()
There is a tool available to import tables from excel. You can find more about this here\
\
\
-tableImage.description = Gets the image asset value from the specified table .
+tableImage.description = Gets the image asset value from the specified table .
tableImage.summary = \
\
\
@@ -25790,7 +25790,7 @@ tableImage.summary = \
tableImage() Function\
\
• Introduced in version 1.3b40\
- Gets the image asset value from the specified table. If the row is not specified then the default roll for the table is used.\
+ Gets the image asset value from the specified table. If the row is not specified then the default roll for the table is used.\
\
Usage\
\
@@ -25806,16 +25806,16 @@ tblImage(name, row, size)\
Parameters\
\
\
- name - A string containing the name of the table.row - The row of the table that should have the image asset returned.name - A string containing the name of the table.row - The row of the table that should have the image asset returned.size - The size the image asset returned should be. If the image is not square, this will be the size of the height.
\
\
Examples\
\
- Example 1: Display a random image from table "tbl1" using default roll:\
+ Example 1: Display a random image from table "tbl1" using default roll:\
<image src='[r: tableImage("tbl1")]'></image>\
-Example 1: Display the first image from table "tbl1":\
+
Example 1: Display the first image from table "tbl1":\
\
<image src='[r: tableImage("tbl1", 1)]'></image>\
Example 2: Display one of the first four images, resized to 40 pixels tall, from "tbl1", chosed randomly:\
@@ -25856,8 +25856,8 @@ tbl(name, row)\
Parameters\
\
\
- name - A string containing the name of the table.row - The row of the table that should be returned.name - A string containing the name of the table.row - The row of the table that should be returned.
\
\
Examples\
@@ -25883,12 +25883,12 @@ tbl(name, row)\
\
See Also\
\
- tableImage()
There is a tool available to import tables from excel. You can find more about this here\
+ tableImage()
There is a tool available to import tables from excel. You can find more about this here\
\
\
-tblImage.description = Gets the image asset value from the specified table .
+tblImage.description = Gets the image asset value from the specified table .
tblImage.summary = \
\
\
@@ -25897,7 +25897,7 @@ tblImage.summary = \
tableImage() Function\
\
• Introduced in version 1.3b40\
- Gets the image asset value from the specified table. If the row is not specified then the default roll for the table is used.\
+ Gets the image asset value from the specified table. If the row is not specified then the default roll for the table is used.\
\
Usage\
\
@@ -25913,16 +25913,16 @@ tblImage(name, row, size)\
Parameters\
\
\
- name - A string containing the name of the table.row - The row of the table that should have the image asset returned.name - A string containing the name of the table.row - The row of the table that should have the image asset returned.size - The size the image asset returned should be. If the image is not square, this will be the size of the height.
\
\
Examples\
\
- Example 1: Display a random image from table "tbl1" using default roll:\
+ Example 1: Display a random image from table "tbl1" using default roll:\
<image src='[r: tableImage("tbl1")]'></image>\
-Example 1: Display the first image from table "tbl1":\
+
Example 1: Display the first image from table "tbl1":\
\
<image src='[r: tableImage("tbl1", 1)]'></image>\
Example 2: Display one of the first four images, resized to 40 pixels tall, from "tbl1", chosed randomly:\
@@ -25949,7 +25949,7 @@ toggleFoW.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.1.3\
@@ -25980,7 +25980,7 @@ toggleFoW.summary = \
\
See Also\
\
- \
+ \
\
\
@@ -25995,7 +25995,7 @@ transferVBL.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.2.0\
@@ -26018,7 +26018,7 @@ transferVBL(value, delete, id)\
value - The value of the setting to set:\
0 transfer normal (blue) VBL to token (yellow) VBL1 transfer token (yellow) VBL to normal (blue) VBL
delete - Defines if the transferred VBL is deleted from the source.id - OPTIONAL: The token id of the token for which you want to set this setting, defaults to the Current Token.id - OPTIONAL: The token id of the token for which you want to set this setting, defaults to the Current Token.\
Examples\
@@ -26053,7 +26053,7 @@ transferVBL(value, delete, id)\
\
See Also\
\
- \
+ \
\
Version Changes\
\
@@ -26146,7 +26146,7 @@ Returns a number than is between 0 and 5.
\
\
See Also\
\
- For another method of rolling dice, see Dice Expressions.\
+ For another method of rolling dice, see Dice Expressions.\
\
\
@@ -26189,7 +26189,7 @@ Returns a number than is between 0 and 5.\
\
See Also\
\
- For another method of rolling dice, see Dice Expressions.\
+ For another method of rolling dice, see Dice Expressions.\
\
\
@@ -26225,7 +26225,7 @@ This Is a Test\
\
-varsFromStrProp.description = Creates variables from a string property list with the values assigned to variables with the names of the keys in the string property list .
+varsFromStrProp.description = Creates variables from a string property list with the values assigned to variables with the names of the keys in the string property list .
varsFromStrProp.summary = \
\
\
@@ -26234,7 +26234,7 @@ varsFromStrProp.summary = \
varsFromStrProp() Function\
\
• Introduced in version 1.3b42\
- Creates variables from a string property list with the values assigned to variables with the names of the keys in the string property list. The function returns the number of variables that were created.\
+ Creates variables from a string property list with the values assigned to variables with the names of the keys in the string property list. The function returns the number of variables that were created.\
\
Usage\
\
player - The player for which you want to retrieve the owned tokens, defaults to the current player.delim - the delimiter used to separate the values in the string list which defaults to "," if not specified.delim - the delimiter used to separate the values in the string list which defaults to "," if not specified.mapname - The name of the map to find the tokens. Defaults to the current map.To display the ids of all of the tokens on the current map by the Player use.\
\
[h: names = getOwnedNames(getPlayerName())]\
[foreach(name, names, "<br>"): name]\ @@ -8721,7 +8721,7 @@ getOwnedNames(player, delim, mapname)\
\
@@ -8730,7 +8730,7 @@ getOwnerOnlyVisible.summary = \
getOwnerOnlyVisible() Function\
\
\
-getOwners.description = Returns a String List or JSON Array containing the names of the owners of a Token .
+getOwners.description = Returns a String List or JSON Array containing the names of the owners of a Token .
getOwners.summary = \
• Introduced in version 1.3b74
\
- \
+ \
\ Usage\
\ @@ -8744,7 +8744,7 @@ getOwnerOnlyVisible.summary = \ Parameter\ \- \
-
id- The tokenidof token that has its player visibility checked, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidof token that has its player visibility checked, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
\
\
@@ -8757,7 +8757,7 @@ getOwnerOnlyVisible.summary = \
\
\
@@ -8766,7 +8766,7 @@ getOwners.summary = \
getOwners() Function\
\
• Introduced in version 1.3b48
\
- Returns a String List or JSON Array containing the names of the owners of a Token. The type of the value returned depends on the delimiter parameter.
\
+ Returns a String List or JSON Array containing the names of the owners of a Token. The type of the value returned depends on the delimiter parameter.
\
\ Usage\
\ @@ -8780,14 +8780,14 @@ getOwners(delim, id, mapname)\ Parameters\ \- \
-
delim- The delimiter used to separate the values in the String List, defaults to",". If set to"json", this function will return a JSON Array instead of a String List. \
- id- The tokenidof the token which has its owners returned, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ delim- The delimiter used to separate the values in the String List, defaults to",". If set to"json", this function will return a JSON Array instead of a String List. \
+ id- The tokenidof the token which has its owners returned, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ Example\
\ -To display the owners of the Current Token use.\
+
\
-getPC.description = Returns a list containing the ids of the PC tokens on the current map .
+getPC.description = Returns a list containing the ids of the PC tokens on the current map .
getPC.summary = \
To display the owners of the Current Token use.\
\
[h: names = getOwners()]\
[foreach(name, names, "<br>"): name]\ @@ -8809,7 +8809,7 @@ getOwners(delim, id, mapname)\
\
\
@@ -8819,12 +8819,12 @@ getPC.summary = \
\
\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b48
\
- Returns a list containing the ids of the PC tokens on the current map. The type of the value returned depends on the delimiter parameter.\
-\
Usage\
@@ -8833,19 +8833,19 @@ getPC.summary = \
\
- - If the delimiter is not specified then a string list is returned with the default value of
","is used. - If the delimiter
jsonthen a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
Returns a list containing the ids of the PC tokens on the current map. The type of the value returned depends on the delimiter parameter.\
+
\
- If the delimiter is not specified then a string list is returned with the default value of
","is used. - If the delimiter
jsonthen a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
Usage\
@@ -8833,19 +8833,19 @@ getPC.summary = \
getPC()\
getPC(delim)
\
delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
+
delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
\ Example\
\ -To display the ids of all of the PC tokens on the current map use.\
+
\
-getPCNames.description = Returns a list containing the names of the PC tokens on the current map .
+getPCNames.description = Returns a list containing the names of the PC tokens on the current map .
getPCNames.summary = \
To display the ids of all of the PC tokens on the current map use.\
\
[h: ids = getPC()]\
[foreach(id, ids, "<br>"): id]\ See Also\
\\
- [foreach():]\
+ [foreach():]\
\
\ Version Changes\ @@ -8859,7 +8859,7 @@ getPC(delim)\
\
\
@@ -8869,12 +8869,12 @@ getPCNames.summary = \
\
\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b48
\
- Returns a list containing the names of the PC tokens on the current map. The type of the value returned depends on the delimiter parameter.\
-\
Usage\
@@ -8883,19 +8883,19 @@ getPCNames.summary = \
\
- - If the delimiter is not specified then a string list is returned with the default value of
","is used. - If the delimiter
jsonthen a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
Returns a list containing the names of the PC tokens on the current map. The type of the value returned depends on the delimiter parameter.\
+
\
- If the delimiter is not specified then a string list is returned with the default value of
","is used. - If the delimiter
jsonthen a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
Usage\
@@ -8883,19 +8883,19 @@ getPCNames.summary = \
getPCNames()\
getPCNames(delim)
\
delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
+
delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
\ Example\
\ -To display the names of all of the PC tokens on the current map use.\
+
\
-getPCs.description = Returns a list containing the ids of the PC tokens on the current map .
+getPCs.description = Returns a list containing the ids of the PC tokens on the current map .
getPCs.summary = \
To display the names of all of the PC tokens on the current map use.\
\
[h: names = getPCNames()]\
[foreach(name, names, "<br>"): name]\ See Also\
\\
- [foreach():]\
+ [foreach():]\
\
\ Version Changes\ @@ -8909,7 +8909,7 @@ getPCNames(delim)\
\
\
@@ -8919,12 +8919,12 @@ getPCs.summary = \
\
\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b48
\
- Returns a list containing the ids of the PC tokens on the current map. The type of the value returned depends on the delimiter parameter.\
-\
Usage\
@@ -8933,19 +8933,19 @@ getPCs.summary = \
\
- - If the delimiter is not specified then a string list is returned with the default value of
","is used. - If the delimiter
jsonthen a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
Returns a list containing the ids of the PC tokens on the current map. The type of the value returned depends on the delimiter parameter.\
+
\
- If the delimiter is not specified then a string list is returned with the default value of
","is used. - If the delimiter
jsonthen a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
Usage\
@@ -8933,19 +8933,19 @@ getPCs.summary = \
getPC()\
getPC(delim)
\
delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
+
delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
\ Example\
\ -To display the ids of all of the PC tokens on the current map use.\
+ \
Version Changes\
@@ -8969,7 +8969,7 @@ getPenColor.summary = \
\
\
-getPlayerName.description = Returns the name of the player for the Client that it executes on.
+getPlayerName.description = Returns the name of the player for the Client that it executes on.
getPlayerName.summary = \
To display the ids of all of the PC tokens on the current map use.\
\
[h: ids = getPC()]\
[foreach(id, ids, "<br>"): id]\ See Also\
\\
- [foreach():]\
+ [foreach():]\
\
\
Version Changes\
@@ -8969,7 +8969,7 @@ getPenColor.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -9016,7 +9016,7 @@ getPenWidth.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -9054,7 +9054,7 @@ A drawing will have a line width, even if the line itself is not displayed. See
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\\
\
@@ -9063,7 +9063,7 @@ getPlayerName.summary = \
getPlayerName() Function\
\
\
-getProperty.description = Returns the value of a Token Property on a Token .
+getProperty.description = Returns the value of a Token Property on a Token .
getProperty.summary = \
• Introduced in version 1.3b48
\
- Returns the name of the player for the Client that it executes on.
\
+ Returns the name of the player for the Client that it executes on.
\
\ Usage\
\ @@ -9082,7 +9082,7 @@ getPlayerName.summary = \\
\
-getPropertyDefault.description = Returns the default value of a token property for the Current Token .
+getPropertyDefault.description = Returns the default value of a token property for the Current Token .
getPropertyDefault.summary = \
\
@@ -9091,8 +9091,8 @@ getProperty.summary = \
getProperty() Function\
\
\
• Introduced in version 1.3b48
\
- Returns the value of a Token Property on a Token.\
-If the Token Property is empty (
\
+ NULL) or not defined, an empty string ("") is returned.Returns the value of a Token Property on a Token.\
+If the Token Property is empty (
\
NULL) or not defined, an empty string ("") is returned.\ Usage\
\ @@ -9106,7 +9106,7 @@ getProperty(property, id, mapname)\ \- \
property- The property that has its value returned. For referencing the literal name of the property (for instance, if you wish to get the property Constitution configured in Campaign Properties), enclose the property name in quotes. If using a variable whose value is the name of the property, do not enclose the variable name in quotes. \
- id- The tokenidor name of the token that has its property value returned, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidor name of the token that has its property value returned, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ @@ -9145,7 +9145,7 @@ The value of property 'Constitution' is 12.
\
\
-getPropertyNames.description = Returns a String List or JSON Array containing the names of the Token Properties for the Current Token .
+getPropertyNames.description = Returns a String List or JSON Array containing the names of the Token Properties for the Current Token .
getPropertyNames.summary = \
\
@@ -9154,7 +9154,7 @@ getPropertyDefault.summary = \
getPropertyDefault() Function\
\
\
• Introduced in version 1.3b48
\
- Returns the default value of a token property for the Current Token. If the default value contains nothing then an empty string (
\
+ "") is returned.Returns the default value of a token property for the Current Token. If the default value contains nothing then an empty string (
\
"") is returned.\ Usage\
\ @@ -9167,13 +9167,13 @@ getPropertyDefault(name, propType)\ \- \
name- The name of the property to get the default value of. \
- propType- The token type to get the property from. Defaults to the token type of the Current Token. \
+ propType- The token type to get the property from. Defaults to the token type of the Current Token. \
\
\
@@ -9182,7 +9182,7 @@ getPropertyNames.summary = \
getPropertyNames() Function\
\
• Introduced in version 1.3b48
\
- Returns a String List or JSON Array containing the names of the Token Properties for the Current Token. The type of the value returned depends on the delimiter parameter. All names returned will be in lower case. Use getPropertyNamesRaw() to get the names as they are shown in Campaign Properties.\
+ \
@@ -9198,14 +9198,14 @@ getPropertyNames(delim, id, mapname)\
Parameters\
\
Returns a String List or JSON Array containing the names of the Token Properties for the Current Token. The type of the value returned depends on the delimiter parameter. All names returned will be in lower case. Use getPropertyNamesRaw() to get the names as they are shown in Campaign Properties.\
\
When a token is added to a campaign it inherits the currently defined properties of the current campaign. These properties are persistent in the token even if the properties are subsequently removed from the campaign. Properties that have been removed from the campaign are no longer editable via the Edit Token dialog but they are still present on the token and may be read and set with getProperty() and setProperty() respectively. To get all properties defined on a token, including those removed from the campaign, use getPropertyNames(). To see only the currently defined properties for the campaign, use getAllPropertyNames().
\
@@ -9198,14 +9198,14 @@ getPropertyNames(delim, id, mapname)\
Parameters\
\
\
- delim - The delimiter used to separate the values in the String List, defaults to ",". Returns a JSON Array if set to "json".id - The token id of the token which has its property names returned, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
delim - The delimiter used to separate the values in the String List, defaults to ",". Returns a JSON Array if set to "json".id - The token id of the token which has its property names returned, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
Example\
\
- To display the names of all of the properties on the current token use.\
+ To display the names of all of the properties on the current token use.\
[h: names = getPropertyNames()]\
[foreach(name, names, "<br>"): name]
\
\
@@ -9225,7 +9225,7 @@ getPropertyNames(delim, id, mapname)\
\
-getPropertyNamesRaw.description = Returns a String List or JSON Array containing the names of the Token Properties on a Token .
+getPropertyNamesRaw.description = Returns a String List or JSON Array containing the names of the Token Properties on a Token .
getPropertyNamesRaw.summary = \
\
\
@@ -9234,8 +9234,8 @@ getPropertyNamesRaw.summary = \
getPropertyNamesRaw() Function\
\
• Introduced in version 1.3b64\
- Returns a String List or JSON Array containing the names of the Token Properties on a Token. The type of the value returned depends on the delimiter parameter.\
-The difference between this function and getPropertyNames() is that getPropertyNames() returns all the property names in lower case (see this forum thread to get the reason why it was created).\
+ Returns a String List or JSON Array containing the names of the Token Properties on a Token. The type of the value returned depends on the delimiter parameter.\
+The difference between this function and getPropertyNames() is that getPropertyNames() returns all the property names in lower case (see this forum thread to get the reason why it was created).\
\
Usage\
\
@@ -9249,14 +9249,14 @@ getPropertyNamesRaw(delim, id, mapname)\
Parameters\
\
\
- delim - The delimiter used to separate the values in the String List, defaults to ",". Returns a JSON Array if set to "json".id - The token id of the token which has its property names returned, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
delim - The delimiter used to separate the values in the String List, defaults to ",". Returns a JSON Array if set to "json".id - The token id of the token which has its property names returned, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
Example\
\
- To display the names of all of the properties on the current token use.\
+ To display the names of all of the properties on the current token use.\
[h: names = getPropertyNamesRaw()]\
[foreach(name, names, "<br>"): name]
\
\
@@ -9279,7 +9279,7 @@ getPropertyNamesRaw(delim, id, mapname)\
\
-getPropertyType.description = Returns the Property Type of a Token .
+getPropertyType.description = Returns the Property Type of a Token .
getPropertyType.summary = \
\
\
@@ -9288,7 +9288,7 @@ getPropertyType.summary = \
getPropertyType() Function\
\
• Introduced in version 1.3b48\
- Returns the Property Type of a Token.\
+ Returns the Property Type of a Token.\
\
Usage\
\
@@ -9301,7 +9301,7 @@ getPropertyType(id, mapname)\
Parameter\
\
\
- id - The token id of the token which has its Property Type returned, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token which has its Property Type returned, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -9326,7 +9326,7 @@ getPropertyType(id, mapname)\
\
-getRawProperty.description = Gets the unevaluated value of a token property , returns "" if the property is empty.
+getRawProperty.description = Gets the unevaluated value of a token property , returns "" if the property is empty.
getRawProperty.summary = \
\
\
@@ -9335,7 +9335,7 @@ getRawProperty.summary = \
getRawProperty() Function\
\
• Introduced in version 1.3b51\
- Gets the unevaluated value of a token property, returns "" if the property is empty. This will not return the property's default value.\
+ Gets the unevaluated value of a token property, returns "" if the property is empty. This will not return the property's default value.\
\
Usage\
\
@@ -9394,13 +9394,13 @@ getRecursionDepth.summary = \
\
See Also\
\
- \
+ \
\
\
-getRolled.description = Returns a JSON Array of all the raw, i.e. unmodified, dice rolls that have occurred within the current macro context.
+getRolled.description = Returns a JSON Array of all the raw, i.e. unmodified, dice rolls that have occurred within the current macro context.
getRolled.summary = \
\
\
@@ -9409,7 +9409,7 @@ getRolled.summary = \
getRolled() Function\
\
• Introduced in version 1.5.2\
- Returns a JSON Array of all the raw, i.e. unmodified, dice rolls that have occurred within the current macro context.\
+ Returns a JSON Array of all the raw, i.e. unmodified, dice rolls that have occurred within the current macro context.\
\
Usage\
\
@@ -9446,7 +9446,7 @@ Get Rolled: [9,6,5,1]\
\
-getSelected.description = Returns a list containing the ids of the selected tokens on the current map .
+getSelected.description = Returns a list containing the ids of the selected tokens on the current map .
getSelected.summary = \
\
\
@@ -9455,8 +9455,8 @@ getSelected.summary = \
getSelected() Function\
\
• Introduced in version 1.3b48\
- Returns a list containing the ids of the selected tokens on the current map. The type of the value returned depends on the delimiter parameter.\
-- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
+ Returns a list containing the ids of the selected tokens on the current map. The type of the value returned depends on the delimiter parameter.\
+- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
\
\
Usage\
@@ -9465,12 +9465,12 @@ getSelected.summary = \
getSelected()\
getSelected(delim)
\
\
- delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
+
delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
\
\
Example\
\
- To display the ids of all of the selected tokens on the current map use.\
+ To display the ids of all of the selected tokens on the current map use.\
[h: ids = getSelected()]\
[foreach(id, ids, "<br>"): id]
\
\
@@ -9489,7 +9489,7 @@ getSelected(delim)\
\
-getSelectedNames.description = Returns a list containing the names of the selected tokens on the current map .
+getSelectedNames.description = Returns a list containing the names of the selected tokens on the current map .
getSelectedNames.summary = \
\
\
@@ -9498,8 +9498,8 @@ getSelectedNames.summary = \
getSelectedNames() Function\
\
• Introduced in version 1.3b48\
- Returns a list containing the names of the selected tokens on the current map. The type of the value returned depends on the delimiter parameter.\
-- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
+ Returns a list containing the names of the selected tokens on the current map. The type of the value returned depends on the delimiter parameter.\
+- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
\
\
Usage\
@@ -9508,12 +9508,12 @@ getSelectedNames.summary = \
getSelectedNames()\
getSelectedNames(delim)
\
\
- delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
+
delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
\
\
Example\
\
- To display the names of all of the selected tokens on the current map use.\
+ To display the names of all of the selected tokens on the current map use.\
[h: names = getSelectedNames()]\
[foreach(name, names, "<br>"): name]
\
\
@@ -9532,7 +9532,7 @@ getSelectedNames(delim)\
\
-getSightType.description = Returns the type of sight that the Current Token has.
+getSightType.description = Returns the type of sight that the Current Token has.
getSightType.summary = \
\
\
@@ -9541,7 +9541,7 @@ getSightType.summary = \
getSightType() Function\
\
• Introduced in version 1.3b48\
- Returns the type of sight that the Current Token has. When no sight type is set, returns an empty string.\
+ Returns the type of sight that the Current Token has. When no sight type is set, returns an empty string.\
\
Usage\
\
@@ -9554,7 +9554,7 @@ getSightType(mapname)\
Parameters\
\
\
- id - The id of the token to have the State set. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The id of the token to have the State set. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -9573,7 +9573,7 @@ getSightType(mapname)\
\
-getSize.description = Returns the Size of a Token .
+getSize.description = Returns the Size of a Token .
getSize.summary = \
\
\
@@ -9582,7 +9582,7 @@ getSize.summary = \
getSize() Function\
\
• Introduced in version 1.3b48\
- Returns the Size of a Token.\
+ Returns the Size of a Token.\
The sizes returned are:\
\
FineDiminutiveTinySmallMediumLargeHugeGargantuanColossal
\
@@ -9599,7 +9599,7 @@ getSize(id, mapname)\
Parameter\
\
\
- id - The token id of the token which has its Size returned, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token which has its Size returned, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -9648,7 +9648,7 @@ getSoundProperties(uri)\
Parameter\
\
\
- uri - The uri/url of the audio source to edit. If set to "*", a JSON Array containing the properties of all audio sources is returned. Defaults to "*".uri - The uri/url of the audio source to edit. If set to "*", a JSON Array containing the properties of all audio sources is returned. Defaults to "*".
\
Properties returned for streams: nicknames, uri, cycleCount, volume, startTime, stopTime, currentTime, totalTime, bufferTime, currentCount, status.\
\
@@ -9669,7 +9669,7 @@ getSoundProperties(uri)\
\
-getSpeech.description = Returns the Speech value from the Current Token .
+getSpeech.description = Returns the Speech value from the Current Token .
getSpeech.summary = \
\
\
@@ -9678,7 +9678,7 @@ getSpeech.summary = \
getSpeech() Function\
\
• Introduced in version 1.3b48\
- Returns the Speech value from the Current Token.\
+ Returns the Speech value from the Current Token.\
\
Usage\
\
@@ -9689,7 +9689,7 @@ getSpeech.summary = \
\
-getSpeechNames.description = Returns a list containing the speech names of the Current Token .
+getSpeechNames.description = Returns a list containing the speech names of the Current Token .
getSpeechNames.summary = \
\
\
@@ -9698,8 +9698,8 @@ getSpeechNames.summary = \
getSpeechNames() Function\
\
• Introduced in version 1.3b48\
- Returns a list containing the speech names of the Current Token. The type of the value returned depends on the delimiter parameter.\
-- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
+ Returns a list containing the speech names of the Current Token. The type of the value returned depends on the delimiter parameter.\
+- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
\
\
Usage\
@@ -9708,12 +9708,12 @@ getSpeechNames.summary = \
getSpeechNames()\
getSpeechNames(delim)
\
\
- delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
+
delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
\
\
Example\
\
- To display the names of all of the speech values for the Current Token use.\
+ To display the names of all of the speech values for the Current Token use.\
[h: names = getSpeech()]\
[foreach(name, names, "<br>"): name]
\
\
@@ -9731,7 +9731,7 @@ getSpeechNames(delim)\
\
-getState.description = Checks whether the specified State is active on a token, returning true ( 1 ) or false ( 0 ).
+getState.description = Checks whether the specified State is active on a token, returning true ( 1 ) or false ( 0 ).
getState.summary = \
\
\
@@ -9740,7 +9740,7 @@ getState.summary = \
getState() Function\
\
• Introduced in version 1.3b40\
- \
+ \
\
Usage\
\
@@ -9754,7 +9754,7 @@ getState(state, id, mapname)\
\
\
state - The name of the state to check for.id - The token id of the token to check for the state. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to check for the state. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -9768,7 +9768,7 @@ getState(state, id, mapname)\
\
See Also\
\
- \
+ \
\
Version Changes\
\
@@ -9782,7 +9782,7 @@ getState(state, id, mapname)\
\
-getStateImage.description = Gets the asset id for the image of a state, the state must be one of the image types for this to work.
+getStateImage.description = Gets the asset id for the image of a state, the state must be one of the image types for this to work.
getStateImage.summary = \
\
\
@@ -9791,7 +9791,7 @@ getStateImage.summary = \
getStateImage() Function\
\
• Introduced in version 1.3b40\
- Gets the asset id for the image of a state, the state must be one of the image types for this to work.\
+ Gets the asset id for the image of a state, the state must be one of the image types for this to work.\
\
Usage\
\
@@ -9811,7 +9811,7 @@ getStateImage.summary = \
\
Example\
\
- To display the image for the "Dead" token state use.\
+ To display the image for the "Dead" token state use.\
<img src='[r:getStateImage("Dead")]'></img>\
\
\
@@ -9838,7 +9838,7 @@ getSoundProperties(uri)\
Parameter\
\
\
- uri - The uri/url of the audio source to edit. If set to "*", a JSON Array containing the properties of all audio sources is returned. Defaults to "*".uri - The uri/url of the audio source to edit. If set to "*", a JSON Array containing the properties of all audio sources is returned. Defaults to "*".
\
Properties returned for streams: nicknames, uri, cycleCount, volume, startTime, stopTime, currentTime, totalTime, bufferTime, currentCount, status.\
\
@@ -9859,7 +9859,7 @@ getSoundProperties(uri)\
\
-getStrProp.description = Returns the value associated with a key from the specified string property list .
+getStrProp.description = Returns the value associated with a key from the specified string property list .
getStrProp.summary = \
\
\
@@ -9868,7 +9868,7 @@ getStrProp.summary = \
getStrProp() Function\
\
• Introduced in version 1.3b42\
- Returns the value associated with a key from the specified string property list.\
+ Returns the value associated with a key from the specified string property list.\
\
Usage\
\
@@ -9889,16 +9889,16 @@ getStrProp(propList, key, default, delim)\
\
Example\
\
- To get the name from a weapon string property list\
+ To get the name from a weapon string property list\
[h: weapon = "name=longsword; damage=1d8; maxdamage=8"]\
Name of Weapon: [r: getStrProp(weapon, "name")]
\
Returns Name of Weapon: longsword.\
-
To get the minimum damage from a weapon string property list with a default value should the key not exist\
+
To get the minimum damage from a weapon string property list with a default value should the key not exist\
\
[h: weapon = "name=longsword; damage=1d8; maxdamage=8"]\
Minimum damage of Weapon: [r: getStrProp(weapon, "mindamage", 1)]
\
Returns Minimum damage of Weapon: 1.\
-
To get the damage from a weapon string property list where the field delimiter is a colon. The default is 1d3 (note that a default value must be provided in order to specify the delimiter).\
+
To get the damage from a weapon string property list where the field delimiter is a colon. The default is 1d3 (note that a default value must be provided in order to specify the delimiter).\
\
[h: weapon = "name=longsword: damage=1d8: maxdamage=8"]\
Damage of Weapon: [r: getStrProp(weapon, "damage", "1d3", ":")]
\
@@ -9965,7 +9965,7 @@ getTableEntry.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.4\
@@ -10002,7 +10002,7 @@ getTableEntry.summary = \
\
-getTableImage.description = Gets the asset id for the image of the current row for the given table.
+getTableImage.description = Gets the asset id for the image of the current row for the given table.
getTableImage.summary = \
\
\
@@ -10012,11 +10012,11 @@ getTableImage.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
- Gets the asset id for the image of the current row for the given table. See setTableRoll() to learn how to set the current row.\
+ Gets the asset id for the image of the current row for the given table. See setTableRoll() to learn how to set the current row.\
\
Usage\
\
@@ -10050,7 +10050,7 @@ getTableNames.summary = \
getTableNames()\
getTableNames(delim)
\
\
- If delim is specified then it is used to separate the values in the list; if it is not specified then it defaults to ",". When delim is the string "json" the return value will be in the form of a JSON Array.\
+
If delim is specified then it is used to separate the values in the list; if it is not specified then it defaults to ",". When delim is the string "json" the return value will be in the form of a JSON Array.\
\
\
Examples\
@@ -10065,7 +10065,7 @@ getTableNames(delim)\
\
See Also\
\
- \
+ \
\
\
@@ -10080,7 +10080,7 @@ getTablePickOnce.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.6.0\
@@ -10121,7 +10121,7 @@ getTablePicksLeft.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.6.0\
@@ -10163,7 +10163,7 @@ getTableRoll.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.0.1\
@@ -10240,7 +10240,7 @@ getTerrainModifier.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.2\
@@ -10309,7 +10309,7 @@ getTextLabelStatus.summary = \
\
• Introduced in version 1.6\
• Last checked for compatibility with version 1.6\
- Get the display status for Text Labels. This is also shown in the View menu.\
+ Get the display status for Text Labels. This is also shown in the View menu.\
\
Usage\
\
@@ -10362,7 +10362,7 @@ getTokenDrawOrder(id, mapname)\
Parameter\
\
\
- id - The id of the token to move, defaults to the Current Token.id - The id of the token to move, defaults to the Current Token.mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -10408,7 +10408,7 @@ getTokenFacing(id, mapname)\
Parameters\
\
\
- id - The id of the token to get the facing from, defaults to the current token. Note: This parameter can only be used in a Trusted Macro.
id - The id of the token to get the facing from, defaults to the current token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
Returns\
@@ -10432,7 +10432,7 @@ The angle in degrees or "" if no facing has been set\
Returns:\
\
\
- \
+ \
\
\
\
@@ -10469,7 +10469,7 @@ getTokenGMName.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b40\
@@ -10509,7 +10509,7 @@ getTokenHalo.summary = \
\
-getTokenHandout.description = Returns the asset id of the handout image for the for the Current Token .
+getTokenHandout.description = Returns the asset id of the handout image for the for the Current Token .
getTokenHandout.summary = \
\
\
@@ -10517,7 +10517,7 @@ getTokenHandout.summary = \
\
getTokenHandout() Function\
\
- Returns the asset id of the handout image for the for the Current Token.\
+ Returns the asset id of the handout image for the for the Current Token.\
\
Usage\
\
@@ -10532,13 +10532,13 @@ getTokenHandout(size, id, mapname)\
\
\
size - OPTIONAL: The size the image should be returned as. If a blank string "", no size adjustment is done. Defaults to "".id - OPTIONAL: The token id of the token for which you want to retrieve the token handout image, defaults to the Current Token.id - OPTIONAL: The token id of the token for which you want to retrieve the token handout image, defaults to the Current Token.mapname - OPTIONAL: The name of the map to find the token. Defaults to the current map.
\
\
Example\
\
- To display the image for the current Token.\
+ To display the image for the current Token.\
<img src='[r:getTokenHandout()]'></img>
\
\
\
@@ -10577,7 +10577,7 @@ getTokenHeight(id, mapname)\
Parameter\
\
\
- id - The token id of the token to check for its height, defaults to the Current Token.id - The token id of the token to check for its height, defaults to the Current Token.mapname - The name of the map to find the token. Defaults to the current map.
\
Result
\
@@ -10613,7 +10613,7 @@ The token's boundary (image) height in pixels.\
\
-getTokenImage.description = Returns the asset id of the image for the for the Current Token .
+getTokenImage.description = Returns the asset id of the image for the for the Current Token .
getTokenImage.summary = \
\
\
@@ -10621,7 +10621,7 @@ getTokenImage.summary = \
\
getTokenImage() Function\
\
- Returns the asset id of the image for the for the Current Token.\
+ Returns the asset id of the image for the for the Current Token.\
\
Usage\
\
@@ -10636,15 +10636,15 @@ getTokenImage(size, id, mapname)\
\
\
size - OPTIONAL: The size in pixels the image should be returned as. If a blank string "", no size adjustment is done. Defaults to "".id - OPTIONAL: The token id of the token for which you want to retrieve the token image, defaults to the Current Token.id - OPTIONAL: The token id of the token for which you want to retrieve the token image, defaults to the Current Token.mapname - OPTIONAL: The name of the map to find the token. Defaults to the current map.
\
\
Examples\
\
- To display the image for the current token.\
+ To display the image for the current token.\
<img src='[r:getTokenImage()]'></img>
\
-To get the image of any token using its id and the token roll option.\
+
To get the image of any token using its id and the token roll option.\
\
[h, token(tokenId): imgAsset = getTokenImage()]
\
\
@@ -10688,7 +10688,7 @@ getTokenLabel.summary = \
\
-getTokenLayoutProps.description = Return the Token Layout scale , xOffset , and yOffset values in either a JSON Object or String Property List .
+getTokenLayoutProps.description = Return the Token Layout scale , xOffset , and yOffset values in either a JSON Object or String Property List .
getTokenLayoutProps.summary = \
\
\
@@ -10697,7 +10697,7 @@ getTokenLayoutProps.summary = \
getTokenLayoutProps() Function\
\
• Introduced in version 1.6.1\
- Return the Token Layout scale, xOffset, and yOffset values in either a JSON Object or String Property List. These values represent the positioning of the token image within the Layout portion of the Config tab in the Edit Token Dialog.\
+ Return the Token Layout scale, xOffset, and yOffset values in either a JSON Object or String Property List. These values represent the positioning of the token image within the Layout portion of the Config tab in the Edit Token Dialog.\
\
Usage\
\
@@ -10712,7 +10712,7 @@ getTokenLayoutProps(delim, id, mapName)\
\
\
delim - The delimiter of the String Property List. If set to json, the function will instead return a Json Object. Defaults to ,.id - The token id of the token to name, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to name, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -10754,7 +10754,7 @@ getTokenMap.summary = \
getTokenMap() Function\
\
• Introduced in version 1.5.11\
- Gets the list of map(s) where a token resides. The list is returned either as a string list, or as a JSON Array.\
+ Gets the list of map(s) where a token resides. The list is returned either as a string list, or as a JSON Array.\
\
Usage\
\
@@ -10782,7 +10782,7 @@ getTokenMap(name/ID, delim)\
\
-getTokenNames.description = Gets a list containing the names of all the tokens on the current map , or all the tokens that match the specified conditions.
+getTokenNames.description = Gets a list containing the names of all the tokens on the current map , or all the tokens that match the specified conditions.
getTokenNames.summary = \
\
\
@@ -10792,11 +10792,11 @@ getTokenNames.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
- Gets a list containing the names of all the tokens on the current map, or all the tokens that match the specified conditions. The type of the value returned depends on the delimiter parameter. This function does not return the IDs of lib:tokens. Note: apparently the order of the list that getTokens() returns is also the z-order of the tokens, where the lowest z-order is the first in the list or array that is returned!\
+ Gets a list containing the names of all the tokens on the current map, or all the tokens that match the specified conditions. The type of the value returned depends on the delimiter parameter. This function does not return the IDs of lib:tokens. Note: apparently the order of the list that getTokens() returns is also the z-order of the tokens, where the lowest z-order is the first in the list or array that is returned!\
\
Usage\
\
@@ -10809,9 +10809,9 @@ getTokenNames(delim, conditions)\
Parameters\
\
\
- delim - The delimiter used to separate the values in the String List that is returned, defaults to ",". If "json" is specified, a JSON Array is returned instead of a String List.conditions - A JSON Object that contains various conditions that the tokens must fullfill. All conditions are optional.\
-setStates - A JSON array of states the token must have or a single state name as a string. Any token which does not contain all of these states in the true condition will be removed from the returned list.unsetStates - A JSON array of states the token must not have or a single state name as a string.npc - If the token must be a NPC, set to true(1) or false(0).pc - If the token must be a PC, set to true(1) or false(0).propertyType - A JSON array of token types or a single token type as a string. Only tokens of a type included in the array will be returned.selected - If the token must be selected, set to true(1) or false(0).impersonated - If the token must be impersonated, set to true(1) or false(0).current - If the token must be the current token, set to true(1) or false(0).owned - A JSON Array containing player names. All tokens that have at least one of the listed players as owner will be returned. Alternatively, a string containing one of the following options:\
+ delim - The delimiter used to separate the values in the String List that is returned, defaults to ",". If "json" is specified, a JSON Array is returned instead of a String List.conditions - A JSON Object that contains various conditions that the tokens must fullfill. All conditions are optional.\
+setStates - A JSON array of states the token must have or a single state name as a string. Any token which does not contain all of these states in the true condition will be removed from the returned list.unsetStates - A JSON array of states the token must not have or a single state name as a string.npc - If the token must be a NPC, set to true(1) or false(0).pc - If the token must be a PC, set to true(1) or false(0).propertyType - A JSON array of token types or a single token type as a string. Only tokens of a type included in the array will be returned.selected - If the token must be selected, set to true(1) or false(0).impersonated - If the token must be impersonated, set to true(1) or false(0).current - If the token must be the current token, set to true(1) or false(0).owned - A JSON Array containing player names. All tokens that have at least one of the listed players as owner will be returned. Alternatively, a string containing one of the following options:\
self - tokens owned by the current playernotself - tokens not owned by the current playerothers - tokens owned by any player, but not owned by the current playerany - tokens owned by any playernone - tokens not owned by any playersingle - tokens owned by a single playermultiple - tokens owned by more than one playerbyall - tokens owned by all playersnotbyall - tokens not owned by all players
visible - If the token is visible in the current client's view. Set to true(1) or false(0).\
- When the visible option is used only tokens on the TOKEN layer and which are shown within the client's current map view will be returned.
- This is not a test of whether or not other tokens on the map out of view are visible to a specific token. See canSeeToken().
- GMs will be able to see all tokens within the current map view. Players (including View as Player) will only get returned those tokens that are shown in their current map view. Tokens returned will also be affected by server settings like Individual Views.
layer - A JSON array of layer names, or a single layer name as a string. Note that a token not on any of the listed layers will be removed from the list returned.mapName - The name of the map to get the tokens from. Defaults to the current map.range - A JSON object with range conditions, all range conditions are optional.\
token - The id or name of the source token that the distance is measured from, defaults to the current token.\
@@ -10839,7 +10839,7 @@ getTokenNames(delim, conditions)\
*You can use the following code to print out the names of all of the tokens on the current map:\
[h: names = getTokenNames()]\
[foreach(name, names, "<br>"): name]
\
-- Find and return a JSON Array containing all NPC tokens' names that are within 2 squares or hexes:
\
+- Find and return a JSON Array containing all NPC tokens' names that are within 2 squares or hexes:
\
[h: cond = '{ range: {upto:2, distancePerCell:0}, npc:1 }']\
[h: names = getTokenNames("json", cond)]
\
- Modifying the above example to exclude dead tokens:
\
@@ -10931,7 +10931,7 @@ getTokenNativeHeight(id, mapname)\
Parameter\
\
\
- id - The token id of the token to check for its height, defaults to the Current Token.id - The token id of the token to check for its height, defaults to the Current Token.mapname - The name of the map to find the token. Defaults to the current map.
\
Result
\
@@ -10989,7 +10989,7 @@ getTokenNativeWidth(id, mapname)\
Parameters\
\
\
- id - The token id of the token to check for its width, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to check for its width, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
Result
\
@@ -11047,7 +11047,7 @@ getTokenOpacity(id, mapname)\
Parameters\
\
\
- id - OPTIONAL: The token id of the token for which you want to retrieve the opacity, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - OPTIONAL: The token id of the token for which you want to retrieve the opacity, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - OPTIONAL: The name of the map to find the token. Defaults to the current map.
\
\
@@ -11074,7 +11074,7 @@ getTokenOpacity(id, mapname)\
\
-getTokenPortrait.description = Returns the asset id of the portrait image for the for the Current Token .
+getTokenPortrait.description = Returns the asset id of the portrait image for the for the Current Token .
getTokenPortrait.summary = \
\
\
@@ -11082,7 +11082,7 @@ getTokenPortrait.summary = \
\
getTokenPortrait() Function\
\
- Returns the asset id of the portrait image for the for the Current Token.\
+ Returns the asset id of the portrait image for the for the Current Token.\
\
Usage\
\
@@ -11097,13 +11097,13 @@ getTokenPortrait(size, id, mapname)\
\
\
size - OPTIONAL: The size the picture should be returned as. If a blank string "", no size adjustment is done. Defaults to "".id - OPTIONAL: The token id of the token for which you want to retrieve the token image, defaults to the Current Token.id - OPTIONAL: The token id of the token for which you want to retrieve the token image, defaults to the Current Token.mapname - OPTIONAL: The name of the map to find the token. Defaults to the current map.
\
\
Examples\
\
- To display the image for the current Token.\
+ To display the image for the current Token.\
<img src='[r:getTokenPortrait()]'></img>
\
\
Version Changes\
@@ -11147,7 +11147,7 @@ getTokenRotation(id, mapname)\
Parameters\
\
\
- id - The token id of the token to retrieve the rotation angle. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to retrieve the rotation angle. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
Result
\
@@ -11166,7 +11166,7 @@ The function returns the token's rotation as a numeric value measured in degrees
[h: switchToken("Troll")]\
[r: token.name] - [r: r = getTokenRotation()]
\
Returns:\
-\
+\
Relation to Token Facing
When the facing is defined, the relation between a token's rotation and the token's facing can be expressed as\
\
rotation = -(facing + 90)
\
@@ -11199,7 +11199,7 @@ getTokens.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
@@ -11217,9 +11217,9 @@ getTokens(delim, conditions)\
Parameters\
\
\
- delim - The delimiter used to sepearate the values in the String List that is returned, defaults to ",". If "json" is specified, a JSON Array is returned instead of a String List.conditions - A JSON Object that contains various conditions that the tokens must fullfill. All conditions are optional.\
-setStates - A JSON array of states the token must have or a single state name as a string. Any token which does not contain all of these states in the true condition will be removed from the returned list.unsetStates - A JSON array of states the token must not have or a single state name as a string.npc - If the token must be a NPC, set to true(1) or false(0).pc - If the token must be a PC, set to true(1) or false(0).propertyType - A JSON array of token types or a single token type as a string. Only tokens of a type included in the array will be returned.selected - If the token must be selected, set to true(1) or false(0).impersonated - If the token must be impersonated, set to true(1) or false(0).current - If the token must be the current token, set to true(1) or false(0).owned - A JSON Array containing player names. All tokens that have at least one of the listed players as owner will be returned. Alternatively, a string containing one of the following options:\
+ delim - The delimiter used to sepearate the values in the String List that is returned, defaults to ",". If "json" is specified, a JSON Array is returned instead of a String List.conditions - A JSON Object that contains various conditions that the tokens must fullfill. All conditions are optional.\
+setStates - A JSON array of states the token must have or a single state name as a string. Any token which does not contain all of these states in the true condition will be removed from the returned list.unsetStates - A JSON array of states the token must not have or a single state name as a string.npc - If the token must be a NPC, set to true(1) or false(0).pc - If the token must be a PC, set to true(1) or false(0).propertyType - A JSON array of token types or a single token type as a string. Only tokens of a type included in the array will be returned.selected - If the token must be selected, set to true(1) or false(0).impersonated - If the token must be impersonated, set to true(1) or false(0).current - If the token must be the current token, set to true(1) or false(0).owned - A JSON Array containing player names. All tokens that have at least one of the listed players as owner will be returned. Alternatively, a string containing one of the following options:\
self - tokens owned by the current playernotself - tokens not owned by the current playerothers - tokens owned by any player, but not owned by the current playerany - tokens owned by any playernone - tokens not owned by any playersingle - tokens owned by a single playermultiple - tokens owned by more than one playerbyall - tokens owned by all playersnotbyall - tokens not owned by all players
visible - If the token is visible in the current client's view. Set to true(1) or false(0).\
- When the visible option is used only tokens on the TOKEN layer and which are shown within the client's current map view will be returned.
- This is not a test of whether or not other tokens on the map out of view are visible to a specific token. See canSeeToken().
- GMs will be able to see all tokens within the current map view. Players (including View as Player) will only get returned those tokens that are shown in their current map view. Tokens returned will also be affected by server settings like Individual Views.
layer - A JSON array of layer names, or a single layer name as a string. Only tokens on one of the listed layers will be returned. By default, tokens on the Token and Hidden layers are returned.mapName - The name of the map to get the tokens from. Defaults to the current map.range - A JSON object with range conditions, all range conditions are optional.\
token - The id or name of the source token that the distance is measured from, defaults to the current token.\
@@ -11250,7 +11250,7 @@ The movement metric in range specifies the movement metric use, the metric can b
[foreach(id, ids, "<br>"): id]
\
- Find ALL the tokens on ALL the layers on the map:
\
[r:getTokens(",", json.set("{}", "layer", json.append("[]","TOKEN","HIDDEN","OBJECT","BACKGROUND")))]
\
-- Find and return a JSON Array containing all NPC tokens that are with 2 squares or hexes of the selected token:
\
+- Find and return a JSON Array containing all NPC tokens that are with 2 squares or hexes of the selected token:
\
[h: cond = '{ "range": {"upto":2, "distancePerCell":0, "token":"' +getSelected()+ '"}, "npc":1}']\
[h: ids = getTokens("json", cond)]
\
- Modifying the above example to exclude dead tokens:
\
@@ -11337,7 +11337,7 @@ getTokenShape(id, mapname)\
Parameters\
\
\
- id - The token id of the token to check for the shape, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to check for the shape, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
Result
\
@@ -11370,7 +11370,7 @@ The function returns the token's shape as a string value: "TOP_DOWN"\
-getTokenStates.description = Returns the valid states in the campaign settings in either a String List or JSON Array .
+getTokenStates.description = Returns the valid states in the campaign settings in either a String List or JSON Array .
getTokenStates.summary = \
\
\
@@ -11379,7 +11379,7 @@ getTokenStates.summary = \
getTokenStates() Function\
\
• Introduced in version 1.3b51\
- Returns the valid states in the campaign settings in either a String List or JSON Array. Alternatively, if a token id is specified, instead returns the list of the states that are set to true(1) for the token.\
+ Returns the valid states in the campaign settings in either a String List or JSON Array. Alternatively, if a token id is specified, instead returns the list of the states that are set to true(1) for the token.\
\
Usage\
\
@@ -11396,21 +11396,21 @@ getTokenStates(delim, groupName, id, mapname)\
\
delim - Specifies the delimiter used in the string list that is returned, default is ",". If the value is set to json, the function returns a JSON array instead.groupName - Specifies the name of the group to get the states for. If set to "*", get all states.id - The id of the token to get the states set to true(1). If the parameter is not used, instead returns all valid states in the campaign settings. Note: This parameter can only be used in a Trusted Macro.
id - The id of the token to get the states set to true(1). If the parameter is not used, instead returns all valid states in the campaign settings. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map where the token is. Set to the current map by default.
\
\
Example\
\
- To get a String List of the valid Token States in the campaign.\
+ To get a String List of the valid Token States in the campaign.\
[h: states = getTokenStates()]
\
-To get a JSON Array of the valid Token States in the campaign.\
+
To get a JSON Array of the valid Token States in the campaign.\
\
[h: states = getTokenStates("json")]\
-To get a JSON Array of the valid Token States in the Damage group in the campaign in 1.3b55 or later.\
+
To get a JSON Array of the valid Token States in the Damage group in the campaign in 1.3b55 or later.\
\
[h: states = getTokenStates("json", "Damage")]\
-To get a JSON Array of the Token States set to true(1) for the "Dragon" token:\
+
To get a JSON Array of the Token States set to true(1) for the "Dragon" token:\
\
[h: states = getTokenStates("json", "*", "Dragon")]\
\
@@ -11439,7 +11439,7 @@ getTokenVBL.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.1.6\
@@ -11458,7 +11458,7 @@ getTokenVBL.summary = \
Parameters\
\
\
- id - OPTIONAL: The token id of the token for which you want to get the VBL. Defaults to the Current Token.id - OPTIONAL: The token id of the token for which you want to get the VBL. Defaults to the Current Token.
\
\
Example:\
@@ -11476,7 +11476,7 @@ getTokenVBL.summary = \
\
See Also\
\
- \
+ \
\
\
@@ -11503,7 +11503,7 @@ getTokenWidth(id, mapname)\
Parameters\
\
\
- id - The token id of the token to check for its width, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to check for its width, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
Result
\
@@ -11563,7 +11563,7 @@ getTokenX(units, id, mapname)\
\
\
units - If set to false(0), the coordinate is a location on the grid in number of cells. Defaults to true(1), where the coordinate is in number of Pixels (in other words 0:distance in cells, 1: distance in pixels)'.id - The id of the token to move, defaults to the Current Token.id - The id of the token to move, defaults to the Current Token.mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -11595,13 +11595,13 @@ The exception to this is when the token is 'Freesize' AND 'Snapped to Grid' AND
\
Examples\
\
- Moves the Current Token down 5 units, and left 10 units.\
+ Moves the Current Token down 5 units, and left 10 units.\
[h: CurrentX = getTokenX()]\
[h: CurrentY = getTokenY()]\
[h: NewX = CurrentX + 5]\
[h: NewY = CurrentY - 10]\
[h: moveToken(NewX, NewY)]
\
-Moves the Current Token down 5 cells, and left 10 cells.\
+
Moves the Current Token down 5 cells, and left 10 cells.\
\
[h: CurrentX = getTokenX(0)]\
[h: CurrentY = getTokenY(0)]\
@@ -11651,7 +11651,7 @@ getTokenY(units, id, mapname)
\
\
\
units - If set to false(0), the coordinate is a location on the grid in number of cells. Defaults to true(1), where the coordinate is in number of Pixels (in other words 0:distance in cells, 1: distance in pixels)'.id - The id of the token to move, defaults to the Current Token.id - The id of the token to move, defaults to the Current Token.mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -11683,13 +11683,13 @@ The exception to this is when the token is 'Freesize' AND 'Snapped to Grid' AND
\
Examples\
\
- Moves the Current Token down 5 units, and left 10 units.\
+ Moves the Current Token down 5 units, and left 10 units.\
[h: CurrentX = getTokenX()]\
[h: CurrentY = getTokenY()]\
[h: NewX = CurrentX + 5]\
[h: NewY = CurrentY - 10]\
[h: moveToken(NewX, NewY)]
\
-Moves the Current Token down 5 cells, and left 10 cells.\
+
Moves the Current Token down 5 cells, and left 10 cells.\
\
[h: CurrentX = getTokenX(0)]\
[h: CurrentY = getTokenY(0)]\
@@ -11725,7 +11725,7 @@ getVBL.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b90\
@@ -11764,7 +11764,7 @@ getVBL.summary = \
\
See Also\
\
- \
+ \
\
\
@@ -11875,7 +11875,7 @@ centerX=646; centerY=319,\
\
-getVisible.description = Returns true ( 1 ) if the visible to players flag is set on a Token otherwise returns false ( 0 ).
+getVisible.description = Returns true ( 1 ) if the visible to players flag is set on a Token otherwise returns false ( 0 ).
getVisible.summary = \
\
\
@@ -11884,7 +11884,7 @@ getVisible.summary = \
getVisible() Function\
\
• Introduced in version 1.3b40\
- Returns true(1) if the visible to players flag is set on a Token otherwise returns false(0). The visible to players flag has two meanings, on a normal Token players will only be able to see the Token if it is set (when all other things like Fog of War etc are taken into account). If it is a Library Token then it determines if players can call Macros using [macro():].\
+ Returns true(1) if the visible to players flag is set on a Token otherwise returns false(0). The visible to players flag has two meanings, on a normal Token players will only be able to see the Token if it is set (when all other things like Fog of War etc are taken into account). If it is a Library Token then it determines if players can call Macros using [macro():].\
\
Usage\
\
@@ -11898,7 +11898,7 @@ getVisible.summary = \
Parameter\
\
\
- id - The token id of token that has its player visibility checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of token that has its player visibility checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
\
\
\
@@ -11921,7 +11921,7 @@ getVisible.summary = \
\
-getVisibleMapDisplayNames.description = Returns the display names of all of the player visible maps as either a String List or JSON Array .
+getVisibleMapDisplayNames.description = Returns the display names of all of the player visible maps as either a String List or JSON Array .
getVisibleMapDisplayNames.summary = \
\
\
@@ -11930,7 +11930,7 @@ getVisibleMapDisplayNames.summary = \
getVisibleMapNames() Function\
\
• Introduced in version 1.9.0\
- Returns the display names of all of the player visible maps as either a String List or JSON Array.\
+ Returns the display names of all of the player visible maps as either a String List or JSON Array.\
\
Usage\
\
@@ -11944,14 +11944,14 @@ getVisibleMapDisplayNames.summary = \
Parameters\
\
\
- delim - The delimiter to use for the String List. If the value is json then a JSON Array is returned.delim - The delimiter to use for the String List. If the value is json then a JSON Array is returned.
\
\
Examples\
\
- To get the display names of all of the player visible maps in a String List.\
+ To get the display names of all of the player visible maps in a String List.\
[h: maps = getVisibleMapNames()]
\
-To get the display names of all of the player visible maps in a JSON Array\
+
To get the display names of all of the player visible maps in a JSON Array\
\
[h: maps = getVisibleMapNames("json")]\
\
@@ -11965,7 +11965,7 @@ getVisibleMapDisplayNames.summary = \
\
-getVisibleMapNames.description = Returns the names of all of the player visible maps as either a String List or JSON Array .
+getVisibleMapNames.description = Returns the names of all of the player visible maps as either a String List or JSON Array .
getVisibleMapNames.summary = \
\
\
@@ -11974,7 +11974,7 @@ getVisibleMapNames.summary = \
getVisibleMapNames() Function\
\
• Introduced in version 1.3b55\
- Returns the names of all of the player visible maps as either a String List or JSON Array.\
+ Returns the names of all of the player visible maps as either a String List or JSON Array.\
\
Usage\
\
@@ -11988,14 +11988,14 @@ getVisibleMapNames.summary = \
Parameters\
\
\
- delim - The delimiter to use for the String List. If the value is json then a JSON Array is returned.delim - The delimiter to use for the String List. If the value is json then a JSON Array is returned.
\
\
Examples\
\
- To get the names of all of the player visible maps in a String List.\
+ To get the names of all of the player visible maps in a String List.\
[h: maps = getVisibleMapNames()]
\
-To get the names of all of the player visible maps in a JSON Array\
+
To get the names of all of the player visible maps in a JSON Array\
\
[h: maps = getVisibleMapNames("json")]\
\
@@ -12009,7 +12009,7 @@ getVisibleMapNames.summary = \
\
-getVisibleTokenNames.description = Returns a string list or JSON Array of Token:token names for the tokens that are visible to the player.
+getVisibleTokenNames.description = Returns a string list or JSON Array of Token:token names for the tokens that are visible to the player.
getVisibleTokenNames.summary = \
\
\
@@ -12018,8 +12018,8 @@ getVisibleTokenNames.summary = \
getVisibleTokenNames() Function\
\
• Introduced in version 1.3b49\
- Returns a string list or JSON Array of Token:token names for the tokens that are visible to the player. The type of the value returned depends on the delimiter parameter.\
-- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
+ Returns a string list or JSON Array of Token:token names for the tokens that are visible to the player. The type of the value returned depends on the delimiter parameter.\
+- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
\
\
Usage\
@@ -12051,7 +12051,7 @@ getVisibleTokenNames.summary = \
\
-getVisibleTokens.description = Returns a string list or JSON Array of token ids for the tokens that are visible to the player.
+getVisibleTokens.description = Returns a string list or JSON Array of token ids for the tokens that are visible to the player.
getVisibleTokens.summary = \
\
\
@@ -12060,8 +12060,8 @@ getVisibleTokens.summary = \
getVisibleTokens() Function\
\
• Introduced in version 1.3b49\
- Returns a string list or JSON Array of token ids for the tokens that are visible to the player. The type of the value returned depends on the delimiter parameter.\
-- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
+ Returns a string list or JSON Array of token ids for the tokens that are visible to the player. The type of the value returned depends on the delimiter parameter.\
+- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
\
\
Usage\
@@ -12098,7 +12098,7 @@ getVisibleTokens.summary = \
\
-getWithState.description = Gets a list containing the ids of all the tokens on the current map that have the specified token state set.
+getWithState.description = Gets a list containing the ids of all the tokens on the current map that have the specified token state set.
getWithState.summary = \
\
\
@@ -12108,12 +12108,12 @@ getWithState.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
- Gets a list containing the ids of all the tokens on the current map that have the specified token state set. The type of the value returned depends on the delimiter parameter.\
-- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
+ Gets a list containing the ids of all the tokens on the current map that have the specified token state set. The type of the value returned depends on the delimiter parameter.\
+- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
\
\
Usage\
@@ -12127,7 +12127,7 @@ getWithState(state, delim)\
\
Example\
\
- You can use the following code to print out the ids of all of the tokens on the current map with the "Dead" token state set.\
+ You can use the following code to print out the ids of all of the tokens on the current map with the "Dead" token state set.\
[h: ids = getWithState("Dead")]\
[foreach(id, ids, "<br>"): id]\
\
@@ -12145,7 +12145,7 @@ getWithState(state, delim)\
\
-getWithStateNames.description = Gets a list containing the names of all the tokens on the current map that have the specified token state set.
+getWithStateNames.description = Gets a list containing the names of all the tokens on the current map that have the specified token state set.
getWithStateNames.summary = \
\
\
@@ -12155,12 +12155,12 @@ getWithStateNames.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
- Gets a list containing the names of all the tokens on the current map that have the specified token state set. The type of the value returned depends on the delimiter parameter.\
-- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
+ Gets a list containing the names of all the tokens on the current map that have the specified token state set. The type of the value returned depends on the delimiter parameter.\
+- If the delimiter is not specified then a string list is returned with the default value of
"," is used. - If the delimiter
json then a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
\
\
Usage\
@@ -12174,7 +12174,7 @@ getWithStateNames(state, delim)\
\
Example\
\
- You can use the following code to print out the names of all of the tokens on the current map with the "Dead" token state set.\
+ You can use the following code to print out the names of all of the tokens on the current map with the "Dead" token state set.\
[h: names = getWithStateNames("Dead")]\
[foreach(name, names, "<br>"): name]\
\
@@ -12329,7 +12329,7 @@ gt.summary = \
\
-hasImpersonated.description = Returns 1 if there is an impersonated token otherwise returns 0.
+hasImpersonated.description = Returns 1 if there is an impersonated token otherwise returns 0.
hasImpersonated.summary = \
\
\
@@ -12338,7 +12338,7 @@ hasImpersonated.summary = \
hasImpersonated() Function\
\
• Introduced in version 1.3b48\
- Returns 1 if there is an impersonated token otherwise returns 0.\
+ Returns 1 if there is an impersonated token otherwise returns 0.\
\
Usage\
\
@@ -12349,7 +12349,7 @@ hasImpersonated.summary = \
\
-hasLightSource.description = Returns 1 if the Current Token has any light sources that match the criteria passed in or 0 if there are no matches.
+hasLightSource.description = Returns 1 if the Current Token has any light sources that match the criteria passed in or 0 if there are no matches.
hasLightSource.summary = \
\
\
@@ -12358,7 +12358,7 @@ hasLightSource.summary = \
hasLightSource() Function\
\
• Introduced in version 1.3b48\
- Returns 1 if the Current Token has any light sources that match the criteria passed in or 0 if there are no matches. If no arguments are passed to the function then it will return 1 if any light source is on. If only the first argument is passed it will return 1 if any light source of that light source type is on. If both arguments are passed to the function it will return 1 if the light source with the specified name and specified light source type is on.\
+ Returns 1 if the Current Token has any light sources that match the criteria passed in or 0 if there are no matches. If no arguments are passed to the function then it will return 1 if any light source is on. If only the first argument is passed it will return 1 if any light source of that light source type is on. If both arguments are passed to the function it will return 1 if the light source with the specified name and specified light source type is on.\
\
Usage\
\
@@ -12374,8 +12374,8 @@ hasLightSource(type, name, id, mapname)\
\
\
type - The light source type, (e.g. "Generic", "D20"). If "*" is entered, all light sources types are checked. Defaults to "*".name - the name of the light source. If "*" is entered, all light sources names are checked. Defaults to "*".id - The token id of the token which is checked for light sources, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
name - the name of the light source. If "*" is entered, all light sources names are checked. Defaults to "*".id - The token id of the token which is checked for light sources, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -12401,7 +12401,7 @@ hasLightSource(type, name, id, mapname)\
\
-hasMacro.description = Returns true ( 1 ) if a macro button with the specified label exists on the Current Token .
+hasMacro.description = Returns true ( 1 ) if a macro button with the specified label exists on the Current Token .
hasMacro.summary = \
\
\
@@ -12410,7 +12410,7 @@ hasMacro.summary = \
hasMacro() Function\
\
• Introduced in version 1.3b48\
- \
+ \
\
Usage\
\
@@ -12424,7 +12424,7 @@ hasMacro(label, id, mapname)\
\
\
label - The label of the macro to check for.id - The token id of the token that the function is executed on. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token that the function is executed on. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -12443,7 +12443,7 @@ hasMacro(label, id, mapname)\
\
-hasProperty.description = Returns true ( 1 ) if the Token Property with the specified name exists on a Token .
+hasProperty.description = Returns true ( 1 ) if the Token Property with the specified name exists on a Token .
hasProperty.summary = \
\
\
@@ -12452,7 +12452,7 @@ hasProperty.summary = \
hasProperty() Function\
\
• Introduced in version 1.3b48\
- Returns true(1) if the Token Property with the specified name exists on a Token. The function will return true if the token possesses the specified property, even if that property is not defined in the token's current property type.\
+ Returns true(1) if the Token Property with the specified name exists on a Token. The function will return true if the token possesses the specified property, even if that property is not defined in the token's current property type.\
\
Usage\
\
@@ -12465,8 +12465,8 @@ hasProperty(name, id, mapname)\
Parameters\
\
\
- name - The name of the Token Property which is checked for on the token.id - The token id of the token which is checked for the Token Property, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
name - The name of the Token Property which is checked for on the token.id - The token id of the token which is checked for the Token Property, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -12485,7 +12485,7 @@ hasProperty(name, id, mapname)\
\
-hasSight.description = Returns 1 if the Current Token has sight .
+hasSight.description = Returns 1 if the Current Token has sight .
hasSight.summary = \
\
\
@@ -12494,7 +12494,7 @@ hasSight.summary = \
hasSight() Function\
\
• Introduced in version 1.3b48\
- Returns 1 if the Current Token has sight.\
+ Returns 1 if the Current Token has sight.\
\
Usage\
\
@@ -12507,7 +12507,7 @@ hasSight(id, mapname)\
Parameters\
\
\
- id - The id of the token to return the sight. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The id of the token to return the sight. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -12566,7 +12566,7 @@ Returns a number than is between 5 and 50 for the hero
See Also\
\
\
+For another method of rolling dice, see Dice Expressions.\
\
\
@@ -12609,7 +12609,7 @@ Returns a number than is between 5 and 50 for the hero
See Also\
\
\
+For another method of rolling dice, see Dice Expressions.\
\
\
@@ -12624,7 +12624,7 @@ herolab.getImage.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5\
@@ -12658,7 +12658,7 @@ herolab.getImage(index, id)\
See Also\
\
\
\
Version Changes\
@@ -12682,7 +12682,7 @@ herolab.getInfo.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5\
@@ -12719,7 +12719,7 @@ herolab.getInfo(id,field)\
See Also\
\
\
\
Version Changes\
@@ -12743,7 +12743,7 @@ herolab.getMasterName.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5\
@@ -12775,7 +12775,7 @@ herolab.getMasterName(id)\
See Also\
\
\
\
Version Changes\
@@ -12799,7 +12799,7 @@ herolab.getStatBlock.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5\
@@ -12811,7 +12811,7 @@ herolab.getStatBlock.summary = \
herolab.getStatBlock(type)\
herolab.getStatBlock(type,id)
\
\
- Note: The different formats may or may not contain the same information but it does reflects what is stored in the portfolio. If you find missing information, in the XML statblock for instance, you will need to report that to [Wolf Lair].\
+
Note: The different formats may or may not contain the same information but it does reflects what is stored in the portfolio. If you find missing information, in the XML statblock for instance, you will need to report that to [Wolf Lair].\
\
\
Parameters\
@@ -12834,7 +12834,7 @@ herolab.getStatBlock(type,id)\
See Also\
\
\
\
Version Changes\
@@ -12858,7 +12858,7 @@ herolab.hasChanged.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5\
@@ -12890,7 +12890,7 @@ herolab.hasChanged(id)\
See Also\
\
\
\
Version Changes\
@@ -12914,7 +12914,7 @@ herolab.isMinion.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5\
@@ -12951,7 +12951,7 @@ herolab.isMinion(id)\
See Also\
\
\
\
Version Changes\
@@ -12975,7 +12975,7 @@ herolab.refresh.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5\
@@ -13009,7 +13009,7 @@ herolab.refresh(id)\
See Also\
\
\
\
Version Changes\
@@ -13033,7 +13033,7 @@ herolab.XPath.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -13058,7 +13058,7 @@ herolab.XPath(XPath, id, "json")\
\
XPath - The XPath expression to evaluate against the XML statblock.id - The id of the token. Defaults to the Current Token.delim - Coming in 1.8. Custom delimiter for the returned results. Defaults to ", ". If equal to "json", a JSON Array will be returned instead of a String List.delim - Coming in 1.8. Custom delimiter for the returned results. Defaults to ", ". If equal to "json", a JSON Array will be returned instead of a String List.
\
Returns the requested data.\
\
@@ -13073,7 +13073,7 @@ herolab.XPath(XPath, id, "json")\
\
Human Neutral Good 1
\
Changes Coming in 1.8
\
-Sometimes the data desired from herolab contains commas or is otherwise incompatible with the String List format and default (comma) separator. In the following example, the list of spells retrieved includes one called "Delay Poison, Communal" - as we see in the default output, this element would be incompatible with the standard String List format.\
+
Sometimes the data desired from herolab contains commas or is otherwise incompatible with the String List format and default (comma) separator. In the following example, the list of spells retrieved includes one called "Delay Poison, Communal" - as we see in the default output, this element would be incompatible with the standard String List format.\
\
[h: vXPath = "/document/public/character/spellsmemorized/spell[contains(@name,'De')]/@name"]\
Default: [r: herolab.XPath(vXPath)]<br />\
@@ -13094,7 +13094,7 @@ When dealing with more complicated text elements with potential delimiter confli
See Also\
\
\
\
Version Changes\
@@ -13149,7 +13149,7 @@ Returns a number than is between 5 and 50 for the hero
See Also\
\
\
+For another method of rolling dice, see Dice Expressions.\
\
\
@@ -13189,7 +13189,7 @@ hideTextLabels.summary = \
\
• Introduced in version 1.6\
• Last checked for compatibility with version 1.6\
- Disables the display of Text Labels if they are not showing. This can also be set in the View menu.\
+ Disables the display of Text Labels if they are not showing. This can also be set in the View menu.\
\
Usage\
\
@@ -13300,7 +13300,7 @@ This function doesn't have the parentheses limit that the roll option has:\
Parameters\
\
\
- condition - What is tested to determine is the trueExpr or falseExpr will be executed. This follows the standard rules for conditions that can be found in the Branching and Looping article.condition - What is tested to determine is the trueExpr or falseExpr will be executed. This follows the standard rules for conditions that can be found in the Branching and Looping article.trueExpr - A section of code that is returned if condition is true(1).falseExpr - A section of code that is returned if condition is false(0).
\
@@ -13357,7 +13357,7 @@ This function doesn't have the parentheses limit that the roll option has:\
\
- Returns:
property set to 0 \
\
-
Example 5: Usually its better to use the roll option version [if():]. Sometimes it's pretty handy to use the version documented here, since you can easily embed it in loops and expressions.\
+
Example 5: Usually its better to use the roll option version [if():]. Sometimes it's pretty handy to use the version documented here, since you can easily embed it in loops and expressions.\
\
Let's say you want to check if one of a player's tokens has Initiative, you could do it this like this:\
\
@@ -13371,7 +13371,7 @@ This function doesn't have the parentheses limit that the roll option has:\
\
See Also\
\
- \
+ \
\
\
@@ -13386,12 +13386,12 @@ impersonate.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.7.0\
• Last checked for compatibility with version 1.7.0\
- Impersonate changes the impersonated token for the client running the function, replacing any current impersonation. Rather than being used like switchToken() to aid in macro execution, this function is the same as right-clicking a token and selecting 'Impersonate'. The function does not set the Current Token. Use switchToken() for that.\
+ Impersonate changes the impersonated token for the client running the function, replacing any current impersonation. Rather than being used like switchToken() to aid in macro execution, this function is the same as right-clicking a token and selecting 'Impersonate'. The function does not set the Current Token. Use switchToken() for that.\
\
Usage\
\
@@ -13413,7 +13413,7 @@ Nice weather, eh?<br>\
Seen any dragons?\
Output:\
\
-\
+\
\
See Also\
\
@@ -13430,7 +13430,7 @@ Seen any dragons?\
\
-indexKeyStrProp.description = Returns the key from the specified string property list at the specified index.
+indexKeyStrProp.description = Returns the key from the specified string property list at the specified index.
indexKeyStrProp.summary = \
\
\
@@ -13439,7 +13439,7 @@ indexKeyStrProp.summary = \
indexKeyStrProp() Function\
\
• Introduced in version 1.3b42\
- Returns the key from the specified string property list at the specified index. The index for the string property list starts at 0.\
+ Returns the key from the specified string property list at the specified index. The index for the string property list starts at 0.\
\
Usage\
\
@@ -13485,7 +13485,7 @@ Returns -1.\
\
-indexValueStrProp.description = Returns the value from the specified string property list at the specified index.
+indexValueStrProp.description = Returns the value from the specified string property list at the specified index.
indexValueStrProp.summary = \
\
\
@@ -13494,7 +13494,7 @@ indexValueStrProp.summary = \
indexValueStrProp() Function\
\
• Introduced in version 1.3b42\
- Returns the value from the specified string property list at the specified index. The index for the string property list starts at 0.\
+ Returns the value from the specified string property list at the specified index. The index for the string property list starts at 0.\
\
Usage\
\
@@ -13510,7 +13510,7 @@ Returns "doh".\
\
-initiativeSize.description = Returns the number of tokens in the initiative panel
+initiativeSize.description = Returns the number of tokens in the initiative panel
initiativeSize.summary = \
\
\
@@ -13518,7 +13518,7 @@ initiativeSize.summary = \
\
initiativeSize() Function\
\
- Returns the number of tokens in the initiative panel\
+ Returns the number of tokens in the initiative panel\
\
Usage\
\
@@ -13560,7 +13560,7 @@ Note that there are no built-in mechanisms for input validation for TEXTParameters\
\
\
- 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.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:\
\
@@ -13610,7 +13610,7 @@ Note that there are no built-in mechanisms for input validation for TEXTICONSIZE=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.DELIMITER=, - The delimiter used in the list; defaults to the comma ,. The delimiter cannot contain empty spaces. If set to JSON, a JSON Array should be provided instead.DELIMITER=, - The delimiter used in the list; defaults to the comma ,. The delimiter cannot contain empty spaces. If set to JSON, a JSON Array should be provided instead.
\
\
@@ -13638,7 +13638,7 @@ Note that there are no built-in mechanisms for input validation for TEXTSELECT=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.DELIMITER=, - The delimiter used in the list; defaults to the comma ,. The delimiter cannot contain empty spaces. If set to JSON, a JSON Array should be provided instead.DELIMITER=, - The delimiter used in the list; defaults to the comma ,. The delimiter cannot contain empty spaces. If set to JSON, a JSON Array should be provided instead.\
\
@@ -13662,14 +13662,14 @@ Note that there are no built-in mechanisms for input validation for TEXT\
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.\
+
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.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.WIDTH=nnn - Sets the width of the input box; defaults to WIDTH=14.TYPE=JSON - Result returned in variableName will be a JSON object instead of string property.TEXT\
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.\
+
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\
@@ -13709,7 +13709,7 @@ Note that there are no built-in mechanisms for input validation for TEXTDisplays:\
\
\
@@ -13732,7 +13732,7 @@ Note that there are no built-in mechanisms for input validation for TEXTDisplays:\
\
\
@@ -13752,11 +13752,11 @@ Note that there are no built-in mechanisms for input validation for TEXTDisplays:\
\
\
- 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.\
+
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.\
\
\
Input using using the DELIMITER option for LIST.\
@@ -13791,7 +13791,7 @@ You chose: [r: color] [r: meat] with [r: sauce]\
inptext\
)]\
\
- 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.\
+
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. Dynamic Variable Example, by aliasmask. Uses strformat to create the property names and json.evaluate to put in default values.\
@@ -13916,7 +13916,7 @@ If you really want to go full monty on the tooltip INSIDE the input, here's an e
This is the result:\
\
\
@@ -13942,7 +13942,7 @@ This can simply be done with the <html><img> tags. Howe
[h:input("junk|<html><img src='"+replace(getTokenHandout(), ":", ":")+"' height=90 width=90></img></html>|-|LABEL|SPAN=TRUE")]\
\
\
@@ -13967,7 +13967,7 @@ This can simply be done with the <html><img> tags. Howe
[r,token(me), if(picChoice == 2): "<img src='"+getTokenHandout(picSize)+"'></img>"]\
\
\
@@ -13993,7 +13993,7 @@ This can simply be done with the <html><img> tags. Howe
\
-isBarVisible.description = Returns true ( 1 ) if the specified Token Bar on the Current Token is visible, or false ( 0 ) if it is not.
+isBarVisible.description = Returns true ( 1 ) if the specified Token Bar on the Current Token is visible, or false ( 0 ) if it is not.
isBarVisible.summary = \
\
\
@@ -14002,7 +14002,7 @@ isBarVisible.summary = \
isBarVisible() Function\
\
• Introduced in version 1.3b46\
- Returns true(1) if the specified Token Bar on the Current Token is visible, or false(0) if it is not.\
+ Returns true(1) if the specified Token Bar on the Current Token is visible, or false(0) if it is not.\
\
Usage\
\
@@ -14016,7 +14016,7 @@ isBarVisible(bar, id, mapname)\
\
\
bar - A string that contains the name of the bar that has its visibility checked.id - The token id of the token which has its bar checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token which has its bar checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -14052,10 +14052,10 @@ isBarVisible(bar, id, mapname)\
\
\
- \
- HP and Health Bars\
+ HP and Health Bars\
\
- \
- The
bar.name special variable\
+ The bar.name special variable\
\
\
\
@@ -14220,7 +14220,7 @@ isGm.summary = \
\
-isNPC.description = Returns true ( 1 ) if a Token is a NPC or false ( 0 ) if it is not.
+isNPC.description = Returns true ( 1 ) if a Token is a NPC or false ( 0 ) if it is not.
isNPC.summary = \
\
\
@@ -14229,7 +14229,7 @@ isNPC.summary = \
isNPC() Function\
\
• Introduced in version 1.3b48\
- \
+ \
\
Usage\
\
@@ -14242,7 +14242,7 @@ isNPC(id, mapname)\
Parameter\
\
\
- id - The token id of the token which has its NPC status checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token which has its NPC status checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -14313,7 +14313,7 @@ This function will return 1 even if a registered overlay is hidden using the \
-isOwnedByAll.description = Returns true ( 1 ) if a Token has the Owned by All check box checked.
+isOwnedByAll.description = Returns true ( 1 ) if a Token has the Owned by All check box checked.
isOwnedByAll.summary = \
\
\
@@ -14322,7 +14322,7 @@ isOwnedByAll.summary = \
isOwnedByAll() Function\
\
• Introduced in version 1.3b48\
- \
+ \
\
Usage\
\
@@ -14335,13 +14335,13 @@ isOwnedByAll(id, mapname)\
Parameter\
\
\
- id - The token id of the token which has its Owned by All status checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token which has its Owned by All status checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
Example\
\
- Returns Anyone can edit me if the Current Token has the Owned by All check box checked.\
+ Returns Anyone can edit me if the Current Token has the Owned by All check box checked.\
[r, if(isOwnedByAll()): "Anyone can edit me"]
\
\
See Also\
@@ -14361,7 +14361,7 @@ isOwnedByAll(id, mapname)\
\
-isOwner.description = Returns true ( 1 ) if the given Player is an owner of a specific Token .
+isOwner.description = Returns true ( 1 ) if the given Player is an owner of a specific Token .
isOwner.summary = \
\
\
@@ -14370,7 +14370,7 @@ isOwner.summary = \
isOwner() Function\
\
• Introduced in version 1.3b48\
- \
+ \
\
Usage\
\
@@ -14384,16 +14384,16 @@ isOwner(player, id, mapname)\
Parameters\
\
\
- player - The name of the player to check for ownership, defaults to the Current Player.id - The token id of the token which is checked for ownership, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
player - The name of the player to check for ownership, defaults to the Current Player.id - The token id of the token which is checked for ownership, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
Examples\
\
- Returns You can edit me. if the Current Player is an owner of the Current Token.\
+ Returns You can edit me. if the Current Player is an owner of the Current Token.\
[r, if(isOwner()): "You can edit me."]
\
-Returns Azhrei can edit me. if the given Player is an owner of the given Token.\
+
Returns Azhrei can edit me. if the given Player is an owner of the given Token.\
\
[h: id = getSelected() ]\
[r, if(isOwner("Azhrei", id)): "Azhrei can edit me."]\
@@ -14415,7 +14415,7 @@ isOwner(player, id, mapname)\
\
-isPC.description = Returns true ( 1 ) if a Token is a PC or false ( 0 ) if it is not.
+isPC.description = Returns true ( 1 ) if a Token is a PC or false ( 0 ) if it is not.
isPC.summary = \
\
\
@@ -14424,7 +14424,7 @@ isPC.summary = \
isPC() Function\
\
• Introduced in version 1.3b48\
- \
+ \
\
Usage\
\
@@ -14437,7 +14437,7 @@ isPC(id, mapname)\
Parameter\
\
\
- id - The token id of the token which has its PC status checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token which has its PC status checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -14467,7 +14467,7 @@ isPC(id, mapname)\
\
-isPropertyEmpty.description = Returns true ( 1 ) if the Token Property for a specific Token is empty.
+isPropertyEmpty.description = Returns true ( 1 ) if the Token Property for a specific Token is empty.
isPropertyEmpty.summary = \
\
\
@@ -14476,7 +14476,7 @@ isPropertyEmpty.summary = \
isPropertyEmpty() Function\
\
• Introduced in version 1.3b48\
- Returns true(1) if the Token Property for a specific Token is empty. A Token Property is considered empty if it is NULL; if an empty string ("") has been assigned to it, it is not considered empty.\
+ Returns true(1) if the Token Property for a specific Token is empty. A Token Property is considered empty if it is NULL; if an empty string ("") has been assigned to it, it is not considered empty.\
Note: If the token type sets a default value, this function will still see the property as empty. Try using json.isEmpty().\
\
Usage\
@@ -14491,7 +14491,7 @@ isPropertyEmpty(property, id, mapname)\
\
\
property - The name of the property that has its value checked.id - The token id of the token that has its value checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token that has its value checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -14522,7 +14522,7 @@ isPropertyEmpty(property, id, mapname)\
\
-isSnapToGrid.description = Returns true ( 1 ) if a Token is snapped to grid or false ( 0 ) if it is not.
+isSnapToGrid.description = Returns true ( 1 ) if a Token is snapped to grid or false ( 0 ) if it is not.
isSnapToGrid.summary = \
\
\
@@ -14531,7 +14531,7 @@ isSnapToGrid.summary = \
isSnapToGrid() Function\
\
• Introduced in version 1.3b69\
- \
+ \
\
Usage\
\
@@ -14544,7 +14544,7 @@ isSnapToGrid(id, mapname)\
Parameter\
\
\
- id - The token id of the token which has its snapToGrid status checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token which has its snapToGrid status checked, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -14571,7 +14571,7 @@ isSnapToGrid(id, mapname)\
\
-isTrusted.description = Returns 1 if this is running as a trusted macro or 0 if it is not.
+isTrusted.description = Returns 1 if this is running as a trusted macro or 0 if it is not.
isTrusted.summary = \
\
\
@@ -14580,7 +14580,7 @@ isTrusted.summary = \
isTrusted() Function\
\
• Introduced in version 1.3b48\
- Returns 1 if this is running as a trusted macro or 0 if it is not.\
+ Returns 1 if this is running as a trusted macro or 0 if it is not.\
\
Usage\
\
@@ -14623,7 +14623,7 @@ isVisible(x,y,id)\
\
x - Then tokens x coordinate. Always in map units, not grid .y - Then tokens x coordinate. Always in map units, not grid .id - The check for visibility is performed from token id. Note: This parameter can only be used in a Trusted Macro.
id - The check for visibility is performed from token id. Note: This parameter can only be used in a Trusted Macro.
\
\
Example\
@@ -14655,7 +14655,7 @@ isVisible(x,y,id)\
\
-json.append.description = Appends values to the end of a JSON Array .
+json.append.description = Appends values to the end of a JSON Array .
json.append.summary = \
\
\
@@ -14664,7 +14664,7 @@ json.append.summary = \
json.append() Function\
\
• Introduced in version 1.3b49\
- Appends values to the end of a JSON Array. An empty string ("") can be used to represent an empty JSON Array to append the values to.\
+ Appends values to the end of a JSON Array. An empty string ("") can be used to represent an empty JSON Array to append the values to.\
\
Usage\
\
@@ -14690,7 +14690,7 @@ json.append.summary = \
\
-json.contains.description = Returns true ( 1 ) if the JSON Object contains the specified key, or if the JSON Array contains the specified value.
+json.contains.description = Returns true ( 1 ) if the JSON Object contains the specified key, or if the JSON Array contains the specified value.
json.contains.summary = \
\
\
@@ -14699,7 +14699,7 @@ json.contains.summary = \
json.contains() Function\
\
• Introduced in version 1.3b49\
- Returns true(1) if the JSON Object contains the specified key, or if the JSON Array contains the specified value.\
+ Returns true(1) if the JSON Object contains the specified key, or if the JSON Array contains the specified value.\
\
Usage\
\
@@ -14713,24 +14713,24 @@ json.contains.summary = \
Parameters\
\
\
- object - The JSON Object to test for the key.object - The JSON Object to test for the key.key - The key to check the object for.array - The JSON Array to test for the value.array - The JSON Array to test for the value.value - The value to check the array for.
\
\
Examples\
\
- Check if the JSON Object a contains the key "b":\
+ Check if the JSON Object a contains the key "b":\
[h:a=json.fromStrProp("a=1;b=44;c=12")]\
[json.contains(a,"b")]\
Returns true(1)\
-
Check if the JSON Object a contains the key "z":\
+
Check if the JSON Object a contains the key "z":\
\
[h:a=json.fromStrProp("a=1;b=44;c=12")]\
[json.contains(a,"z")]\
Returns false(0)\
-
Check if the JSON Array a contains the value "b":\
+
Check if the JSON Array a contains the value "b":\
\
[h:a=json.fromList("1,b,3,d")]\
[json.contains(a,"b")]\
@@ -14746,14 +14746,14 @@ Returns true(1)\
\
\
\
- - 1.3b51 - Added ability for function to work with JSON Arrays.
\
+ - 1.3b51 - Added ability for function to work with JSON Arrays.
\
\
\
\
\
-json.count.description = Returns the number of occurrences of a value in a JSON Array .
+json.count.description = Returns the number of occurrences of a value in a JSON Array .
json.count.summary = \
\
\
@@ -14762,7 +14762,7 @@ json.count.summary = \
json.count() Function\
\
• Introduced in version 1.3b53\
- Returns the number of occurrences of a value in a JSON Array. If the value does not occur in the JSON Array then 0 is returned. The index for the JSON Array starts at 0.\
+ Returns the number of occurrences of a value in a JSON Array. If the value does not occur in the JSON Array then 0 is returned. The index for the JSON Array starts at 0.\
\
Usage\
\
@@ -14776,7 +14776,7 @@ json.count.summary = \
Parameters\
\
\
- array - The JSON Array to search.array - The JSON Array to search.value - The value to count the occurrences of.start - The index to start searching from, if not specified it defaults to 0.
\
@@ -14800,7 +14800,7 @@ Returns 2\
\
-json.difference.description = Returns an array with the differences of all of the JSON Object keys, or JSON Array values.
+json.difference.description = Returns an array with the differences of all of the JSON Object keys, or JSON Array values.
json.difference.summary = \
\
\
@@ -14809,7 +14809,7 @@ json.difference.summary = \
json.difference() Function\
\
• Introduced in version 1.3b53\
- Returns an array with the differences of all of the JSON Object keys, or JSON Array values. Output contains keys or values which exist in the first parameter, but do not exist in any others.\
+ Returns an array with the differences of all of the JSON Object keys, or JSON Array values. Output contains keys or values which exist in the first parameter, but do not exist in any others.\
\
Usage\
\
@@ -14823,8 +14823,8 @@ json.difference.summary = \
Parameter\
\
\
- array - A JSON Array to get the difference of.object - A JSON Object to get the difference of.array - A JSON Array to get the difference of.object - A JSON Object to get the difference of.
\
\
Example\
@@ -14882,7 +14882,7 @@ json.evaluate.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b51\
@@ -14924,7 +14924,7 @@ json.evaluate.summary = \
\
-json.fields.description = Returns the fields (keys) for a JSON Object or the indexes for a JSON Array as a string list.
+json.fields.description = Returns the fields (keys) for a JSON Object or the indexes for a JSON Array as a string list.
json.fields.summary = \
\
\
@@ -14933,8 +14933,8 @@ json.fields.summary = \
json.fields() Function\
\
• Introduced in version 1.3b49\
- Returns the fields (keys) for a JSON Object or the indexes for a JSON Array as a string list. The type of the value returned depends on the delimiter parameter.\
-Note: Because JSON Objects are unordered, json.fields will not reflect the order they were set in.\
+ Returns the fields (keys) for a JSON Object or the indexes for a JSON Array as a string list. The type of the value returned depends on the delimiter parameter.\
+Note: Because JSON Objects are unordered, json.fields will not reflect the order they were set in.\
\
Usage\
\
@@ -14949,7 +14949,7 @@ json.fields.summary = \
\
\
delim =\
-unspecified: a standard string list is returned, with its default "," delimiter."json": a JSON Array is returned."x": a string list is returned with "x" used as a delimiter.
unspecified: a standard string list is returned, with its default "," delimiter."json": a JSON Array is returned."x": a string list is returned with "x" used as a delimiter.
\
\
\
Example\
@@ -14968,7 +14968,7 @@ json.fields.summary = \
\
-json.fromList.description = Returns a JSON Array from a String List .
+json.fromList.description = Returns a JSON Array from a String List .
json.fromList.summary = \
\
\
@@ -14977,7 +14977,7 @@ json.fromList.summary = \
json.fromList() Function\
\
• Introduced in version 1.3b49\
- Returns a JSON Array from a String List.\
+ Returns a JSON Array from a String List.\
\
Usage\
\
@@ -14991,8 +14991,8 @@ json.fromList.summary = \
Parameters\
\
\
- strList - The String List that is converted to a JSON Array.delim - The delimiter used in the String List, defaults to ",".strList - The String List that is converted to a JSON Array.delim - The delimiter used in the String List, defaults to ",".
\
\
Example\
@@ -15009,7 +15009,7 @@ Returns ["a",1,"g",4]
\
\
-json.fromStrProp.description = Creates a json object from a string property list .
+json.fromStrProp.description = Creates a json object from a string property list .
json.fromStrProp.summary = \
\
\
@@ -15018,7 +15018,7 @@ json.fromStrProp.summary = \
json.fromStrProp() Function\
\
• Introduced in version 1.3b49\
- Creates a json object from a string property list.\
+ Creates a json object from a string property list.\
\
Usage\
\
@@ -15043,7 +15043,7 @@ json.fromStrProp(propList,delim)\
\
-json.get.description = Returns the value in a JSON Array at the specified index, returns a slice of a JSON Array from the specified indexes, or returns the value from JSON Object for the specified key.
+json.get.description = Returns the value in a JSON Array at the specified index, returns a slice of a JSON Array from the specified indexes, or returns the value from JSON Object for the specified key.
json.get.summary = \
\
\
@@ -15052,7 +15052,7 @@ json.get.summary = \
json.get() Function\
\
• Introduced in version 1.3b49\
- Returns the value in a JSON Array at the specified index, returns a slice of a JSON Array from the specified indexes, or returns the value from JSON Object for the specified key.\
+ Returns the value in a JSON Array at the specified index, returns a slice of a JSON Array from the specified indexes, or returns the value from JSON Object for the specified key.\
\
Usage\
\
@@ -15069,12 +15069,12 @@ json.get.summary = \
Parameters\
\
\
- array - The JSON Array to retrieve the element from.array - The JSON Array to retrieve the element from.index - The numerical index of the element you want returned.start - The starting index of the element you wish the slice to begin at.end - The ending index of the element you wish the slice to end at.object - The JSON Object to retrieve the element from.key - The name of a field that should be returned. This parameter can exist more than once, if it does then a JSON Object is returned with all the specified elements.object - The JSON Object to retrieve the element from.key - The name of a field that should be returned. This parameter can exist more than once, if it does then a JSON Object is returned with all the specified elements.
\
When extracting slices:
\
Negative numbers can be used as the offsets from the end of the array. -1 is the last element in the array, -2 is the second to last, and so on. If the element specified by the start index and the element specified by the end index are located in reverse order in array (so reading from left to right end comes before start), then the array slice is returned in reverse order compared to array (because fetching from start to end means reading backwards).
\
@@ -15126,8 +15126,8 @@ ERROR b) -- java.lang.ArrayIndexOutOfBoundsException, the last valid index is 2\
\
\
\
- - 1.3b51 - Added ability to return JSON Array slices.
\
- - 1.3b51 - Added ability to return JSON Objects of select fields from other JSON Objects.
\
+ - 1.3b51 - Added ability to return JSON Array slices.
\
+ - 1.3b51 - Added ability to return JSON Objects of select fields from other JSON Objects.
\
\
\
\
@@ -15165,7 +15165,7 @@ Formatting will not appear unless the function is surrounded by the "pre" html t
\
-json.indexOf.description = Returns the index of the first occurrence of a value in the JSON Array .
+json.indexOf.description = Returns the index of the first occurrence of a value in the JSON Array .
json.indexOf.summary = \
\
\
@@ -15174,7 +15174,7 @@ json.indexOf.summary = \
json.indexOf() Function\
\
• Introduced in version 1.3b53\
- Returns the index of the first occurrence of a value in the JSON Array. If the value does not exist in the JSON Array then -1 is returned. All JSON Array indexes start at 0.\
+ Returns the index of the first occurrence of a value in the JSON Array. If the value does not exist in the JSON Array then -1 is returned. All JSON Array indexes start at 0.\
\
Usage\
\
@@ -15188,8 +15188,8 @@ json.indexOf.summary = \
Parameters\
\
\
- array - The JSON Array to search.value - The value to find the index of in the JSON Array.array - The JSON Array to search.value - The value to find the index of in the JSON Array.start - The index to start searching from, if not specified it defaults to 0.
\
\
@@ -15228,7 +15228,7 @@ Returns: 2
\
\
-json.intersection.description = Returns a JSON Array with the intersection of all of the JSON Object keys or JSON Array values.
+json.intersection.description = Returns a JSON Array with the intersection of all of the JSON Object keys or JSON Array values.
json.intersection.summary = \
\
\
@@ -15237,7 +15237,7 @@ json.intersection.summary = \
json.intersection() Function\
\
• Introduced in version 1.3b53\
- Returns a JSON Array with the intersection of all of the JSON Object keys or JSON Array values. A value or key only appears in the output if it exists in all input arrays or objects.\
+ Returns a JSON Array with the intersection of all of the JSON Object keys or JSON Array values. A value or key only appears in the output if it exists in all input arrays or objects.\
This function is useful for removing Token IDs from a saved list which have been deleted from the map by eliminating them using this function, the saved array and getTokens().\
\
Usage\
@@ -15252,8 +15252,8 @@ This function is useful for removing Token IDs from a saved list which have been
Parameters\
\
\
- array - A JSON Array used in the intersection.object - A JSON Object used in the intersection.array - A JSON Array used in the intersection.object - A JSON Object used in the intersection.
\
\
Examples\
@@ -15306,7 +15306,7 @@ json.isEmpty.summary = \
\
-json.isSubset.description = Returns true ( 1 ) if all of the JSON Object keys or JSON Array values are contained within the first JSON Object or JSON Array .
+json.isSubset.description = Returns true ( 1 ) if all of the JSON Object keys or JSON Array values are contained within the first JSON Object or JSON Array .
json.isSubset.summary = \
\
\
@@ -15315,7 +15315,7 @@ json.isSubset.summary = \
json.isSubset() Function\
\
• Introduced in version 1.3b53\
- Returns true(1) if all of the JSON Object keys or JSON Array values are contained within the first JSON Object or JSON Array.\
+ Returns true(1) if all of the JSON Object keys or JSON Array values are contained within the first JSON Object or JSON Array.\
\
Usage\
\
@@ -15329,10 +15329,10 @@ json.isSubset.summary = \
Parameters\
\
\
- firstArray - The JSON Array that must contain all of the values of the subsequent JSON Arrays for this function to return true(1).array - A JSON Array with values that are tested to be within the firstArray.firstObject - The JSON Object that must contain all of the keys of the subsequent JSON Objects for this function to return true(1).object - A JSON Object with keys that are tested to be within the firstObject.firstArray - The JSON Array that must contain all of the values of the subsequent JSON Arrays for this function to return true(1).array - A JSON Array with values that are tested to be within the firstArray.firstObject - The JSON Object that must contain all of the keys of the subsequent JSON Objects for this function to return true(1).object - A JSON Object with keys that are tested to be within the firstObject.
\
\
\
@@ -15347,7 +15347,7 @@ json.isSubset.summary = \
\
-json.length.description = Returns the number of fields in a json object or number of elements in a json array .
+json.length.description = Returns the number of fields in a json object or number of elements in a json array .
json.length.summary = \
\
\
@@ -15356,7 +15356,7 @@ json.length.summary = \
json.length() Function\
\
• Introduced in version 1.3b49\
- Returns the number of fields in a json object or number of elements in a json array.\
+ Returns the number of fields in a json object or number of elements in a json array.\
\
Usage\
\
@@ -15381,7 +15381,7 @@ json.length.summary = \
\
-json.merge.description = Merges multiple JSON Arrays or JSON Objects .
+json.merge.description = Merges multiple JSON Arrays or JSON Objects .
json.merge.summary = \
\
\
@@ -15390,10 +15390,10 @@ json.merge.summary = \
json.merge() Function\
\
• Introduced in version 1.3b53\
- Merges multiple JSON Arrays or JSON Objects.\
-For JSON Arrays the value returned is that of all the JSON Arrays concatenated together.\
+
Merges multiple JSON Arrays or JSON Objects.\
+For JSON Arrays the value returned is that of all the JSON Arrays concatenated together.\
\
-For JSON Objects the value returned is a JSON Object with all of the keys from all of the JSON Objects set, if any key is specified in more than one JSON Object then the value for the last specified JSON Object is used.\
+For JSON Objects the value returned is a JSON Object with all of the keys from all of the JSON Objects set, if any key is specified in more than one JSON Object then the value for the last specified JSON Object is used.\
\
Usage\
\
@@ -15407,20 +15407,20 @@ For Parameters\
\
\
- array - A JSON Array.object - A JSON Object.array - A JSON Array.object - A JSON Object.
\
\
Examples\
\
- Merge three JSON Arrays:\
+ Merge three JSON Arrays:\
[r: json.merge("[1,2]", "[3,4]", "[1,2]")]\
Returns: [1,2,3,4,1,2]\
-
Merge two JSON Objects with no matching keys:\
+
Merge two JSON Objects with no matching keys:\
\
[r: json.merge("{a:1, b:2}", "{c:10, d:7}")]\
Returns: {"a":1,"b":2,"c":10,"d":7} \
-
Merge three JSON Objects with a matching key, a:\
+
Merge three JSON Objects with a matching key, a:\
\
[r: json.merge("{a:1, b:2}", "{c:10, d:7}", "{a:11, z:7}")]\
Returns: {"a":11,"b":2,"c":10,"d":7,"z":7} \
@@ -15433,7 +15433,7 @@ Returns: {"a":11,"b":2,"c":10,"d":7,"z":7} \
\
\
\
- - 1.3b54 - Fixed bug which allows
json.merge() to work correctly with JSON Objects. \
+ - 1.3b54 - Fixed bug which allows
json.merge() to work correctly with JSON Objects. \
\
\
\
@@ -15536,12 +15536,12 @@ json.objrolls.summary = \
\
See Also\
\
- \
+ \
\
\
-json.path.add.description = Add an element to a nested JSON Array .
+json.path.add.description = Add an element to a nested JSON Array .
json.path.add.summary = \
\
\
@@ -15550,7 +15550,7 @@ json.path.add.summary = \
json.path.add() Function\
\
• Introduced in version 1.5.5\
- Add an element to a nested JSON Array. Additional information on how to specify the path is available here.\
+ Add an element to a nested JSON Array. Additional information on how to specify the path is available here.\
\
Usage\
\
@@ -15561,8 +15561,8 @@ json.path.add.summary = \
Parameters\
\
\
- json - The json element in which the JSON Array is nested.path - The path to the JSON Array.json - The json element in which the JSON Array is nested.path - The path to the JSON Array.value - The value to add to the array.
\
\
@@ -15579,7 +15579,7 @@ json.path.add.summary = \
\
-json.path.delete.description = Returns a JSON Array or JSON Object with deleted elements.
+json.path.delete.description = Returns a JSON Array or JSON Object with deleted elements.
json.path.delete.summary = \
\
\
@@ -15588,7 +15588,7 @@ json.path.delete.summary = \
json.path.delete() Function\
\
• Introduced in version 1.5.5\
- Returns a JSON Array or JSON Object with deleted elements. These deletions are specified through the path parameter. Additional information on how to specify the path is availabe here.\
+ Returns a JSON Array or JSON Object with deleted elements. These deletions are specified through the path parameter. Additional information on how to specify the path is availabe here.\
\
Usage\
\
@@ -15622,7 +15622,7 @@ json.path.delete.summary = \
\
-json.path.put.description = Create or update the key with the given value at the given path of a nested JSON Object .
+json.path.put.description = Create or update the key with the given value at the given path of a nested JSON Object .
json.path.put.summary = \
\
\
@@ -15631,7 +15631,7 @@ json.path.put.summary = \
json.path.put() Function\
\
• Introduced in version 1.5.5\
- Create or update the key with the given value at the given path of a nested JSON Object. json.path.put() is only used creating/updating name/value pairs in JSON Objects. See json.path.set() for creating/updated values in arrays. Additional information on how to specify the path is available here.\
+ Create or update the key with the given value at the given path of a nested JSON Object. json.path.put() is only used creating/updating name/value pairs in JSON Objects. See json.path.set() for creating/updated values in arrays. Additional information on how to specify the path is available here.\
\
Usage\
\
@@ -15642,9 +15642,9 @@ json.path.put.summary = \
Parameters\
\
\
- json - The json element in which the JSON Object is nested.path - The path to the JSON Object.key - The key of the JSON Object.json - The json element in which the JSON Object is nested.path - The path to the JSON Object.key - The key of the JSON Object.value - The value to associated with the key.
\
\
@@ -15668,7 +15668,7 @@ json.path.put.summary = \
\
-json.path.read.description = Returns the values in a nested JSON Array or JSON Object corresponding to the provided path.
+json.path.read.description = Returns the values in a nested JSON Array or JSON Object corresponding to the provided path.
json.path.read.summary = \
\
\
@@ -15677,7 +15677,7 @@ json.path.read.summary = \
json.path.read() Function\
\
• Introduced in version 1.5.5\
- Returns the values in a nested JSON Array or JSON Object corresponding to the provided path. It is unnecessary to include the root node operator $ at the beginning of the requested path. To do so, you must escape the dollar sign like this: \$.path.to.read. The json.path functions support both dot, Monsters.Orc.Attacks, and bracket, ['Monsters']['Orc']['Attacks'], notation.\
+ Returns the values in a nested JSON Array or JSON Object corresponding to the provided path. It is unnecessary to include the root node operator $ at the beginning of the requested path. To do so, you must escape the dollar sign like this: \$.path.to.read. The json.path functions support both dot, Monsters.Orc.Attacks, and bracket, ['Monsters']['Orc']['Attacks'], notation.\
For detailed information on how to specify the path, please read the JsonPath ReadMe.\
\
Usage\
@@ -15693,7 +15693,7 @@ json.path.read(json, path, config)\
json - The json data to get the values from.path - The path of the value(s) to retrieve.config - A String containing configuration options separated by a comma. The options can include\
-ALWAYS_RETURN_LIST - Always return the results in a JSON Array, even when the path is definite.AS_PATH_LIST - Return a JSON Array of path strings representing the path of the evaluation hits.DEFAULT_PATH_LEAF_TO_NULL - Return null when the given path almost exists but ends with a JSON Object key that is missing. Without this configuration, a definite path will return an error. With this configuration, an indefinite path will include null in the JSON Array if the key is missing. Without this configuration or if any other kind of nonexistent path structure is provided, an indefinite path will simply not match and return an empty JSON Array or less results in the JSON Array.REQUIRE_PROPERTIES - When an indefinite path is evaluated and ends in a key, all matching JSON Objects must have that key, otherwise an error is returned. This are the cases where DEFAULT_PATH_LEAF_TO_NULL will return null instead.SUPPRESS_EXCEPTIONS - Suppress all exceptions when evaluating paths. If ALWAYS_RETURN_LIST is also used return an empty list. Otherwise return null.
ALWAYS_RETURN_LIST - Always return the results in a JSON Array, even when the path is definite.AS_PATH_LIST - Return a JSON Array of path strings representing the path of the evaluation hits.DEFAULT_PATH_LEAF_TO_NULL - Return null when the given path almost exists but ends with a JSON Object key that is missing. Without this configuration, a definite path will return an error. With this configuration, an indefinite path will include null in the JSON Array if the key is missing. Without this configuration or if any other kind of nonexistent path structure is provided, an indefinite path will simply not match and return an empty JSON Array or less results in the JSON Array.REQUIRE_PROPERTIES - When an indefinite path is evaluated and ends in a key, all matching JSON Objects must have that key, otherwise an error is returned. This are the cases where DEFAULT_PATH_LEAF_TO_NULL will return null instead.SUPPRESS_EXCEPTIONS - Suppress all exceptions when evaluating paths. If ALWAYS_RETURN_LIST is also used return an empty list. Otherwise return null.
\
\
See the Jayway javadoc page for more info.\
\
@@ -15728,7 +15728,7 @@ which returns ["Troll"]. Note the use of bracket notation for the p
\
-json.path.set.description = Change an element in a nested JSON Array .
+json.path.set.description = Change an element in a nested JSON Array .
json.path.set.summary = \
\
\
@@ -15737,7 +15737,7 @@ json.path.set.summary = \
json.path.set() Function\
\
• Introduced in version 1.5.5\
- Change an element in a nested JSON Array. Additional information on how to specify the path is available here.\
+ Change an element in a nested JSON Array. Additional information on how to specify the path is available here.\
\
Usage\
\
@@ -15748,8 +15748,8 @@ json.path.set.summary = \
Parameters\
\
\
- json - The json element in which the JSON Array is nested.path - The path to the element in the JSON Array.json - The json element in which the JSON Array is nested.path - The path to the element in the JSON Array.value - The value to change.
\
\
@@ -15769,7 +15769,7 @@ json.path.set.summary = \
\
-json.remove.description = Removes a field from a JSON Object , or the value at the specified index from a JSON Array .
+json.remove.description = Removes a field from a JSON Object , or the value at the specified index from a JSON Array .
json.remove.summary = \
\
\
@@ -15778,7 +15778,7 @@ json.remove.summary = \
json.remove() Function\
\
• Introduced in version 1.3b49\
- Removes a field from a JSON Object, or the value at the specified index from a JSON Array.\
+ Removes a field from a JSON Object, or the value at the specified index from a JSON Array.\
\
Usage\
\
@@ -15798,7 +15798,7 @@ json.remove.summary = \
\
-json.removeAll.description = Removes all the keys or values from the first JSON Object or JSON Array that occur in the following JSON Objects or JSON Arrays .
+json.removeAll.description = Removes all the keys or values from the first JSON Object or JSON Array that occur in the following JSON Objects or JSON Arrays .
json.removeAll.summary = \
\
\
@@ -15807,7 +15807,7 @@ json.removeAll.summary = \
json.removeAll() Function\
\
• Introduced in version 1.3b53\
- Removes all the keys or values from the first JSON Object or JSON Array that occur in the following JSON Objects or JSON Arrays.\
+ Removes all the keys or values from the first JSON Object or JSON Array that occur in the following JSON Objects or JSON Arrays.\
\
Usage\
\
@@ -15821,10 +15821,10 @@ json.removeAll.summary = \
Parameters\
\
\
- firstArray - The JSON Array to remove the occurrences from.array - The JSON Arrays to get the occurrences from.firstObject - The JSON Object to remove the occurrences from.object - The JSON Objects to get the occurrences from.firstArray - The JSON Array to remove the occurrences from.array - The JSON Arrays to get the occurrences from.firstObject - The JSON Object to remove the occurrences from.object - The JSON Objects to get the occurrences from.
\
\
\
@@ -15894,7 +15894,7 @@ json.removeFirst.summary = \
\
See Also\
\
- \
+ \
\
\
@@ -15971,12 +15971,12 @@ The three parameter version returns a two dimensional array\
\
See Also\
\
- \
+ \
\
\
-json.set.description = Sets the value in at the specified index in a JSON Array or for the specified key in a JSON Object .
+json.set.description = Sets the value in at the specified index in a JSON Array or for the specified key in a JSON Object .
json.set.summary = \
\
\
@@ -15985,7 +15985,7 @@ json.set.summary = \
json.set() Function\
\
• Introduced in version 1.3b49\
- Sets the value in at the specified index in a JSON Array or for the specified key in a JSON Object. You can use an empty string ("") to represent a new JSON Array or JSON Object.\
+ Sets the value in at the specified index in a JSON Array or for the specified key in a JSON Object. You can use an empty string ("") to represent a new JSON Array or JSON Object.\
\
Usage\
\
@@ -16008,9 +16008,9 @@ json.set.summary = \
Parameters\
\
\
- jarr - The JSON Array that has an index's value set.jarr - The JSON Array that has an index's value set.index - The numeric index which has its value set.jobj - The JSON Object that has a key's value set.jobj - The JSON Object that has a key's value set.key - The named key which has its value set.value - The content that is set to the index or key.
\
@@ -16029,7 +16029,7 @@ json.set.summary = \
{"a":5}\
{"a":5, "b":8}\
[8, 3]\
-To save the new value in the JSON Array or JSON Object so that you can reference it later in a macro, you must set the array equal to the result of json.set().\
+
To save the new value in the JSON Array or JSON Object so that you can reference it later in a macro, you must set the array equal to the result of json.set().\
[myArray = json.append("", 1, 2, 3)]\
[myArray = json.set(myArray, 0, 5)]\
[myArray]Returns\
@@ -16092,7 +16092,7 @@ json.sort.summary = \
\
json.sort(array, direction)
\
\
- If you have a JSON Array that contains JSON Objects\
+
If you have a JSON Array that contains JSON Objects\
\
\
json.sort(array, direction, key1, ..., keyN)
\
@@ -16104,15 +16104,15 @@ json.sort.summary = \
array - The JSON array to sort.direction - Defaults to "ascending", acceptable values:\
"ascending""descending""ascend""descend""asc""desc""a""d"
key1, ..., keyN - The keys in the JSON Objects contained within the JSON Array used for sorting. All JSON Objects must contain these fields.key1, ..., keyN - The keys in the JSON Objects contained within the JSON Array used for sorting. All JSON Objects must contain these fields.\
Examples\
\
- Sorting a JSON Array containing numbers.\
+ Sorting a JSON Array containing numbers.\
[json.sort("[1,4,5,6,2,1,9,20,1]")]\
Produces [1,1,1,2,4,5,6,9,20]\
-
Sorting a JSON Array containing strings.\
+
Sorting a JSON Array containing strings.\
\
[json.sort("['Hero', 'Dragon', 'Elf', 'Wolf', 'Mage', 'Eagle', 'Troll']")]\
Produces ["Dragon","Eagle","Elf","Hero","Mage","Troll","Wolf"]\
@@ -16153,7 +16153,7 @@ json.sort.summary = \
\
-json.subset.description = Returns true ( 1 ) if all of the JSON Object keys or JSON Array values are contained within the first JSON Object or JSON Array .
+json.subset.description = Returns true ( 1 ) if all of the JSON Object keys or JSON Array values are contained within the first JSON Object or JSON Array .
json.subset.summary = \
\
\
@@ -16162,7 +16162,7 @@ json.subset.summary = \
json.isSubset() Function\
\
• Introduced in version 1.3b53\
- Returns true(1) if all of the JSON Object keys or JSON Array values are contained within the first JSON Object or JSON Array.\
+ Returns true(1) if all of the JSON Object keys or JSON Array values are contained within the first JSON Object or JSON Array.\
\
Usage\
\
@@ -16176,10 +16176,10 @@ json.subset.summary = \
Parameters\
\
\
- firstArray - The JSON Array that must contain all of the values of the subsequent JSON Arrays for this function to return true(1).array - A JSON Array with values that are tested to be within the firstArray.firstObject - The JSON Object that must contain all of the keys of the subsequent JSON Objects for this function to return true(1).object - A JSON Object with keys that are tested to be within the firstObject.firstArray - The JSON Array that must contain all of the values of the subsequent JSON Arrays for this function to return true(1).array - A JSON Array with values that are tested to be within the firstArray.firstObject - The JSON Object that must contain all of the keys of the subsequent JSON Objects for this function to return true(1).object - A JSON Object with keys that are tested to be within the firstObject.
\
\
\
@@ -16194,7 +16194,7 @@ json.subset.summary = \
\
-json.toList.description = Creates a string list from a JSON Array .
+json.toList.description = Creates a string list from a JSON Array .
json.toList.summary = \
\
\
@@ -16203,7 +16203,7 @@ json.toList.summary = \
json.toList() Function\
\
• Introduced in version 1.3b49\
- Creates a string list from a JSON Array. If the delimiter is not specified then the default value of ',' is used.\
+ Creates a string list from a JSON Array. If the delimiter is not specified then the default value of ',' is used.\
\
Usage\
\
@@ -16236,7 +16236,7 @@ json.toList.summary = \
\
-json.toStrProp.description = Creates a string list from a json object or json array using the specified delimiter in the result.
+json.toStrProp.description = Creates a string list from a json object or json array using the specified delimiter in the result.
json.toStrProp.summary = \
\
\
@@ -16245,7 +16245,7 @@ json.toStrProp.summary = \
json.toStrProp() Function\
\
• Introduced in version 1.3b49\
- Creates a string list from a json object or json array using the specified delimiter in the result. If a delimiter is not provided then the default value of ';' is used.\
+ Creates a string list from a json object or json array using the specified delimiter in the result. If a delimiter is not provided then the default value of ';' is used.\
\
Usage\
\
@@ -16279,7 +16279,7 @@ json.toStrProp.summary = \
\
-json.toVars.description = Creates variables from a from a JSON Object or JSON Array .
+json.toVars.description = Creates variables from a from a JSON Object or JSON Array .
json.toVars.summary = \
\
\
@@ -16288,7 +16288,7 @@ json.toVars.summary = \
json.toVars() Function\
\
• Introduced in version 1.5.5\
- Creates variables from a from a JSON Object or JSON Array. For a JSON object the names of the variables are the keys of the object, while the variables are assigned the values of the object. Characters in key values that are not allowed in MTScript variable names will be replaced with underscores. For a JSON array, only the values are passed in and the variable names will be created from the 2nd parameter suffixed with a number.\
+ Creates variables from a from a JSON Object or JSON Array. For a JSON object the names of the variables are the keys of the object, while the variables are assigned the values of the object. Characters in key values that are not allowed in MTScript variable names will be replaced with underscores. For a JSON array, only the values are passed in and the variable names will be created from the 2nd parameter suffixed with a number.\
\
Usage\
\
@@ -16392,7 +16392,7 @@ json.type.summary = \
Returns a string which contains the type of JSON variable that is passed in.\
Return values are\
\
-ARRAY - The object is a JSON Array.OBJECT - The object is a JSON Object.UNKNOWN - It is neither a JSON Array nor JSON Object.
\
+ARRAY - The object is a JSON Array.OBJECT - The object is a JSON Object.UNKNOWN - It is neither a JSON Array nor JSON Object.
\
\
\
Usage\
@@ -16414,7 +16414,7 @@ UNKNOWN
\
\
-json.union.description = Returns an JSON Array with the union of all of the JSON Object keys, or JSON Array values.
+json.union.description = Returns an JSON Array with the union of all of the JSON Object keys, or JSON Array values.
json.union.summary = \
\
\
@@ -16423,7 +16423,7 @@ json.union.summary = \
json.union() Function\
\
• Introduced in version 1.3b53\
- Returns an JSON Array with the union of all of the JSON Object keys, or JSON Array values. If a value or a key occurs in multiple different objects or arrays, it will only be placed once in the output object or array.\
+ Returns an JSON Array with the union of all of the JSON Object keys, or JSON Array values. If a value or a key occurs in multiple different objects or arrays, it will only be placed once in the output object or array.\
\
Usage\
\
@@ -16437,8 +16437,8 @@ json.union.summary = \
Parameters\
\
\
- array - The JSON Arrays to union.object - The JSON Objects to union.array - The JSON Arrays to union.object - The JSON Objects to union.
\
\
Examples\
@@ -16456,7 +16456,7 @@ json.union.summary = \
\
-json.unique.description = Returns a JSON Array with each value that occurs in the source JSON Array occurring only once.
+json.unique.description = Returns a JSON Array with each value that occurs in the source JSON Array occurring only once.
json.unique.summary = \
\
\
@@ -16465,7 +16465,7 @@ json.unique.summary = \
json.unique() Function\
\
• Introduced in version 1.3b53\
- Returns a JSON Array with each value that occurs in the source JSON Array occurring only once. The relative order of the values in the array may not be preserved.\
+ Returns a JSON Array with each value that occurs in the source JSON Array occurring only once. The relative order of the values in the array may not be preserved.\
\
Usage\
\
@@ -16476,13 +16476,13 @@ json.unique.summary = \
Parameters\
\
\
- array - The JSON Array to return only unique values from.array - The JSON Array to return only unique values from.
\
\
Example\
\
- Lets say you have a JSON Array that contains the following Token names: ["Hero", "Dragon"], and you use getPCNames() to return the names of\
-the PC Tokens, you could use the following code to generate a JSON Array that contains the values in both JSON Arrays with no value present more than once.\
+
Lets say you have a JSON Array that contains the following Token names: ["Hero", "Dragon"], and you use getPCNames() to return the names of\
+the PC Tokens, you could use the following code to generate a JSON Array that contains the values in both JSON Arrays with no value present more than once.\
\
[h: names1 = '["Hero", "Dragon"]']\
[h: names2 = getNPCNames()]\
@@ -16544,7 +16544,7 @@ Returns a number than is between 2 and 20, with a high
\
See Also\
\
- For another method of rolling dice, see Dice Expressions.\
+ For another method of rolling dice, see Dice Expressions.\
\
\
@@ -16589,7 +16589,7 @@ Returns a number than is between 3 and 30, with a low
\
See Also\
\
- For another method of rolling dice, see Dice Expressions.\
+ For another method of rolling dice, see Dice Expressions.\
\
Version Changes\
\
@@ -16705,7 +16705,7 @@ Returns 5\
\
-listAppend.description = Returns a string list with a value appended to the end of the string list .
+listAppend.description = Returns a string list with a value appended to the end of the string list .
listAppend.summary = \
\
\
@@ -16714,7 +16714,7 @@ listAppend.summary = \
listAppend() Function\
\
• Introduced in version 1.3b42\
- Returns a string list with a value appended to the end of the string list.\
+ Returns a string list with a value appended to the end of the string list.\
\
Usage\
\
@@ -16724,7 +16724,7 @@ listAppend.summary = \
\
listAppend(list, value, delim)
\
\
- If delim is not specified then the default value of ',' is used to separate the values in the string list\
+
If delim is not specified then the default value of ',' is used to separate the values in the string list\
\
\
Examples\
@@ -16736,7 +16736,7 @@ Returns This: is: a: test
\
\
-listContains.description = Returns the number of occurrences of a value in a String List .
+listContains.description = Returns the number of occurrences of a value in a String List .
listContains.summary = \
\
\
@@ -16745,7 +16745,7 @@ listContains.summary = \
listContains() Function\
\
• Introduced in version 1.3b42\
- Returns the number of occurrences of a value in a String List.\
+ Returns the number of occurrences of a value in a String List.\
\
Usage\
\
@@ -16757,9 +16757,9 @@ listContains(list, value, delim)\
Parameters\
\
\
- list - The String List that is checked for occurrences of the value.value - The value to search the String List for occurrences.delim - The delimiter that separates the values in the String List; defaults to ",".list - The String List that is checked for occurrences of the value.value - The value to search the String List for occurrences.delim - The delimiter that separates the values in the String List; defaults to ",".
\
\
Examples\
@@ -16778,7 +16778,7 @@ Returns 2
\
\
-listCount.description = Returns the number of items in a string list .
+listCount.description = Returns the number of items in a string list .
listCount.summary = \
\
\
@@ -16787,7 +16787,7 @@ listCount.summary = \
listCount() Function\
\
• Introduced in version 1.3b42\
- Returns the number of items in a string list.\
+ Returns the number of items in a string list.\
\
Usage\
\
@@ -16797,7 +16797,7 @@ listCount.summary = \
\
listCount(list, delim)
\
\
- If delim is not specified then the default value of ',' is used as the value separator in the string list\
+
If delim is not specified then the default value of ',' is used as the value separator in the string list\
\
\
Examples\
@@ -16809,7 +16809,7 @@ Returns 4
\
\
-listDelete.description = Returns a string list with the specified item deleted from it.
+listDelete.description = Returns a string list with the specified item deleted from it.
listDelete.summary = \
\
\
@@ -16818,7 +16818,7 @@ listDelete.summary = \
listDelete() Function\
\
• Introduced in version 1.3b42\
- Returns a string list with the specified item deleted from it. The index for the string list\
+ Returns a string list with the specified item deleted from it. The index for the string list\
\
Usage\
\
@@ -16828,7 +16828,7 @@ listDelete.summary = \
\
listDelete(list, index, delim)
\
\
- If delim is not specified then the default value of ',' is used as the value separator in the string list\
+
If delim is not specified then the default value of ',' is used as the value separator in the string list\
\
\
Example\
@@ -16839,7 +16839,7 @@ Returns This, a, test
\
\
-listFind.description = Returns the index of the first occurrence of a value in a string list .
+listFind.description = Returns the index of the first occurrence of a value in a string list .
listFind.summary = \
\
\
@@ -16848,7 +16848,7 @@ listFind.summary = \
listFind() Function\
\
• Introduced in version 1.3b42\
- Returns the index of the first occurrence of a value in a string list. If the value is not found then -1 is returned.\
+ Returns the index of the first occurrence of a value in a string list. If the value is not found then -1 is returned.\
\
Usage\
\
@@ -16858,7 +16858,7 @@ listFind.summary = \
\
listFind(list, value, delim)
\
\
- If delim is not specified then the default value of ',' is used as the value separator in the string list\
+
If delim is not specified then the default value of ',' is used as the value separator in the string list\
\
\
Examples\
@@ -16913,7 +16913,7 @@ The first argument is the list, returned by \
-listGet.description = Returns the value in the string list at the specified index.
+listGet.description = Returns the value in the string list at the specified index.
listGet.summary = \
\
\
@@ -16922,7 +16922,7 @@ listGet.summary = \
listGet() Function\
\
• Introduced in version 1.3b42\
- Returns the value in the string list at the specified index. The index for a string list starts at 0.\
+ Returns the value in the string list at the specified index. The index for a string list starts at 0.\
\
Usage\
\
@@ -16932,7 +16932,7 @@ listGet.summary = \
\
listGet(list, index, delim)
\
\
- If delim is not specified then the default value of ',' is used as the value separator in the string list\
+
If delim is not specified then the default value of ',' is used as the value separator in the string list\
\
\
Example\
@@ -16944,7 +16944,7 @@ Returns is
\
\
-listInsert.description = Inserts a value into the string list at the specified index.
+listInsert.description = Inserts a value into the string list at the specified index.
listInsert.summary = \
\
\
@@ -16953,7 +16953,7 @@ listInsert.summary = \
listInsert() Function\
\
• Introduced in version 1.3b42\
- Inserts a value into the string list at the specified index. If a delimiter is not specified then the default value of ',' is used. The index for lists starts at 0\
+ Inserts a value into the string list at the specified index. If a delimiter is not specified then the default value of ',' is used. The index for lists starts at 0\
\
Usage\
\
@@ -16973,7 +16973,7 @@ Returns This: is: a: test\
\
-listReplace.description = Replaces the element at the specified index of a String List with a new value.
+listReplace.description = Replaces the element at the specified index of a String List with a new value.
listReplace.summary = \
\
\
@@ -16982,7 +16982,7 @@ listReplace.summary = \
listReplace() Function\
\
• Introduced in version 1.3b42\
- Replaces the element at the specified index of a String List with a new value. If a delimiter is not specified then the default value of "," is used. The index for lists starts at 0.\
+ Replaces the element at the specified index of a String List with a new value. If a delimiter is not specified then the default value of "," is used. The index for lists starts at 0.\
\
Usage\
\
@@ -16996,8 +16996,8 @@ listReplace.summary = \
Examples\
\
Simple example:[r: listReplace("This, isnt, a , test", 1, "is")]Returns This, is, a, Test\
-
Example using a String List with a non-default delimiter:
[r: listReplace("This: isnt: a: test", 1, "is", ":")]Returns This: is: a: test\
-
Example using a String List stored in a variable:
[h: ListVar = "This, is, a, great, test"]\
+Example using a String List with a non-default delimiter:
[r: listReplace("This: isnt: a: test", 1, "is", ":")]Returns This: is: a: test\
+
Example using a String List stored in a variable:
[h: ListVar = "This, is, a, great, test"]\
[h: ListVar = listReplace(ListVar, 3, "silly")]\
[r: ListVar]
\
Returns: This, is, a, silly, test
\
@@ -17110,7 +17110,7 @@ log.debug.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.2\
@@ -17156,7 +17156,7 @@ log.error.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.2\
@@ -17202,7 +17202,7 @@ log.fatal.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.2\
@@ -17248,7 +17248,7 @@ log.getLoggers.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.2\
@@ -17318,7 +17318,7 @@ log.info.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.2\
@@ -17364,7 +17364,7 @@ log.setLevel.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.2\
@@ -17407,11 +17407,11 @@ log.setLevel.summary = \
[r: "Setting <i><b>" + lname + "</b></i> to <b>" + level + "</b>."]\
[h: log.setLevel(lname,level)]\
\
-\
+\
\
See Also\
\
- \
+ \
\
\
@@ -17426,7 +17426,7 @@ log.trace.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.7\
@@ -17472,7 +17472,7 @@ log.warn.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.2\
@@ -17618,7 +17618,7 @@ lt.summary = \
\
-macroLink.description = Creates the HTML for a link which will run the specified macro when clicked on in a frame , dialog , or the chat window.
+macroLink.description = Creates the HTML for a link which will run the specified macro when clicked on in a frame , dialog , or the chat window.
macroLink.summary = \
\
\
@@ -17627,7 +17627,7 @@ macroLink.summary = \
macroLink() Function\
\
• Introduced in version 1.3b48\
- Creates the HTML for a link which will run the specified macro when clicked on in a frame, dialog, or the chat window. Additionally, if you send the link to the chat window, it will automatically be executed by any recipients as soon as they receive it. This can be useful for popping up or updating frames or dialogs for your players. To auto-execute in the chat window, it must not be hidden by roll options like [h:], but may be hidden by being contained within an HTML comment.
\
+ Creates the HTML for a link which will run the specified macro when clicked on in a frame, dialog, or the chat window. Additionally, if you send the link to the chat window, it will automatically be executed by any recipients as soon as they receive it. This can be useful for popping up or updating frames or dialogs for your players. To auto-execute in the chat window, it must not be hidden by roll options like [h:], but may be hidden by being contained within an HTML comment.
\
Some notes on the auto execution
\
- If you refer to a macro on a lib:token it will automatically execute, however if you refer to a macro on the campaign panel, the macro is NOT automatically executed when sent to the chat.
- It will also not work if the owner of the lib:token is not an (online) GM, though as a general practice its best not to set ownership of lib:tokens at all.
- To prevent the macro from automatically executing you can turn off the 'auto execute' in the edit panel of the macro that you're linking to.
\
\
@@ -17655,24 +17655,24 @@ macroLink.summary = \
\
\
text - is the text to display for the link.macroName - is the name of the macro to run when the link is clicked. The macroName is in the same format that is used for [macro(...): ...] e.g. Test@Lib:test.macroName - is the name of the macro to run when the link is clicked. The macroName is in the same format that is used for [macro(...): ...] e.g. Test@Lib:test.output - contains who the output of the macro should go to, values are (defaults to "none"):\
-"self" - Display only to person who clicked on the link."gm" - Display to GM."all" - everyone (acts like a /say)."none" - discard any output."gm-self" - Display to GM and the person executing the link."list" - Displays to a list of players. When the output is set to "list" then the macro link expects the args parameter to be a JSON Object, that contains a field called mlOutputList which is a JSON Array containing the players to send the output to.
"self" - Display only to person who clicked on the link."gm" - Display to GM."all" - everyone (acts like a /say)."none" - discard any output."gm-self" - Display to GM and the person executing the link."list" - Displays to a list of players. When the output is set to "list" then the macro link expects the args parameter to be a JSON Object, that contains a field called mlOutputList which is a JSON Array containing the players to send the output to.
\
args - Any arguments to be passed to the macro when it is called.target - Which tokens to run the macro on. Target can be one or more of the following separated by commas (defaults to "impersonated"):\
-
\
\
Examples\
\
- * To create a link that will call a macro called Test on the Library Token named Lib:Test that says "Click on me!" and displays the output to the GM.\
+ * To create a link that will call a macro called Test on the Library Token named Lib:Test that says "Click on me!" and displays the output to the GM.\
[r: macroLink("Click on me!", "Test@Lib:Test", "gm", "count=6", "impersonated")]
\
produces this output:<ahref="macro://Test@Lib:Test/gm/impersonated?count=6;">Click on me!</a>
\
- Sending to multiple players and the GM in 1.3b55
\
[h: outputTo = '["Fred", "Barney", "gm"]']\
[h: args = json.set("{}", "mlOutputList", outputTo)]\
[r: macroLink("Click on me!", "Test@Lib:Test", "list", args)]
\
-- Updating a character sheet frame without displaying the link:
\
+- Updating a character sheet frame without displaying the link:
\
Took 4 points of damage.<!-- [r: macroLink("Update Character Sheet", "Update Character Sheet@Lib:Test")] -->
\
- An example of a longer custom macrolink:
\
This is a link that is user created to send several variables to the AttackMacro. Each variable must be separated by a & sign. Spaces within text must be replaced with a + sign. Plus sign can't be sent, you might want to use the html code for plus sign (&27;) instead of +.\
@@ -17714,7 +17714,7 @@ macroLinkText.summary = \
macroLinkText() Function\
\
• Introduced in version 1.3b48\
- Creates the text that would appear in a HTML tag for a link which will run the specified macro when clicked on. This is useful for callbacks in [dialog():] or [frame():]. If you just want to send a click-able link to someone use macroLink().\
+ Creates the text that would appear in a HTML tag for a link which will run the specified macro when clicked on. This is useful for callbacks in [dialog():] or [frame():]. If you just want to send a click-able link to someone use macroLink().\
\
Usage\
\
@@ -17736,21 +17736,21 @@ macroLinkText.summary = \
\
macroName - The name of the macro to run when the link is clicked. The macroName is in the standard macro reference format (e.g. Macro@Lib:Token)output - Who the output of the macro should go to, values are (defaults to none):\
-self - Display only to person who clicked on the link.gm - Display to GM.all - Everyone (acts like a /say)none - Discard any output.gm-self - Display to GM and the person executing the link.list - Displays to a list of players. When the output parameter is "list" then the macro link expects the args parameter to be a JSON Object, that contains a field called mlOutputList which is a JSON Array containing the players to send the output to.
self - Display only to person who clicked on the link.gm - Display to GM.all - Everyone (acts like a /say)none - Discard any output.gm-self - Display to GM and the person executing the link.list - Displays to a list of players. When the output parameter is "list" then the macro link expects the args parameter to be a JSON Object, that contains a field called mlOutputList which is a JSON Array containing the players to send the output to.
\
args - Any arguments to be passed to the macro when it is called.target - Which tokens to run the macro on. Target can be one or more of the following separated by commas (defaults to impersonated):\
-
\
\
Examples\
\
- To create the text that would go inside a form element as the action attribute, and that will call a macro named Test on the Library Token named Lib:Test:\
+ To create the text that would go inside a form element as the action attribute, and that will call a macro named Test on the Library Token named Lib:Test:\
[r: macroLinkText("Test@Lib:Test","", "gm")]\
Returns: macro://Test@Lib:Test/gm/impersonated?\
-
To create the text that would go inside a form element as the action attribute and call the AddWeapon on the Library Token named Lib:PC which will act upon the Current Token:\
+
To create the text that would go inside a form element as the action attribute and call the AddWeapon on the Library Token named Lib:PC which will act upon the Current Token:\
\
[r:macroLinkText('AddWeapon@Lib:PC', 'none', '', currentToken())]\
-Returns: macro://AddWeapon@Lib:PC/none/#ID#? where #ID# is the id of the Current Token.\
+
Returns: macro://AddWeapon@Lib:PC/none/#ID#? where #ID# is the id of the Current Token.\
Sending to multiple players and the GM in 1.3b55\
\
[h: outputTo = '["Fred", "Barney", "gm"]']\
@@ -17852,7 +17852,7 @@ markdownToHTML(string, type)
\
\
Examples\
\
- Retrieve the text stored in the current token's Notes and convert them to HTML for display inside a frame5().\
+ Retrieve the text stored in the current token's Notes and convert them to HTML for display inside a frame5().\
[frame5("Notes", "title=" + token.name): {<br>\
[r: markdownToHTML(getNotes())]\
}]\
@@ -17878,7 +17878,7 @@ matches.summary = \
matches() Function\
\
• Introduced in version 1.3b48\
- Returns 1 if a string matches pattern or 0 if it does not. The pattern can be a regular expression. Matches performs a while string comparison, so the pattern must match the whole of the input string and not only part of it.\
+ Returns 1 if a string matches pattern or 0 if it does not. The pattern can be a regular expression. Matches performs a while string comparison, so the pattern must match the whole of the input string and not only part of it.\
\
Usage\
\
@@ -18200,7 +18200,7 @@ Returns: 8.0\
\
-math.listMax.description = Find the maximum value in a String List .
+math.listMax.description = Find the maximum value in a String List .
math.listMax.summary = \
\
\
@@ -18209,7 +18209,7 @@ math.listMax.summary = \
math.listMax() Function\
\
• Introduced in version 1.7\
- Find the maximum value in a String List. Only allows numeric elements - any non-numeric values will produce an error.\
+ Find the maximum value in a String List. Only allows numeric elements - any non-numeric values will produce an error.\
\
Usage\
\
@@ -18237,7 +18237,7 @@ math.listMax.summary = \
\
-math.listMean.description = Calculates the arithmetic mean of the contents of a String List .
+math.listMean.description = Calculates the arithmetic mean of the contents of a String List .
math.listMean.summary = \
\
\
@@ -18246,7 +18246,7 @@ math.listMean.summary = \
math.listMean() Function\
\
• Introduced in version 1.7\
- Calculates the arithmetic mean of the contents of a String List. Only allows numeric elements - any non-numeric values will produce an error. The mean is equal to the sum of all the list's contents divided by the number of elements.\
+ Calculates the arithmetic mean of the contents of a String List. Only allows numeric elements - any non-numeric values will produce an error. The mean is equal to the sum of all the list's contents divided by the number of elements.\
\
Usage\
\
@@ -18274,7 +18274,7 @@ math.listMean.summary = \
\
-math.listMedian.description = Calculates the Median of the contents of a String List .
+math.listMedian.description = Calculates the Median of the contents of a String List .
math.listMedian.summary = \
\
\
@@ -18283,7 +18283,7 @@ math.listMedian.summary = \
math.listMedian() Function\
\
• Introduced in version 1.7\
- Calculates the Median of the contents of a String List. The median value is is the value where half the numbers in the list are greater than or equal to it, and the other half are less than or equal to it. The median is calculated by sorting the list contents and picking the middle number if the number of elements is odd, or averaging the two in the middle if the number of elements is even. Only allows numeric elements - any non-numeric values will produce an error.\
+ Calculates the Median of the contents of a String List. The median value is is the value where half the numbers in the list are greater than or equal to it, and the other half are less than or equal to it. The median is calculated by sorting the list contents and picking the middle number if the number of elements is odd, or averaging the two in the middle if the number of elements is even. Only allows numeric elements - any non-numeric values will produce an error.\
\
Usage\
\
@@ -18311,7 +18311,7 @@ math.listMedian.summary = \
\
-math.listMin.description = Find the minimum value in a String List .
+math.listMin.description = Find the minimum value in a String List .
math.listMin.summary = \
\
\
@@ -18320,7 +18320,7 @@ math.listMin.summary = \
math.listMin() Function\
\
• Introduced in version 1.7\
- Find the minimum value in a String List. Only allows numeric elements - any non-numeric values will produce an error.\
+ Find the minimum value in a String List. Only allows numeric elements - any non-numeric values will produce an error.\
\
Usage\
\
@@ -18348,7 +18348,7 @@ math.listMin.summary = \
\
-math.listProduct.description = Multiplies together the contents of a String List .
+math.listProduct.description = Multiplies together the contents of a String List .
math.listProduct.summary = \
\
\
@@ -18357,7 +18357,7 @@ math.listProduct.summary = \
math.listProduct() Function\
\
• Introduced in version 1.7\
- Multiplies together the contents of a String List. Only allows numeric elements - any non-numeric values will produce an error.\
+ Multiplies together the contents of a String List. Only allows numeric elements - any non-numeric values will produce an error.\
\
Usage\
\
@@ -18385,7 +18385,7 @@ math.listProduct.summary = \
\
-math.listSum.description = Adds together the contents of a String List .
+math.listSum.description = Adds together the contents of a String List .
math.listSum.summary = \
\
\
@@ -18394,7 +18394,7 @@ math.listSum.summary = \
math.listSum() Function\
\
• Introduced in version 1.7\
- Adds together the contents of a String List. Only allows numeric elements - any non-numeric values will produce an error.\
+ Adds together the contents of a String List. Only allows numeric elements - any non-numeric values will produce an error.\
\
Usage\
\
@@ -18575,7 +18575,7 @@ movedOverDrawing.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.2\
@@ -18681,7 +18681,7 @@ Moved Over: [r: movedOverPoints(jsonArray,lastPath)]\
\
-movedOverToken.description = Is used to check if the location of the target token is in an array of cell coordinates like the one received from getLastPath() or the onTokenMove event's macro.args .
+movedOverToken.description = Is used to check if the location of the target token is in an array of cell coordinates like the one received from getLastPath() or the onTokenMove event's macro.args .
movedOverToken.summary = \
\
\
@@ -18690,7 +18690,7 @@ movedOverToken.summary = \
movedOverToken() Function\
\
• Introduced in version 1.3.b74\
- Is used to check if the location of the target token is in an array of cell coordinates like the one received from getLastPath() or the onTokenMove event's macro.args.\
+ Is used to check if the location of the target token is in an array of cell coordinates like the one received from getLastPath() or the onTokenMove event's macro.args.\
\
\
Usage\
@@ -18795,20 +18795,20 @@ moveToken(x, y, units, id)\
x - The X coordinate to move the token to.y - The Y coordinate to move the token to.units - If set to false(0), the coordinates are a location on the grid in cells. Defaults to true(1), where the coordinates are in Distance Per Cell pixels.id - The id string of the token to move, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The id string of the token to move, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
\
\
\
Examples\
\
- Moves the Current Token down 5 units, and left 10 units.\
+ Moves the Current Token down 5 units, and left 10 units.\
[h: CurrentX = getTokenX()]\
[h: CurrentY = getTokenY()]\
[h: NewX = CurrentX + 5]\
[h: NewY = CurrentY - 10]\
[h: moveToken(NewX, NewY)]
\
-Moves the Current Token down 5 cells, and left 10 cells.\
+
Moves the Current Token down 5 cells, and left 10 cells.\
\
[h: CurrentX = getTokenX(0)]\
[h: CurrentY = getTokenY(0)]\
@@ -18834,7 +18834,7 @@ moveTokenFrom.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b54\
@@ -18852,7 +18852,7 @@ moveTokenFromMap(id, map, x, y, z)\
Parameters\
\
\
- id - The token id or a JSON Array of token ids of the token/s to move.id - The token id or a JSON Array of token ids of the token/s to move.map - A string containing the name of the map that the token is moved from.x - The X coordinate of the current map that the token should be moved to. Defaults to 0.y - The Y coordinate of the current map that the token should be moved to. Defaults to 0.\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b54\
@@ -18899,7 +18899,7 @@ moveTokenFromMap(id, map, x, y, z)\
Parameters\
\
\
- id - The token id or a JSON Array of token ids of the token/s to move.id - The token id or a JSON Array of token ids of the token/s to move.map - A string containing the name of the map that the token is moved from.x - The X coordinate of the current map that the token should be moved to. Defaults to 0.y - The Y coordinate of the current map that the token should be moved to. Defaults to 0.\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b54\
@@ -18946,7 +18946,7 @@ moveTokenToMap(id, map, x, y, z)\
Parameters\
\
\
- id - The token id or a JSON Array of token ids of the token/s to move.id - The token id or a JSON Array of token ids of the token/s to move.map - A string containing the name of the map that the token is moved to.x - The X coordinate of the map that the token should be moved to. Default to 0.y - The Y coordinate of the map that the token should be moved to. Default to 0.
\
-nextInitiative.description = Advances the initiative to the next Token in the Initiative Panel .
+nextInitiative.description = Advances the initiative to the next Token in the Initiative Panel .
nextInitiative.summary = \
\
\
@@ -19058,12 +19058,12 @@ nextInitiative.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b41\
- Advances the initiative to the next Token in the Initiative Panel. Only the GM or a trusted macro can call this function. This function returns the offset into the Initiative Panel (starting at 0) of the Token that will get the Initiative.\
-- Since 1.8: This function triggers the
onInitiativeChangeRequest (and onInitiativeChange) events, so it is possible that the change will be blocked. See the Guide to Initiative Events for more details. This function will return the offset of the token that has initiative after this function completes, whether the change proceeded as requested or not.
\
+ Advances the initiative to the next Token in the Initiative Panel. Only the GM or a trusted macro can call this function. This function returns the offset into the Initiative Panel (starting at 0) of the Token that will get the Initiative.\
+- Since 1.8: This function triggers the
onInitiativeChangeRequest (and onInitiativeChange) events, so it is possible that the change will be blocked. See the Guide to Initiative Events for more details. This function will return the offset of the token that has initiative after this function completes, whether the change proceeded as requested or not.
\
\
Usage\
\
@@ -19143,7 +19143,7 @@ number.summary = \
number() Function\
\
• Introduced in version 1.3b48\
- Returns the value that is passed in as a number. If the value can not be converted to a number then an error will occur. If you are unsure if a value is a number to can use isNumber() before calling this function.\
+ Returns the value that is passed in as a number. If the value can not be converted to a number then an error will occur. If you are unsure if a value is a number to can use isNumber() before calling this function.\
\
Usage\
\
@@ -19164,7 +19164,7 @@ oldFunction.summary = \
\
• Introduced in version 1.3b51\
If a user-defined function redefines a standard MapTool function or another user-defined function -- for instance, a user defines a function called eval(), redefining the standard MapTool eval() -- oldFunction() can be used in the user-defined function to call the original function. When a user-defined function redefines an existing function, it keeps track of the function that it redefined. Due to this tracking, it is possible to redefine a function multiple times and oldFunction() will always reference the previous function in the chain.\
-Note: Do not rely on a specific order in the function chain unless you are sure that the functions will be redefined in that order. Calls to defineFunction() within onCampaignLoad macros on different Library Tokens are not executed in any standard order.\
+Note: Do not rely on a specific order in the function chain unless you are sure that the functions will be redefined in that order. Calls to defineFunction() within onCampaignLoad macros on different Library Tokens are not executed in any standard order.\
\
Usage\
\
@@ -19235,7 +19235,7 @@ Returns a string that is similar to Dice: 5, 4, 19, 6, 3, Maximum: 19\
See Also\
\
- For another method of rolling dice, see Dice Expressions.\
+ For another method of rolling dice, see Dice Expressions.\
\
\
@@ -19314,7 +19314,7 @@ playClip(uri, cycleCount, volume)\
Parameter\
\
\
- uri - The uri/url of the file. For example, http://www.mywebsite/mysong.mp3 or file:/C:/mysong.mp3uri - The uri/url of the file. For example, https://www.mywebsite/mysong.mp3 or file:/C:/mysong.mp3cycleCount - The number of times the audio should play. If set to 0, the file is cached but not played; if set to -1, the file is played continuously. Defaults to 1.volume - The volume the audio is to be played at. Can range from 0 to 1. Defaults to 1.
\
@@ -19325,7 +19325,7 @@ playClip(uri, cycleCount, volume)\
[playClip(macro.args)]
\
To play the song, the GM can then use execLink:\
\
-[H: songUrl = "http://erinmcnamee.com.hostbaby.com/files/07_No_Sorrow__Banish_Misfortune.mp3"]\
+[H: songUrl = "https://erinmcnamee.com.hostbaby.com/files/07_No_Sorrow__Banish_Misfortune.mp3"]\
[H: audioByte = macroLinkText("playSong@Lib:MusicPlayer", "none", songUrl)]\
[H: execLink(audioByte,0,"all")]\
Dropbox URLs
\
@@ -19360,7 +19360,7 @@ playStream(uri, cycleCount, volume, start, stop)
\
Parameter\
\
\
- uri - The uri/url of the file. For example, http://www.mywebsite/mysong.mp3 or file:/C:/mysong.mp3uri - The uri/url of the file. For example, https://www.mywebsite/mysong.mp3 or file:/C:/mysong.mp3cycleCount - The number of times the audio should play. If set to 0, the file is cached but not played; if set to -1, the file is played continuously. Defaults to 1.volume - The volume the audio is to be played at. Can range from 0 to 1. Defaults to 1.start - The time offset in seconds where audio should start playing, or restart from when repeating. Defaults to 0.[playStream(macro.args)]
\
To play the song, the GM can then use execLink:\
\
-[H: songUrl = "http://erinmcnamee.com.hostbaby.com/files/07_No_Sorrow__Banish_Misfortune.mp3"]\
+[H: songUrl = "https://erinmcnamee.com.hostbaby.com/files/07_No_Sorrow__Banish_Misfortune.mp3"]\
[H: audioByte = macroLinkText("playSong@Lib:MusicPlayer", "none", songUrl)]\
[H: execLink(audioByte,0,"all")]\
Alternatively, the GM can use execFunction:\
\
-[H: songUrl = json.append("[]","http://erinmcnamee.com.hostbaby.com/files/07_No_Sorrow__Banish_Misfortune.mp3")]\
+[H: songUrl = json.append("[]","https://erinmcnamee.com.hostbaby.com/files/07_No_Sorrow__Banish_Misfortune.mp3")]\
[H: execFunction("playStream", songUrl, 0, "all")\
Dropbox URLs
\
After creating the dropbox share link you have to replace www.dropbox.com with dl.dropboxusercontent.com. That provides a direct link that playStream can use. Thanks to Full Bleed on the forums for the tip.\
@@ -19490,7 +19490,7 @@ power.summary = \
\
-prevInitiative.description = Restores the initiative to the previous Token in the Initiative Panel , returning to the previous round if necessary.
+prevInitiative.description = Restores the initiative to the previous Token in the Initiative Panel , returning to the previous round if necessary.
prevInitiative.summary = \
\
\
@@ -19500,12 +19500,12 @@ prevInitiative.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.8\
- Restores the initiative to the previous Token in the Initiative Panel, returning to the previous round if necessary. Only the GM or a trusted macro can call this function. This function returns the offset into the Initiative Panel (starting at 0) of the Token that will receive Initiative. Note: neither this function nor the corresponding UI button will allow the Initiative to fall back any further than the first token in the first round.\
-- This function triggers the
onInitiativeChangeRequest (and onInitiativeChange) events, so it is possible that the change will be blocked. See the Guide to Initiative Events for more details. This function will return the offset of the token that has initiative after this function completes, whether the change proceeded as requested or not.
\
+ Restores the initiative to the previous Token in the Initiative Panel, returning to the previous round if necessary. Only the GM or a trusted macro can call this function. This function returns the offset into the Initiative Panel (starting at 0) of the Token that will receive Initiative. Note: neither this function nor the corresponding UI button will allow the Initiative to fall back any further than the first token in the first round.\
+- This function triggers the
onInitiativeChangeRequest (and onInitiativeChange) events, so it is possible that the change will be blocked. See the Guide to Initiative Events for more details. This function will return the offset of the token that has initiative after this function completes, whether the change proceeded as requested or not.
\
\
Usage\
\
@@ -19543,7 +19543,7 @@ refreshDrawing.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -19580,7 +19580,7 @@ refreshDrawing.summary = \
\
-removeAllFromInitiative.description = Removes all of the Tokens from the Initiative Panel .
+removeAllFromInitiative.description = Removes all of the Tokens from the Initiative Panel .
removeAllFromInitiative.summary = \
\
\
@@ -19590,10 +19590,10 @@ removeAllFromInitiative.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
- Removes all of the Tokens from the Initiative Panel. This function returns the number of Tokens that were removed. Only the GM can call this function.\
+ Removes all of the Tokens from the Initiative Panel. This function returns the number of Tokens that were removed. Only the GM can call this function.\
\
Usage\
\
@@ -19604,7 +19604,7 @@ removeAllFromInitiative.summary = \
\
-removeAllNPCsFromInitiative.description = Removes all of the NPC Tokens from the Initiative Panel .
+removeAllNPCsFromInitiative.description = Removes all of the NPC Tokens from the Initiative Panel .
removeAllNPCsFromInitiative.summary = \
\
\
@@ -19614,10 +19614,10 @@ removeAllNPCsFromInitiative.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
- Removes all of the NPC Tokens from the Initiative Panel. This function returns the number of Tokens that were removed. Only the GM can call this function.\
+ Removes all of the NPC Tokens from the Initiative Panel. This function returns the number of Tokens that were removed. Only the GM can call this function.\
\
Usage\
\
@@ -19628,7 +19628,7 @@ removeAllNPCsFromInitiative.summary = \
\
-removeAllPCsFromInitiative.description = Removes all of the PC Tokens from the Initiative Panel .
+removeAllPCsFromInitiative.description = Removes all of the PC Tokens from the Initiative Panel .
removeAllPCsFromInitiative.summary = \
\
\
@@ -19638,10 +19638,10 @@ removeAllPCsFromInitiative.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
- Removes all of the PC Tokens from the Initiative Panel. This function returns the number of Tokens that were removed. Only the GM can call this function.\
+ Removes all of the PC Tokens from the Initiative Panel. This function returns the number of Tokens that were removed. Only the GM can call this function.\
\
Usage\
\
@@ -19652,7 +19652,7 @@ removeAllPCsFromInitiative.summary = \
\
-removeFromInitiative.description = Removes the Current Token from the Initiative Panel .
+removeFromInitiative.description = Removes the Current Token from the Initiative Panel .
removeFromInitiative.summary = \
\
\
@@ -19660,7 +19660,7 @@ removeFromInitiative.summary = \
\
removeFromInitiative() Function\
\
- Removes the Current Token from the Initiative Panel. Additional parameters allow you to specify the token.\
+ Removes the Current Token from the Initiative Panel. Additional parameters allow you to specify the token.\
\
Usage\
\
@@ -19673,14 +19673,14 @@ removeFromInitiative(id, mapname)\
Parameters\
\
\
- id - The token id of the token to be removed from the initiative. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to be removed from the initiative. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.return - Returns 1 if removed from the initiative, 0 if did not.
\
\
Example\
\
- To remove the token with the name "Dragon" in current map from the initiative panel.\
+ To remove the token with the name "Dragon" in current map from the initiative panel.\
[h: removeFromInitiative("Dragon")]\
\
See Also\
@@ -19754,7 +19754,7 @@ removeToken.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b51\
@@ -19795,7 +19795,7 @@ removeTokenFacing.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b51\
@@ -19839,7 +19839,7 @@ replace.summary = \
replace() Function\
\
• Introduced in version 1.3b48\
- Returns the string with the occurrences of a pattern replaced by the specified value. If the number of times to perform the replacement is not specified then all occurrences of the pattern are replaced. Pattern can be a regular expression. This means if the pattern string contains any regular expression special characters they must be escaped.\
+ Returns the string with the occurrences of a pattern replaced by the specified value. If the number of times to perform the replacement is not specified then all occurrences of the pattern are replaced. Pattern can be a regular expression. This means if the pattern string contains any regular expression special characters they must be escaped.\
\
Usage\
\
@@ -19913,7 +19913,7 @@ Returns a number than is between 25 and 50.
\
\
See Also\
\
- For another method of rolling dice, see Dice Expressions.\
+ For another method of rolling dice, see Dice Expressions.\
\
\
@@ -19960,7 +19960,7 @@ May return 5 [2, 1, 2, 4] - the first die produced a 2, which was r
\
See Also\
\
- For another method of rolling dice, see Dice Expressions.\
+ For another method of rolling dice, see Dice Expressions.\
\
\
@@ -19992,13 +19992,13 @@ resetFrame.summary = \
\
See Also\
\
- [frame():],\
+ \
\
\
-resetProperty.description = Resets the specified Token Property on a specific Token so that it is empty and will return the default value when queried (if it has one).
+resetProperty.description = Resets the specified Token Property on a specific Token so that it is empty and will return the default value when queried (if it has one).
resetProperty.summary = \
\
\
@@ -20007,7 +20007,7 @@ resetProperty.summary = \
resetProperty() Function\
\
• Introduced in version 1.3b48\
- Resets the specified Token Property on a specific Token so that it is empty and will return the default value when queried (if it has one).\
+ Resets the specified Token Property on a specific Token so that it is empty and will return the default value when queried (if it has one).\
\
Usage\
\
@@ -20021,7 +20021,7 @@ resetProperty(property, id, mapname)\
\
\
property - The name of the property to reset.id - The token id of the token which has its property reset, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token which has its property reset, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -20039,7 +20039,7 @@ resetProperty(property, id, mapname)\
\
\
- 1.3b51 - Added
id parameter option. \
- - 1.3b68 - Token Property is now deleted from Token
\
+ - 1.3b68 - Token Property is now deleted from Token
\
- 1.5.4 - Added
mapname parameter option. \
\
\
@@ -20047,7 +20047,7 @@ resetProperty(property, id, mapname)\
\
-resetSize.description = Resets the Size of a Token to the default for grid type of the map it occupies.
+resetSize.description = Resets the Size of a Token to the default for grid type of the map it occupies.
resetSize.summary = \
\
\
@@ -20057,11 +20057,11 @@ resetSize.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
- Resets the Size of a Token to the default for grid type of the map it occupies. See setSize() for details about the default size for different grid types.\
+ Resets the Size of a Token to the default for grid type of the map it occupies. See setSize() for details about the default size for different grid types.\
\
Usage\
\
@@ -20074,7 +20074,7 @@ resetSize(id, mapname)\
Parameters\
\
\
- id - The token id of the token to reset, defaults to the Current Token.id - The token id of the token to reset, defaults to the Current Token.mapName - Optional map name to find the token. Defaults to current map.
\
\
@@ -20116,7 +20116,7 @@ resetTablePicks.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.6.0\
@@ -20135,8 +20135,8 @@ resetTablePicks(tableName, entriesToReset, "json")\
\
\
tableName - A string containing the name of the Table.entriesToReset - Since 1.8. Identifies specific entries to be reset. Can be a String List using the provided delim (defaults to "," if no delim provided), or a JSON Array if delim is "json".delim - Since 1.8. Custom delimiter for the `entriesToReset` param. Defaults to ",". Should be "json" if entriesToReset is a JSON Array instead of a String List.entriesToReset - Since 1.8. Identifies specific entries to be reset. Can be a String List using the provided delim (defaults to "," if no delim provided), or a JSON Array if delim is "json".delim - Since 1.8. Custom delimiter for the `entriesToReset` param. Defaults to ",". Should be "json" if entriesToReset is a JSON Array instead of a String List.
\
\
Examples\
@@ -20154,7 +20154,7 @@ resetTablePicks(tableName, entriesToReset, "json")\
If this table is set to Pick Once, then the Ace and Two of Clubs can be reset with any of:\
[h:resetTablePicks("Standard", "0,1")]\
[h:resetTablePicks("Standard", "0@1", "@")]\
-[h:resetTablePicks("Standard", json.append("", 0, 1), "json")]Note that entries on Pick Once tables are identified by list index (starting at 0), and not by range as in normal tables. Take care to properly identify entries when resetting. For more info, see Introduction to Tables and the table() function.\
+[h:resetTablePicks("Standard", json.append("", 0, 1), "json")]Note that entries on Pick Once tables are identified by list index (starting at 0), and not by range as in normal tables. Take care to properly identify entries when resetting. For more info, see Introduction to Tables and the table() function.\
\
See Also\
\
@@ -20184,7 +20184,7 @@ REST.delete.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -20251,7 +20251,7 @@ Note the 204 - No Content status and thus no "body" element in the JSON. If the
See Also\
\
\
\
Version Changes\
@@ -20275,7 +20275,7 @@ REST.get.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -20365,7 +20365,7 @@ See this See Also\
\
\
\
\
@@ -20381,7 +20381,7 @@ REST.patch.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -20450,7 +20450,7 @@ REST.patch(url, payload, mediaType, headers, getFullResponse)\
See Also\
\
\
\
\
@@ -20466,7 +20466,7 @@ REST.post.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -20539,7 +20539,7 @@ REST.post(url, payload, mediaType, headers, getFullResponse)\
See Also\
\
\
\
\
@@ -20555,7 +20555,7 @@ REST.put.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -20610,7 +20610,7 @@ REST.put(url, payload, mediaType, headers, getFullResponse)\
See Also\
\
\
\
\
@@ -20626,7 +20626,7 @@ restoreFoW.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.1.3\
@@ -20660,7 +20660,7 @@ restoreFoW(mapname)\
\
See Also\
\
- \
+ \
\
\
@@ -20674,7 +20674,7 @@ return.summary = \
return() Function\
\
• Introduced in version 1.5.0\
- Is used to conditionally return from the execution of a macro like an abort, but not stopping further macro execution. Optionally also returning a value by automatically assigning macro.return. If the first argument to return() is 0 then the return is happening. If the first argument to return() is non zero then the macro continues. The optional second argument of return() defines if there is a value that should be returned to a calling macro. Any other output is discarded when using return().\
+ Is used to conditionally return from the execution of a macro like an abort, but not stopping further macro execution. Optionally also returning a value by automatically assigning macro.return. If the first argument to return() is 0 then the return is happening. If the first argument to return() is non zero then the macro continues. The optional second argument of return() defines if there is a value that should be returned to a calling macro. Any other output is discarded when using return().\
Common uses for this function are\
\
- Ending a macro with or without a return value to stop the further execution of the following lines in the current macro.
- The macro has conditions and based on these you want to return different values and not continue further in the current macro.
\
@@ -20777,12 +20777,12 @@ roll.summary = \
[h: listOfRolls = listAppend(listOfRolls, r)]\
}]\
You rolled [r: listSort(listOfRolls, "N-")] = [r: sum].Rolls 5 times a d6 and returns these as sorted list as well as the total.\
-
- See also[count():], listAppend() and listSort().
\
+- See also[count():], listAppend() and listSort().
\
\
\
See Also\
\
- For another method of rolling dice, see Dice Expressions.\
+ For another method of rolling dice, see Dice Expressions.\
\
\
@@ -20820,7 +20820,7 @@ Returns a number that is between 40 and 115 (and no longer 5 to 100 as with a re
\
See Also\
\
- The corresponding dice roll expression is XdYaZlW. For other methods of rolling dice, see Dice Expressions.\
+ The corresponding dice roll expression is XdYaZlW. For other methods of rolling dice, see Dice Expressions.\
\
\
@@ -20858,7 +20858,7 @@ Returns a number that is between 35 and 90 (and no longer 5 to 100 as with a reg
\
See Also\
\
- The corresponding dice roll expression is XdYaZuW. For other methods of rolling dice, see Dice Expressions.\
+ The corresponding dice roll expression is XdYaZuW. For other methods of rolling dice, see Dice Expressions.\
\
\
@@ -20896,7 +20896,7 @@ Returns a number that is between 15 and 90 (and no longer 5 to 100 as with a reg
\
See Also\
\
- The corresponding dice roll expression is XdYsZlW. For other methods of rolling dice, see Dice Expressions.\
+ The corresponding dice roll expression is XdYsZlW. For other methods of rolling dice, see Dice Expressions.\
\
\
@@ -20934,7 +20934,7 @@ Returns a number that is between -10 and 70 (and no longer 5 to 100 as with a re
\
See Also\
\
- The corresponding dice roll expression is XdYsZuW. For other methods of rolling dice, see Dice Expressions.\
+ The corresponding dice roll expression is XdYsZuW. For other methods of rolling dice, see Dice Expressions.\
\
\
@@ -20971,7 +20971,7 @@ Returns a number that is between 35 and 100 (and no longer down to 5 as with a r
\
See Also\
\
- The corresponding dice roll expression is XdYlZ. For other methods of rolling dice, see Dice Expressions.\
+ The corresponding dice roll expression is XdYlZ. For other methods of rolling dice, see Dice Expressions.\
\
\
@@ -21008,7 +21008,7 @@ Returns a number that is between 5 and 80 (and no longer up to 100 as with a reg
\
See Also\
\
- The corresponding dice roll expression is XdYuZ. For other methods of rolling dice, see Dice Expressions.\
+ The corresponding dice roll expression is XdYuZ. For other methods of rolling dice, see Dice Expressions.\
\
\
@@ -21129,18 +21129,18 @@ selectTokens.summary = \
\
id - the id string or token name of a specific token to select (the examples below use token names, but IDs are also permitted); if left blank all visible tokens are selected.add - if the value of add is true(1), the selections will be added to the current set of selected tokens; if the value is false(0) currently selected tokens will be deselected before new tokens are selected. Defaults to false.tokens - a String List of tokens to select.delim - Specifies the delimiter used in the string list that is supplied. If the delimiter is "json", then the value for tokens may be a JSON Array instead. Note: if using a JSON Array or String List, both add and delim must be specified.tokens - a String List of tokens to select.delim - Specifies the delimiter used in the string list that is supplied. If the delimiter is "json", then the value for tokens may be a JSON Array instead. Note: if using a JSON Array or String List, both add and delim must be specified.
\
\
Example\
\
To select a single token with the name "Adventurer":\
[h:selectTokens("Adventurer")]\
-To select a list of Tokens using a String List, replacing the current selection\
+
To select a list of Tokens using a String List, replacing the current selection\
\
[h:selectTokens("Adventurer, Orc 2, Goblin 1", 0, ",")]\
-To select a list of Tokens using a JSON Array, adding the specified tokens to the current set of selected Tokens:\
+
To select a list of Tokens using a JSON Array, adding the specified tokens to the current set of selected Tokens:\
\
[h:selectTokens("['Adventurer', 'Orc 2', 'Goblin 1']", 1, "json")]\
\
@@ -21171,7 +21171,7 @@ sendDrawingToBack.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.1.7\
@@ -21207,7 +21207,7 @@ sendDrawingToBack.summary = \
\
-sendToBack.description = Adjust the z-order (or draw order) of the Token so that it is drawn before all other Tokens on the same Map Layer , this has the effect of making the Token appear to be in back of the other Tokens as it will be obscured by other Tokens on the same Map Layer in the same location.
+sendToBack.description = Adjust the z-order (or draw order) of the Token so that it is drawn before all other Tokens on the same Map Layer , this has the effect of making the Token appear to be in back of the other Tokens as it will be obscured by other Tokens on the same Map Layer in the same location.
sendToBack.summary = \
\
\
@@ -21216,7 +21216,7 @@ sendToBack.summary = \
sendToBack() Function\
\
• Introduced in version 1.3b48\
- Adjust the z-order (or draw order) of the Token so that it is drawn before all other Tokens on the same Map Layer, this has the effect of making the Token appear to be in back of the other Tokens as it will be obscured by other Tokens on the same Map Layer in the same location.\
+ Adjust the z-order (or draw order) of the Token so that it is drawn before all other Tokens on the same Map Layer, this has the effect of making the Token appear to be in back of the other Tokens as it will be obscured by other Tokens on the same Map Layer in the same location.\
\
Usage\
\
@@ -21229,13 +21229,13 @@ sendToBack(id, mapname)\
Parameter\
\
\
- id - The token id or name of the token that has its z-order changed, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id or name of the token that has its z-order changed, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
Examples\
\
- Sends the Current Token to the lowest z-order.\
+ Sends the Current Token to the lowest z-order.\
[h: sendToBack()]
\
Sends all of the selected tokens to the lowest z-order.\
\
@@ -21316,7 +21316,7 @@ This function is rarely used because a simple assignment to a variable name can
\
-setAllStates.description = Sets all of the States of a Token to on ( true ( 1 )) or off ( false ( 0 )).
+setAllStates.description = Sets all of the States of a Token to on ( true ( 1 )) or off ( false ( 0 )).
setAllStates.summary = \
\
\
@@ -21325,7 +21325,7 @@ setAllStates.summary = \
setAllSates() Function\
\
• Introduced in version 1.3b40\
- \
+ \
\
Usage\
\
@@ -21339,21 +21339,21 @@ setAllStates(value, id, mapname)\
\
\
value - If all states should be set on or off, true(1) or false(0).id - The id of the token that should have its States set. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The id of the token that should have its States set. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
Examples\
\
- Set all Token States on\
+ Set all Token States on\
[h: setAllStates(1)]
\
-Set all Token States off\
+
Set all Token States off\
\
[h: setAllStates(0)]
\
\
See Also\
\
- \
+ \
\
Version Changes\
\
@@ -21388,7 +21388,7 @@ setAlwaysVisible.summary = \
\
\
value - The value of the setting to set, true(1) or false(0).id - OPTIONAL: The token id of the token for which you want to set this setting, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - OPTIONAL: The token id of the token for which you want to set this setting, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
\
\
Example\
@@ -21403,7 +21403,7 @@ setAlwaysVisible.summary = \
\
-setBar.description = Sets the value of the specified bar for the Current Token and makes the bar visible.
+setBar.description = Sets the value of the specified bar for the Current Token and makes the bar visible.
setBar.summary = \
\
\
@@ -21413,11 +21413,11 @@ setBar.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b42\
- Sets the value of the specified bar for the Current Token and makes the bar visible. The value to set is between 0 and 1 for 0% to 100% respectively.\
+ Sets the value of the specified bar for the Current Token and makes the bar visible. The value to set is between 0 and 1 for 0% to 100% respectively.\
\
Usage\
\
@@ -21432,7 +21432,7 @@ setBar(name, pct/100, id, mapname)\
\
name - The name of the bar.value - The value of the bar. Should be between 0 and 1.id - The token id of the token which has its bar set, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token which has its bar set, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -21462,17 +21462,17 @@ setBar(name, pct/100, id, mapname)\
\
\
- \
- HP and Health Bars\
+ HP and Health Bars\
\
- \
- The
bar.name special variable\
+ The bar.name special variable\
\
\
\
\
-setBarVisible.description = Sets if the specified bar for the Current Token is visible or not.
+setBarVisible.description = Sets if the specified bar for the Current Token is visible or not.
setBarVisible.summary = \
\
\
@@ -21481,7 +21481,7 @@ setBarVisible.summary = \
setBarVisible() Function\
\
• Introduced in version 1.3b46\
- Sets if the specified bar for the Current Token is visible or not. If the value is non zero then the bar is visible, if it is 0 it is not visible.\
+ Sets if the specified bar for the Current Token is visible or not. If the value is non zero then the bar is visible, if it is 0 it is not visible.\
\
Usage\
\
@@ -21496,15 +21496,15 @@ setBarVisible(name, value, id, mapname)\
\
bar - A string that contains the name of the bar that has its visibility set.value - The visibility value of the bar, either 0 or 1.id - The token id of the token which has its bar visibility set, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token which has its bar visibility set, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
Examples\
\
- Make "health" bar for the Current Token visible.\
+ Make "health" bar for the Current Token visible.\
[h: setBarVisible("Health", 1)]\
-Hide "health" bar for the Current Token.\
+
Hide "health" bar for the Current Token.\
\
[h: setBarVisible("Health", 0)]\
\
@@ -21526,17 +21526,17 @@ setBarVisible(name, value, id, mapname)\
\
\
- \
- HP and Health Bars\
+ HP and Health Bars\
\
- \
- The
bar.name special variable\
+ The bar.name special variable\
\
\
\
\
-setCurrentInitiative.description = Gives the Initiative to the Token at the specified offset in the Initiative Panel .
+setCurrentInitiative.description = Gives the Initiative to the Token at the specified offset in the Initiative Panel .
setCurrentInitiative.summary = \
\
\
@@ -21544,7 +21544,7 @@ setCurrentInitiative.summary = \
\
setCurrentInitiative() Function\
\
- Gives the Initiative to the Token at the specified offset in the Initiative Panel. Offsets start at 0.\
+ Gives the Initiative to the Token at the specified offset in the Initiative Panel. Offsets start at 0.\
To clear, specify a number that is not a valid token offset, like -1.\
\
Usage\
@@ -21555,7 +21555,7 @@ To clear, specify a number that is not a valid token offset, like -1.
\
\
Examples\
\
- Give Initiative to the 4th Token.\
+ Give Initiative to the 4th Token.\
[h: setCurrentInitiative(3)]
\
Clear current initiative (any number that is not a valid token offset will work).\
\
@@ -21578,7 +21578,7 @@ setCurrentMap.summary = \
WARNING: This function changes an internal variable used by MapTool to keep track of which map is current and this change takes place immediately. However, changes to tokens are queued up and only occur when the macro finishes execution (well, sort of). The end result is that if a token is being modified on map "A" and your macro calls setCurrentMap() to switch to map "B", when the macro finishes and the token changes are executed they will be processing a token on map B! If there was no such token on map B a new one will be created, thus mysteriously duplicating tokens!\
Therefore, do NOT modify any token properties, states, names, notes, or any other token-specific values after calling setCurrentMap(). Or make sure that the first thing your macro does is call setCurrentMap() so that all tokens accessed later will be on the map that is current when the macro finishes.\
\
-Search http://forums.rptools.net/ for setCurrentMap to find some discussion threads on this topic.\
+Search https://forums.rptools.net/ for setCurrentMap to find some discussion threads on this topic.\
\
Usage\
\
@@ -21617,7 +21617,7 @@ setDrawingEraser.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -21668,12 +21668,12 @@ setDrawingLayer.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.1.7\
For a specified drawing, set the layer of the map to which the drawing belongs.\
-The Map Layer is one of:\
+
The Map Layer is one of:\
\
TOKENGM also known as HiddenOBJECTBACKGROUND
\
\
@@ -21721,7 +21721,7 @@ setDrawingOpacity.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -21770,7 +21770,7 @@ setDrawingProperties.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -21819,7 +21819,7 @@ setFillColor.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -21871,7 +21871,7 @@ setGMName.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b49\
@@ -21889,13 +21889,13 @@ setGMName(name, id, mapname)\
\
\
name - A string that is set as the GM Name on the token.id - The token id of the token that has its GM Name set. Defaults to the Current Token.id - The token id of the token that has its GM Name set. Defaults to the Current Token.mapname - The name of the map to find the token. Defaults to the current map.
\
\
Examples\
\
- Sets the GM Name of the Current Token to New GM Name.\
+ Sets the GM Name of the Current Token to New GM Name.\
[h: setGMName("New GM Name")]\
Sets the GM Name of all selected tokens to New GM Name.\
\
@@ -21923,7 +21923,7 @@ setGMName(name, id, mapname)\
\
-setGMNotes.description = Sets the GM notes of the Current Token .
+setGMNotes.description = Sets the GM notes of the Current Token .
setGMNotes.summary = \
\
\
@@ -21933,11 +21933,11 @@ setGMNotes.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
- Sets the GM notes of the Current Token.\
+ Sets the GM notes of the Current Token.\
\
Usage\
\
@@ -21951,14 +21951,14 @@ setGMNotes(notes, id, mapname)\
\
\
notes - The GM notes to set on the token.id - The token id of the token to set the GM notes on. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to set the GM notes on. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
\
-setHalo.description = Sets the Halo color of a Token .
+setHalo.description = Sets the Halo color of a Token .
setHalo.summary = \
\
\
@@ -21967,7 +21967,7 @@ setHalo.summary = \
setHalo() Function\
\
• Introduced in version 1.3b49\
- \
+ \
\
Usage\
\
@@ -21981,25 +21981,25 @@ setHalo.summary = \
Parameters\
\
\
- color - The color to set the Halo to, valid values are:\
+ color - The color to set the Halo to, valid values are:\
"Black""Green""Yellow""Orange""Red""Cyan""Magenta""White"- A hexadecimal color value in the format
"#RRGGBB" "None"
id - The token id of the token that has its Halo set by this function. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token that has its Halo set by this function. Note: This parameter can only be used in a Trusted Macro.
\
\
Examples\
\
- To remove the Halo from the Current Token.\
+ To remove the Halo from the Current Token.\
[h: setHalo("None")]\
-To set the Halo for the Current Token to red.\
+
To set the Halo for the Current Token to red.\
\
[h: setHalo("Red")]\
-To set the Halo from the Current Token to a custom color\
+
To set the Halo from the Current Token to a custom color\
\
[h: setHalo("#33AAFF")]\
\
See Also\
\
- \
-setHasSight.description = Enables/disables sight for the Current Token .
+setHasSight.description = Enables/disables sight for the Current Token .
setHasSight.summary = \
\
\
@@ -22022,7 +22022,7 @@ setHasSight.summary = \
setHasSight() Function\
\
• Introduced in version 1.3b48\
- Enables/disables sight for the Current Token. If the argument is 0 (false) sight will be disabled on the Current Token. If it is non-zero (true) sight is enabled.\
+ Enables/disables sight for the Current Token. If the argument is 0 (false) sight will be disabled on the Current Token. If it is non-zero (true) sight is enabled.\
\
Usage\
\
@@ -22036,13 +22036,13 @@ setHasSight(state, id, mapname)\
\
\
state - Boolean - true to enable sight, false to disableid - The id of the token to set the sight of. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The id of the token to set the sight of. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
Example\
\
- Enables sight for Current Token\
+ Enables sight for Current Token\
[h: setHasSight(1)]
\
Returns: Empty String.\
\
@@ -22060,7 +22060,7 @@ Returns: Empty String.
\
\
-setInitiative.description = Sets the Initiative of the Current Token .
+setInitiative.description = Sets the Initiative of the Current Token .
setInitiative.summary = \
\
\
@@ -22069,7 +22069,7 @@ setInitiative.summary = \
setInitiative() Function\
\
• Introduced in version 1.3b41\
- Sets the Initiative of the Current Token.\
+ Sets the Initiative of the Current Token.\
\
Usage\
\
@@ -22080,7 +22080,7 @@ setInitiative(value, id, mapname)\
\
\
value - The initiative value to set. If included, the initiative will be set even if the token is already on the initiative list.id - The token id of the token to have its initiative set. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to have its initiative set. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -22103,7 +22103,7 @@ setInitiative(value, id, mapname)\
\
-setInitiativeHold.description = Sets if the Current Token is on hold in the Initiative Panel .
+setInitiativeHold.description = Sets if the Current Token is on hold in the Initiative Panel .
setInitiativeHold.summary = \
\
\
@@ -22112,7 +22112,7 @@ setInitiativeHold.summary = \
setInitiativeHold() Function\
\
• Introduced in version 1.3b41\
- Sets if the Current Token is on hold in the Initiative Panel. If the value passed is non zero then the Current Token is placed on hold, if it is 0 it is removed from on hold.\
+ Sets if the Current Token is on hold in the Initiative Panel. If the value passed is non zero then the Current Token is placed on hold, if it is 0 it is removed from on hold.\
\
Usage\
\
@@ -22126,7 +22126,7 @@ setInitiativeHold(value, id, mapname)\
\
\
value - The initiative hold value to set.id - The token id of the token to set the initiative hold. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to set the initiative hold. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -22144,7 +22144,7 @@ setInitiativeHold(value, id, mapname)\
\
-setInitiativeRound.description = Sets the current round number in the Initiative Panel .
+setInitiativeRound.description = Sets the current round number in the Initiative Panel .
setInitiativeRound.summary = \
\
\
@@ -22154,10 +22154,10 @@ setInitiativeRound.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
- Sets the current round number in the Initiative Panel.\
+ Sets the current round number in the Initiative Panel.\
\
Usage\
\
@@ -22168,7 +22168,7 @@ setInitiativeRound.summary = \
\
-setLabel.description = Sets the Token Label of a specific Token .
+setLabel.description = Sets the Token Label of a specific Token .
setLabel.summary = \
\
\
@@ -22177,7 +22177,7 @@ setLabel.summary = \
setLabel() Function\
\
• Introduced in version 1.3b48\
- Sets the Token Label of a specific Token.\
+ Sets the Token Label of a specific Token.\
\
Usage\
\
@@ -22191,8 +22191,8 @@ setLabel.summary = \
Parameters\
\
\
- label - The string that the Token Label is set to.id - The token id of the token that has its label set, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
label - The string that the Token Label is set to.id - The token id of the token that has its label set, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
\
\
\
@@ -22215,7 +22215,7 @@ setLabel.summary = \
\
-setLayer.description = Sets the Map Layer that a Token is on.
+setLayer.description = Sets the Map Layer that a Token is on.
setLayer.summary = \
\
\
@@ -22225,12 +22225,12 @@ setLayer.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
- Sets the Map Layer that a Token is on.\
-The Map Layer is one of:\
+
Sets the Map Layer that a Token is on.\
+The Map Layer is one of:\
\
TOKENGM also known as HiddenOBJECTBACKGROUND
\
\
@@ -22247,8 +22247,8 @@ setLayer(layer, id, forceshape, mapname)\
Parameters\
\
\
- layer - The layer to move the Token to.id - The token id of the token which has its layer set, defaults to the Current Token.layer - The layer to move the Token to.id - The token id of the token which has its layer set, defaults to the Current Token.forceshape - If true(1), change the token shape type to TOP_DOWN if the layer is OBJECT, and to a shape reflecting its image if the layer is TOKEN. Defaults to true(1).mapname - The name of the map to find the token. Defaults to the current map.
\
@@ -22283,7 +22283,7 @@ setLayer(layer, id, forceshape, mapname)\
\
-setLibProperty.description = Sets the Token Property on a Library Token . if the name of the Library Token is not specified then the Token Property is set on the Library Token that the macro is running from.
+setLibProperty.description = Sets the Token Property on a Library Token . if the name of the Library Token is not specified then the Token Property is set on the Library Token that the macro is running from.
setLibProperty.summary = \
\
\
@@ -22292,7 +22292,7 @@ setLibProperty.summary = \
setLibProperty() Function\
\
• Introduced in version 1.3b48\
- Sets the Token Property on a Library Token. if the name of the Library Token is not specified then the Token Property is set on the Library Token that the macro is running from.\
+ Sets the Token Property on a Library Token. if the name of the Library Token is not specified then the Token Property is set on the Library Token that the macro is running from.\
\
Usage\
\
@@ -22303,9 +22303,9 @@ setLibProperty(name, value, libName)\
\
Examples\
\
- Set a property on the Library Token that the macro is running from.\
+ Set a property on the Library Token that the macro is running from.\
[h: setLibProperty("defaultStrength", 10)]\
-Set a property on a specifig Library Token.\
+
Set a property on a specifig Library Token.\
\
[h: setLibProperty("defaultStrength", 10, "Lib:Character")]\
Known Bug: note that using setLibProperty during onCampaignLoad and not being on the map where the lib resides, will result in a duplicate of that lib on the current map!\
@@ -22313,7 +22313,7 @@ Known Bug: note that using setLibProperty during onCampaignLoad and not being on
\
-setLight.description = Sets the light sources of the Current Token .
+setLight.description = Sets the light sources of the Current Token .
setLight.summary = \
\
\
@@ -22322,7 +22322,7 @@ setLight.summary = \
setLight() Function\
\
• Introduced in version 1.3b48\
- Sets the light sources of the Current Token. If the value is false(0) then the light source is turned off; otherwise, it is turned on.\
+ Sets the light sources of the Current Token. If the value is false(0) then the light source is turned off; otherwise, it is turned on.\
\
Usage\
\
@@ -22336,9 +22336,9 @@ setLight(type, name, value, id, mapname)\
\
\
type - The light source type, (e.g. "Generic", "D20").name - The name of the light source.name - The name of the light source.value - If true(1) sets the light on, if false(0) turns it off.id - The token id of the token to change the light sources, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to change the light sources, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -22374,7 +22374,7 @@ setLineCap.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -22415,7 +22415,7 @@ setLineCap.summary = \
\
-setMacroCommand.description = Sets the command that will be run when the Macro Button is pressed.
+setMacroCommand.description = Sets the command that will be run when the Macro Button is pressed.
setMacroCommand.summary = \
\
\
@@ -22425,11 +22425,11 @@ setMacroCommand.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
- Sets the command that will be run when the Macro Button is pressed. Note because of the way the parser interprets values within [] you may have to use the encode() and decode() functions with the string.\
+ Sets the command that will be run when the Macro Button is pressed. Note because of the way the parser interprets values within [] you may have to use the encode() and decode() functions with the string.\
\
Usage\
\
@@ -22469,7 +22469,7 @@ setMacroCommand(index, command, id, mapname)\
\
-setMacroProps.description = Sets the properties for the specified Macro Button on the Current Token .
+setMacroProps.description = Sets the properties for the specified Macro Button on the Current Token .
setMacroProps.summary = \
\
\
@@ -22478,7 +22478,7 @@ setMacroProps.summary = \
setMacroProps() Function\
\
• Introduced in version 1.3b48\
- Sets the properties for the specified Macro Button on the Current Token . The properties are passed to this function as a String Property List. This function accepts either a Macro Button Index or the label of a Macro Button. If it is a label then all of Macro Buttons on the Current Token with a matching label are changed.\
+ Sets the properties for the specified Macro Button on the Current Token . The properties are passed to this function as a String Property List. This function accepts either a Macro Button Index or the label of a Macro Button. If it is a label then all of Macro Buttons on the Current Token with a matching label are changed.\
\
Usage\
\
@@ -22500,11 +22500,11 @@ setMacroProps(label, props, delim, id, mapname)\
\
index - The index of the macro button.label - The label of the macro button.props - A String Property List or JSON Object containing the properties for the button.\
-applyToSelected - Should the macro be applied to the selected tokens.autoExecute - If the macro will be automatically executed when the button is clicked, accepts true(1) or false(0).color - The name of the color for the button.command - The command for the macro (only when using JSON version of function).fontColor - The name of the font color for the button.fontSize - The size of the font for the button.includeLabel - If the label will be output when the button is clicked. Accepts true(1) or false(0).group - The name of the group that the button belongs to.sortBy - The sort by value of the macro button.label - The label for the button.maxWidth - The maximum width of the button.minWidth - The minimum width of the button.playerEditable - Is the button player editable, accepts true(1) or false(0).tooltip - The tool tip for the macro button.compare - Takes a JSON Array which can contain one or more of the following keywords (only usable with JSON version of the function).\
+ props - A String Property List or JSON Object containing the properties for the button.\
+applyToSelected - Should the macro be applied to the selected tokens.autoExecute - If the macro will be automatically executed when the button is clicked, accepts true(1) or false(0).color - The name of the color for the button.command - The command for the macro (only when using JSON version of function).fontColor - The name of the font color for the button.fontSize - The size of the font for the button.includeLabel - If the label will be output when the button is clicked. Accepts true(1) or false(0).group - The name of the group that the button belongs to.sortBy - The sort by value of the macro button.label - The label for the button.maxWidth - The maximum width of the button.minWidth - The minimum width of the button.playerEditable - Is the button player editable, accepts true(1) or false(0).tooltip - The tool tip for the macro button.compare - Takes a JSON Array which can contain one or more of the following keywords (only usable with JSON version of the function).\
applyToSelected - Use the macro applyToSelected for common macro comparisons.autoExecute - Use the macro autoExec for common macro comparisons.command - Use the macro command for common macro comparisons.group - Use the macro group for common macro comparisons.includeLabel - Use the macro includeLabel for common macro comparisons.sortPrefix - Use the macro sortPrefix for common macro comparisons.
delim - The delimiter used in the String Property List that is sent to the props parameter, defaults to ";" and can be omitted if you are sending a JSON Object to the props parameter. If you are sending a JSON Object to the props parameter, and using the id parameter, you can set this to "json".id - The token id of the token that the macro button is located on. Note: This parameter can only be used in a Trusted Macro.
delim - The delimiter used in the String Property List that is sent to the props parameter, defaults to ";" and can be omitted if you are sending a JSON Object to the props parameter. If you are sending a JSON Object to the props parameter, and using the id parameter, you can set this to "json".id - The token id of the token that the macro button is located on. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -22550,7 +22550,7 @@ setMapDisplayName.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.9.0\
@@ -22596,7 +22596,7 @@ setMapName.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.0.1\
@@ -22636,7 +22636,7 @@ setMapVisible.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.0.1\
@@ -22668,7 +22668,7 @@ setMapVisible(visible, mapName)\
\
-setMaxLoopIterations.description = Sets the max amount of loops (in [count():] , [foreach():] , [for():] , [while():] ) that are allowed.
+setMaxLoopIterations.description = Sets the max amount of loops (in [count():] , [foreach():] , [for():] , [while():] ) that are allowed.
setMaxLoopIterations.summary = \
\
\
@@ -22677,7 +22677,7 @@ setMaxLoopIterations.summary = \
setMaxLoopIterations() Function\
\
• Introduced in version 1.4.0.2\
- Sets the max amount of loops (in [count():], [foreach():], [for():], [while():]) that are allowed. The current allowed min is 10,000. Note that this settings lasts only for the current session.\
+ Sets the max amount of loops (in [count():], [foreach():], [for():], [while():]) that are allowed. The current allowed min is 10,000. Note that this settings lasts only for the current session.\
\
Usage\
\
@@ -22743,7 +22743,7 @@ setMaxRecursionDepth.summary = \
\
-setName.description = Sets the name of a Token .
+setName.description = Sets the name of a Token .
setName.summary = \
\
\
@@ -22752,7 +22752,7 @@ setName.summary = \
setName() Function\
\
• Introduced in version 1.3b40\
- Sets the name of a Token.\
+ Sets the name of a Token.\
\
Usage\
\
@@ -22766,7 +22766,7 @@ setName(name, id, mapname)\
\
\
name - The name to set on the current token.id - The token id of the token which has its name set. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token which has its name set. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -22785,7 +22785,7 @@ setName(name, id, mapname)\
\
-setNotes.description = Sets the notes of the Current Token .
+setNotes.description = Sets the notes of the Current Token .
setNotes.summary = \
\
\
@@ -22794,7 +22794,7 @@ setNotes.summary = \
setNotes() Function\
\
• Introduced in version 1.3b48\
- Sets the notes of the Current Token.\
+ Sets the notes of the Current Token.\
\
Usage\
\
@@ -22809,7 +22809,7 @@ setNotes(notes, id, mapname)\
\
\
notes - The notes to set on the token.id - The token id of the token to set the notes on. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to set the notes on. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -22822,7 +22822,7 @@ See also getNotes\
\
-setNPC.description = Sets a Token to a NPC Token .
+setNPC.description = Sets a Token to a NPC Token .
setNPC.summary = \
\
\
@@ -22832,11 +22832,11 @@ setNPC.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
- \
+ \
\
Usage\
\
@@ -22849,7 +22849,7 @@ setNPC(id, mapname)\
Parameter\
\
\
- id - The token id of the token which has its NPC status set, defaults to the Current Token.id - The token id of the token which has its NPC status set, defaults to the Current Token.mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -22897,7 +22897,7 @@ setOwnedByAll(owned, id, mapname)\
\
\
owned - The value of the setting to set, true(1) or false(0).id - The token id of the token which has its Owned by All status set, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token which has its Owned by All status set, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -22925,7 +22925,7 @@ setOwnedByAll(owned, id, mapname)\
\
-setOwner.description = Changes the owners of a token (default is the Current Token ) when given a String owner name or JSON Array of owner names.
+setOwner.description = Changes the owners of a token (default is the Current Token ) when given a String owner name or JSON Array of owner names.
setOwner.summary = \
\
\
@@ -22934,7 +22934,7 @@ setOwner.summary = \
setOwner() Function\
\
• Introduced in version 1.3b48?\
- Changes the owners of a token (default is the Current Token) when given a String owner name or JSON Array of owner names. All other owners are removed.\
+ Changes the owners of a token (default is the Current Token) when given a String owner name or JSON Array of owner names. All other owners are removed.\
\
Usage\
\
@@ -22950,33 +22950,33 @@ setOwner(ownerNames, id, mapname)\
Parameters\
\
\
- ownerName - The player name to set the ownership on the token. Ownership is not constrained to the client names currently connected, but only currently connected clients appear in the Token Editor Dialog. This parameter is a String. An empty string here is treated as an empty JSON array (see next parameter).ownerNames - The player names to set the ownership on the token. Ownership is not constrained to the client names currently connected, but only currently connected clients appear in the Token Editor Dialog. This parameter is a JSON Array.id - The token id of the token which has its owners changed, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
ownerName - The player name to set the ownership on the token. Ownership is not constrained to the client names currently connected, but only currently connected clients appear in the Token Editor Dialog. This parameter is a String. An empty string here is treated as an empty JSON array (see next parameter).ownerNames - The player names to set the ownership on the token. Ownership is not constrained to the client names currently connected, but only currently connected clients appear in the Token Editor Dialog. This parameter is a JSON Array.id - The token id of the token which has its owners changed, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
Examples\
\
- To change the owners of the Current Token to a single user use:\
+ To change the owners of the Current Token to a single user use:\
[h: setOwner("Frank")]\
-To change the owners of the Current Token to a list of three players use:\
+
To change the owners of the Current Token to a list of three players use:\
\
[h: setOwner("['Peter', 'Paul', 'Mary']")]\
or:\
\
[h: list = json.append("[]", "Peter", "Paul", "Mary")]\
[h: setOwner(list)]\
-To make all current players owners of the Current Token use:\
+
To make all current players owners of the Current Token use:\
\
[h: setOwner(getAllPlayerNames("json"))]\
-To remove all owners of the Current Token use:\
+
To remove all owners of the Current Token use:\
\
[h: setOwner("")]\
or:\
\
[h: setOwner("[]")]\
-To display the current owners of the Current Token as checkboxes, then accept the user's changes to apply back onto the token, use the following. Note that this example does not provide for adding owners to the list, only removing them. (Adding owners would require the use of getAllPlayerNames() and would make this example even more complex.)\
+
To display the current owners of the Current Token as checkboxes, then accept the user's changes to apply back onto the token, use the following. Note that this example does not provide for adding owners to the list, only removing them. (Adding owners would require the use of getAllPlayerNames() and would make this example even more complex.)\
\
[h: names = getOwners("json")]\
[h: input = "tab0 | OwnerList || TAB"]\
@@ -23010,7 +23010,7 @@ setOwner(ownerNames, id, mapname)\
\
-setOwnerOnlyVisible.description = Sets the Visible to Owners Only flag on a Token if the value passed in is non-zero( true ( 1 )), otherwise resets it to false ( 0 ).
+setOwnerOnlyVisible.description = Sets the Visible to Owners Only flag on a Token if the value passed in is non-zero( true ( 1 )), otherwise resets it to false ( 0 ).
setOwnerOnlyVisible.summary = \
\
\
@@ -23020,11 +23020,11 @@ setOwnerOnlyVisible.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b74\
- Sets the Visible to Owners Only flag on a Token if the value passed in is non-zero(true(1)), otherwise resets it to false(0).\
+ Sets the Visible to Owners Only flag on a Token if the value passed in is non-zero(true(1)), otherwise resets it to false(0).\
\
Usage\
\
@@ -23039,7 +23039,7 @@ setOwnerOnlyVisible.summary = \
\
\
visible - The state of owner only visibility, true(1) or false(0).id - The token id of the token which has its owner only visibility set, defaults to the Current Token.id - The token id of the token which has its owner only visibility set, defaults to the Current Token.
\
\
\
@@ -23052,7 +23052,7 @@ setOwnerOnlyVisible.summary = \
\
-setPC.description = Sets a Token to a PC Token .
+setPC.description = Sets a Token to a PC Token .
setPC.summary = \
\
\
@@ -23062,11 +23062,11 @@ setPC.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
- \
+ \
\
Usage\
\
@@ -23079,7 +23079,7 @@ setPC(id, mapname)\
Parameter\
\
\
- id - The token id of the token which has its PC status set, defaults to the Current Token.id - The token id of the token which has its PC status set, defaults to the Current Token.mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -23114,7 +23114,7 @@ setPenColor.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -23163,7 +23163,7 @@ setPenWidth.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.0\
@@ -23203,7 +23203,7 @@ Regardless of the set width, a line will only be visible if it has a visible col
\
-setProperty.description = Sets the value of a Token Property on the Current Token (unless trusted, in which case a Token ID can be supplied to indicate which token is to be affected).
+setProperty.description = Sets the value of a Token Property on the Current Token (unless trusted, in which case a Token ID can be supplied to indicate which token is to be affected).
setProperty.summary = \
\
\
@@ -23212,7 +23212,7 @@ setProperty.summary = \
setProperty() Function\
\
• Introduced in version 1.3b48\
- Sets the value of a Token Property on the Current Token (unless trusted, in which case a Token ID can be supplied to indicate which token is to be affected).\
+ Sets the value of a Token Property on the Current Token (unless trusted, in which case a Token ID can be supplied to indicate which token is to be affected).\
Note that if there is not already an existing property by the name listed in the macro, setProperty will create a new Token Property with that name. Any created Property will not be visible in the Properties tab of the Edit Token window but can still be used like normal. It's value can be retrieved with the getProperty command.\
\
Usage\
@@ -23228,13 +23228,13 @@ setProperty(property, value, id, mapname)\
\
property - A string containing the name of the property that has its value set.value - The value that the property is set to.id - The token id of the token which has its property set, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token which has its property set, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
Examples\
\
- Sets a property named Health to the value of 10 on the Current Token.\
+ Sets a property named Health to the value of 10 on the Current Token.\
[h: setProperty("Health", 10)]\
Sets a property named Fatigue to the value of 5 on the selected token.\
\
@@ -23264,7 +23264,7 @@ setProperty(property, value, id, mapname)\
\
-setPropertyType.description = Sets the Property Type of a Token .
+setPropertyType.description = Sets the Property Type of a Token .
setPropertyType.summary = \
\
\
@@ -23273,7 +23273,7 @@ setPropertyType.summary = \
setPropertyType() Function\
\
• Introduced in version 1.3b48\
- Sets the Property Type of a Token.\
+ Sets the Property Type of a Token.\
\
Usage\
\
@@ -23287,7 +23287,7 @@ setPropertyType(type, id, mapname)\
\
\
type - The property type to set on the token.id - The token id of the token which has its property type set, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token which has its property type set, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -23312,7 +23312,7 @@ setPropertyType(type, id, mapname)\
\
-setSightType.description = Sets the type of sight that the Current Token has.
+setSightType.description = Sets the type of sight that the Current Token has.
setSightType.summary = \
\
\
@@ -23321,7 +23321,7 @@ setSightType.summary = \
setSightType() Function\
\
• Introduced in version 1.3b48\
- Sets the type of sight that the Current Token has.\
+ Sets the type of sight that the Current Token has.\
\
Usage\
\
@@ -23335,7 +23335,7 @@ setSightType(type, id, mapname)\
\
\
type - The type of sight to set.id - The id of the token to set the sight. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The id of the token to set the sight. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -23353,7 +23353,7 @@ setSightType(type, id, mapname)\
\
-setSize.description = Sets the size of a Token with one of the defined sizes according to each Grid Type.
+setSize.description = Sets the size of a Token with one of the defined sizes according to each Grid Type.
setSize.summary = \
\
\
@@ -23363,11 +23363,11 @@ setSize.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
- Sets the size of a Token with one of the defined sizes according to each Grid Type. The sizes can be found on the Token Size page.\
+ Sets the size of a Token with one of the defined sizes according to each Grid Type. The sizes can be found on the Token Size page.\
\
Usage\
\
@@ -23380,8 +23380,8 @@ setSize(size, id, mapname)\
Parameters\
\
\
- size - The Token Size to set the token to.id - The token id of the token which will have its Token Size set. Defaults to the Current Token.size - The Token Size to set the token to.id - The token id of the token which will have its Token Size set. Defaults to the Current Token.mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -23412,7 +23412,7 @@ setSize(size, id, mapname)\
\
-setSpeech.description = Sets the Speech value from the Current Token .
+setSpeech.description = Sets the Speech value from the Current Token .
setSpeech.summary = \
\
\
@@ -23421,7 +23421,7 @@ setSpeech.summary = \
setSpeech() Function\
\
• Introduced in version 1.3b48\
- Sets the Speech value from the Current Token.\
+ Sets the Speech value from the Current Token.\
\
Usage\
\
@@ -23432,7 +23432,7 @@ setSpeech.summary = \
\
-setState.description = Sets the value of the State on Token .
+setState.description = Sets the value of the State on Token .
setState.summary = \
\
\
@@ -23441,7 +23441,7 @@ setState.summary = \
setState() Function\
\
• Introduced in version 1.3b40\
- Sets the value of the State on Token. If The value is false(0) then the State is unset if it is non-zero(true(1)) then it is set.\
+ Sets the value of the State on Token. If The value is false(0) then the State is unset if it is non-zero(true(1)) then it is set.\
\
Usage\
\
@@ -23456,21 +23456,21 @@ setState(state, value, id, mapname)\
\
state - The name of the state to set on the token.value - The value of the state to set, true(1) or false(0).id - The id of the token to have the State set. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The id of the token to have the State set. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
Examples\
\
- To set the "Dead" Token State on the Current Token\
+ To set the "Dead" Token State on the Current Token\
[h: setState("Dead", 1)]\
-To reset the "Dead" Token State on the Current Token\
+
To reset the "Dead" Token State on the Current Token\
\
[h: setState("Dead", 0)]\
\
See Also\
\
- State,\
+ \
\
@@ -23486,7 +23486,7 @@ setState(state, value, id, mapname)\
\
-setStrProp.description = Returns a String Property List with the key set to the value passed in.
+setStrProp.description = Returns a String Property List with the key set to the value passed in.
setStrProp.summary = \
\
\
@@ -23495,7 +23495,7 @@ setStrProp.summary = \
setStrProp() Function\
\
• Introduced in version 1.3b42\
- Returns a String Property List with the key set to the value passed in.\
+ Returns a String Property List with the key set to the value passed in.\
\
Usage\
\
@@ -23506,19 +23506,19 @@ setStrProp.summary = \
Parameters\
\
\
- propList - The String Property List affected by this function.key - The key in the specified String Property List that will have its value set.propList - The String Property List affected by this function.key - The key in the specified String Property List that will have its value set.value - The value that the specified key will be set to.
\
\
Examples\
\
- Add a new key to an existing String Property List:\
+ Add a new key to an existing String Property List:\
[h: weapon = "name=longsword; damage=1d8; maxdamage=8"]\
[h: weapon = setStrProp(weapon, "value", 10)]\
[r: weapon]
\
Returns "name=longsword ; damage=1d8 ; maxdamage=8 ; value=10 ; "\
-
Change the value of a key in an existing String Property List:\
+
Change the value of a key in an existing String Property List:\
\
[h: weapon = "name=longsword; damage=1d8; maxdamage=8"]\
[h: weapon = setStrProp(weapon, "damage", "1d6")]\
@@ -23544,7 +23544,7 @@ setTableAccess.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.0.1\
@@ -23592,7 +23592,7 @@ setTableEntry.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.0.1\
@@ -23620,7 +23620,7 @@ setTableEntry(tableName, roll, result, imageId)\
See Also\
\
\
\
\
@@ -23636,7 +23636,7 @@ setTableImage.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.0.1\
@@ -23678,7 +23678,7 @@ setTablePickOnce.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.6.0\
@@ -23720,7 +23720,7 @@ setTableRoll.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.0.1\
@@ -23767,7 +23767,7 @@ setTableVisible.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.0.1\
@@ -23815,7 +23815,7 @@ setTerrainModifier.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.5.2\
@@ -23902,7 +23902,7 @@ setTokenDrawOrder(z, id, mapname)\
\
\
z - The Z coordinate to set the draw order to.id - The id of the token to move, defaults to the Current Token.id - The id of the token to move, defaults to the Current Token.mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -23936,7 +23936,7 @@ setTokenFacing.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b51\
@@ -23987,7 +23987,7 @@ setTokenGMName.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b40\
@@ -24008,7 +24008,7 @@ setTokenGMName.summary = \
\
-setTokenHandout.description = Sets the handout image for the for the Current Token .
+setTokenHandout.description = Sets the handout image for the for the Current Token .
setTokenHandout.summary = \
\
\
@@ -24017,7 +24017,7 @@ setTokenHandout.summary = \
setTokenHandout() Function\
\
• Introduced in version 1.3b77\
- Sets the handout image for the for the Current Token. The image can come from several sources. It can be an asset id (like from tblImage() orgetTokenImage().) or a Image Token.\
+ Sets the handout image for the for the Current Token. The image can come from several sources. It can be an asset id (like from tblImage() orgetTokenImage().) or a Image Token.\
\
Usage\
\
@@ -24035,7 +24035,7 @@ setTokenHandout(tokenImageName, id, mapname)\
Parameters\
\
\
- id - OPTIONAL: The token id of the token for which you want to set the handout, defaults to the Current Token.id - OPTIONAL: The token id of the token for which you want to set the handout, defaults to the Current Token.mapname - OPTIONAL: The name of the map to find the token. Defaults to the current map.
\
\
@@ -24075,7 +24075,7 @@ setTokenHeight(size, id, mapname)\
\
\
size - grid size of the tokenid - The token id of the token to set its height. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to set its height. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -24103,7 +24103,7 @@ setTokenHeight(size, id, mapname)\
\
-setTokenImage.description = Sets the image for the for the Current Token .
+setTokenImage.description = Sets the image for the for the Current Token .
setTokenImage.summary = \
\
\
@@ -24112,7 +24112,7 @@ setTokenImage.summary = \
setTokenImage() Function\
\
• Introduced in version 1.3b48\
- Sets the image for the for the Current Token. The function accepts an Asset ID or an Image Token name. You can get Asset IDs from macro functions such as tblImage() or getTokenImage(). Image Tokens are special tokens whose name starts with "image:".\
+ Sets the image for the for the Current Token. The function accepts an Asset ID or an Image Token name. You can get Asset IDs from macro functions such as tblImage() or getTokenImage(). Image Tokens are special tokens whose name starts with "image:".\
\
Usage\
\
@@ -24132,7 +24132,7 @@ setTokenImage(imageToken, id, mapname)\
\
assetId - The Asset ID for an image.imageToken - The name of an image token e.g. "image:myimage"id - OPTIONAL: The token id of the token for which you want to set the image, defaults to the Current Token.id - OPTIONAL: The token id of the token for which you want to set the image, defaults to the Current Token.mapname - OPTIONAL: The name of the map to find the token. Defaults to the current map.
\
\
@@ -24215,7 +24215,7 @@ setLayoutProps(scale, xOffset, yOffset, id, mapName)\
scale - The scale of the token layout. If an empty string, the scale is not changed.xOffset - The xOffset of the token layout. If an empty string, the xOffset is not changed. Negative values shift the image left.yOffset - The yOffset of the token layout. If an empty string, the yOffset is not changed. Negative values shift the image up.id - The token id of the token to name, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to name, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.The xOffset and yOffset values must be integers.\
@@ -24261,7 +24261,7 @@ setTokenOpacity(value, id, mapname)\
\
\
value - The value of the opacity to set, ranging from 0.0 (completely transparent) to 1.0 (completely opaque). This must be a floating point value with leading zero if less than 1.0.id - OPTIONAL: The token id of the token for which you want to retrieve the opacity, defaults to the Current Token.id - OPTIONAL: The token id of the token for which you want to retrieve the opacity, defaults to the Current Token.mapname - OPTIONAL: The name of the map to find the token. Defaults to the current map.
\
Returns\
@@ -24291,7 +24291,7 @@ The opacity value that was set.\
\
-setTokenPortrait.description = Sets the portrait image for the for the Current Token .
+setTokenPortrait.description = Sets the portrait image for the for the Current Token .
setTokenPortrait.summary = \
\
\
@@ -24300,7 +24300,7 @@ setTokenPortrait.summary = \
setTokenPortrait() Function\
\
• Introduced in version 1.3b77\
- Sets the portrait image for the for the Current Token. The image can come from several sources. It can be an asset id (like from tblImage() or getTokenImage()), or a Image Token.\
+ Sets the portrait image for the for the Current Token. The image can come from several sources. It can be an asset id (like from tblImage() or getTokenImage()), or a Image Token.\
\
Usage\
\
@@ -24318,7 +24318,7 @@ setTokenPortrait(tokenImageName, id, mapname)\
Parameters\
\
\
- id - OPTIONAL: The token id of the token for which you want to set the portrait, defaults to the Current Token.id - OPTIONAL: The token id of the token for which you want to set the portrait, defaults to the Current Token.mapname - OPTIONAL: The name of the map to find the token. Defaults to the current map.
\
\
@@ -24359,7 +24359,7 @@ setTokenShape(shape, id, mapname)\
\
\
shape - String value: "TOP_DOWN", "CIRCLE", "SQUARE", "FIGURE".id - The token id of the token to set to a new shape, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to set to a new shape, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
Result
\
@@ -24401,7 +24401,7 @@ The function returns the token's shape as a string value: "TOP_DOWN"\
-setTokenSnapToGrid.description = Sets the "snap to" behaviour for the Current Token or a specified token.
+setTokenSnapToGrid.description = Sets the "snap to" behaviour for the Current Token or a specified token.
setTokenSnapToGrid.summary = \
\
\
@@ -24410,7 +24410,7 @@ setTokenSnapToGrid.summary = \
setTokenSnapToGrid() Function\
\
• Introduced in version 1.4\
- Sets the "snap to" behaviour for the Current Token or a specified token.\
+ Sets the "snap to" behaviour for the Current Token or a specified token.\
\
Usage\
\
@@ -24464,7 +24464,7 @@ setTokenVBL.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.1.6\
@@ -24486,7 +24486,7 @@ setTokenVBL.summary = \
\
\
vbl - A JSON object containing the vbl to be added to the token. Use getTokenVBL() to get VBL from another token.id - OPTIONAL: The token id of the token for which you want to set this setting, defaults to the Current Token.id - OPTIONAL: The token id of the token for which you want to set this setting, defaults to the Current Token.
\
\
Example\
@@ -24498,14 +24498,14 @@ setTokenVBL.summary = \
\
[r: finalVblData = "{'shape':'none'}"]\
[r: setTokenVBL(finalVblData)]
\
-
Auto-generate VBL for the Current Token\
+
Auto-generate VBL for the Current Token\
\
[h: options = json.set("{}", "shape", "auto", "sensitivity", 10, "inverse", 0, "level", 2, "method", "DOUGLAS_PEUCKER_SIMPLIFIER", "r", 0, "g", 0, "b", 0, "a", 255)]\
[h: setTokenVBL(options)]
\
\
See Also\
\
- \
+ \
\
Version Changes\
\
@@ -24542,7 +24542,7 @@ setTokenWidth(size, id, mapname)\
\
\
size - grid size of the tokenid - The token id of the token to set its width. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
id - The token id of the token to set its width. Defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.
\
\
@@ -24613,7 +24613,7 @@ setViewArea.summary = \
\
-setVisible.description = Sets the Visible to Players flag on a Token if the value passed in is non-zero( true ( 1 )), otherwise resets it to false ( 0 ).
+setVisible.description = Sets the Visible to Players flag on a Token if the value passed in is non-zero( true ( 1 )), otherwise resets it to false ( 0 ).
setVisible.summary = \
\
\
@@ -24623,11 +24623,11 @@ setVisible.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b40\
- Sets the Visible to Players flag on a Token if the value passed in is non-zero(true(1)), otherwise resets it to false(0). The Visible to Players flag has two meanings, on a normal Token players will only be able to see the Token if it is set (when all other things like Fog of War etc are taken into account). If it is a Library Token then it determines if players can call Category:Macros using the [macro(...): ...] roll option.\
+ Sets the Visible to Players flag on a Token if the value passed in is non-zero(true(1)), otherwise resets it to false(0). The Visible to Players flag has two meanings, on a normal Token players will only be able to see the Token if it is set (when all other things like Fog of War etc are taken into account). If it is a Library Token then it determines if players can call Category:Macros using the [macro(...): ...] roll option.\
\
Usage\
\
@@ -24642,7 +24642,7 @@ setVisible.summary = \
\
\
visible - The state of visibility, true(1) or false(0).id - The token id of the token which has its player visibility set, defaults to the Current Token.id - The token id of the token which has its player visibility set, defaults to the Current Token.
\
\
\
@@ -24723,7 +24723,7 @@ showTextLabels.summary = \
\
• Introduced in version 1.6\
• Last checked for compatibility with version 1.6\
- Enables the display of Text Labels if they are not showing. This can also be set in the View menu.\
+ Enables the display of Text Labels if they are not showing. This can also be set in the View menu.\
\
Usage\
\
@@ -24754,7 +24754,7 @@ showTextLabels.summary = \
\
-sortInitiative.description = Sorts the Initiative Panel Tokens and returns the number of Tokens in the Initiative Panel .
+sortInitiative.description = Sorts the Initiative Panel Tokens and returns the number of Tokens in the Initiative Panel .
sortInitiative.summary = \
\
\
@@ -24764,11 +24764,11 @@ sortInitiative.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b41\
- Sorts the Initiative Panel Tokens and returns the number of Tokens in the Initiative Panel.\
+ Sorts the Initiative Panel Tokens and returns the number of Tokens in the Initiative Panel.\
- The Default sort order is descending, with any non-numeric values coming after any numbers, and any blank values coming last.
- Since 1.8: If the
reverseOrder parameter is 1, this order is reversed - blank values come first, and any non-numeric strings (in ascending lexical order) come before numbers (in ascending order).
\
\
Usage\
@@ -24792,7 +24792,7 @@ sortInitiative(reverseOrder)\
Reverse Order\
Command\
sortInitiative()
sortInitiative(0)sortInitiative(1)Result\
-
\
+\
\
\
@@ -24986,7 +24986,7 @@ sr4.summary = \
\
See Also\
\
- For another method of rolling dice, see Dice Expressions.\
+ For another method of rolling dice, see Dice Expressions.\
\
\
@@ -25022,7 +25022,7 @@ sr4e.summary = \
\
See Also\
\
- For another method of rolling dice, see Dice Expressions.\
+ For another method of rolling dice, see Dice Expressions.\
\
\
@@ -25208,10 +25208,10 @@ strfind.summary = \
strfind() Function\
\
• Introduced in version 1.3b48\
- Finds and extracts substrings from a string. strfind() is used to match a pattern against an input string and extract all of the capture groups. The function returns an id which can be used with other functions to extract the information. The supplied pattern is a regular expression.\
+ Finds and extracts substrings from a string. strfind() is used to match a pattern against an input string and extract all of the capture groups. The function returns an id which can be used with other functions to extract the information. The supplied pattern is a regular expression.\
Functions related to strfind():\
\
-- getFindCount(id)
- getGroupCount(id)
- getGroup(id, matchNo, groupNo)
- getGroupStart(id, matchNo, groupNo)
- getGroupEnd(id, matchNo, groupNo)
\
+- getFindCount(id)
- getGroupCount(id)
- getGroup(id, matchNo, groupNo)
- getGroupStart(id, matchNo, groupNo)
- getGroupEnd(id, matchNo, groupNo)
\
Both matchNo and groupNo start at 1, the special group number 0 returns the whole pattern match.\
\
Groups are the regex capture groups, designated by the parts in "(" parenthesis ")". Group 1 returns the string that matches the first regex statement in (), 2 returns the second, etc.\
@@ -25447,7 +25447,7 @@ string.summary = \
\
-stringToList.description = Converts a string into a string list using a pattern to determine separator between elements.
+stringToList.description = Converts a string into a string list using a pattern to determine separator between elements.
stringToList.summary = \
\
\
@@ -25456,7 +25456,7 @@ stringToList.summary = \
stringToList() Function\
\
• Introduced in version 1.3b48\
- Converts a string into a string list using a pattern to determine separator between elements. The specified delimiter is used to separate the elements in the Macros:string list if it is specified, otherwise the default value of "," is used. Pattern can be a regular expression.\
+ Converts a string into a string list using a pattern to determine separator between elements. The specified delimiter is used to separate the elements in the Macros:string list if it is specified, otherwise the default value of "," is used. Pattern can be a regular expression.\
\
Usage\
\
@@ -25656,7 +25656,7 @@ Returns a number than is between 0 and 12, which is th
\
See Also\
\
- For another method of rolling dice, see Dice Expressions.\
+ For another method of rolling dice, see Dice Expressions.\
\
\
@@ -25697,7 +25697,7 @@ Returns:"14"
\
-switchToken.description = Changes the Current Token for the remainder of the Macro.
+switchToken.description = Changes the Current Token for the remainder of the Macro.
switchToken.summary = \
\
\
@@ -25707,12 +25707,12 @@ switchToken.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.3b48\
- Changes the Current Token for the remainder of the Macro.\
-In practice, "the remainder of the Macro" is the same as the variable scope. Thus, if a macro is running as a user defined function (see defineFunction() ) with a new scope, switchToken will only apply until the end of the current macro. Once control passes back to the calling macro, the Current Token reverts back to what it was before the external macro was called ( as a function ).\
+
Changes the Current Token for the remainder of the Macro.\
+In practice, "the remainder of the Macro" is the same as the variable scope. Thus, if a macro is running as a user defined function (see defineFunction() ) with a new scope, switchToken will only apply until the end of the current macro. Once control passes back to the calling macro, the Current Token reverts back to what it was before the external macro was called ( as a function ).\
If a defineFunction() does not create a new variable scope for the called macro, then effects of switchToken persist when control passes back to the calling macro.
\
Note: You cannot switch to a token on a different map.\
\
@@ -25749,8 +25749,8 @@ tbl(name, row)\
Parameters\
\
\
- name - A string containing the name of the table.row - The row of the table that should be returned.name - A string containing the name of the table.row - The row of the table that should be returned.
\
\
Examples\
@@ -25776,12 +25776,12 @@ tbl(name, row)\
\
See Also\
\
- tableImage()
There is a tool available to import tables from excel. You can find more about this here\
+ tableImage()
There is a tool available to import tables from excel. You can find more about this here\
\
\
-tableImage.description = Gets the image asset value from the specified table .
+tableImage.description = Gets the image asset value from the specified table .
tableImage.summary = \
\
\
@@ -25790,7 +25790,7 @@ tableImage.summary = \
tableImage() Function\
\
• Introduced in version 1.3b40\
- Gets the image asset value from the specified table. If the row is not specified then the default roll for the table is used.\
+ Gets the image asset value from the specified table. If the row is not specified then the default roll for the table is used.\
\
Usage\
\
@@ -25806,16 +25806,16 @@ tblImage(name, row, size)\
Parameters\
\
\
- name - A string containing the name of the table.row - The row of the table that should have the image asset returned.name - A string containing the name of the table.row - The row of the table that should have the image asset returned.size - The size the image asset returned should be. If the image is not square, this will be the size of the height.
\
\
Examples\
\
- Example 1: Display a random image from table "tbl1" using default roll:\
+ Example 1: Display a random image from table "tbl1" using default roll:\
<image src='[r: tableImage("tbl1")]'></image>\
-Example 1: Display the first image from table "tbl1":\
+
Example 1: Display the first image from table "tbl1":\
\
<image src='[r: tableImage("tbl1", 1)]'></image>\
Example 2: Display one of the first four images, resized to 40 pixels tall, from "tbl1", chosed randomly:\
@@ -25856,8 +25856,8 @@ tbl(name, row)\
Parameters\
\
\
- name - A string containing the name of the table.row - The row of the table that should be returned.name - A string containing the name of the table.row - The row of the table that should be returned.
\
\
Examples\
@@ -25883,12 +25883,12 @@ tbl(name, row)\
\
See Also\
\
- tableImage()
There is a tool available to import tables from excel. You can find more about this here\
+ tableImage()
There is a tool available to import tables from excel. You can find more about this here\
\
\
-tblImage.description = Gets the image asset value from the specified table .
+tblImage.description = Gets the image asset value from the specified table .
tblImage.summary = \
\
\
@@ -25897,7 +25897,7 @@ tblImage.summary = \
tableImage() Function\
\
• Introduced in version 1.3b40\
- Gets the image asset value from the specified table. If the row is not specified then the default roll for the table is used.\
+ Gets the image asset value from the specified table. If the row is not specified then the default roll for the table is used.\
\
Usage\
\
@@ -25913,16 +25913,16 @@ tblImage(name, row, size)\
Parameters\
\
\
- name - A string containing the name of the table.row - The row of the table that should have the image asset returned.name - A string containing the name of the table.row - The row of the table that should have the image asset returned.size - The size the image asset returned should be. If the image is not square, this will be the size of the height.
\
\
Examples\
\
- Example 1: Display a random image from table "tbl1" using default roll:\
+ Example 1: Display a random image from table "tbl1" using default roll:\
<image src='[r: tableImage("tbl1")]'></image>\
-Example 1: Display the first image from table "tbl1":\
+
Example 1: Display the first image from table "tbl1":\
\
<image src='[r: tableImage("tbl1", 1)]'></image>\
Example 2: Display one of the first four images, resized to 40 pixels tall, from "tbl1", chosed randomly:\
@@ -25949,7 +25949,7 @@ toggleFoW.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.1.3\
@@ -25980,7 +25980,7 @@ toggleFoW.summary = \
\
See Also\
\
- \
+ \
\
\
@@ -25995,7 +25995,7 @@ transferVBL.summary = \
\
\
\
- Note: This function can only be used in a Trusted Macro\
+ Note: This function can only be used in a Trusted Macro\
\
\
• Introduced in version 1.4.2.0\
@@ -26018,7 +26018,7 @@ transferVBL(value, delete, id)\
value - The value of the setting to set:\
0 transfer normal (blue) VBL to token (yellow) VBL1 transfer token (yellow) VBL to normal (blue) VBL
delete - Defines if the transferred VBL is deleted from the source.id - OPTIONAL: The token id of the token for which you want to set this setting, defaults to the Current Token.id - OPTIONAL: The token id of the token for which you want to set this setting, defaults to the Current Token.\
Examples\
@@ -26053,7 +26053,7 @@ transferVBL(value, delete, id)\
\
See Also\
\
- \
+ \
\
Version Changes\
\
@@ -26146,7 +26146,7 @@ Returns a number than is between 0 and 5.
\
\
See Also\
\
- For another method of rolling dice, see Dice Expressions.\
+ For another method of rolling dice, see Dice Expressions.\
\
\
@@ -26189,7 +26189,7 @@ Returns a number than is between 0 and 5.\
\
See Also\
\
- For another method of rolling dice, see Dice Expressions.\
+ For another method of rolling dice, see Dice Expressions.\
\
\
@@ -26225,7 +26225,7 @@ This Is a Test\
\
-varsFromStrProp.description = Creates variables from a string property list with the values assigned to variables with the names of the keys in the string property list .
+varsFromStrProp.description = Creates variables from a string property list with the values assigned to variables with the names of the keys in the string property list .
varsFromStrProp.summary = \
\
\
@@ -26234,7 +26234,7 @@ varsFromStrProp.summary = \
varsFromStrProp() Function\
\
• Introduced in version 1.3b42\
- Creates variables from a string property list with the values assigned to variables with the names of the keys in the string property list. The function returns the number of variables that were created.\
+ Creates variables from a string property list with the values assigned to variables with the names of the keys in the string property list. The function returns the number of variables that were created.\
\
Usage\
\
delim - The delimiter used to separate the values in the String List, defaults to ",". Returns a JSON Array if set to "json".id - The token id of the token which has its property names returned, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
delim - The delimiter used to separate the values in the String List, defaults to ",". Returns a JSON Array if set to "json".id - The token id of the token which has its property names returned, defaults to the Current Token. Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.To display the names of all of the properties on the current token use.\
\
[h: names = getPropertyNames()]\
[foreach(name, names, "<br>"): name]\ @@ -9225,7 +9225,7 @@ getPropertyNames(delim, id, mapname)\
\
@@ -9234,8 +9234,8 @@ getPropertyNamesRaw.summary = \
getPropertyNamesRaw() Function\
\
• Introduced in version 1.3b64
\
- Returns a String List or JSON Array containing the names of the Token Properties on a Token. The type of the value returned depends on the delimiter parameter.\
-The difference between this function and getPropertyNames() is that getPropertyNames() returns all the property names in lower case (see this forum thread to get the reason why it was created).
\
+ Returns a String List or JSON Array containing the names of the Token Properties on a Token. The type of the value returned depends on the delimiter parameter.\
+The difference between this function and getPropertyNames() is that getPropertyNames() returns all the property names in lower case (see this forum thread to get the reason why it was created).
\
\ Usage\
\ @@ -9249,14 +9249,14 @@ getPropertyNamesRaw(delim, id, mapname)\ Parameters\ \- \
-
delim- The delimiter used to separate the values in the String List, defaults to",". Returns a JSON Array if set to"json". \
- id- The tokenidof the token which has its property names returned, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ delim- The delimiter used to separate the values in the String List, defaults to",". Returns a JSON Array if set to"json". \
+ id- The tokenidof the token which has its property names returned, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ Example\
\ -To display the names of all of the properties on the current token use.\
+
\
-getPropertyType.description = Returns the Property Type of a Token .
+getPropertyType.description = Returns the Property Type of a Token .
getPropertyType.summary = \
To display the names of all of the properties on the current token use.\
\
[h: names = getPropertyNamesRaw()]\
[foreach(name, names, "<br>"): name]\ @@ -9279,7 +9279,7 @@ getPropertyNamesRaw(delim, id, mapname)\
\
\
-getSelected.description = Returns a list containing the ids of the selected tokens on the current map .
+getSelected.description = Returns a list containing the ids of the selected tokens on the current map .
getSelected.summary = \
\
@@ -9288,7 +9288,7 @@ getPropertyType.summary = \
getPropertyType() Function\
\
\
-getRawProperty.description = Gets the unevaluated value of a token property , returns • Introduced in version 1.3b48
\
- Returns the Property Type of a Token.
\
+ Returns the Property Type of a Token.
\
\ Usage\
\ @@ -9301,7 +9301,7 @@ getPropertyType(id, mapname)\ Parameter\ \- \
-
id- The tokenidof the token which has its Property Type returned, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidof the token which has its Property Type returned, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ @@ -9326,7 +9326,7 @@ getPropertyType(id, mapname)\
"" if the property is empty.
+getRawProperty.description = Gets the unevaluated value of a token property , returns "" if the property is empty.
getRawProperty.summary = \
\
\
-getRolled.description = Returns a JSON Array of all the raw, i.e. unmodified, dice rolls that have occurred within the current macro context.
+getRolled.description = Returns a JSON Array of all the raw, i.e. unmodified, dice rolls that have occurred within the current macro context.
getRolled.summary = \
\
@@ -9335,7 +9335,7 @@ getRawProperty.summary = \
getRawProperty() Function\
\
\
• Introduced in version 1.3b51
\
- Gets the unevaluated value of a token property, returns
\
+ "" if the property is empty. This will not return the property's default value.Gets the unevaluated value of a token property, returns
\
"" if the property is empty. This will not return the property's default value.\ Usage\
\ @@ -9394,13 +9394,13 @@ getRecursionDepth.summary = \\ See Also\
\ - \ + \\
\
\
@@ -9409,7 +9409,7 @@ getRolled.summary = \
getRolled() Function\
\
• Introduced in version 1.5.2
\
- Returns a JSON Array of all the raw, i.e. unmodified, dice rolls that have occurred within the current macro context.
\
+ Returns a JSON Array of all the raw, i.e. unmodified, dice rolls that have occurred within the current macro context.
\
\ Usage\
\ @@ -9446,7 +9446,7 @@ Get Rolled: [9,6,5,1]\
\
@@ -9455,8 +9455,8 @@ getSelected.summary = \
getSelected() Function\
\
• Introduced in version 1.3b48
\
- Returns a list containing the ids of the selected tokens on the current map. The type of the value returned depends on the delimiter parameter.\
-\
Usage\
@@ -9465,12 +9465,12 @@ getSelected.summary = \
\
- - If the delimiter is not specified then a string list is returned with the default value of
","is used. - If the delimiter
jsonthen a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
Returns a list containing the ids of the selected tokens on the current map. The type of the value returned depends on the delimiter parameter.\
+
\
- If the delimiter is not specified then a string list is returned with the default value of
","is used. - If the delimiter
jsonthen a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
Usage\
@@ -9465,12 +9465,12 @@ getSelected.summary = \
getSelected()\
getSelected(delim)
\
delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
+
delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
\ Example\
\ -To display the ids of all of the selected tokens on the current map use.\
+
\
-getSelectedNames.description = Returns a list containing the names of the selected tokens on the current map .
+getSelectedNames.description = Returns a list containing the names of the selected tokens on the current map .
getSelectedNames.summary = \
To display the ids of all of the selected tokens on the current map use.\
\
[h: ids = getSelected()]\
[foreach(id, ids, "<br>"): id]\ @@ -9489,7 +9489,7 @@ getSelected(delim)\
\
\
@@ -9498,8 +9498,8 @@ getSelectedNames.summary = \
getSelectedNames() Function\
\
• Introduced in version 1.3b48
\
- Returns a list containing the names of the selected tokens on the current map. The type of the value returned depends on the delimiter parameter.\
-\
Usage\
@@ -9508,12 +9508,12 @@ getSelectedNames.summary = \
\
- - If the delimiter is not specified then a string list is returned with the default value of
","is used. - If the delimiter
jsonthen a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
Returns a list containing the names of the selected tokens on the current map. The type of the value returned depends on the delimiter parameter.\
+
\
- If the delimiter is not specified then a string list is returned with the default value of
","is used. - If the delimiter
jsonthen a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
Usage\
@@ -9508,12 +9508,12 @@ getSelectedNames.summary = \
getSelectedNames()\
getSelectedNames(delim)
\
delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
+
delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
\ Example\
\ -To display the names of all of the selected tokens on the current map use.\
+
\
-getSightType.description = Returns the type of sight that the Current Token has.
+getSightType.description = Returns the type of sight that the Current Token has.
getSightType.summary = \
To display the names of all of the selected tokens on the current map use.\
\
[h: names = getSelectedNames()]\
[foreach(name, names, "<br>"): name]\ @@ -9532,7 +9532,7 @@ getSelectedNames(delim)\
\
\
@@ -9541,7 +9541,7 @@ getSightType.summary = \
getSightType() Function\
\
\
-getSize.description = Returns the Size of a Token .
+getSize.description = Returns the Size of a Token .
getSize.summary = \
• Introduced in version 1.3b48
\
- Returns the type of sight that the Current Token has. When no sight type is set, returns an empty string.
\
+ Returns the type of sight that the Current Token has. When no sight type is set, returns an empty string.
\
\ Usage\
\ @@ -9554,7 +9554,7 @@ getSightType(mapname)\ Parameters\ \- \
-
id- Theidof the token to have the State set. Defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- Theidof the token to have the State set. Defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ @@ -9573,7 +9573,7 @@ getSightType(mapname)\
\
\
@@ -9582,7 +9582,7 @@ getSize.summary = \
getSize() Function\
\
• Introduced in version 1.3b48
\
- Returns the Size of a Token.\
+
Returns the Size of a Token.\
\
-getSpeech.description = Returns the Speech value from the Current Token .
+getSpeech.description = Returns the Speech value from the Current Token .
getSpeech.summary = \
The sizes returned are:\
\FineDiminutiveTinySmallMediumLargeHugeGargantuanColossal
- \
-
id- The tokenidof the token which has its Size returned, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidof the token which has its Size returned, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
- \
@@ -9648,7 +9648,7 @@ getSoundProperties(uri)\
Parameter\
\
uri- The uri/url of the audio source to edit. If set to "*", a JSON Array containing the properties of all audio sources is returned. Defaults to "*". \
+ uri- The uri/url of the audio source to edit. If set to "*", a JSON Array containing the properties of all audio sources is returned. Defaults to "*". \
- \
-
Properties returned for streams: nicknames, uri, cycleCount, volume, startTime, stopTime, currentTime, totalTime, bufferTime, currentCount, status.\
\ @@ -9669,7 +9669,7 @@ getSoundProperties(uri)\\
\
@@ -9678,7 +9678,7 @@ getSpeech.summary = \
getSpeech() Function\
\
\
-getSpeechNames.description = Returns a list containing the speech names of the Current Token .
+getSpeechNames.description = Returns a list containing the speech names of the Current Token .
getSpeechNames.summary = \
• Introduced in version 1.3b48
\
- Returns the Speech value from the Current Token.
\
+ Returns the Speech value from the Current Token.
\
\ Usage\
\ @@ -9689,7 +9689,7 @@ getSpeech.summary = \\
\
@@ -9698,8 +9698,8 @@ getSpeechNames.summary = \
getSpeechNames() Function\
\
• Introduced in version 1.3b48
\
- Returns a list containing the speech names of the Current Token. The type of the value returned depends on the delimiter parameter.\
-\
Usage\
@@ -9708,12 +9708,12 @@ getSpeechNames.summary = \
\
- - If the delimiter is not specified then a string list is returned with the default value of
","is used. - If the delimiter
jsonthen a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
Returns a list containing the speech names of the Current Token. The type of the value returned depends on the delimiter parameter.\
+
\
- If the delimiter is not specified then a string list is returned with the default value of
","is used. - If the delimiter
jsonthen a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\
Usage\
@@ -9708,12 +9708,12 @@ getSpeechNames.summary = \
getSpeechNames()\
getSpeechNames(delim)
\
delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
+
delim is the delimiter used to separate the values in the string list which defaults to "," if not specified.\
\ Example\
\ -To display the names of all of the speech values for the Current Token use.\
+
\
-getState.description = Checks whether the specified State is active on a token, returning To display the names of all of the speech values for the Current Token use.\
\
[h: names = getSpeech()]\
[foreach(name, names, "<br>"): name]\ @@ -9731,7 +9731,7 @@ getSpeechNames(delim)\
true ( 1 ) or false ( 0 ).
+getState.description = Checks whether the specified State is active on a token, returning true ( 1 ) or false ( 0 ).
getState.summary = \
\
\
@@ -9740,7 +9740,7 @@ getState.summary = \
getState() Function\
\
\
@@ -9768,7 +9768,7 @@ getState(state, id, mapname)\
\
-getStateImage.description = Gets the asset id for the image of a state, the state must be one of the image types for this to work.
+getStateImage.description = Gets the asset id for the image of a state, the state must be one of the image types for this to work.
getStateImage.summary = \
• Introduced in version 1.3b40
\
- \
+ \
\ Usage\
\ @@ -9754,7 +9754,7 @@ getState(state, id, mapname)\ \- \
state- The name of the state to check for. \
- id- The tokenidof the token to check for the state. Defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidof the token to check for the state. Defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\
@@ -9768,7 +9768,7 @@ getState(state, id, mapname)\
\
See Also\
\
- \
+ \
\
Version Changes\
\
@@ -9782,7 +9782,7 @@ getState(state, id, mapname)\
\
\
-getStrProp.description = Returns the value associated with a key from the specified string property list .
+getStrProp.description = Returns the value associated with a key from the specified string property list .
getStrProp.summary = \
\
@@ -9791,7 +9791,7 @@ getStateImage.summary = \
getStateImage() Function\
\
\
@@ -9838,7 +9838,7 @@ getSoundProperties(uri)\
Parameter\
\
• Introduced in version 1.3b40
\
- Gets the asset id for the image of a state, the state must be one of the image types for this to work.
\
+ Gets the asset id for the image of a state, the state must be one of the image types for this to work.
\
\ Usage\
\ @@ -9811,7 +9811,7 @@ getStateImage.summary = \\ Example\
\ -To display the image for the "Dead" token state use.\
+
\
To display the image for the "Dead" token state use.\
\
<img src='[r:getStateImage("Dead")]'></img>- \
-
uri- The uri/url of the audio source to edit. If set to "*", a JSON Array containing the properties of all audio sources is returned. Defaults to "*". \
+ uri- The uri/url of the audio source to edit. If set to "*", a JSON Array containing the properties of all audio sources is returned. Defaults to "*". \
Properties returned for streams: nicknames, uri, cycleCount, volume, startTime, stopTime, currentTime, totalTime, bufferTime, currentCount, status.\
\ @@ -9859,7 +9859,7 @@ getSoundProperties(uri)\\
\
-getTokenHandout.description = Returns the asset id of the handout image for the for the Current Token .
+getTokenHandout.description = Returns the asset id of the handout image for the for the Current Token .
getTokenHandout.summary = \
\
@@ -9868,7 +9868,7 @@ getStrProp.summary = \
getStrProp() Function\
\
\
\
\
@@ -10469,7 +10469,7 @@ getTokenGMName.summary = \
\
• Introduced in version 1.3b42
\
- Returns the value associated with a key from the specified string property list.
\
+ Returns the value associated with a key from the specified string property list.
\
\ Usage\
\ @@ -9889,16 +9889,16 @@ getStrProp(propList, key, default, delim)\\ Example\
\ -To get the name from a weapon string property list\
+
\
@@ -10080,7 +10080,7 @@ getTablePickOnce.summary = \
\
To get the name from a weapon string property list\
\
\
\
@@ -9965,7 +9965,7 @@ getTableEntry.summary = \
\
\
-getTableImage.description = Gets the asset id for the image of the current row for the given table.
+getTableImage.description = Gets the asset id for the image of the current row for the given table.
getTableImage.summary = \
[h: weapon = "name=longsword; damage=1d8; maxdamage=8"]\
Name of Weapon: [r: getStrProp(weapon, "name")]Returns Name of Weapon: longsword.\
-
To get the minimum damage from a weapon string property list with a default value should the key not exist\ +
To get the minimum damage from a weapon string property list with a default value should the key not exist\
\[h: weapon = "name=longsword; damage=1d8; maxdamage=8"]\
Minimum damage of Weapon: [r: getStrProp(weapon, "mindamage", 1)]Returns Minimum damage of Weapon: 1.\
-
To get the damage from a weapon string property list where the field delimiter is a colon. The default is 1d3 (note that a default value must be provided in order to specify the delimiter).\ +
To get the damage from a weapon string property list where the field delimiter is a colon. The default is 1d3 (note that a default value must be provided in order to specify the delimiter).\
\[h: weapon = "name=longsword: damage=1d8: maxdamage=8"]\
Damage of Weapon: [r: getStrProp(weapon, "damage", "1d3", ":")]\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.5.4
\
@@ -10002,7 +10002,7 @@ getTableEntry.summary = \
\
\
Examples\
@@ -10065,7 +10065,7 @@ getTableNames(delim)\
\
\
@@ -10012,11 +10012,11 @@ getTableImage.summary = \
\
\
- \
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.5.0
\
- Gets the asset id for the image of the current row for the given table. See setTableRoll() to learn how to set the current row.
\
+ Gets the asset id for the image of the current row for the given table. See setTableRoll() to learn how to set the current row.
\
\ Usage\
\ @@ -10050,7 +10050,7 @@ getTableNames.summary = \getTableNames()\ getTableNames(delim)\
If delim is specified then it is used to separate the values in the list; if it is not specified then it defaults to ",". When delim is the string "json" the return value will be in the form of a JSON Array.\
+
If delim is specified then it is used to separate the values in the list; if it is not specified then it defaults to ",". When delim is the string "json" the return value will be in the form of a JSON Array.\
\
Examples\
@@ -10065,7 +10065,7 @@ getTableNames(delim)\
\
See Also\
\
- \
+ \
\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.6.0
\
@@ -10121,7 +10121,7 @@ getTablePicksLeft.summary = \
\
\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.6.0
\
@@ -10163,7 +10163,7 @@ getTableRoll.summary = \
\
\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.4.0.1
\
@@ -10240,7 +10240,7 @@ getTerrainModifier.summary = \
\
\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.5.2
\
@@ -10309,7 +10309,7 @@ getTextLabelStatus.summary = \
\
• Introduced in version 1.6
\
• Last checked for compatibility with version 1.6
\
- Get the display status for Text Labels. This is also shown in the View menu.
\
+ Get the display status for Text Labels. This is also shown in the View menu.
\
\ Usage\
\ @@ -10362,7 +10362,7 @@ getTokenDrawOrder(id, mapname)\ Parameter\ \- \
-
id- The id of the token to move, defaults to the Current Token. \
+ id- The id of the token to move, defaults to the Current Token. \
mapname- The name of the map to find the token. Defaults to the current map. \
\ @@ -10408,7 +10408,7 @@ getTokenFacing(id, mapname)\ Parameters\
\- \
-
id- The id of the token to get the facing from, defaults to the current token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The id of the token to get the facing from, defaults to the current token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
Returns\
@@ -10432,7 +10432,7 @@ The angle in degrees or "" if no facing has been set\
Returns:\
\
\
\
\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b40
\
@@ -10509,7 +10509,7 @@ getTokenHalo.summary = \
\
\
@@ -10517,7 +10517,7 @@ getTokenHandout.summary = \
\
getTokenHandout() Function\
\
-
Returns the asset id of the handout image for the for the Current Token.
\
+ Returns the asset id of the handout image for the for the Current Token.
\
\ Usage\
\ @@ -10532,13 +10532,13 @@ getTokenHandout(size, id, mapname)\ \- \
size- OPTIONAL: The size the image should be returned as. If a blank string "", no size adjustment is done. Defaults to "". \
- id- OPTIONAL: The tokenidof the token for which you want to retrieve the token handout image, defaults to the Current Token. \
+ id- OPTIONAL: The tokenidof the token for which you want to retrieve the token handout image, defaults to the Current Token. \
mapname- OPTIONAL: The name of the map to find the token. Defaults to the current map. \
\ Example\
\ -To display the image for the current Token.\
+
\
-getTokenImage.description = Returns the asset id of the image for the for the Current Token .
+getTokenImage.description = Returns the asset id of the image for the for the Current Token .
getTokenImage.summary = \
To display the image for the current Token.\
\
<img src='[r:getTokenHandout()]'></img>\
\
@@ -10577,7 +10577,7 @@ getTokenHeight(id, mapname)\
Parameter\
- \
-
id- The token id of the token to check for its height, defaults to the Current Token. \
+ id- The token id of the token to check for its height, defaults to the Current Token. \
mapname- The name of the map to find the token. Defaults to the current map. \
Result
\
@@ -10613,7 +10613,7 @@ The token's boundary (image) height in pixels.\
\
\
@@ -10621,7 +10621,7 @@ getTokenImage.summary = \
\
getTokenImage() Function\
\
-
Returns the asset id of the image for the for the Current Token.
\
+ Returns the asset id of the image for the for the Current Token.
\
\ Usage\
\ @@ -10636,15 +10636,15 @@ getTokenImage(size, id, mapname)\ \- \
size- OPTIONAL: The size in pixels the image should be returned as. If a blank string "", no size adjustment is done. Defaults to "". \
- id- OPTIONAL: The tokenidof the token for which you want to retrieve the token image, defaults to the Current Token. \
+ id- OPTIONAL: The tokenidof the token for which you want to retrieve the token image, defaults to the Current Token. \
mapname- OPTIONAL: The name of the map to find the token. Defaults to the current map. \
\ Examples\
\ -To display the image for the current token.\
+
\
-getTokenLayoutProps.description = Return the Token Layout To display the image for the current token.\
\
-
\
<img src='[r:getTokenImage()]'></img>To get the image of any token using its id and the token roll option.\ +
To get the image of any token using its id and the token roll option.\
\[h, token(tokenId): imgAsset = getTokenImage()]\ @@ -10688,7 +10688,7 @@ getTokenLabel.summary = \
scale , xOffset , and yOffset values in either a JSON Object or String Property List .
+getTokenLayoutProps.description = Return the Token Layout scale , xOffset , and yOffset values in either a JSON Object or String Property List .
getTokenLayoutProps.summary = \
\
\
@@ -10697,7 +10697,7 @@ getTokenLayoutProps.summary = \
getTokenLayoutProps() Function\
\
\
@@ -10754,7 +10754,7 @@ getTokenMap.summary = \
getTokenMap() Function\
\
\
-getTokenNames.description = Gets a list containing the names of all the tokens on the current map , or all the tokens that match the specified conditions.
+getTokenNames.description = Gets a list containing the names of all the tokens on the current map , or all the tokens that match the specified conditions.
getTokenNames.summary = \
• Introduced in version 1.6.1
\
- Return the Token Layout
\
+ scale, xOffset, and yOffset values in either a JSON Object or String Property List. These values represent the positioning of the token image within the Layout portion of the Config tab in the Edit Token Dialog.Return the Token Layout
\
scale, xOffset, and yOffset values in either a JSON Object or String Property List. These values represent the positioning of the token image within the Layout portion of the Config tab in the Edit Token Dialog.\ Usage\
\ @@ -10712,7 +10712,7 @@ getTokenLayoutProps(delim, id, mapName)\ \- \
delim- The delimiter of the String Property List. If set tojson, the function will instead return a Json Object. Defaults to,. \
- id- The tokenidof the token to name, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidof the token to name, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\
@@ -10754,7 +10754,7 @@ getTokenMap.summary = \
getTokenMap() Function\
\
• Introduced in version 1.5.11\
- Gets the list of map(s) where a token resides. The list is returned either as a string list, or as a JSON Array.\
+ Gets the list of map(s) where a token resides. The list is returned either as a string list, or as a JSON Array.\
\
Usage\
\
@@ -10782,7 +10782,7 @@ getTokenMap(name/ID, delim)\
\
\
@@ -10792,11 +10792,11 @@ getTokenNames.summary = \
\
\
\
\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b48
\
- Gets a list containing the names of all the tokens on the current map, or all the tokens that match the specified conditions. The type of the value returned depends on the delimiter parameter. This function does not return the IDs of lib:tokens. Note: apparently the order of the list that getTokens() returns is also the z-order of the tokens, where the lowest z-order is the first in the list or array that is returned!
\
+ Gets a list containing the names of all the tokens on the current map, or all the tokens that match the specified conditions. The type of the value returned depends on the delimiter parameter. This function does not return the IDs of lib:tokens. Note: apparently the order of the list that getTokens() returns is also the z-order of the tokens, where the lowest z-order is the first in the list or array that is returned!
\
\ Usage\
\ @@ -10809,9 +10809,9 @@ getTokenNames(delim, conditions)\ Parameters\ \- \
-
delim- The delimiter used to separate the values in the String List that is returned, defaults to",". If"json"is specified, a JSON Array is returned instead of a String List. \
- conditions- A JSON Object that contains various conditions that the tokens must fullfill. All conditions are optional.\ -setStates- A JSON array of states the token must have or a single state name as a string. Any token which does not contain all of these states in thetruecondition will be removed from the returned list.unsetStates- A JSON array of states the token must not have or a single state name as a string.npc- If the token must be a NPC, set totrue(1) orfalse(0).pc- If the token must be a PC, set totrue(1) orfalse(0).propertyType- A JSON array of token types or a single token type as a string. Only tokens of a type included in the array will be returned.selected- If the token must be selected, set totrue(1) orfalse(0).impersonated- If the token must be impersonated, set totrue(1) orfalse(0).current- If the token must be the current token, set totrue(1) orfalse(0).owned- A JSON Array containing player names. All tokens that have at least one of the listed players as owner will be returned. Alternatively, a string containing one of the following options:\ +delim- The delimiter used to separate the values in the String List that is returned, defaults to",". If"json"is specified, a JSON Array is returned instead of a String List. \
+ conditions- A JSON Object that contains various conditions that the tokens must fullfill. All conditions are optional.\ +setStates- A JSON array of states the token must have or a single state name as a string. Any token which does not contain all of these states in thetruecondition will be removed from the returned list.unsetStates- A JSON array of states the token must not have or a single state name as a string.npc- If the token must be a NPC, set totrue(1) orfalse(0).pc- If the token must be a PC, set totrue(1) orfalse(0).propertyType- A JSON array of token types or a single token type as a string. Only tokens of a type included in the array will be returned.selected- If the token must be selected, set totrue(1) orfalse(0).impersonated- If the token must be impersonated, set totrue(1) orfalse(0).current- If the token must be the current token, set totrue(1) orfalse(0).owned- A JSON Array containing player names. All tokens that have at least one of the listed players as owner will be returned. Alternatively, a string containing one of the following options:\self- tokens owned by the current playernotself- tokens not owned by the current playerothers- tokens owned by any player, but not owned by the current playerany- tokens owned by any playernone- tokens not owned by any playersingle- tokens owned by a single playermultiple- tokens owned by more than one playerbyall- tokens owned by all playersnotbyall- tokens not owned by all players
visible- If the token is visible in the current client's view. Set totrue(1) orfalse(0).\- When the visible option is used only tokens on the TOKEN layer and which are shown within the client's current map view will be returned.
- This is not a test of whether or not other tokens on the map out of view are visible to a specific token. See canSeeToken().
- GMs will be able to see all tokens within the current map view. Players (including View as Player) will only get returned those tokens that are shown in their current map view. Tokens returned will also be affected by server settings like Individual Views.
layer- A JSON array of layer names, or a single layer name as a string. Note that a token not on any of the listed layers will be removed from the list returned.mapName- The name of the map to get the tokens from. Defaults to the current map.range- A JSON object with range conditions, all range conditions are optional.\token- The id or name of the source token that the distance is measured from, defaults to the current token.\ @@ -10839,7 +10839,7 @@ getTokenNames(delim, conditions)\*You can use the following code to print out the names of all of the tokens on the current map:\\ -getTokenPortrait.description = Returns the asset id of the portrait image for the for the Current Token . +getTokenPortrait.description = Returns the asset id of the portrait image for the for the Current Token . getTokenPortrait.summary = \[h: names = getTokenNames()]\ [foreach(name, names, "<br>"): name]
\ -- Find and return a JSON Array containing all NPC tokens' names that are within 2 squares or hexes:
- Find and return a JSON Array containing all NPC tokens' names that are within 2 squares or hexes:
[h: cond = '{ range: {upto:2, distancePerCell:0}, npc:1 }']\ [h: names = getTokenNames("json", cond)]
\- Modifying the above example to exclude dead tokens:
- \
-
id- The token id of the token to check for its height, defaults to the Current Token. \
+ id- The token id of the token to check for its height, defaults to the Current Token. \
mapname- The name of the map to find the token. Defaults to the current map. \
\
Result
\ @@ -10989,7 +10989,7 @@ getTokenNativeWidth(id, mapname)\ Parameters\- \
-
id- The token id of the token to check for its width, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The token id of the token to check for its width, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\
Result
\ @@ -11047,7 +11047,7 @@ getTokenOpacity(id, mapname)\ Parameters\- \
-
id- OPTIONAL: The tokenidof the token for which you want to retrieve the opacity, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- OPTIONAL: The tokenidof the token for which you want to retrieve the opacity, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- OPTIONAL: The name of the map to find the token. Defaults to the current map. \
\ @@ -11074,7 +11074,7 @@ getTokenOpacity(id, mapname)\
\\ @@ -11082,7 +11082,7 @@ getTokenPortrait.summary = \ \ getTokenPortrait() Function\ \ -Returns the asset id of the portrait image for the for the Current Token.\ +Returns the asset id of the portrait image for the for the Current Token.\\ Usage\
\ @@ -11097,13 +11097,13 @@ getTokenPortrait(size, id, mapname)\ \- \
size- OPTIONAL: The size the picture should be returned as. If a blank string "", no size adjustment is done. Defaults to "". \
- id- OPTIONAL: The tokenidof the token for which you want to retrieve the token image, defaults to the Current Token. \
+ id- OPTIONAL: The tokenidof the token for which you want to retrieve the token image, defaults to the Current Token. \
mapname- OPTIONAL: The name of the map to find the token. Defaults to the current map. \
\ Examples\
\ -To display the image for the current Token.\ +\To display the image for the current Token.\\<img src='[r:getTokenPortrait()]'></img>
\ Version Changes\ @@ -11147,7 +11147,7 @@ getTokenRotation(id, mapname)\ Parameters\ \
- \
-
id- The token id of the token to retrieve the rotation angle. Defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The token id of the token to retrieve the rotation angle. Defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
Result
\ @@ -11166,7 +11166,7 @@ The function returns the token's rotation as a numeric value measured in degrees [h: switchToken("Troll")]\ [r: token.name] - [r: r = getTokenRotation()]Returns:\ -
\
+\
Relation to Token Facing
When the facing is defined, the relation between a token's rotation and the token's facing can be expressed as\
\\ @@ -11199,7 +11199,7 @@ getTokens.summary = \ \rotation = -(facing + 90)
\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b48\ @@ -11217,9 +11217,9 @@ getTokens(delim, conditions)\ Parameters\ \- \
-
delim- The delimiter used to sepearate the values in the String List that is returned, defaults to",". If"json"is specified, a JSON Array is returned instead of a String List. \
- conditions- A JSON Object that contains various conditions that the tokens must fullfill. All conditions are optional.\ -setStates- A JSON array of states the token must have or a single state name as a string. Any token which does not contain all of these states in thetruecondition will be removed from the returned list.unsetStates- A JSON array of states the token must not have or a single state name as a string.npc- If the token must be a NPC, set totrue(1) orfalse(0).pc- If the token must be a PC, set totrue(1) orfalse(0).propertyType- A JSON array of token types or a single token type as a string. Only tokens of a type included in the array will be returned.selected- If the token must be selected, set totrue(1) orfalse(0).impersonated- If the token must be impersonated, set totrue(1) orfalse(0).current- If the token must be the current token, set totrue(1) orfalse(0).owned- A JSON Array containing player names. All tokens that have at least one of the listed players as owner will be returned. Alternatively, a string containing one of the following options:\ +delim- The delimiter used to sepearate the values in the String List that is returned, defaults to",". If"json"is specified, a JSON Array is returned instead of a String List. \
+ conditions- A JSON Object that contains various conditions that the tokens must fullfill. All conditions are optional.\ +setStates- A JSON array of states the token must have or a single state name as a string. Any token which does not contain all of these states in thetruecondition will be removed from the returned list.unsetStates- A JSON array of states the token must not have or a single state name as a string.npc- If the token must be a NPC, set totrue(1) orfalse(0).pc- If the token must be a PC, set totrue(1) orfalse(0).propertyType- A JSON array of token types or a single token type as a string. Only tokens of a type included in the array will be returned.selected- If the token must be selected, set totrue(1) orfalse(0).impersonated- If the token must be impersonated, set totrue(1) orfalse(0).current- If the token must be the current token, set totrue(1) orfalse(0).owned- A JSON Array containing player names. All tokens that have at least one of the listed players as owner will be returned. Alternatively, a string containing one of the following options:\self- tokens owned by the current playernotself- tokens not owned by the current playerothers- tokens owned by any player, but not owned by the current playerany- tokens owned by any playernone- tokens not owned by any playersingle- tokens owned by a single playermultiple- tokens owned by more than one playerbyall- tokens owned by all playersnotbyall- tokens not owned by all players
visible- If the token is visible in the current client's view. Set totrue(1) orfalse(0).\- When the visible option is used only tokens on the TOKEN layer and which are shown within the client's current map view will be returned.
- This is not a test of whether or not other tokens on the map out of view are visible to a specific token. See canSeeToken().
- GMs will be able to see all tokens within the current map view. Players (including View as Player) will only get returned those tokens that are shown in their current map view. Tokens returned will also be affected by server settings like Individual Views.
layer- A JSON array of layer names, or a single layer name as a string. Only tokens on one of the listed layers will be returned. By default, tokens on the Token and Hidden layers are returned.mapName- The name of the map to get the tokens from. Defaults to the current map.range- A JSON object with range conditions, all range conditions are optional.\token- The id or name of the source token that the distance is measured from, defaults to the current token.\ @@ -11250,7 +11250,7 @@ The movement metric in range specifies the movement metric use, the metric can b [foreach(id, ids, "<br>"): id]
\- Find ALL the tokens on ALL the layers on the map:
[r:getTokens(",", json.set("{}", "layer", json.append("[]","TOKEN","HIDDEN","OBJECT","BACKGROUND")))]
\ -- Find and return a JSON Array containing all NPC tokens that are with 2 squares or hexes of the selected token:
- Find and return a JSON Array containing all NPC tokens that are with 2 squares or hexes of the selected token:
[h: cond = '{ "range": {"upto":2, "distancePerCell":0, "token":"' +getSelected()+ '"}, "npc":1}']\ [h: ids = getTokens("json", cond)]
\- Modifying the above example to exclude dead tokens:
- \
-
id- The token id of the token to check for the shape, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The token id of the token to check for the shape, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
Result
\ @@ -11370,7 +11370,7 @@ The function returns the token's shape as a string value:"TOP_DOWN"\ -getTokenStates.description = Returns the valid states in the campaign settings in either a String List or JSON Array . +getTokenStates.description = Returns the valid states in the campaign settings in either a String List or JSON Array . getTokenStates.summary = \\\ @@ -11379,7 +11379,7 @@ getTokenStates.summary = \ getTokenStates() Function\ \\ @@ -11503,7 +11503,7 @@ getTokenWidth(id, mapname)\ Parameters\ \• Introduced in version 1.3b51\ -Returns the valid states in the campaign settings in either a String List or JSON Array. Alternatively, if a token id is specified, instead returns the list of the states that are set to\ +true(1) for the token.Returns the valid states in the campaign settings in either a String List or JSON Array. Alternatively, if a token id is specified, instead returns the list of the states that are set to\true(1) for the token.\ Usage\
\ @@ -11396,21 +11396,21 @@ getTokenStates(delim, groupName, id, mapname)\- \
delim- Specifies the delimiter used in the string list that is returned, default is",". If the value is set tojson, the function returns a JSON array instead. \
groupName- Specifies the name of the group to get the states for. If set to "*", get all states. \
- id- The id of the token to get the states set totrue(1). If the parameter is not used, instead returns all valid states in the campaign settings.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The id of the token to get the states set totrue(1). If the parameter is not used, instead returns all valid states in the campaign settings.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map where the token is. Set to the current map by default. \
\ Example\
\ -To get a String List of the valid Token States in the campaign.\ +\To get a String List of the valid Token States in the campaign.\\\ -[h: states = getTokenStates()]
To get a JSON Array of the valid Token States in the campaign.\ +
To get a JSON Array of the valid Token States in the campaign.\
\\ -[h: states = getTokenStates("json")]To get a JSON Array of the valid Token States in the Damage group in the campaign in 1.3b55 or later.\ +
To get a JSON Array of the valid Token States in the Damage group in the campaign in 1.3b55 or later.\
\\ -[h: states = getTokenStates("json", "Damage")]To get a JSON Array of the Token States set to
true(1) for the "Dragon" token:\ +To get a JSON Array of the Token States set to
\true(1) for the "Dragon" token:\[h: states = getTokenStates("json", "*", "Dragon")]\ @@ -11439,7 +11439,7 @@ getTokenVBL.summary = \ \
\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.4.1.6\ @@ -11458,7 +11458,7 @@ getTokenVBL.summary = \ Parameters\ \- \
-
id- OPTIONAL: The tokenidof the token for which you want to get the VBL. Defaults to the Current Token. \
+ id- OPTIONAL: The tokenidof the token for which you want to get the VBL. Defaults to the Current Token. \
\ Example:\ @@ -11476,7 +11476,7 @@ getTokenVBL.summary = \
\ See Also\
\ - \ + \- \
-
id- The token id of the token to check for its width, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The token id of the token to check for its width, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\
Result
\ @@ -11563,7 +11563,7 @@ getTokenX(units, id, mapname)\- \
units- If set tofalse(0), the coordinate is a location on the grid in number of cells. Defaults totrue(1), where the coordinate is in number of Pixels (in other words 0:distance in cells, 1: distance in pixels)'. \
- id- The id of the token to move, defaults to the Current Token. \
+ id- The id of the token to move, defaults to the Current Token. \
mapname- The name of the map to find the token. Defaults to the current map. \
\ @@ -11595,13 +11595,13 @@ The exception to this is when the token is 'Freesize' AND 'Snapped to Grid' AND
\ Examples\
\ -Moves the Current Token down5units, and left10units.\ +Moves the Current Token down\ -getVisible.description = Returns5units, and left10units.\\ -[h: CurrentX = getTokenX()]\ [h: CurrentY = getTokenY()]\ [h: NewX = CurrentX + 5]\ [h: NewY = CurrentY - 10]\ [h: moveToken(NewX, NewY)]
Moves the Current Token down
5cells, and left10cells.\ +Moves the Current Token down
\5cells, and left10cells.\\[h: CurrentX = getTokenX(0)]\ [h: CurrentY = getTokenY(0)]\ @@ -11651,7 +11651,7 @@ getTokenY(units, id, mapname)
\ \- \
units- If set tofalse(0), the coordinate is a location on the grid in number of cells. Defaults totrue(1), where the coordinate is in number of Pixels (in other words 0:distance in cells, 1: distance in pixels)'. \
- id- The id of the token to move, defaults to the Current Token. \
+ id- The id of the token to move, defaults to the Current Token. \
mapname- The name of the map to find the token. Defaults to the current map. \
\ @@ -11683,13 +11683,13 @@ The exception to this is when the token is 'Freesize' AND 'Snapped to Grid' AND
\ Examples\
\ -Moves the Current Token down5units, and left10units.\ +Moves the Current Token down\ @@ -11875,7 +11875,7 @@ centerX=646; centerY=319,5units, and left10units.\\ -[h: CurrentX = getTokenX()]\ [h: CurrentY = getTokenY()]\ [h: NewX = CurrentX + 5]\ [h: NewY = CurrentY - 10]\ [h: moveToken(NewX, NewY)]
Moves the Current Token down
5cells, and left10cells.\ +Moves the Current Token down
\5cells, and left10cells.\\[h: CurrentX = getTokenX(0)]\ [h: CurrentY = getTokenY(0)]\ @@ -11725,7 +11725,7 @@ getVBL.summary = \ \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b90\ @@ -11764,7 +11764,7 @@ getVBL.summary = \\ See Also\
\ - \ + \true(1) if the visible to players flag is set on a Token otherwise returnsfalse(0). +getVisible.description = Returnstrue(1) if the visible to players flag is set on a Token otherwise returnsfalse(0). getVisible.summary = \\\ @@ -11884,7 +11884,7 @@ getVisible.summary = \ getVisible() Function\ \\ -getVisibleMapDisplayNames.description = Returns the display names of all of the player visible maps as either a String List or JSON Array . +getVisibleMapDisplayNames.description = Returns the display names of all of the player visible maps as either a String List or JSON Array . getVisibleMapDisplayNames.summary = \• Introduced in version 1.3b40\ -Returns\ +true(1) if the visible to players flag is set on a Token otherwise returnsfalse(0). The visible to players flag has two meanings, on a normal Token players will only be able to see the Token if it is set (when all other things like Fog of War etc are taken into account). If it is a Library Token then it determines if players can call Macros using [macro():].Returns\true(1) if the visible to players flag is set on a Token otherwise returnsfalse(0). The visible to players flag has two meanings, on a normal Token players will only be able to see the Token if it is set (when all other things like Fog of War etc are taken into account). If it is a Library Token then it determines if players can call Macros using [macro():].\ Usage\
\ @@ -11898,7 +11898,7 @@ getVisible.summary = \ Parameter\ \- \
-
id- The tokenidof token that has its player visibility checked, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidof token that has its player visibility checked, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
\
\ @@ -11921,7 +11921,7 @@ getVisible.summary = \\\ @@ -11930,7 +11930,7 @@ getVisibleMapDisplayNames.summary = \ getVisibleMapNames() Function\ \• Introduced in version 1.9.0\ -Returns the display names of all of the player visible maps as either a String List or JSON Array.\ +Returns the display names of all of the player visible maps as either a String List or JSON Array.\\ Usage\
\ @@ -11944,14 +11944,14 @@ getVisibleMapDisplayNames.summary = \ Parameters\ \- \
-
delim- The delimiter to use for the String List. If the value isjsonthen a JSON Array is returned. \
+ delim- The delimiter to use for the String List. If the value isjsonthen a JSON Array is returned. \
\ Examples\
\ -To get the display names of all of the player visible maps in a String List.\ +\ -getVisibleMapNames.description = Returns the names of all of the player visible maps as either a String List or JSON Array . +getVisibleMapNames.description = Returns the names of all of the player visible maps as either a String List or JSON Array . getVisibleMapNames.summary = \To get the display names of all of the player visible maps in a String List.\\\ -[h: maps = getVisibleMapNames()]
To get the display names of all of the player visible maps in a JSON Array\ +
To get the display names of all of the player visible maps in a JSON Array\
\[h: maps = getVisibleMapNames("json")]\ @@ -11965,7 +11965,7 @@ getVisibleMapDisplayNames.summary = \
\\ -isBarVisible.description = Returns\ @@ -11974,7 +11974,7 @@ getVisibleMapNames.summary = \ getVisibleMapNames() Function\ \\ \ @@ -13993,7 +13993,7 @@ This can simply be done with the• Introduced in version 1.3b55\ -Returns the names of all of the player visible maps as either a String List or JSON Array.\ +Returns the names of all of the player visible maps as either a String List or JSON Array.\\ Usage\
\ @@ -11988,14 +11988,14 @@ getVisibleMapNames.summary = \ Parameters\ \- \
-
delim- The delimiter to use for the String List. If the value isjsonthen a JSON Array is returned. \
+ delim- The delimiter to use for the String List. If the value isjsonthen a JSON Array is returned. \
\ Examples\
\ -To get the names of all of the player visible maps in a String List.\ +\ -getVisibleTokenNames.description = Returns a string list or JSON Array of Token:token names for the tokens that are visible to the player. +getVisibleTokenNames.description = Returns a string list or JSON Array of Token:token names for the tokens that are visible to the player. getVisibleTokenNames.summary = \To get the names of all of the player visible maps in a String List.\\\ -[h: maps = getVisibleMapNames()]
To get the names of all of the player visible maps in a JSON Array\ +
To get the names of all of the player visible maps in a JSON Array\
\[h: maps = getVisibleMapNames("json")]\ @@ -12009,7 +12009,7 @@ getVisibleMapNames.summary = \
\\ -indexKeyStrProp.description = Returns the key from the specified string property list at the specified index. +indexKeyStrProp.description = Returns the key from the specified string property list at the specified index. indexKeyStrProp.summary = \\ @@ -12018,8 +12018,8 @@ getVisibleTokenNames.summary = \ getVisibleTokenNames() Function\ \\• Introduced in version 1.3b49\ -Returns a string list or JSON Array of Token:token names for the tokens that are visible to the player. The type of the value returned depends on the delimiter parameter.\ -\ -getVisibleTokens.description = Returns a string list or JSON Array of token ids for the tokens that are visible to the player. +getVisibleTokens.description = Returns a string list or JSON Array of token ids for the tokens that are visible to the player. getVisibleTokens.summary = \- If the delimiter is not specified then a string list is returned with the default value of
","is used. - If the delimiter
jsonthen a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
Returns a string list or JSON Array of Token:token names for the tokens that are visible to the player. The type of the value returned depends on the delimiter parameter.\ +\- If the delimiter is not specified then a string list is returned with the default value of
","is used. - If the delimiter
jsonthen a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\ Usage\ @@ -12051,7 +12051,7 @@ getVisibleTokenNames.summary = \
\\\ @@ -12060,8 +12060,8 @@ getVisibleTokens.summary = \ getVisibleTokens() Function\ \\ +• Introduced in version 1.3b49\ -Returns a string list or JSON Array of token ids for the tokens that are visible to the player. The type of the value returned depends on the delimiter parameter.\ -\ -getWithState.description = Gets a list containing the ids of all the tokens on the current map that have the specified token state set. +getWithState.description = Gets a list containing the ids of all the tokens on the current map that have the specified token state set. getWithState.summary = \- If the delimiter is not specified then a string list is returned with the default value of
","is used. - If the delimiter
jsonthen a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
Returns a string list or JSON Array of token ids for the tokens that are visible to the player. The type of the value returned depends on the delimiter parameter.\ +\- If the delimiter is not specified then a string list is returned with the default value of
","is used. - If the delimiter
jsonthen a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\ Usage\ @@ -12098,7 +12098,7 @@ getVisibleTokens.summary = \
\\\ @@ -12108,12 +12108,12 @@ getWithState.summary = \ \\ @@ -13386,12 +13386,12 @@ impersonate.summary = \ \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b48\ -Gets a list containing the ids of all the tokens on the current map that have the specified token state set. The type of the value returned depends on the delimiter parameter.\ -\- If the delimiter is not specified then a string list is returned with the default value of
","is used. - If the delimiter
jsonthen a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
Gets a list containing the ids of all the tokens on the current map that have the specified token state set. The type of the value returned depends on the delimiter parameter.\ +\- If the delimiter is not specified then a string list is returned with the default value of
","is used. - If the delimiter
jsonthen a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\ Usage\ @@ -12127,7 +12127,7 @@ getWithState(state, delim)\
\ Example\
\ -You can use the following code to print out the ids of all of the tokens on the current map with the "Dead" token state set.\ +\ -getWithStateNames.description = Gets a list containing the names of all the tokens on the current map that have the specified token state set. +getWithStateNames.description = Gets a list containing the names of all the tokens on the current map that have the specified token state set. getWithStateNames.summary = \You can use the following code to print out the ids of all of the tokens on the current map with the "Dead" token state set.\\[h: ids = getWithState("Dead")]\ [foreach(id, ids, "<br>"): id]\ @@ -12145,7 +12145,7 @@ getWithState(state, delim)\
\\ @@ -13189,7 +13189,7 @@ hideTextLabels.summary = \ \\ @@ -12155,12 +12155,12 @@ getWithStateNames.summary = \ \\\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b48\ -Gets a list containing the names of all the tokens on the current map that have the specified token state set. The type of the value returned depends on the delimiter parameter.\ -\ -- If the delimiter is not specified then a string list is returned with the default value of
","is used. - If the delimiter
jsonthen a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
Gets a list containing the names of all the tokens on the current map that have the specified token state set. The type of the value returned depends on the delimiter parameter.\ +\- If the delimiter is not specified then a string list is returned with the default value of
","is used. - If the delimiter
jsonthen a JSON Array is returned. - Otherwise a string list is returned with the delimiter passed in.
\ Usage\ @@ -12174,7 +12174,7 @@ getWithStateNames(state, delim)\
\ \\ Example\
\ -You can use the following code to print out the names of all of the tokens on the current map with the "Dead" token state set.\ +\ -hasImpersonated.description = Returns 1 if there is an impersonated token otherwise returns 0. +hasImpersonated.description = Returns 1 if there is an impersonated token otherwise returns 0. hasImpersonated.summary = \You can use the following code to print out the names of all of the tokens on the current map with the "Dead" token state set.\\[h: names = getWithStateNames("Dead")]\ [foreach(name, names, "<br>"): name]\ @@ -12329,7 +12329,7 @@ gt.summary = \
\\ @@ -12624,7 +12624,7 @@ herolab.getImage.summary = \ \\ @@ -12338,7 +12338,7 @@ hasImpersonated.summary = \ hasImpersonated() Function\ \\ -hasLightSource.description = Returns 1 if the Current Token has any light sources that match the criteria passed in or 0 if there are no matches. +hasLightSource.description = Returns 1 if the Current Token has any light sources that match the criteria passed in or 0 if there are no matches. hasLightSource.summary = \• Introduced in version 1.3b48\ -Returns 1 if there is an impersonated token otherwise returns 0.\ +Returns 1 if there is an impersonated token otherwise returns 0.\\ Usage\
\ @@ -12349,7 +12349,7 @@ hasImpersonated.summary = \\\\ @@ -12358,7 +12358,7 @@ hasLightSource.summary = \ hasLightSource() Function\ \\ -hasMacro.description = Returns• Introduced in version 1.3b48\ -Returns 1 if the Current Token has any light sources that match the criteria passed in or 0 if there are no matches. If no arguments are passed to the function then it will return 1 if any light source is on. If only the first argument is passed it will return 1 if any light source of that light source type is on. If both arguments are passed to the function it will return 1 if the light source with the specified name and specified light source type is on.\ +Returns 1 if the Current Token has any light sources that match the criteria passed in or 0 if there are no matches. If no arguments are passed to the function then it will return 1 if any light source is on. If only the first argument is passed it will return 1 if any light source of that light source type is on. If both arguments are passed to the function it will return 1 if the light source with the specified name and specified light source type is on.\\ Usage\
\ @@ -12374,8 +12374,8 @@ hasLightSource(type, name, id, mapname)\ \- \
type- The light source type, (e.g. "Generic", "D20"). If "*" is entered, all light sources types are checked. Defaults to "*". \
- name- the name of the light source. If "*" is entered, all light sources names are checked. Defaults to "*". \
- id- The tokenidof the token which is checked for light sources, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ name- the name of the light source. If "*" is entered, all light sources names are checked. Defaults to "*". \
+ id- The tokenidof the token which is checked for light sources, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ @@ -12401,7 +12401,7 @@ hasLightSource(type, name, id, mapname)\
true(1) if a macro button with the specified label exists on the Current Token . +hasMacro.description = Returnstrue(1) if a macro button with the specified label exists on the Current Token . hasMacro.summary = \\\\ @@ -12410,7 +12410,7 @@ hasMacro.summary = \ hasMacro() Function\ \\ -hasProperty.description = Returns• Introduced in version 1.3b48\ - \ + \\ Usage\
\ @@ -12424,7 +12424,7 @@ hasMacro(label, id, mapname)\ \- \
label- The label of the macro to check for. \
- id- The tokenidof the token that the function is executed on.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidof the token that the function is executed on.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ @@ -12443,7 +12443,7 @@ hasMacro(label, id, mapname)\
true(1) if the Token Property with the specified name exists on a Token . +hasProperty.description = Returnstrue(1) if the Token Property with the specified name exists on a Token . hasProperty.summary = \\\ @@ -12609,7 +12609,7 @@ Returns a number than is between\ @@ -12452,7 +12452,7 @@ hasProperty.summary = \ hasProperty() Function\ \\ -hasSight.description = Returns 1 if the Current Token has sight . +hasSight.description = Returns 1 if the Current Token has sight . hasSight.summary = \• Introduced in version 1.3b48\ -Returns\ +true(1) if the Token Property with the specified name exists on a Token. The function will return true if the token possesses the specified property, even if that property is not defined in the token's current property type.Returns\true(1) if the Token Property with the specified name exists on a Token. The function will return true if the token possesses the specified property, even if that property is not defined in the token's current property type.\ Usage\
\ @@ -12465,8 +12465,8 @@ hasProperty(name, id, mapname)\ Parameters\ \- \
-
name- The name of the Token Property which is checked for on the token. \
- id- The tokenidof the token which is checked for the Token Property, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ name- The name of the Token Property which is checked for on the token. \
+ id- The tokenidof the token which is checked for the Token Property, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ @@ -12485,7 +12485,7 @@ hasProperty(name, id, mapname)\
\\\ @@ -12494,7 +12494,7 @@ hasSight.summary = \ hasSight() Function\ \\• Introduced in version 1.3b48\ -Returns 1 if the Current Token has sight.\ +Returns 1 if the Current Token has sight.\\ Usage\
\ @@ -12507,7 +12507,7 @@ hasSight(id, mapname)\ Parameters\ \- \
-
id- Theidof the token to return the sight. Defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- Theidof the token to return the sight. Defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ @@ -12566,7 +12566,7 @@ Returns a number than is between
\ +For another method of rolling dice, see Dice Expressions.5and50for the hero See Also\ \5and50for the hero See Also\ \ \ +For another method of rolling dice, see Dice Expressions.\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.5\ @@ -12658,7 +12658,7 @@ herolab.getImage(index, id)\ See Also\\ Version Changes\ @@ -12682,7 +12682,7 @@ herolab.getInfo.summary = \ \
\ \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.5\ @@ -12719,7 +12719,7 @@ herolab.getInfo(id,field)\ See Also\\ Version Changes\ @@ -12743,7 +12743,7 @@ herolab.getMasterName.summary = \ \
\ \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.5\ @@ -12775,7 +12775,7 @@ herolab.getMasterName(id)\ See Also\\ Version Changes\ @@ -12799,7 +12799,7 @@ herolab.getStatBlock.summary = \ \
\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.5\ @@ -12811,7 +12811,7 @@ herolab.getStatBlock.summary = \herolab.getStatBlock(type)\ herolab.getStatBlock(type,id)
\Note: The different formats may or may not contain the same information but it does reflects what is stored in the portfolio. If you find missing information, in the XML statblock for instance, you will need to report that to [Wolf Lair].\ +
Note: The different formats may or may not contain the same information but it does reflects what is stored in the portfolio. If you find missing information, in the XML statblock for instance, you will need to report that to [Wolf Lair].\
\\ Parameters\ @@ -12834,7 +12834,7 @@ herolab.getStatBlock(type,id)\ See Also\ \
\\ Version Changes\ @@ -12858,7 +12858,7 @@ herolab.hasChanged.summary = \ \
\ \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.5\ @@ -12890,7 +12890,7 @@ herolab.hasChanged(id)\ See Also\\ Version Changes\ @@ -12914,7 +12914,7 @@ herolab.isMinion.summary = \ \
\ \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.5\ @@ -12951,7 +12951,7 @@ herolab.isMinion(id)\ See Also\\ Version Changes\ @@ -12975,7 +12975,7 @@ herolab.refresh.summary = \ \
\ \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.5\ @@ -13009,7 +13009,7 @@ herolab.refresh(id)\ See Also\\ Version Changes\ @@ -13033,7 +13033,7 @@ herolab.XPath.summary = \ \
\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.5.0\ @@ -13058,7 +13058,7 @@ herolab.XPath(XPath, id, "json")\- \
XPath- The XPath expression to evaluate against the XML statblock. \
id- The id of the token. Defaults to the Current Token. \
- delim- Coming in 1.8. Custom delimiter for the returned results. Defaults to", ". If equal to"json", a JSON Array will be returned instead of a String List. \
+ delim- Coming in 1.8. Custom delimiter for the returned results. Defaults to", ". If equal to"json", a JSON Array will be returned instead of a String List. \
Returns the requested data.\
\ @@ -13073,7 +13073,7 @@ herolab.XPath(XPath, id, "json")\ \\Human Neutral Good 1
Changes Coming in 1.8
\ -Sometimes the data desired from herolab contains commas or is otherwise incompatible with the String List format and default (comma) separator. In the following example, the list of spells retrieved includes one called "Delay Poison, Communal" - as we see in the default output, this element would be incompatible with the standard String List format.\ +
Sometimes the data desired from herolab contains commas or is otherwise incompatible with the String List format and default (comma) separator. In the following example, the list of spells retrieved includes one called "Delay Poison, Communal" - as we see in the default output, this element would be incompatible with the standard String List format.\
\\[h: vXPath = "/document/public/character/spellsmemorized/spell[contains(@name,'De')]/@name"]\ Default: [r: herolab.XPath(vXPath)]<br />\ @@ -13094,7 +13094,7 @@ When dealing with more complicated text elements with potential delimiter confli See Also\ \ \\ Version Changes\ @@ -13149,7 +13149,7 @@ Returns a number than is between
\ \ +For another method of rolling dice, see Dice Expressions.5and50for the hero See Also\• Introduced in version 1.6\• Last checked for compatibility with version 1.6\ -Disables the display of Text Labels if they are not showing. This can also be set in the View menu.\ +Disables the display of Text Labels if they are not showing. This can also be set in the View menu.\\ Usage\
\ @@ -13300,7 +13300,7 @@ This function doesn't have the parentheses limit that the roll option has:\ Parameters\ \- \
-
condition- What is tested to determine is thetrueExprorfalseExprwill be executed. This follows the standard rules for conditions that can be found in the Branching and Looping article. \
+ condition- What is tested to determine is thetrueExprorfalseExprwill be executed. This follows the standard rules for conditions that can be found in the Branching and Looping article. \
trueExpr- A section of code that is returned ifconditionistrue(1). \
falseExpr- A section of code that is returned ifconditionisfalse(0). \
- \
- Returns:
propertyset to0\
Example 5: Usually its better to use the roll option version [if():]. Sometimes it's pretty handy to use the version documented here, since you can easily embed it in loops and expressions.\ +
\
Example 5: Usually its better to use the roll option version [if():]. Sometimes it's pretty handy to use the version documented here, since you can easily embed it in loops and expressions.\Let's say you want to check if one of a player's tokens has Initiative, you could do it this like this:\
\ @@ -13371,7 +13371,7 @@ This function doesn't have the parentheses limit that the roll option has:\\ See Also\
\ - \ + \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.7.0\• Last checked for compatibility with version 1.7.0\ -Impersonate changes the impersonated token for the client running the function, replacing any current impersonation. Rather than being used like switchToken() to aid in macro execution, this function is the same as right-clicking a token and selecting 'Impersonate'. The function does not set the Current Token. Use switchToken() for that.\ +Impersonate changes the impersonated token for the client running the function, replacing any current impersonation. Rather than being used like switchToken() to aid in macro execution, this function is the same as right-clicking a token and selecting 'Impersonate'. The function does not set the Current Token. Use switchToken() for that.\\ Usage\
\ @@ -13413,7 +13413,7 @@ Nice weather, eh?<br>\ Seen any dragons?Output:\
\ -\ See Also\
\ @@ -13430,7 +13430,7 @@ Seen any dragons?\\ -indexValueStrProp.description = Returns the value from the specified string property list at the specified index. +indexValueStrProp.description = Returns the value from the specified string property list at the specified index. indexValueStrProp.summary = \\ @@ -13439,7 +13439,7 @@ indexKeyStrProp.summary = \ indexKeyStrProp() Function\ \\• Introduced in version 1.3b42\ -Returns the key from the specified string property list at the specified index. The index for the string property list starts at 0.\ +Returns the key from the specified string property list at the specified index. The index for the string property list starts at 0.\\ Usage\
\ @@ -13485,7 +13485,7 @@ Returns -1.\\ -initiativeSize.description = Returns the number of tokens in the initiative panel +initiativeSize.description = Returns the number of tokens in the initiative panel initiativeSize.summary = \\ @@ -13494,7 +13494,7 @@ indexValueStrProp.summary = \ indexValueStrProp() Function\ \\• Introduced in version 1.3b42\ -Returns the value from the specified string property list at the specified index. The index for the string property list starts at 0.\ +Returns the value from the specified string property list at the specified index. The index for the string property list starts at 0.\\ Usage\
\ @@ -13510,7 +13510,7 @@ Returns "doh".\\ \ @@ -13967,7 +13967,7 @@ This can simply be done with the\ @@ -13518,7 +13518,7 @@ initiativeSize.summary = \ \ initiativeSize() Function\ \ -\ -Returns the number of tokens in the initiative panel\ +Returns the number of tokens in the initiative panel\\ Usage\
\ @@ -13560,7 +13560,7 @@ Note that there are no built-in mechanisms for input validation forTEXTParameters\ \- \
-
inputField- A string containing various 'sub-parameters' that set the type and options of eachinputField; requires at least oneinputFieldbut will accept a reasonably large amount. TheinputFields 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. \
+ inputField- A string containing various 'sub-parameters' that set the type and options of eachinputField; requires at least oneinputFieldbut will accept a reasonably large amount. TheinputFields 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
\ @@ -13610,7 +13610,7 @@ Note that there are no built-in mechanisms for input validation forinputFieldin the following manner:\TEXTICONSIZE=nnn- The size the icons; defaults toICONSIZE=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 toTEXT=TRUE, and is ignored if no icon is set.SPAN=TRUE- Causes thepromptto be hidden and allows theinputFieldto span the width of the dialog; defaults toSPAN=FALSE. If hidden theprompttext is used as a tooltip.DELIMITER=,- The delimiter used in the list; defaults to the comma,. The delimiter cannot contain empty spaces. If set toJSON, a JSON Array should be provided instead.DELIMITER=,- The delimiter used in the list; defaults to the comma,. The delimiter cannot contain empty spaces. If set toJSON, a JSON Array should be provided instead.
\\ @@ -13638,7 +13638,7 @@ Note that there are no built-in mechanisms for input validation for
\ -TEXTSELECT=nnn- Sets the initially selected radio button (the first item is number0); defaults toSELECT=0.\VALUE=STRING- The variable is assigned the string contents of the selected item instead of the index; defaults toVALUE=NUMBER.SPAN=TRUE- Causes thepromptto be hidden and allows theinputFieldto span the width of the dialog; defaults toSPAN=FALSE. If hidden theprompttext is used as title placed in the border of the radio button group.DELIMITER=,- The delimiter used in the list; defaults to the comma,. The delimiter cannot contain empty spaces. If set toJSON, a JSON Array should be provided instead.DELIMITER=,- The delimiter used in the list; defaults to the comma,. The delimiter cannot contain empty spaces. If set toJSON, a JSON Array should be provided instead.\
\ @@ -13662,14 +13662,14 @@ Note that there are no built-in mechanisms for input validation forTEXT\ PROPS\Creates a bordered sub-area containing multiple text boxes, one for each entry in a String Property List stored in
value. ThevariableNameis assigned a new string property containing all the entries with their updated values.\ +Creates a bordered sub-area containing multiple text boxes, one for each entry in a String Property List stored in
\value. ThevariableNameis 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 toSETVARS=NONE. \
- SETVARS=UNSUFFIXED- Makes variable assignments to unmodified variable names.SUFFIXEDis usually preferred, unless you are not using variable names that match Token Properties or if you specifically intend to overwrite them. \
+ SETVARS=UNSUFFIXED- Makes variable assignments to unmodified variable names.SUFFIXEDis usually preferred, unless you are not using variable names that match Token Properties or if you specifically intend to overwrite them. \
SPAN=TRUE- Causes thepromptto be hidden and allows theinputFieldto span the width of the dialog; defaults toSPAN=FALSE. If hidden theprompttext is used as title placed in the border of thePROPSgroup. \
WIDTH=nnn- Sets the width of the input box; defaults toWIDTH=14. \
TYPE=JSON- Result returned invariableNamewill be a JSON object instead of string property. \
@@ -13678,7 +13678,7 @@ Note that there are no built-in mechanisms for input validation for
TEXT\ TAB\ \ -Creates a tab for a tabbed dialog box. The
variableNamevariable 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 firstinputFieldmust be aTAB.\ +Creates a tab for a tabbed dialog box. The
\variableNamevariable 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 firstinputFieldmust be aTAB.\\ TAB Options\ @@ -13709,7 +13709,7 @@ Note that there are no built-in mechanisms for input validation for
TEXTDisplays:\ \ \ @@ -13732,7 +13732,7 @@ Note that there are no built-in mechanisms for input validation forTEXTDisplays:\ \ \ @@ -13752,11 +13752,11 @@ Note that there are no built-in mechanisms for input validation forTEXTDisplays:\ \ \ -Note that the
promptsection for each list contains a list of items, or a variable containing a String List (e.g., the variableimgList). In the first list, theICONandICONSIZEoptions are set, because that list contains image asset URLs for token images. In the second two lists, theVALUE=STRINGoption 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.\ +Note that the
\promptsection for each list contains a list of items, or a variable containing a String List (e.g., the variableimgList). In the first list, theICONandICONSIZEoptions are set, because that list contains image asset URLs for token images. In the second two lists, theVALUE=STRINGoption 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.\\ Input using using the DELIMITER option for LIST.\ @@ -13791,7 +13791,7 @@ You chose: [r: color] [r: meat] with [r: sauce]\ inptext\ )]\
In this example, variables
SPD1-SPD9andCMSLare 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.\ +In this example, variables
\SPD1-SPD9andCMSLare 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. Dynamic Variable Example, by aliasmask. Uses strformat to create the property names and json.evaluate to put in default values.\ @@ -13916,7 +13916,7 @@ If you really want to go full monty on the tooltip INSIDE the input, here's an e This is the result:\
\ \ @@ -13942,7 +13942,7 @@ This can simply be done with the<html><img>tags. Howe[h:input("junk|<html><img src='"+replace(getTokenHandout(), ":", ":")+"' height=90 width=90></img></html>|-|LABEL|SPAN=TRUE")]\<html><img>tags. Howe [r,token(me), if(picChoice == 2): "<img src='"+getTokenHandout(picSize)+"'></img>"]\<html><img>tags. Howetrue(1) if the specified Token Bar on the Current Token is visible, orfalse(0) if it is not. +isBarVisible.description = Returnstrue(1) if the specified Token Bar on the Current Token is visible, orfalse(0) if it is not. isBarVisible.summary = \\\ -isNPC.description = Returns\ @@ -14002,7 +14002,7 @@ isBarVisible.summary = \ isBarVisible() Function\ \\ @@ -14220,7 +14220,7 @@ isGm.summary = \• Introduced in version 1.3b46\ -Returns\ +true(1) if the specified Token Bar on the Current Token is visible, orfalse(0) if it is not.Returns\true(1) if the specified Token Bar on the Current Token is visible, orfalse(0) if it is not.\ Usage\
\ @@ -14016,7 +14016,7 @@ isBarVisible(bar, id, mapname)\ \- \
bar- A string that contains the name of the bar that has its visibility checked. \
- id- The tokenidof the token which has its bar checked, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidof the token which has its bar checked, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ @@ -14052,10 +14052,10 @@ isBarVisible(bar, id, mapname)\ \
- \
- \ - HP and Health Bars\ + HP and Health Bars\ \
- \
- The
bar.namespecial variable\ + Thebar.namespecial variable\ \
true(1) if a Token is a NPC orfalse(0) if it is not. +isNPC.description = Returnstrue(1) if a Token is a NPC orfalse(0) if it is not. isNPC.summary = \\\ @@ -14229,7 +14229,7 @@ isNPC.summary = \ isNPC() Function\ \• Introduced in version 1.3b48\ - \ + \\ Usage\
\ @@ -14242,7 +14242,7 @@ isNPC(id, mapname)\ Parameter\ \- \
-
id- The tokenidof the token which has its NPC status checked, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidof the token which has its NPC status checked, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ @@ -14313,7 +14313,7 @@ This function will return 1 even if a registered overlay is hidden using the
\ -isOwnedByAll.description = Returns true(1) if a Token has the Owned by All check box checked. +isOwnedByAll.description = Returnstrue(1) if a Token has the Owned by All check box checked. isOwnedByAll.summary = \\\ @@ -14322,7 +14322,7 @@ isOwnedByAll.summary = \ isOwnedByAll() Function\ \• Introduced in version 1.3b48\ - \ + \\ Usage\
\ @@ -14335,13 +14335,13 @@ isOwnedByAll(id, mapname)\ Parameter\ \- \
-
id- The tokenidof the token which has its Owned by All status checked, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidof the token which has its Owned by All status checked, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ Example\
\ -Returns\ -isOwner.description = ReturnsAnyone can edit meif the Current Token has the Owned by All check box checked.\ +Returns\Anyone can edit meif the Current Token has the Owned by All check box checked.\[r, if(isOwnedByAll()): "Anyone can edit me"]
\ See Also\ @@ -14361,7 +14361,7 @@ isOwnedByAll(id, mapname)\
true(1) if the given Player is an owner of a specific Token . +isOwner.description = Returnstrue(1) if the given Player is an owner of a specific Token . isOwner.summary = \\\ @@ -14370,7 +14370,7 @@ isOwner.summary = \ isOwner() Function\ \• Introduced in version 1.3b48\ - \ + \\ Usage\
\ @@ -14384,16 +14384,16 @@ isOwner(player, id, mapname)\ Parameters\ \- \
-
player- The name of the player to check for ownership, defaults to the Current Player. \
- id- The tokenidof the token which is checked for ownership, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ player- The name of the player to check for ownership, defaults to the Current Player. \
+ id- The tokenidof the token which is checked for ownership, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ Examples\
\ -Returns\ -isPC.description = ReturnsYou can edit me.if the Current Player is an owner of the Current Token.\ +Returns\ @@ -14415,7 +14415,7 @@ isOwner(player, id, mapname)\You can edit me.if the Current Player is an owner of the Current Token.\\ -[r, if(isOwner()): "You can edit me."]
Returns
Azhrei can edit me.if the given Player is an owner of the given Token.\ +Returns
\Azhrei can edit me.if the given Player is an owner of the given Token.\[h: id = getSelected() ]\ [r, if(isOwner("Azhrei", id)): "Azhrei can edit me."]true(1) if a Token is a PC orfalse(0) if it is not. +isPC.description = Returnstrue(1) if a Token is a PC orfalse(0) if it is not. isPC.summary = \\\ @@ -14424,7 +14424,7 @@ isPC.summary = \ isPC() Function\ \\ -isPropertyEmpty.description = Returns• Introduced in version 1.3b48\ - \ + \\ Usage\
\ @@ -14437,7 +14437,7 @@ isPC(id, mapname)\ Parameter\ \- \
-
id- The tokenidof the token which has its PC status checked, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidof the token which has its PC status checked, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ @@ -14467,7 +14467,7 @@ isPC(id, mapname)\
true(1) if the Token Property for a specific Token is empty. +isPropertyEmpty.description = Returnstrue(1) if the Token Property for a specific Token is empty. isPropertyEmpty.summary = \\\ @@ -14476,7 +14476,7 @@ isPropertyEmpty.summary = \ isPropertyEmpty() Function\ \• Introduced in version 1.3b48\ -Returns\ -isSnapToGrid.description = Returnstrue(1) if the Token Property for a specific Token is empty. A Token Property is considered empty if it isNULL; if an empty string ("") has been assigned to it, it is not considered empty.\ +Returns\true(1) if the Token Property for a specific Token is empty. A Token Property is considered empty if it isNULL; if an empty string ("") has been assigned to it, it is not considered empty.\ Note: If the token type sets a default value, this function will still see the property as empty. Try using json.isEmpty().\ Usage\ @@ -14491,7 +14491,7 @@ isPropertyEmpty(property, id, mapname)\ \
- \
property- The name of the property that has its value checked. \
- id- The tokenidof the token that has its value checked, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidof the token that has its value checked, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ @@ -14522,7 +14522,7 @@ isPropertyEmpty(property, id, mapname)\
true(1) if a Token is snapped to grid orfalse(0) if it is not. +isSnapToGrid.description = Returnstrue(1) if a Token is snapped to grid orfalse(0) if it is not. isSnapToGrid.summary = \\\ @@ -14531,7 +14531,7 @@ isSnapToGrid.summary = \ isSnapToGrid() Function\ \\ -isTrusted.description = Returns 1 if this is running as a trusted macro or 0 if it is not. +isTrusted.description = Returns 1 if this is running as a trusted macro or 0 if it is not. isTrusted.summary = \• Introduced in version 1.3b69\ - \ + \\ Usage\
\ @@ -14544,7 +14544,7 @@ isSnapToGrid(id, mapname)\ Parameter\ \- \
-
id- The tokenidof the token which has its snapToGrid status checked, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidof the token which has its snapToGrid status checked, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ @@ -14571,7 +14571,7 @@ isSnapToGrid(id, mapname)\
\\ @@ -14580,7 +14580,7 @@ isTrusted.summary = \ isTrusted() Function\ \\ -json.append.description = Appends values to the end of a JSON Array . +json.append.description = Appends values to the end of a JSON Array . json.append.summary = \• Introduced in version 1.3b48\ -Returns 1 if this is running as a trusted macro or 0 if it is not.\ +Returns 1 if this is running as a trusted macro or 0 if it is not.\\ Usage\
\ @@ -14623,7 +14623,7 @@ isVisible(x,y,id)\- \
x- Then tokens x coordinate. Always in map units, not grid . \
y- Then tokens x coordinate. Always in map units, not grid . \
- id- The check for visibility is performed from tokenid.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The check for visibility is performed from tokenid.Note: This parameter can only be used in a Trusted Macro.
\
\ Example\ @@ -14655,7 +14655,7 @@ isVisible(x,y,id)\
\\ @@ -14664,7 +14664,7 @@ json.append.summary = \ json.append() Function\ \\ -json.contains.description = Returns• Introduced in version 1.3b49\ -Appends values to the end of a JSON Array. An empty string ("") can be used to represent an empty JSON Array to append the values to.\ +Appends values to the end of a JSON Array. An empty string ("") can be used to represent an empty JSON Array to append the values to.\\ Usage\
\ @@ -14690,7 +14690,7 @@ json.append.summary = \true(1) if the JSON Object contains the specified key, or if the JSON Array contains the specified value. +json.contains.description = Returnstrue(1) if the JSON Object contains the specified key, or if the JSON Array contains the specified value. json.contains.summary = \\\ @@ -14699,7 +14699,7 @@ json.contains.summary = \ json.contains() Function\ \\ -json.count.description = Returns the number of occurrences of a value in a JSON Array . +json.count.description = Returns the number of occurrences of a value in a JSON Array . json.count.summary = \• Introduced in version 1.3b49\ -Returns\ +true(1) if the JSON Object contains the specified key, or if the JSON Array contains the specified value.Returns\true(1) if the JSON Object contains the specified key, or if the JSON Array contains the specified value.\ Usage\
\ @@ -14713,24 +14713,24 @@ json.contains.summary = \ Parameters\ \- \
-
object- The JSON Object to test for the key. \
+ object- The JSON Object to test for the key. \
key- The key to check the object for. \
- array- The JSON Array to test for the value. \
+ array- The JSON Array to test for the value. \
value- The value to check the array for. \
\ Examples\
\ -Check if the JSON Object\acontains the key"b":\ +Check if the JSON Object\ \acontains the key"b":\\[h:a=json.fromStrProp("a=1;b=44;c=12")]\ [json.contains(a,"b")]Returns
true(1)\ -Check if the JSON Object
acontains the key"z":\ +Check if the JSON Object
\acontains the key"z":\\[h:a=json.fromStrProp("a=1;b=44;c=12")]\ [json.contains(a,"z")]Returns
false(0)\ -Check if the JSON Array
acontains the value"b":\ +Check if the JSON Array
\acontains the value"b":\\ @@ -14746,14 +14746,14 @@ Returns[h:a=json.fromList("1,b,3,d")]\ [json.contains(a,"b")]true(1)\\- \
-
- 1.3b51 - Added ability for function to work with JSON Arrays. \ +
- 1.3b51 - Added ability for function to work with JSON Arrays. \
\\ -json.difference.description = Returns an array with the differences of all of the JSON Object keys, or JSON Array values. +json.difference.description = Returns an array with the differences of all of the JSON Object keys, or JSON Array values. json.difference.summary = \\ @@ -14762,7 +14762,7 @@ json.count.summary = \ json.count() Function\ \\• Introduced in version 1.3b53\ -Returns the number of occurrences of a value in a JSON Array. If the value does not occur in the JSON Array then\ +0is returned. The index for the JSON Array starts at0.Returns the number of occurrences of a value in a JSON Array. If the value does not occur in the JSON Array then\0is returned. The index for the JSON Array starts at0.\ Usage\
\ @@ -14776,7 +14776,7 @@ json.count.summary = \ Parameters\ \- \
-
array- The JSON Array to search. \
+ array- The JSON Array to search. \
value- The value to count the occurrences of. \
start- The index to start searching from, if not specified it defaults to0. \
2\\ @@ -14809,7 +14809,7 @@ json.difference.summary = \ json.difference() Function\ \\ -json.fields.description = Returns the fields (keys) for a JSON Object or the indexes for a JSON Array as a string list. +json.fields.description = Returns the fields (keys) for a JSON Object or the indexes for a JSON Array as a string list. json.fields.summary = \• Introduced in version 1.3b53\ -Returns an array with the differences of all of the JSON Object keys, or JSON Array values. Output contains keys or values which exist in the first parameter, but do not exist in any others.\ +Returns an array with the differences of all of the JSON Object keys, or JSON Array values. Output contains keys or values which exist in the first parameter, but do not exist in any others.\\ Usage\
\ @@ -14823,8 +14823,8 @@ json.difference.summary = \ Parameter\ \- \
-
array- A JSON Array to get the difference of. \
- object- A JSON Object to get the difference of. \
+ array- A JSON Array to get the difference of. \
+ object- A JSON Object to get the difference of. \
\ Example\ @@ -14882,7 +14882,7 @@ json.evaluate.summary = \ \
\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b51\ @@ -14924,7 +14924,7 @@ json.evaluate.summary = \\\ @@ -14933,8 +14933,8 @@ json.fields.summary = \ json.fields() Function\ \\ -json.fromList.description = Returns a JSON Array from a String List . +json.fromList.description = Returns a JSON Array from a String List . json.fromList.summary = \• Introduced in version 1.3b49\ -Returns the fields (keys) for a JSON Object or the indexes for a JSON Array as a string list. The type of the value returned depends on the delimiter parameter.\ -Note: Because JSON Objects are unordered, json.fields will not reflect the order they were set in.\ +Returns the fields (keys) for a JSON Object or the indexes for a JSON Array as a string list. The type of the value returned depends on the delimiter parameter.\ +Note: Because JSON Objects are unordered, json.fields will not reflect the order they were set in.\\ Usage\
\ @@ -14949,7 +14949,7 @@ json.fields.summary = \ \- \
delim=\ -unspecified: a standard string list is returned, with its default","delimiter."json": a JSON Array is returned."x": a string list is returned with"x"used as a delimiter.
\
+unspecified: a standard string list is returned, with its default","delimiter."json": a JSON Array is returned."x": a string list is returned with"x"used as a delimiter.
\ Example\ @@ -14968,7 +14968,7 @@ json.fields.summary = \
\\ -json.fromStrProp.description = Creates a json object from a string property list . +json.fromStrProp.description = Creates a json object from a string property list . json.fromStrProp.summary = \\ @@ -14977,7 +14977,7 @@ json.fromList.summary = \ json.fromList() Function\ \\• Introduced in version 1.3b49\ -Returns a JSON Array from a String List.\ +Returns a JSON Array from a String List.\\ Usage\
\ @@ -14991,8 +14991,8 @@ json.fromList.summary = \ Parameters\ \- \
-
strList- The String List that is converted to a JSON Array. \
- delim- The delimiter used in the String List, defaults to",". \
+ strList- The String List that is converted to a JSON Array. \
+ delim- The delimiter used in the String List, defaults to",". \
\ Example\ @@ -15009,7 +15009,7 @@ Returns
["a",1,"g",4]\\ @@ -15018,7 +15018,7 @@ json.fromStrProp.summary = \ json.fromStrProp() Function\ \\ -json.get.description = Returns the value in a JSON Array at the specified index, returns a slice of a JSON Array from the specified indexes, or returns the value from JSON Object for the specified key. +json.get.description = Returns the value in a JSON Array at the specified index, returns a slice of a JSON Array from the specified indexes, or returns the value from JSON Object for the specified key. json.get.summary = \• Introduced in version 1.3b49\ -Creates a json object from a string property list.\ +Creates a json object from a string property list.\\ Usage\
\ @@ -15043,7 +15043,7 @@ json.fromStrProp(propList,delim)\\\ -json.indexOf.description = Returns the index of the first occurrence of a value in the JSON Array . +json.indexOf.description = Returns the index of the first occurrence of a value in the JSON Array . json.indexOf.summary = \\ @@ -15052,7 +15052,7 @@ json.get.summary = \ json.get() Function\ \\ @@ -15165,7 +15165,7 @@ Formatting will not appear unless the function is surrounded by the "pre" html t• Introduced in version 1.3b49\ -Returns the value in a JSON Array at the specified index, returns a slice of a JSON Array from the specified indexes, or returns the value from JSON Object for the specified key.\ +Returns the value in a JSON Array at the specified index, returns a slice of a JSON Array from the specified indexes, or returns the value from JSON Object for the specified key.\\ Usage\
\ @@ -15069,12 +15069,12 @@ json.get.summary = \ Parameters\ \- \
-
array- The JSON Array to retrieve the element from. \
+ array- The JSON Array to retrieve the element from. \
index- The numerical index of the element you want returned. \
start- The starting index of the element you wish the slice to begin at. \
end- The ending index of the element you wish the slice to end at. \
- object- The JSON Object to retrieve the element from. \
- key- The name of a field that should be returned. This parameter can exist more than once, if it does then a JSON Object is returned with all the specified elements. \
+ object- The JSON Object to retrieve the element from. \
+ key- The name of a field that should be returned. This parameter can exist more than once, if it does then a JSON Object is returned with all the specified elements. \
When extracting slices:
\ Negative numbers can be used as the offsets from the end of the array.-1is the last element in the array,-2is the second to last, and so on. If the element specified by thestartindex and the element specified by theendindex are located in reverse order inarray(so reading from left to rightendcomes beforestart), then the array slice is returned in reverse order compared toarray(because fetching fromstarttoendmeans reading backwards).
\ @@ -15126,8 +15126,8 @@ ERROR b) -- java.lang.ArrayIndexOutOfBoundsException, the last valid index is 2\ \\\- \
-
- 1.3b51 - Added ability to return JSON Array slices. \ -
- 1.3b51 - Added ability to return JSON Objects of select fields from other JSON Objects. \ +
- 1.3b51 - Added ability to return JSON Array slices. \ +
- 1.3b51 - Added ability to return JSON Objects of select fields from other JSON Objects. \
\\ -json.intersection.description = Returns a JSON Array with the intersection of all of the JSON Object keys or JSON Array values. +json.intersection.description = Returns a JSON Array with the intersection of all of the JSON Object keys or JSON Array values. json.intersection.summary = \\ @@ -15174,7 +15174,7 @@ json.indexOf.summary = \ json.indexOf() Function\ \\• Introduced in version 1.3b53\ -Returns the index of the first occurrence of a value in the JSON Array. If the value does not exist in the JSON Array then\ +-1is returned. All JSON Array indexes start at0.Returns the index of the first occurrence of a value in the JSON Array. If the value does not exist in the JSON Array then\-1is returned. All JSON Array indexes start at0.\ Usage\
\ @@ -15188,8 +15188,8 @@ json.indexOf.summary = \ Parameters\ \- \
-
array- The JSON Array to search. \
- value- The value to find the index of in the JSON Array. \
+ array- The JSON Array to search. \
+ value- The value to find the index of in the JSON Array. \
start- The index to start searching from, if not specified it defaults to0. \
\ @@ -15228,7 +15228,7 @@ Returns:
2\\ @@ -15237,7 +15237,7 @@ json.intersection.summary = \ json.intersection() Function\ \• Introduced in version 1.3b53\ -Returns a JSON Array with the intersection of all of the JSON Object keys or JSON Array values. A value or key only appears in the output if it exists in all input arrays or objects.\ +\ -json.isSubset.description = ReturnsReturns a JSON Array with the intersection of all of the JSON Object keys or JSON Array values. A value or key only appears in the output if it exists in all input arrays or objects.\ This function is useful for removing Token IDs from a saved list which have been deleted from the map by eliminating them using this function, the saved array and getTokens().\\ Usage\ @@ -15252,8 +15252,8 @@ This function is useful for removing Token IDs from a saved list which have been Parameters\ \
- \
-
array- A JSON Array used in the intersection. \
- object- A JSON Object used in the intersection. \
+ array- A JSON Array used in the intersection. \
+ object- A JSON Object used in the intersection. \
\ Examples\ @@ -15306,7 +15306,7 @@ json.isEmpty.summary = \
true(1) if all of the JSON Object keys or JSON Array values are contained within the first JSON Object or JSON Array . +json.isSubset.description = Returnstrue(1) if all of the JSON Object keys or JSON Array values are contained within the first JSON Object or JSON Array . json.isSubset.summary = \\\ @@ -15315,7 +15315,7 @@ json.isSubset.summary = \ json.isSubset() Function\ \\ -json.length.description = Returns the number of fields in a json object or number of elements in a json array . +json.length.description = Returns the number of fields in a json object or number of elements in a json array . json.length.summary = \• Introduced in version 1.3b53\ -Returns\ +true(1) if all of the JSON Object keys or JSON Array values are contained within the first JSON Object or JSON Array.Returns\true(1) if all of the JSON Object keys or JSON Array values are contained within the first JSON Object or JSON Array.\ Usage\
\ @@ -15329,10 +15329,10 @@ json.isSubset.summary = \ Parameters\ \- \
-
firstArray- The JSON Array that must contain all of the values of the subsequent JSON Arrays for this function to returntrue(1). \
- array- A JSON Array with values that are tested to be within thefirstArray. \
- firstObject- The JSON Object that must contain all of the keys of the subsequent JSON Objects for this function to returntrue(1). \
- object- A JSON Object with keys that are tested to be within thefirstObject. \
+ firstArray- The JSON Array that must contain all of the values of the subsequent JSON Arrays for this function to returntrue(1). \
+ array- A JSON Array with values that are tested to be within thefirstArray. \
+ firstObject- The JSON Object that must contain all of the keys of the subsequent JSON Objects for this function to returntrue(1). \
+ object- A JSON Object with keys that are tested to be within thefirstObject. \
\
\ @@ -15347,7 +15347,7 @@ json.isSubset.summary = \\\ -json.path.add.description = Add an element to a nested JSON Array . +json.path.add.description = Add an element to a nested JSON Array . json.path.add.summary = \\ @@ -15356,7 +15356,7 @@ json.length.summary = \ json.length() Function\ \\ -json.merge.description = Merges multiple JSON Arrays or JSON Objects . +json.merge.description = Merges multiple JSON Arrays or JSON Objects . json.merge.summary = \• Introduced in version 1.3b49\ -Returns the number of fields in a json object or number of elements in a json array.\ +Returns the number of fields in a json object or number of elements in a json array.\\ Usage\
\ @@ -15381,7 +15381,7 @@ json.length.summary = \\\\ @@ -15390,10 +15390,10 @@ json.merge.summary = \ json.merge() Function\ \\ @@ -15536,12 +15536,12 @@ json.objrolls.summary = \• Introduced in version 1.3b53\ -Merges multiple JSON Arrays or JSON Objects.\ -\For JSON Arrays the value returned is that of all the JSON Arrays concatenated together.\ +
Merges multiple JSON Arrays or JSON Objects.\ +\ +For JSON Objects the value returned is a JSON Object with all of the keys from all of the JSON Objects set, if any key is specified in more than one JSON Object then the value for the last specified JSON Object is used.For JSON Arrays the value returned is that of all the JSON Arrays concatenated together.\
\ -For JSON Objects the value returned is a JSON Object with all of the keys from all of the JSON Objects set, if any key is specified in more than one JSON Object then the value for the last specified JSON Object is used.\ Usage\
\ @@ -15407,20 +15407,20 @@ For Parameters\ \- \
-
array- A JSON Array. \
- object- A JSON Object. \
+ array- A JSON Array. \
+ object- A JSON Object. \
\ Examples\
\ -Merge three JSON Arrays:\ +\ \Merge three JSON Arrays:\\ @@ -15433,7 +15433,7 @@ Returns:\[r: json.merge("[1,2]", "[3,4]", "[1,2]")]Returns:
[1,2,3,4,1,2]\ -Merge two JSON Objects with no matching keys:\ +
Merge two JSON Objects with no matching keys:\
\\[r: json.merge("{a:1, b:2}", "{c:10, d:7}")]Returns:
{"a":1,"b":2,"c":10,"d":7}\ -Merge three JSON Objects with a matching key,
a:\ +Merge three JSON Objects with a matching key,
\a:\\ Returns:[r: json.merge("{a:1, b:2}", "{c:10, d:7}", "{a:11, z:7}")]{"a":11,"b":2,"c":10,"d":7,"z":7}{"a":11,"b":2,"c":10,"d":7,"z":7}\\- \
-
- 1.3b54 - Fixed bug which allows
json.merge()to work correctly with JSON Objects. \
+ - 1.3b54 - Fixed bug which allows
json.merge()to work correctly with JSON Objects. \
\ See Also\
\ - \ + \\\ @@ -15550,7 +15550,7 @@ json.path.add.summary = \ json.path.add() Function\ \\ -json.path.delete.description = Returns a JSON Array or JSON Object with deleted elements. +json.path.delete.description = Returns a JSON Array or JSON Object with deleted elements. json.path.delete.summary = \• Introduced in version 1.5.5\ -Add an element to a nested JSON Array. Additional information on how to specify the path is available here.\ +Add an element to a nested JSON Array. Additional information on how to specify the path is available here.\\ Usage\
\ @@ -15561,8 +15561,8 @@ json.path.add.summary = \ Parameters\ \- \
-
json- The json element in which the JSON Array is nested. \
- path- The path to the JSON Array. \
+ json- The json element in which the JSON Array is nested. \
+ path- The path to the JSON Array. \
value- The value to add to the array. \
\ @@ -15579,7 +15579,7 @@ json.path.add.summary = \
\\ @@ -15588,7 +15588,7 @@ json.path.delete.summary = \ json.path.delete() Function\ \\ -json.path.put.description = Create or update the key with the given value at the given path of a nested JSON Object . +json.path.put.description = Create or update the key with the given value at the given path of a nested JSON Object . json.path.put.summary = \• Introduced in version 1.5.5\ -Returns a JSON Array or JSON Object with deleted elements. These deletions are specified through the path parameter. Additional information on how to specify the path is availabe here.\ +Returns a JSON Array or JSON Object with deleted elements. These deletions are specified through the path parameter. Additional information on how to specify the path is availabe here.\\ Usage\
\ @@ -15622,7 +15622,7 @@ json.path.delete.summary = \\\ @@ -15631,7 +15631,7 @@ json.path.put.summary = \ json.path.put() Function\ \\ -json.path.read.description = Returns the values in a nested JSON Array or JSON Object corresponding to the provided path. +json.path.read.description = Returns the values in a nested JSON Array or JSON Object corresponding to the provided path. json.path.read.summary = \• Introduced in version 1.5.5\ -Create or update the key with the given value at the given path of a nested JSON Object. json.path.put() is only used creating/updating name/value pairs in JSON Objects. See json.path.set() for creating/updated values in arrays. Additional information on how to specify the path is available here.\ +Create or update the key with the given value at the given path of a nested JSON Object. json.path.put() is only used creating/updating name/value pairs in JSON Objects. See json.path.set() for creating/updated values in arrays. Additional information on how to specify the path is available here.\\ Usage\
\ @@ -15642,9 +15642,9 @@ json.path.put.summary = \ Parameters\ \- \
-
json- The json element in which the JSON Object is nested. \
- path- The path to the JSON Object. \
- key- The key of the JSON Object. \
+ json- The json element in which the JSON Object is nested. \
+ path- The path to the JSON Object. \
+ key- The key of the JSON Object. \
value- The value to associated with the key. \
\ @@ -15668,7 +15668,7 @@ json.path.put.summary = \
\\ @@ -15677,7 +15677,7 @@ json.path.read.summary = \ json.path.read() Function\ \• Introduced in version 1.5.5\ -Returns the values in a nested JSON Array or JSON Object corresponding to the provided path. It is unnecessary to include the root node operator\ -json.path.set.description = Change an element in a nested JSON Array . +json.path.set.description = Change an element in a nested JSON Array . json.path.set.summary = \$at the beginning of the requested path. To do so, you must escape the dollar sign like this:\$.path.to.read. Thejson.pathfunctions support both dot,Monsters.Orc.Attacks, and bracket,['Monsters']['Orc']['Attacks'], notation.\ +Returns the values in a nested JSON Array or JSON Object corresponding to the provided path. It is unnecessary to include the root node operator\$at the beginning of the requested path. To do so, you must escape the dollar sign like this:\$.path.to.read. Thejson.pathfunctions support both dot,Monsters.Orc.Attacks, and bracket,['Monsters']['Orc']['Attacks'], notation.\ For detailed information on how to specify the path, please read the JsonPath ReadMe.\ Usage\ @@ -15693,7 +15693,7 @@ json.path.read(json, path, config)\
json- The json data to get the values from.path- The path of the value(s) to retrieve.config- A String containing configuration options separated by a comma. The options can include\ -ALWAYS_RETURN_LIST- Always return the results in a JSON Array, even when the path is definite.AS_PATH_LIST- Return a JSON Array of path strings representing the path of the evaluation hits.DEFAULT_PATH_LEAF_TO_NULL- Return null when the given path almost exists but ends with a JSON Object key that is missing. Without this configuration, a definite path will return an error. With this configuration, an indefinite path will include null in the JSON Array if the key is missing. Without this configuration or if any other kind of nonexistent path structure is provided, an indefinite path will simply not match and return an empty JSON Array or less results in the JSON Array.REQUIRE_PROPERTIES- When an indefinite path is evaluated and ends in a key, all matching JSON Objects must have that key, otherwise an error is returned. This are the cases where DEFAULT_PATH_LEAF_TO_NULL will return null instead.SUPPRESS_EXCEPTIONS- Suppress all exceptions when evaluating paths. If ALWAYS_RETURN_LIST is also used return an empty list. Otherwise return null.
ALWAYS_RETURN_LIST- Always return the results in a JSON Array, even when the path is definite.AS_PATH_LIST- Return a JSON Array of path strings representing the path of the evaluation hits.DEFAULT_PATH_LEAF_TO_NULL- Return null when the given path almost exists but ends with a JSON Object key that is missing. Without this configuration, a definite path will return an error. With this configuration, an indefinite path will include null in the JSON Array if the key is missing. Without this configuration or if any other kind of nonexistent path structure is provided, an indefinite path will simply not match and return an empty JSON Array or less results in the JSON Array.REQUIRE_PROPERTIES- When an indefinite path is evaluated and ends in a key, all matching JSON Objects must have that key, otherwise an error is returned. This are the cases where DEFAULT_PATH_LEAF_TO_NULL will return null instead.SUPPRESS_EXCEPTIONS- Suppress all exceptions when evaluating paths. If ALWAYS_RETURN_LIST is also used return an empty list. Otherwise return null.
See the Jayway javadoc page for more info.\
\ @@ -15728,7 +15728,7 @@ which returns["Troll"]. Note the use of bracket notation for the p\\ -json.set.description = Sets the value in at the specified index in a JSON Array or for the specified key in a JSON Object . +json.set.description = Sets the value in at the specified index in a JSON Array or for the specified key in a JSON Object . json.set.summary = \\ @@ -15737,7 +15737,7 @@ json.path.set.summary = \ json.path.set() Function\ \\ -json.remove.description = Removes a field from a JSON Object , or the value at the specified index from a JSON Array . +json.remove.description = Removes a field from a JSON Object , or the value at the specified index from a JSON Array . json.remove.summary = \• Introduced in version 1.5.5\ -Change an element in a nested JSON Array. Additional information on how to specify the path is available here.\ +Change an element in a nested JSON Array. Additional information on how to specify the path is available here.\\ Usage\
\ @@ -15748,8 +15748,8 @@ json.path.set.summary = \ Parameters\ \- \
-
json- The json element in which the JSON Array is nested. \
- path- The path to the element in the JSON Array. \
+ json- The json element in which the JSON Array is nested. \
+ path- The path to the element in the JSON Array. \
value- The value to change. \
\ @@ -15769,7 +15769,7 @@ json.path.set.summary = \
\\\ @@ -15778,7 +15778,7 @@ json.remove.summary = \ json.remove() Function\ \\ -json.removeAll.description = Removes all the keys or values from the first JSON Object or JSON Array that occur in the following JSON Objects or JSON Arrays . +json.removeAll.description = Removes all the keys or values from the first JSON Object or JSON Array that occur in the following JSON Objects or JSON Arrays . json.removeAll.summary = \• Introduced in version 1.3b49\ -Removes a field from a JSON Object, or the value at the specified index from a JSON Array.\ +Removes a field from a JSON Object, or the value at the specified index from a JSON Array.\\ Usage\
\ @@ -15798,7 +15798,7 @@ json.remove.summary = \\\ @@ -15971,12 +15971,12 @@ The three parameter version returns a two dimensional array\\ @@ -15807,7 +15807,7 @@ json.removeAll.summary = \ json.removeAll() Function\ \\• Introduced in version 1.3b53\ -Removes all the keys or values from the first JSON Object or JSON Array that occur in the following JSON Objects or JSON Arrays.\ +Removes all the keys or values from the first JSON Object or JSON Array that occur in the following JSON Objects or JSON Arrays.\\ Usage\
\ @@ -15821,10 +15821,10 @@ json.removeAll.summary = \ Parameters\ \- \
-
firstArray- The JSON Array to remove the occurrences from. \
- array- The JSON Arrays to get the occurrences from. \
- firstObject- The JSON Object to remove the occurrences from. \
- object- The JSON Objects to get the occurrences from. \
+ firstArray- The JSON Array to remove the occurrences from. \
+ array- The JSON Arrays to get the occurrences from. \
+ firstObject- The JSON Object to remove the occurrences from. \
+ object- The JSON Objects to get the occurrences from. \
\
\ @@ -15894,7 +15894,7 @@ json.removeFirst.summary = \\ See Also\
\ - \ + \\ See Also\
\ - \ + \\\ @@ -15985,7 +15985,7 @@ json.set.summary = \ json.set() Function\ \• Introduced in version 1.3b49\ -Sets the value in at the specified index in a JSON Array or for the specified key in a JSON Object. You can use an empty string (\ +"") to represent a new JSON Array or JSON Object.Sets the value in at the specified index in a JSON Array or for the specified key in a JSON Object. You can use an empty string (\"") to represent a new JSON Array or JSON Object.\ Usage\
\ @@ -16008,9 +16008,9 @@ json.set.summary = \ Parameters\ \- \
-
jarr- The JSON Array that has an index's value set. \
+ jarr- The JSON Array that has an index's value set. \
index- The numeric index which has its value set. \
- jobj- The JSON Object that has a key's value set. \
+ jobj- The JSON Object that has a key's value set. \
key- The named key which has its value set. \
value- The content that is set to theindexorkey. \
{"a":5}\ {"a":5, "b":8}\ [8, 3]\ -To save the new value in the JSON Array or JSON Object so that you can reference it later in a macro, you must set the array equal to the result of json.set().\ +
To save the new value in the JSON Array or JSON Object so that you can reference it later in a macro, you must set the array equal to the result of json.set().\
[myArray = json.append("", 1, 2, 3)]\ [myArray = json.set(myArray, 0, 5)]\ [myArray]Returns\ @@ -16092,7 +16092,7 @@ json.sort.summary = \
\\ -json.sort(array, direction)
\If you have a JSON Array that contains JSON Objects\ +
If you have a JSON Array that contains JSON Objects\
\\json.sort(array, direction, key1, ..., keyN)
\ @@ -16104,15 +16104,15 @@ json.sort.summary = \array- The JSON array to sort.direction- Defaults to"ascending", acceptable values:\"ascending""descending""ascend""descend""asc""desc""a""d"
key1, ..., keyN- The keys in the JSON Objects contained within the JSON Array used for sorting. All JSON Objects must contain these fields.key1, ..., keyN- The keys in the JSON Objects contained within the JSON Array used for sorting. All JSON Objects must contain these fields.\ Examples\
\ -Sorting a JSON Array containing numbers.\ +Sorting a JSON Array containing numbers.\\ -json.subset.description = Returns\[json.sort("[1,4,5,6,2,1,9,20,1]")]Produces
[1,1,1,2,4,5,6,9,20]\ -Sorting a JSON Array containing strings.\ +
Sorting a JSON Array containing strings.\
\\[json.sort("['Hero', 'Dragon', 'Elf', 'Wolf', 'Mage', 'Eagle', 'Troll']")]Produces
["Dragon","Eagle","Elf","Hero","Mage","Troll","Wolf"]\ @@ -16153,7 +16153,7 @@ json.sort.summary = \true(1) if all of the JSON Object keys or JSON Array values are contained within the first JSON Object or JSON Array . +json.subset.description = Returnstrue(1) if all of the JSON Object keys or JSON Array values are contained within the first JSON Object or JSON Array . json.subset.summary = \\\ -sendToBack.description = Adjust the z-order (or draw order) of the Token so that it is drawn before all other Tokens on the same Map Layer , this has the effect of making the Token appear to be in back of the other Tokens as it will be obscured by other Tokens on the same Map Layer in the same location. +sendToBack.description = Adjust the z-order (or draw order) of the Token so that it is drawn before all other Tokens on the same Map Layer , this has the effect of making the Token appear to be in back of the other Tokens as it will be obscured by other Tokens on the same Map Layer in the same location. sendToBack.summary = \\ @@ -16162,7 +16162,7 @@ json.subset.summary = \ json.isSubset() Function\ \\ -json.toList.description = Creates a string list from a JSON Array . +json.toList.description = Creates a string list from a JSON Array . json.toList.summary = \• Introduced in version 1.3b53\ -Returns\ +true(1) if all of the JSON Object keys or JSON Array values are contained within the first JSON Object or JSON Array.Returns\true(1) if all of the JSON Object keys or JSON Array values are contained within the first JSON Object or JSON Array.\ Usage\
\ @@ -16176,10 +16176,10 @@ json.subset.summary = \ Parameters\ \- \
-
firstArray- The JSON Array that must contain all of the values of the subsequent JSON Arrays for this function to returntrue(1). \
- array- A JSON Array with values that are tested to be within thefirstArray. \
- firstObject- The JSON Object that must contain all of the keys of the subsequent JSON Objects for this function to returntrue(1). \
- object- A JSON Object with keys that are tested to be within thefirstObject. \
+ firstArray- The JSON Array that must contain all of the values of the subsequent JSON Arrays for this function to returntrue(1). \
+ array- A JSON Array with values that are tested to be within thefirstArray. \
+ firstObject- The JSON Object that must contain all of the keys of the subsequent JSON Objects for this function to returntrue(1). \
+ object- A JSON Object with keys that are tested to be within thefirstObject. \
\
\ @@ -16194,7 +16194,7 @@ json.subset.summary = \\\ @@ -21129,18 +21129,18 @@ selectTokens.summary = \\ @@ -16203,7 +16203,7 @@ json.toList.summary = \ json.toList() Function\ \\ -json.toStrProp.description = Creates a string list from a json object or json array using the specified delimiter in the result. +json.toStrProp.description = Creates a string list from a json object or json array using the specified delimiter in the result. json.toStrProp.summary = \• Introduced in version 1.3b49\ -Creates a string list from a JSON Array. If the delimiter is not specified then the default value of ',' is used.\ +Creates a string list from a JSON Array. If the delimiter is not specified then the default value of ',' is used.\\ Usage\
\ @@ -16236,7 +16236,7 @@ json.toList.summary = \\\\ @@ -16245,7 +16245,7 @@ json.toStrProp.summary = \ json.toStrProp() Function\ \\ -json.toVars.description = Creates variables from a from a JSON Object or JSON Array . +json.toVars.description = Creates variables from a from a JSON Object or JSON Array . json.toVars.summary = \• Introduced in version 1.3b49\ -Creates a string list from a json object or json array using the specified delimiter in the result. If a delimiter is not provided then the default value of ';' is used.\ +Creates a string list from a json object or json array using the specified delimiter in the result. If a delimiter is not provided then the default value of ';' is used.\\ Usage\
\ @@ -16279,7 +16279,7 @@ json.toStrProp.summary = \\\ -json.union.description = Returns an JSON Array with the union of all of the JSON Object keys, or JSON Array values. +json.union.description = Returns an JSON Array with the union of all of the JSON Object keys, or JSON Array values. json.union.summary = \\ @@ -16288,7 +16288,7 @@ json.toVars.summary = \ json.toVars() Function\ \\• Introduced in version 1.5.5\ -Creates variables from a from a JSON Object or JSON Array. For a JSON object the names of the variables are the keys of the object, while the variables are assigned the values of the object. Characters in key values that are not allowed in MTScript variable names will be replaced with underscores. For a JSON array, only the values are passed in and the variable names will be created from the 2nd parameter suffixed with a number.\ +Creates variables from a from a JSON Object or JSON Array. For a JSON object the names of the variables are the keys of the object, while the variables are assigned the values of the object. Characters in key values that are not allowed in MTScript variable names will be replaced with underscores. For a JSON array, only the values are passed in and the variable names will be created from the 2nd parameter suffixed with a number.\\ Usage\
\ @@ -16392,7 +16392,7 @@ json.type.summary = \Returns a string which contains the type of JSON variable that is passed in.\\Return values are\
\ -ARRAY- The object is a JSON Array.OBJECT- The object is a JSON Object.UNKNOWN- It is neither a JSON Array nor JSON Object.
ARRAY- The object is a JSON Array.OBJECT- The object is a JSON Object.UNKNOWN- It is neither a JSON Array nor JSON Object.
\ Usage\ @@ -16414,7 +16414,7 @@ UNKNOWN
\\ @@ -21008,7 +21008,7 @@ Returns a number that is between 5 and 80 (and no longer up to 100 as with a reg\ @@ -16423,7 +16423,7 @@ json.union.summary = \ json.union() Function\ \\ -json.unique.description = Returns a JSON Array with each value that occurs in the source JSON Array occurring only once. +json.unique.description = Returns a JSON Array with each value that occurs in the source JSON Array occurring only once. json.unique.summary = \• Introduced in version 1.3b53\ -Returns an JSON Array with the union of all of the JSON Object keys, or JSON Array values. If a value or a key occurs in multiple different objects or arrays, it will only be placed once in the output object or array.\ +Returns an JSON Array with the union of all of the JSON Object keys, or JSON Array values. If a value or a key occurs in multiple different objects or arrays, it will only be placed once in the output object or array.\\ Usage\
\ @@ -16437,8 +16437,8 @@ json.union.summary = \ Parameters\ \- \
-
array- The JSON Arrays to union. \
- object- The JSON Objects to union. \
+ array- The JSON Arrays to union. \
+ object- The JSON Objects to union. \
\ Examples\ @@ -16456,7 +16456,7 @@ json.union.summary = \
\\ -macroLink.description = Creates the HTML for a link which will run the specified macro when clicked on in a frame , dialog , or the chat window. +macroLink.description = Creates the HTML for a link which will run the specified macro when clicked on in a frame , dialog , or the chat window. macroLink.summary = \\ @@ -16465,7 +16465,7 @@ json.unique.summary = \ json.unique() Function\ \\ -listAppend.description = Returns a string list with a value appended to the end of the string list . +listAppend.description = Returns a string list with a value appended to the end of the string list . listAppend.summary = \• Introduced in version 1.3b53\ -Returns a JSON Array with each value that occurs in the source JSON Array occurring only once. The relative order of the values in the array may not be preserved.\ +Returns a JSON Array with each value that occurs in the source JSON Array occurring only once. The relative order of the values in the array may not be preserved.\\ Usage\
\ @@ -16476,13 +16476,13 @@ json.unique.summary = \ Parameters\ \- \
-
array- The JSON Array to return only unique values from. \
+ array- The JSON Array to return only unique values from. \
\ Example\
\ -Lets say you have a JSON Array that contains the following Token names:\["Hero", "Dragon"], and you usegetPCNames()to return the names of\ -the PC Tokens, you could use the following code to generate a JSON Array that contains the values in both JSON Arrays with no value present more than once.\ +
Lets say you have a JSON Array that contains the following Token names:\ @@ -16589,7 +16589,7 @@ Returns a number than is between["Hero", "Dragon"], and you usegetPCNames()to return the names of\ +the PC Tokens, you could use the following code to generate a JSON Array that contains the values in both JSON Arrays with no value present more than once.\
\\[h: names1 = '["Hero", "Dragon"]']\ [h: names2 = getNPCNames()]\ @@ -16544,7 +16544,7 @@ Returns a number than is between
2and20, with a high\ See Also\
\ -For another method of rolling dice, see Dice Expressions.\ +For another method of rolling dice, see Dice Expressions.\3and30, with a low\ See Also\
\ -For another method of rolling dice, see Dice Expressions.\ +For another method of rolling dice, see Dice Expressions.\\ Version Changes\
\ @@ -16705,7 +16705,7 @@ Returns 5\\ -listContains.description = Returns the number of occurrences of a value in a String List . +listContains.description = Returns the number of occurrences of a value in a String List . listContains.summary = \\ @@ -16714,7 +16714,7 @@ listAppend.summary = \ listAppend() Function\ \\• Introduced in version 1.3b42\ -Returns a string list with a value appended to the end of the string list.\ +Returns a string list with a value appended to the end of the string list.\\ Usage\
\ @@ -16724,7 +16724,7 @@ listAppend.summary = \\\ -listAppend(list, value, delim)
\If delim is not specified then the default value of ',' is used to separate the values in the string list\ +
If delim is not specified then the default value of ',' is used to separate the values in the string list\
\\ Examples\ @@ -16736,7 +16736,7 @@ Returns This: is: a: test
\\ -listCount.description = Returns the number of items in a string list . +listCount.description = Returns the number of items in a string list . listCount.summary = \\ @@ -16745,7 +16745,7 @@ listContains.summary = \ listContains() Function\ \\• Introduced in version 1.3b42\ -Returns the number of occurrences of a value in a String List.\ +Returns the number of occurrences of a value in a String List.\\ Usage\
\ @@ -16757,9 +16757,9 @@ listContains(list, value, delim)\ Parameters\ \- \
-
list- The String List that is checked for occurrences of thevalue. \
- value- The value to search the String List for occurrences. \
- delim- The delimiter that separates the values in the String List; defaults to",". \
+ list- The String List that is checked for occurrences of thevalue. \
+ value- The value to search the String List for occurrences. \
+ delim- The delimiter that separates the values in the String List; defaults to",". \
\ Examples\ @@ -16778,7 +16778,7 @@ Returns
2\\ -listDelete.description = Returns a string list with the specified item deleted from it. +listDelete.description = Returns a string list with the specified item deleted from it. listDelete.summary = \\ @@ -16787,7 +16787,7 @@ listCount.summary = \ listCount() Function\ \\• Introduced in version 1.3b42\ -Returns the number of items in a string list.\ +Returns the number of items in a string list.\\ Usage\
\ @@ -16797,7 +16797,7 @@ listCount.summary = \\\ -listCount(list, delim)
\If delim is not specified then the default value of ',' is used as the value separator in the string list\ +
If delim is not specified then the default value of ',' is used as the value separator in the string list\
\\ Examples\ @@ -16809,7 +16809,7 @@ Returns 4
\\ -listFind.description = Returns the index of the first occurrence of a value in a string list . +listFind.description = Returns the index of the first occurrence of a value in a string list . listFind.summary = \\ @@ -16818,7 +16818,7 @@ listDelete.summary = \ listDelete() Function\ \\• Introduced in version 1.3b42\ -Returns a string list with the specified item deleted from it. The index for the string list\ +Returns a string list with the specified item deleted from it. The index for the string list\\ Usage\
\ @@ -16828,7 +16828,7 @@ listDelete.summary = \\\ -listDelete(list, index, delim)
\If delim is not specified then the default value of ',' is used as the value separator in the string list\ +
If delim is not specified then the default value of ',' is used as the value separator in the string list\
\\ Example\ @@ -16839,7 +16839,7 @@ Returns This, a, test
\\ @@ -17426,7 +17426,7 @@ log.trace.summary = \ \\ @@ -16848,7 +16848,7 @@ listFind.summary = \ listFind() Function\ \\• Introduced in version 1.3b42\ -Returns the index of the first occurrence of a value in a string list. If the value is not found then -1 is returned.\ +Returns the index of the first occurrence of a value in a string list. If the value is not found then -1 is returned.\\ Usage\
\ @@ -16858,7 +16858,7 @@ listFind.summary = \\\ -listFind(list, value, delim)
\If delim is not specified then the default value of ',' is used as the value separator in the string list\ +
If delim is not specified then the default value of ',' is used as the value separator in the string list\
\\ Examples\ @@ -16913,7 +16913,7 @@ The first argument is the list, returned by \ -listGet.description = Returns the value in the string list at the specified index. +listGet.description = Returns the value in the string list at the specified index. listGet.summary = \
\\ -listInsert.description = Inserts a value into the string list at the specified index. +listInsert.description = Inserts a value into the string list at the specified index. listInsert.summary = \\ @@ -16922,7 +16922,7 @@ listGet.summary = \ listGet() Function\ \\• Introduced in version 1.3b42\ -Returns the value in the string list at the specified index. The index for a string list starts at 0.\ +Returns the value in the string list at the specified index. The index for a string list starts at 0.\\ Usage\
\ @@ -16932,7 +16932,7 @@ listGet.summary = \\\ -listGet(list, index, delim)
\If delim is not specified then the default value of ',' is used as the value separator in the string list\ +
If delim is not specified then the default value of ',' is used as the value separator in the string list\
\\ Example\ @@ -16944,7 +16944,7 @@ Returns is
\\ -listReplace.description = Replaces the element at the specified index of a String List with a new value. +listReplace.description = Replaces the element at the specified index of a String List with a new value. listReplace.summary = \\ @@ -16953,7 +16953,7 @@ listInsert.summary = \ listInsert() Function\ \\• Introduced in version 1.3b42\ -Inserts a value into the string list at the specified index. If a delimiter is not specified then the default value of ',' is used. The index for lists starts at 0\ +Inserts a value into the string list at the specified index. If a delimiter is not specified then the default value of ',' is used. The index for lists starts at 0\\ Usage\
\ @@ -16973,7 +16973,7 @@ Returns This: is: a: test\\\ @@ -16982,7 +16982,7 @@ listReplace.summary = \ listReplace() Function\ \\ +• Introduced in version 1.3b42\ -Replaces the element at the specified index of a String List with a new value. If a delimiter is not specified then the default value of\ +","is used. The index for lists starts at0.Replaces the element at the specified index of a String List with a new value. If a delimiter is not specified then the default value of\","is used. The index for lists starts at0.\ Usage\
\ @@ -16996,8 +16996,8 @@ listReplace.summary = \ Examples\ \Simple example:\[r: listReplace("This, isnt, a , test", 1, "is")]Returns
This, is, a, Test\ -Example using a String List with a non-default delimiter:
[r: listReplace("This: isnt: a: test", 1, "is", ":")]Returns
This: is: a: test\ -Example using a String List stored in a variable:
\ @@ -17110,7 +17110,7 @@ log.debug.summary = \ \[h: ListVar = "This, is, a, great, test"]\ +
Example using a String List with a non-default delimiter:
[r: listReplace("This: isnt: a: test", 1, "is", ":")]Returns
This: is: a: test\ +Example using a String List stored in a variable:
\ Returns:[h: ListVar = "This, is, a, great, test"]\ [h: ListVar = listReplace(ListVar, 3, "silly")]\ [r: ListVar]
This, is, a, silly, test\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.5.2\ @@ -17156,7 +17156,7 @@ log.error.summary = \ \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.5.2\ @@ -17202,7 +17202,7 @@ log.fatal.summary = \ \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.5.2\ @@ -17248,7 +17248,7 @@ log.getLoggers.summary = \ \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.5.2\ @@ -17318,7 +17318,7 @@ log.info.summary = \ \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.5.2\ @@ -17364,7 +17364,7 @@ log.setLevel.summary = \ \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.5.2\ @@ -17407,11 +17407,11 @@ log.setLevel.summary = \ [r: "Setting <i><b>" + lname + "</b></i> to <b>" + level + "</b>."]\ [h: log.setLevel(lname,level)]
\ -\ See Also\
\ - \ + \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.5.7\ @@ -17472,7 +17472,7 @@ log.warn.summary = \ \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.5.2\ @@ -17618,7 +17618,7 @@ lt.summary = \\\\ @@ -17627,7 +17627,7 @@ macroLink.summary = \ macroLink() Function\ \\ @@ -20971,7 +20971,7 @@ Returns a number that is between 35 and 100 (and no longer down to 5 as with a r• Introduced in version 1.3b48\ -Creates the HTML for a link which will run the specified macro when clicked on in a frame, dialog, or the chat window. Additionally, if you send the link to the chat window, it will automatically be executed by any recipients as soon as they receive it. This can be useful for popping up or updating frames or dialogs for your players. To auto-execute in the chat window, it must not be hidden by roll options like [h:], but may be hidden by being contained within an HTML comment.\
\ +Creates the HTML for a link which will run the specified macro when clicked on in a frame, dialog, or the chat window. Additionally, if you send the link to the chat window, it will automatically be executed by any recipients as soon as they receive it. This can be useful for popping up or updating frames or dialogs for your players. To auto-execute in the chat window, it must not be hidden by roll options like [h:], but may be hidden by being contained within an HTML comment.\ @@ -17655,24 +17655,24 @@ macroLink.summary = \ \
\Some notes on the auto execution
\- If you refer to a macro on a lib:token it will automatically execute, however if you refer to a macro on the campaign panel, the macro is NOT automatically executed when sent to the chat.
- It will also not work if the owner of the lib:token is not an (online) GM, though as a general practice its best not to set ownership of lib:tokens at all.
- To prevent the macro from automatically executing you can turn off the 'auto execute' in the edit panel of the macro that you're linking to.
- \
text- is the text to display for the link. \
- macroName- is the name of the macro to run when the link is clicked. ThemacroNameis in the same format that is used for [macro(...): ...] e.g.Test@Lib:test. \
+ macroName- is the name of the macro to run when the link is clicked. ThemacroNameis in the same format that is used for [macro(...): ...] e.g.Test@Lib:test. \
output- contains who the output of the macro should go to, values are (defaults to"none"):\ -"self"- Display only to person who clicked on the link."gm"- Display to GM."all"- everyone (acts like a /say)."none"- discard any output."gm-self"- Display to GM and the person executing the link."list"- Displays to a list of players. When theoutputis set to"list"then the macro link expects theargsparameter to be a JSON Object, that contains a field calledmlOutputListwhich is a JSON Array containing the players to send the output to.
\
+"self"- Display only to person who clicked on the link."gm"- Display to GM."all"- everyone (acts like a /say)."none"- discard any output."gm-self"- Display to GM and the person executing the link."list"- Displays to a list of players. When theoutputis set to"list"then the macro link expects theargsparameter to be a JSON Object, that contains a field calledmlOutputListwhich is a JSON Array containing the players to send the output to.args- Any arguments to be passed to the macro when it is called. \
target- Which tokens to run the macro on. Target can be one or more of the following separated by commas (defaults to"impersonated"):\ - \
+\
\ Examples\
\ -* To create a link that will call a macro called\ @@ -20934,7 +20934,7 @@ Returns a number that is between -10 and 70 (and no longer 5 to 100 as with a reTeston the Library Token namedLib:Testthat says "Click on me!" and displays the output to the GM.\ +* To create a link that will call a macro called\Teston the Library Token namedLib:Testthat says "Click on me!" and displays the output to the GM.\[r: macroLink("Click on me!", "Test@Lib:Test", "gm", "count=6", "impersonated")]
\ produces this output:<ahref="macro://Test@Lib:Test/gm/impersonated?count=6;">Click on me!</a>
\- Sending to multiple players and the GM in 1.3b55
[h: outputTo = '["Fred", "Barney", "gm"]']\ [h: args = json.set("{}", "mlOutputList", outputTo)]\ [r: macroLink("Click on me!", "Test@Lib:Test", "list", args)]
\ -- Updating a character sheet frame without displaying the link:
- Updating a character sheet frame without displaying the link:
Took 4 points of damage.<!-- [r: macroLink("Update Character Sheet", "Update Character Sheet@Lib:Test")] -->
\- An example of a longer custom macrolink:
This is a link that is user created to send several variables to the AttackMacro. Each variable must be separated by a
&sign. Spaces within text must be replaced with a+sign. Plus sign can't be sent, you might want to use the html code for plus sign (&27;) instead of+.\ @@ -17714,7 +17714,7 @@ macroLinkText.summary = \ macroLinkText() Function\ \• Introduced in version 1.3b48\ -Creates the text that would appear in a HTML tag for a link which will run the specified macro when clicked on. This is useful for callbacks in [dialog():] or [frame():]. If you just want to send a click-able link to someone use macroLink().\ +Creates the text that would appear in a HTML tag for a link which will run the specified macro when clicked on. This is useful for callbacks in [dialog():] or [frame():]. If you just want to send a click-able link to someone use macroLink().\\ Usage\
\ @@ -17736,21 +17736,21 @@ macroLinkText.summary = \- \
macroName- The name of the macro to run when the link is clicked. ThemacroNameis in the standard macro reference format (e.g.Macro@Lib:Token) \
output- Who the output of the macro should go to, values are (defaults tonone):\ -self- Display only to person who clicked on the link.gm- Display to GM.all- Everyone (acts like a/say)none- Discard any output.gm-self- Display to GM and the person executing the link.list- Displays to a list of players. When theoutputparameter is"list"then the macro link expects theargsparameter to be a JSON Object, that contains a field calledmlOutputListwhich is a JSON Array containing the players to send the output to.
\
+self- Display only to person who clicked on the link.gm- Display to GM.all- Everyone (acts like a/say)none- Discard any output.gm-self- Display to GM and the person executing the link.list- Displays to a list of players. When theoutputparameter is"list"then the macro link expects theargsparameter to be a JSON Object, that contains a field calledmlOutputListwhich is a JSON Array containing the players to send the output to.args- Any arguments to be passed to the macro when it is called. \
target- Which tokens to run the macro on. Target can be one or more of the following separated by commas (defaults toimpersonated):\ - \
+\
\ Examples\
\ -To create the text that would go inside a form element as the\ @@ -20896,7 +20896,7 @@ Returns a number that is between 15 and 90 (and no longer 5 to 100 as with a regactionattribute, and that will call a macro namedTeston the Library Token namedLib:Test:\ +To create the text that would go inside a form element as the\actionattribute, and that will call a macro namedTeston the Library Token namedLib:Test:\\[r: macroLinkText("Test@Lib:Test","", "gm")]Returns:
macro://Test@Lib:Test/gm/impersonated?\ -To create the text that would go inside a form element as the
actionattribute and call theAddWeaponon the Library Token namedLib:PCwhich will act upon the Current Token:\ +To create the text that would go inside a form element as the
\actionattribute and call theAddWeaponon the Library Token namedLib:PCwhich will act upon the Current Token:\\ -[r:macroLinkText('AddWeapon@Lib:PC', 'none', '', currentToken())]Returns:
macro://AddWeapon@Lib:PC/none/#ID#?where#ID#is theidof the Current Token.\ +Returns:
macro://AddWeapon@Lib:PC/none/#ID#?where#ID#is theidof the Current Token.\Sending to multiple players and the GM in 1.3b55\
\\ @@ -20858,7 +20858,7 @@ Returns a number that is between 35 and 90 (and no longer 5 to 100 as with a reg[h: outputTo = '["Fred", "Barney", "gm"]']\ @@ -17852,7 +17852,7 @@ markdownToHTML(string, type)
\\ Examples\
\ -Retrieve the text stored in the current token's Notes and convert them to HTML for display inside a frame5().\ +\ -math.listMax.description = Find the maximum value in a String List . +math.listMax.description = Find the maximum value in a String List . math.listMax.summary = \Retrieve the text stored in the current token's Notes and convert them to HTML for display inside a frame5().\\\ @@ -17878,7 +17878,7 @@ matches.summary = \ matches() Function\ \[frame5("Notes", "title=" + token.name): {<br>\ [r: markdownToHTML(getNotes())]\ }]• Introduced in version 1.3b48\ -Returns 1 if a string matches pattern or 0 if it does not. The pattern can be a regular expression. Matches performs a while string comparison, so the pattern must match the whole of the input string and not only part of it.\ +Returns 1 if a string matches pattern or 0 if it does not. The pattern can be a regular expression. Matches performs a while string comparison, so the pattern must match the whole of the input string and not only part of it.\\ Usage\
\ @@ -18200,7 +18200,7 @@ Returns: 8.0\\\ @@ -18209,7 +18209,7 @@ math.listMax.summary = \ math.listMax() Function\ \\ -math.listMean.description = Calculates the arithmetic mean of the contents of a String List . +math.listMean.description = Calculates the arithmetic mean of the contents of a String List . math.listMean.summary = \• Introduced in version 1.7\ -Find the maximum value in a String List. Only allows numeric elements - any non-numeric values will produce an error.\ +Find the maximum value in a String List. Only allows numeric elements - any non-numeric values will produce an error.\\ Usage\
\ @@ -18237,7 +18237,7 @@ math.listMax.summary = \\\ @@ -20820,7 +20820,7 @@ Returns a number that is between 40 and 115 (and no longer 5 to 100 as with a re\ @@ -18246,7 +18246,7 @@ math.listMean.summary = \ math.listMean() Function\ \\ -math.listMedian.description = Calculates the Median of the contents of a String List . +math.listMedian.description = Calculates the Median of the contents of a String List . math.listMedian.summary = \• Introduced in version 1.7\ -Calculates the arithmetic mean of the contents of a String List. Only allows numeric elements - any non-numeric values will produce an error. The mean is equal to the sum of all the list's contents divided by the number of elements.\ +Calculates the arithmetic mean of the contents of a String List. Only allows numeric elements - any non-numeric values will produce an error. The mean is equal to the sum of all the list's contents divided by the number of elements.\\ Usage\
\ @@ -18274,7 +18274,7 @@ math.listMean.summary = \\\\ @@ -18283,7 +18283,7 @@ math.listMedian.summary = \ math.listMedian() Function\ \\ -math.listMin.description = Find the minimum value in a String List . +math.listMin.description = Find the minimum value in a String List . math.listMin.summary = \• Introduced in version 1.7\ -Calculates the Median of the contents of a String List. The median value is is the value where half the numbers in the list are greater than or equal to it, and the other half are less than or equal to it. The median is calculated by sorting the list contents and picking the middle number if the number of elements is odd, or averaging the two in the middle if the number of elements is even. Only allows numeric elements - any non-numeric values will produce an error.\ +Calculates the Median of the contents of a String List. The median value is is the value where half the numbers in the list are greater than or equal to it, and the other half are less than or equal to it. The median is calculated by sorting the list contents and picking the middle number if the number of elements is odd, or averaging the two in the middle if the number of elements is even. Only allows numeric elements - any non-numeric values will produce an error.\\ Usage\
\ @@ -18311,7 +18311,7 @@ math.listMedian.summary = \\\ @@ -20674,7 +20674,7 @@ return.summary = \ return() Function\ \\ @@ -18320,7 +18320,7 @@ math.listMin.summary = \ math.listMin() Function\ \\ -math.listProduct.description = Multiplies together the contents of a String List . +math.listProduct.description = Multiplies together the contents of a String List . math.listProduct.summary = \• Introduced in version 1.7\ -Find the minimum value in a String List. Only allows numeric elements - any non-numeric values will produce an error.\ +Find the minimum value in a String List. Only allows numeric elements - any non-numeric values will produce an error.\\ Usage\
\ @@ -18348,7 +18348,7 @@ math.listMin.summary = \\\\ @@ -18357,7 +18357,7 @@ math.listProduct.summary = \ math.listProduct() Function\ \\ -math.listSum.description = Adds together the contents of a String List . +math.listSum.description = Adds together the contents of a String List . math.listSum.summary = \• Introduced in version 1.7\ -Multiplies together the contents of a String List. Only allows numeric elements - any non-numeric values will produce an error.\ +Multiplies together the contents of a String List. Only allows numeric elements - any non-numeric values will produce an error.\\ Usage\
\ @@ -18385,7 +18385,7 @@ math.listProduct.summary = \\\ @@ -20626,7 +20626,7 @@ restoreFoW.summary = \ \\ @@ -18394,7 +18394,7 @@ math.listSum.summary = \ math.listSum() Function\ \\ -movedOverToken.description = Is used to check if the location of the target• Introduced in version 1.7\ -Adds together the contents of a String List. Only allows numeric elements - any non-numeric values will produce an error.\ +Adds together the contents of a String List. Only allows numeric elements - any non-numeric values will produce an error.\\ Usage\
\ @@ -18575,7 +18575,7 @@ movedOverDrawing.summary = \ \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.5.2\ @@ -18681,7 +18681,7 @@ Moved Over: [r: movedOverPoints(jsonArray,lastPath)]\tokenis in an array of cell coordinates like the one received from getLastPath() or the onTokenMove event'smacro.args. +movedOverToken.description = Is used to check if the location of the targettokenis in an array of cell coordinates like the one received from getLastPath() or the onTokenMove event'smacro.args. movedOverToken.summary = \\\\ @@ -18690,7 +18690,7 @@ movedOverToken.summary = \ movedOverToken() Function\ \\ @@ -20555,7 +20555,7 @@ REST.put.summary = \ \• Introduced in version 1.3.b74\ -Is used to check if the location of the target\tokenis in an array of cell coordinates like the one received from getLastPath() or the onTokenMove event'smacro.args.\ +Is used to check if the location of the target\tokenis in an array of cell coordinates like the one received from getLastPath() or the onTokenMove event'smacro.args.\\ Usage\ @@ -18795,20 +18795,20 @@ moveToken(x, y, units, id)\
x- The X coordinate to move the token to.y- The Y coordinate to move the token to.units- If set tofalse(0), the coordinates are a location on the grid in cells. Defaults totrue(1), where the coordinates are in Distance Per Cell pixels.id- The id string of the token to move, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
id- The id string of the token to move, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
\\ Examples\
\ -Moves the Current Token down\ @@ -20466,7 +20466,7 @@ REST.post.summary = \ \5units, and left10units.\ +Moves the Current Token down\ @@ -19314,7 +19314,7 @@ playClip(uri, cycleCount, volume)\ Parameter\ \5units, and left10units.\\ -[h: CurrentX = getTokenX()]\ [h: CurrentY = getTokenY()]\ [h: NewX = CurrentX + 5]\ [h: NewY = CurrentY - 10]\ [h: moveToken(NewX, NewY)]
Moves the Current Token down
5cells, and left10cells.\ +Moves the Current Token down
\5cells, and left10cells.\\ -nextInitiative.description = Advances the initiative to the next Token in the Initiative Panel . +nextInitiative.description = Advances the initiative to the next Token in the Initiative Panel . nextInitiative.summary = \[h: CurrentX = getTokenX(0)]\ [h: CurrentY = getTokenY(0)]\ @@ -18834,7 +18834,7 @@ moveTokenFrom.summary = \ \\ Parameters\ \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b54\ @@ -18852,7 +18852,7 @@ moveTokenFromMap(id, map, x, y, z)- \
-
id- The tokenidor a JSON Array of tokenids of the token/s to move. \
+ id- The tokenidor a JSON Array of tokenids of the token/s to move. \
map- A string containing the name of the map that the token is moved from. \
x- TheXcoordinate of the current map that the token should be moved to. Defaults to 0. \
y- TheYcoordinate of the current map that the token should be moved to. Defaults to 0. \
@@ -18881,7 +18881,7 @@ moveTokenFromMap.summary = \
\
id- The tokenidor a JSON Array of tokenids of the token/s to move. \
+ id- The tokenidor a JSON Array of tokenids of the token/s to move. \
map- A string containing the name of the map that the token is moved from. \
x- TheXcoordinate of the current map that the token should be moved to. Defaults to 0. \
y- TheYcoordinate of the current map that the token should be moved to. Defaults to 0. \
@@ -18928,7 +18928,7 @@ moveTokenToMap.summary = \
\
id- The tokenidor a JSON Array of tokenids of the token/s to move. \
+ id- The tokenidor a JSON Array of tokenids of the token/s to move. \
map- A string containing the name of the map that the token is moved to. \
x- TheXcoordinate of the map that the token should be moved to. Default to 0. \
y- TheYcoordinate of the map that the token should be moved to. Default to 0. \
@@ -19048,7 +19048,7 @@ ne(s1, s2, ...)\
\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b54\ @@ -18899,7 +18899,7 @@ moveTokenFromMap(id, map, x, y, z)\ Parameters\ \- \
-
\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b54\ @@ -18946,7 +18946,7 @@ moveTokenToMap(id, map, x, y, z)\ Parameters\ \- \
-
\\\ @@ -19058,12 +19058,12 @@ nextInitiative.summary = \ \\\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b41\ -Advances the initiative to the next Token in the Initiative Panel. Only the GM or a trusted macro can call this function. This function returns the offset into the Initiative Panel (starting at 0) of the Token that will get the Initiative.\ -\ +- Since 1.8: This function triggers the
onInitiativeChangeRequest(andonInitiativeChange) events, so it is possible that the change will be blocked. See the Guide to Initiative Events for more details. This function will return the offset of the token that has initiative after this function completes, whether the change proceeded as requested or not.
Advances the initiative to the next Token in the Initiative Panel. Only the GM or a trusted macro can call this function. This function returns the offset into the Initiative Panel (starting at 0) of the Token that will get the Initiative.\ +\- Since 1.8: This function triggers the
onInitiativeChangeRequest(andonInitiativeChange) events, so it is possible that the change will be blocked. See the Guide to Initiative Events for more details. This function will return the offset of the token that has initiative after this function completes, whether the change proceeded as requested or not.
\ Usage\
\ @@ -19143,7 +19143,7 @@ number.summary = \ number() Function\ \• Introduced in version 1.3b48\ -Returns the value that is passed in as a number. If the value can not be converted to a number then an error will occur. If you are unsure if a value is a number to can use isNumber() before calling this function.\ +Returns the value that is passed in as a number. If the value can not be converted to a number then an error will occur. If you are unsure if a value is a number to can use isNumber() before calling this function.\\ Usage\
\ @@ -19164,7 +19164,7 @@ oldFunction.summary = \ \• Introduced in version 1.3b51\If a user-defined function redefines a standard MapTool function or another user-defined function -- for instance, a user defines a function called\ +Note: Do not rely on a specific order in the function chain unless you are sure that the functions will be redefined in that order. Calls to defineFunction() within onCampaignLoad macros on different Library Tokens are not executed in any standard order.eval(), redefining the standard MapTool eval() -- oldFunction() can be used in the user-defined function to call the original function. When a user-defined function redefines an existing function, it keeps track of the function that it redefined. Due to this tracking, it is possible to redefine a function multiple times and oldFunction() will always reference the previous function in the chain.\ -Note: Do not rely on a specific order in the function chain unless you are sure that the functions will be redefined in that order. Calls to defineFunction() within onCampaignLoad macros on different Library Tokens are not executed in any standard order.\ Usage\
\ @@ -19235,7 +19235,7 @@ Returns a string that is similar toDice: 5, 4, 19, 6, 3, Maximum: 19\ See Also\ \ -For another method of rolling dice, see Dice Expressions.\ +For another method of rolling dice, see Dice Expressions.\- \
-
uri- The uri/url of the file. For example, http://www.mywebsite/mysong.mp3 or file:/C:/mysong.mp3 \
+ uri- The uri/url of the file. For example, https://www.mywebsite/mysong.mp3 or file:/C:/mysong.mp3 \
cycleCount- The number of times the audio should play. If set to 0, the file is cached but not played; if set to -1, the file is played continuously. Defaults to 1. \
volume- The volume the audio is to be played at. Can range from 0 to 1. Defaults to 1. \
\[playClip(macro.args)]
To play the song, the GM can then use execLink:\
\ -\[H: songUrl = "http://erinmcnamee.com.hostbaby.com/files/07_No_Sorrow__Banish_Misfortune.mp3"]\ +
\ Parameter\ \\[H: songUrl = "https://erinmcnamee.com.hostbaby.com/files/07_No_Sorrow__Banish_Misfortune.mp3"]\ [H: audioByte = macroLinkText("playSong@Lib:MusicPlayer", "none", songUrl)]\ [H: execLink(audioByte,0,"all")]Dropbox URLs
\ @@ -19360,7 +19360,7 @@ playStream(uri, cycleCount, volume, start, stop)- \
-
uri- The uri/url of the file. For example, http://www.mywebsite/mysong.mp3 orfile:/C:/mysong.mp3\
+ uri- The uri/url of the file. For example, https://www.mywebsite/mysong.mp3 orfile:/C:/mysong.mp3\
cycleCount- The number of times the audio should play. If set to 0, the file is cached but not played; if set to -1, the file is played continuously. Defaults to 1. \
volume- The volume the audio is to be played at. Can range from 0 to 1. Defaults to 1. \
start- The time offset in seconds where audio should start playing, or restart from when repeating. Defaults to 0. \
@@ -19373,12 +19373,12 @@ playStream(uri, cycleCount, volume, start, stop)\
- This function triggers the
onInitiativeChangeRequest(andonInitiativeChange) events, so it is possible that the change will be blocked. See the Guide to Initiative Events for more details. This function will return the offset of the token that has initiative after this function completes, whether the change proceeded as requested or not. - This function triggers the
onInitiativeChangeRequest(andonInitiativeChange) events, so it is possible that the change will be blocked. See the Guide to Initiative Events for more details. This function will return the offset of the token that has initiative after this function completes, whether the change proceeded as requested or not. id- The tokenidof the token to be removed from the initiative. Defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidof the token to be removed from the initiative. Defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
return- Returns 1 if removed from the initiative, 0 if did not. \
property- The name of the property to reset. \
- id- The tokenidof the token which has its property reset, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidof the token which has its property reset, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
- 1.3b51 - Added
idparameter option. \
- - 1.3b68 - Token Property is now deleted from Token \ +
- 1.3b68 - Token Property is now deleted from Token \
- 1.5.4 - Added
mapnameparameter option. \
id- The tokenidof the token to reset, defaults to the Current Token. \
+ id- The tokenidof the token to reset, defaults to the Current Token. \
mapName- Optional map name to find the token. Defaults to current map. \
tableName- A string containing the name of the Table. \
- entriesToReset- Since 1.8. Identifies specific entries to be reset. Can be a String List using the provided delim (defaults to","if no delim provided), or a JSON Array if delim is"json". \
- delim- Since 1.8. Custom delimiter for the `entriesToReset` param. Defaults to",". Should be"json"if entriesToReset is a JSON Array instead of a String List. \
+ entriesToReset- Since 1.8. Identifies specific entries to be reset. Can be a String List using the provided delim (defaults to","if no delim provided), or a JSON Array if delim is"json". \
+ delim- Since 1.8. Custom delimiter for the `entriesToReset` param. Defaults to",". Should be"json"if entriesToReset is a JSON Array instead of a String List. \
\[playStream(macro.args)]
To play the song, the GM can then use execLink:\
\ -\ @@ -20381,7 +20381,7 @@ REST.patch.summary = \ \[H: songUrl = "http://erinmcnamee.com.hostbaby.com/files/07_No_Sorrow__Banish_Misfortune.mp3"]\ +
\[H: songUrl = "https://erinmcnamee.com.hostbaby.com/files/07_No_Sorrow__Banish_Misfortune.mp3"]\ [H: audioByte = macroLinkText("playSong@Lib:MusicPlayer", "none", songUrl)]\ [H: execLink(audioByte,0,"all")]Alternatively, the GM can use execFunction:\
\ -\ -prevInitiative.description = Restores the initiative to the previous Token in the Initiative Panel , returning to the previous round if necessary. +prevInitiative.description = Restores the initiative to the previous Token in the Initiative Panel , returning to the previous round if necessary. prevInitiative.summary = \[H: songUrl = json.append("[]","http://erinmcnamee.com.hostbaby.com/files/07_No_Sorrow__Banish_Misfortune.mp3")]\ +\[H: songUrl = json.append("[]","https://erinmcnamee.com.hostbaby.com/files/07_No_Sorrow__Banish_Misfortune.mp3")]\ [H: execFunction("playStream", songUrl, 0, "all")Dropbox URLs
\After creating the dropbox share link you have to replace www.dropbox.com with dl.dropboxusercontent.com. That provides a direct link that playStream can use. Thanks to Full Bleed on the forums for the tip.\ @@ -19490,7 +19490,7 @@ power.summary = \
\\\ @@ -19500,12 +19500,12 @@ prevInitiative.summary = \ \\ -removeAllFromInitiative.description = Removes all of the Tokens from the Initiative Panel . +removeAllFromInitiative.description = Removes all of the Tokens from the Initiative Panel . removeAllFromInitiative.summary = \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.8\ -Restores the initiative to the previous Token in the Initiative Panel, returning to the previous round if necessary. Only the GM or a trusted macro can call this function. This function returns the offset into the Initiative Panel (starting at 0) of the Token that will receive Initiative. Note: neither this function nor the corresponding UI button will allow the Initiative to fall back any further than the first token in the first round.\ -\ +Restores the initiative to the previous Token in the Initiative Panel, returning to the previous round if necessary. Only the GM or a trusted macro can call this function. This function returns the offset into the Initiative Panel (starting at 0) of the Token that will receive Initiative. Note: neither this function nor the corresponding UI button will allow the Initiative to fall back any further than the first token in the first round.\ +\\ Usage\
\ @@ -19543,7 +19543,7 @@ refreshDrawing.summary = \ \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.5.0\ @@ -19580,7 +19580,7 @@ refreshDrawing.summary = \\\ -resetProperty.description = Resets the specified Token Property on a specific Token so that it is empty and will return the default value when queried (if it has one). +resetProperty.description = Resets the specified Token Property on a specific Token so that it is empty and will return the default value when queried (if it has one). resetProperty.summary = \\ @@ -19590,10 +19590,10 @@ removeAllFromInitiative.summary = \ \\ -removeAllNPCsFromInitiative.description = Removes all of the NPC Tokens from the Initiative Panel . +removeAllNPCsFromInitiative.description = Removes all of the NPC Tokens from the Initiative Panel . removeAllNPCsFromInitiative.summary = \\\ -\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\Removes all of the Tokens from the Initiative Panel. This function returns the number of Tokens that were removed. Only the GM can call this function.\ +Removes all of the Tokens from the Initiative Panel. This function returns the number of Tokens that were removed. Only the GM can call this function.\\ Usage\
\ @@ -19604,7 +19604,7 @@ removeAllFromInitiative.summary = \\\ @@ -19992,13 +19992,13 @@ resetFrame.summary = \\ @@ -19614,10 +19614,10 @@ removeAllNPCsFromInitiative.summary = \ \\ -removeAllPCsFromInitiative.description = Removes all of the PC Tokens from the Initiative Panel . +removeAllPCsFromInitiative.description = Removes all of the PC Tokens from the Initiative Panel . removeAllPCsFromInitiative.summary = \\\ -\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\Removes all of the NPC Tokens from the Initiative Panel. This function returns the number of Tokens that were removed. Only the GM can call this function.\ +Removes all of the NPC Tokens from the Initiative Panel. This function returns the number of Tokens that were removed. Only the GM can call this function.\\ Usage\
\ @@ -19628,7 +19628,7 @@ removeAllNPCsFromInitiative.summary = \\\\ @@ -19638,10 +19638,10 @@ removeAllPCsFromInitiative.summary = \ \\ -removeFromInitiative.description = Removes the Current Token from the Initiative Panel . +removeFromInitiative.description = Removes the Current Token from the Initiative Panel . removeFromInitiative.summary = \\\ -\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\Removes all of the PC Tokens from the Initiative Panel. This function returns the number of Tokens that were removed. Only the GM can call this function.\ +Removes all of the PC Tokens from the Initiative Panel. This function returns the number of Tokens that were removed. Only the GM can call this function.\\ Usage\
\ @@ -19652,7 +19652,7 @@ removeAllPCsFromInitiative.summary = \\\ @@ -19960,7 +19960,7 @@ May return\ @@ -19660,7 +19660,7 @@ removeFromInitiative.summary = \ \ removeFromInitiative() Function\ \ -\Removes the Current Token from the Initiative Panel. Additional parameters allow you to specify the token.\ +Removes the Current Token from the Initiative Panel. Additional parameters allow you to specify the token.\\ Usage\
\ @@ -19673,14 +19673,14 @@ removeFromInitiative(id, mapname)\ Parameters\ \- \
-
\ Example\
\ -To remove the token with the name "Dragon" in current map from the initiative panel.\ +\To remove the token with the name "Dragon" in current map from the initiative panel.\\[h: removeFromInitiative("Dragon")]\ See Also\ @@ -19754,7 +19754,7 @@ removeToken.summary = \ \
\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b51\ @@ -19795,7 +19795,7 @@ removeTokenFacing.summary = \ \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b51\ @@ -19839,7 +19839,7 @@ replace.summary = \ replace() Function\ \• Introduced in version 1.3b48\ -Returns the string with the occurrences of a pattern replaced by the specified value. If the number of times to perform the replacement is not specified then all occurrences of the pattern are replaced. Pattern can be a regular expression. This means if the pattern string contains any regular expression special characters they must be escaped.\ +Returns the string with the occurrences of a pattern replaced by the specified value. If the number of times to perform the replacement is not specified then all occurrences of the pattern are replaced. Pattern can be a regular expression. This means if the pattern string contains any regular expression special characters they must be escaped.\\ Usage\
\ @@ -19913,7 +19913,7 @@ Returns a number than is between25and50.\ See Also\
\ -For another method of rolling dice, see Dice Expressions.\ +For another method of rolling dice, see Dice Expressions.\5 [2, 1, 2, 4]- the first die produced a 2, which was r\ See Also\
\ -For another method of rolling dice, see Dice Expressions.\ +For another method of rolling dice, see Dice Expressions.\\ See Also\
\ -[frame():],\ + \\\\\ @@ -20007,7 +20007,7 @@ resetProperty.summary = \ resetProperty() Function\ \\ -resetSize.description = Resets the Size of a Token to the default for grid type of the map it occupies. +resetSize.description = Resets the Size of a Token to the default for grid type of the map it occupies. resetSize.summary = \• Introduced in version 1.3b48\ -Resets the specified Token Property on a specific Token so that it is empty and will return the default value when queried (if it has one).\ +Resets the specified Token Property on a specific Token so that it is empty and will return the default value when queried (if it has one).\\ Usage\
\ @@ -20021,7 +20021,7 @@ resetProperty(property, id, mapname)\ \- \
\ @@ -20039,7 +20039,7 @@ resetProperty(property, id, mapname)\
\\ @@ -20047,7 +20047,7 @@ resetProperty(property, id, mapname)\- \
\Note that entries on Pick Once tables are identified by list index (starting at 0), and not by range as in normal tables. Take care to properly identify entries when resetting. For more info, see Introduction to Tables and the table() function.\ @@ -20057,11 +20057,11 @@ resetSize.summary = \ \\ +[h:resetTablePicks("Standard", json.append("", 0, 1), "json")]\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b48\ -Resets the Size of a Token to the default for grid type of the map it occupies. See setSize() for details about the default size for different grid types.\ +Resets the Size of a Token to the default for grid type of the map it occupies. See setSize() for details about the default size for different grid types.\\ Usage\
\ @@ -20074,7 +20074,7 @@ resetSize(id, mapname)\ Parameters\ \- \
-
\ @@ -20116,7 +20116,7 @@ resetTablePicks.summary = \ \
\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.6.0\ @@ -20135,8 +20135,8 @@ resetTablePicks(tableName, entriesToReset, "json")\ \- \
\ Examples\ @@ -20154,7 +20154,7 @@ resetTablePicks(tableName, entriesToReset, "json")\
If this table is set to Pick Once, then the Ace and Two of Clubs can be reset with any of:\
Note that entries on Pick Once tables are identified by list index (starting at 0), and not by range as in normal tables. Take care to properly identify entries when resetting. For more info, see Introduction to Tables and the table() function.[h:resetTablePicks("Standard", "0,1")]\ [h:resetTablePicks("Standard", "0@1", "@")]\ -[h:resetTablePicks("Standard", json.append("", 0, 1), "json")]\ See Also\
\ @@ -20184,7 +20184,7 @@ REST.delete.summary = \ \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.5.0\ @@ -20251,7 +20251,7 @@ Note the 204 - No Content status and thus no "body" element in the JSON. If the See Also\ \ \\ Version Changes\ @@ -20275,7 +20275,7 @@ REST.get.summary = \ \
\ \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.5.0\ @@ -20365,7 +20365,7 @@ See this See Also\\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.5.0\ @@ -20450,7 +20450,7 @@ REST.patch(url, payload, mediaType, headers, getFullResponse)\ See Also\ \ \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.5.0\ @@ -20539,7 +20539,7 @@ REST.post(url, payload, mediaType, headers, getFullResponse)\ See Also\ \ \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.5.0\ @@ -20610,7 +20610,7 @@ REST.put(url, payload, mediaType, headers, getFullResponse)\ See Also\ \ \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.4.1.3\ @@ -20660,7 +20660,7 @@ restoreFoW(mapname)\\ See Also\
\ - \ + \• Introduced in version 1.5.0\ -Is used to conditionally return from the execution of a macro like an abort, but not stopping further macro execution. Optionally also returning a value by automatically assigning macro.return. If the first argument to\return()is 0 then the return is happening. If the first argument toreturn()is non zero then the macro continues. The optional second argument ofreturn()defines if there is a value that should be returned to a calling macro. Any other output is discarded when usingreturn().\ +Is used to conditionally return from the execution of a macro like an abort, but not stopping further macro execution. Optionally also returning a value by automatically assigning macro.return. If the first argument toreturn()is 0 then the return is happening. If the first argument toreturn()is non zero then the macro continues. The optional second argument ofreturn()defines if there is a value that should be returned to a calling macro. Any other output is discarded when usingreturn().\Common uses for this function are\
\- Ending a macro with or without a return value to stop the further execution of the following lines in the current macro.
- The macro has conditions and based on these you want to return different values and not continue further in the current macro.
Rolls 5 times a d6 and returns these as sorted list as well as the total.\ -
- See also[count():], listAppend() and listSort().
- See also[count():], listAppend() and listSort().
\ See Also\
\ -For another method of rolling dice, see Dice Expressions.\ +For another method of rolling dice, see Dice Expressions.\\ See Also\
\ -The corresponding dice roll expression is\ +XdYaZlW. For other methods of rolling dice, see Dice Expressions.The corresponding dice roll expression is\XdYaZlW. For other methods of rolling dice, see Dice Expressions.\ See Also\
\ -The corresponding dice roll expression is\ +XdYaZuW. For other methods of rolling dice, see Dice Expressions.The corresponding dice roll expression is\XdYaZuW. For other methods of rolling dice, see Dice Expressions.\ See Also\
\ -The corresponding dice roll expression is\ +XdYsZlW. For other methods of rolling dice, see Dice Expressions.The corresponding dice roll expression is\XdYsZlW. For other methods of rolling dice, see Dice Expressions.\ See Also\
\ -The corresponding dice roll expression is\ +XdYsZuW. For other methods of rolling dice, see Dice Expressions.The corresponding dice roll expression is\XdYsZuW. For other methods of rolling dice, see Dice Expressions.\ See Also\
\ -The corresponding dice roll expression is\ +XdYlZ. For other methods of rolling dice, see Dice Expressions.The corresponding dice roll expression is\XdYlZ. For other methods of rolling dice, see Dice Expressions.\ See Also\
\ -The corresponding dice roll expression is\ +XdYuZ. For other methods of rolling dice, see Dice Expressions.The corresponding dice roll expression is\XdYuZ. For other methods of rolling dice, see Dice Expressions.- \
id- the id string or token name of a specific token to select (the examples below use token names, but IDs are also permitted); if left blank all visible tokens are selected. \
add- if the value of add istrue(1), the selections will be added to the current set of selected tokens; if the value isfalse(0)currently selected tokens will be deselected before new tokens are selected. Defaults to false. \
- tokens- a String List of tokens to select. \
- delim- Specifies the delimiter used in the string list that is supplied. If the delimiter is "json", then the value fortokensmay be a JSON Array instead. Note: if using a JSON Array or String List, bothaddanddelimmust be specified. \
+ tokens- a String List of tokens to select. \
+ delim- Specifies the delimiter used in the string list that is supplied. If the delimiter is "json", then the value fortokensmay be a JSON Array instead. Note: if using a JSON Array or String List, bothaddanddelimmust be specified. \
\ Example\
\To select a single token with the name "Adventurer":\\\ -[h:selectTokens("Adventurer")]To select a list of Tokens using a String List, replacing the current selection\ +
To select a list of Tokens using a String List, replacing the current selection\
\\ -[h:selectTokens("Adventurer, Orc 2, Goblin 1", 0, ",")]To select a list of Tokens using a JSON Array, adding the specified tokens to the current set of selected Tokens:\ +
To select a list of Tokens using a JSON Array, adding the specified tokens to the current set of selected Tokens:\
\[h:selectTokens("['Adventurer', 'Orc 2', 'Goblin 1']", 1, "json")]\ @@ -21171,7 +21171,7 @@ sendDrawingToBack.summary = \ \
\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.4.1.7\ @@ -21207,7 +21207,7 @@ sendDrawingToBack.summary = \\\ @@ -21216,7 +21216,7 @@ sendToBack.summary = \ sendToBack() Function\ \• Introduced in version 1.3b48\ -Adjust the z-order (or draw order) of the Token so that it is drawn before all other Tokens on the same Map Layer, this has the effect of making the Token appear to be in back of the other Tokens as it will be obscured by other Tokens on the same Map Layer in the same location.\ +Adjust the z-order (or draw order) of the Token so that it is drawn before all other Tokens on the same Map Layer, this has the effect of making the Token appear to be in back of the other Tokens as it will be obscured by other Tokens on the same Map Layer in the same location.\\ Usage\
\ @@ -21229,13 +21229,13 @@ sendToBack(id, mapname)\ Parameter\ \- \
-
id- The tokenidor name of the token that has its z-order changed, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidor name of the token that has its z-order changed, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ Examples\
\ -Sends the Current Token to the lowest z-order.\ +Sends the Current Token to the lowest z-order.\\ -setAllStates.description = Sets all of the States of a Token to on (\[h: sendToBack()]
Sends all of the selected tokens to the lowest z-order.\
\ @@ -21316,7 +21316,7 @@ This function is rarely used because a simple assignment to a variable name cantrue(1)) or off (false(0)). +setAllStates.description = Sets all of the States of a Token to on (true(1)) or off (false(0)). setAllStates.summary = \\\ @@ -21325,7 +21325,7 @@ setAllStates.summary = \ setAllSates() Function\ \• Introduced in version 1.3b40\ - \ + \\ Usage\
\ @@ -21339,21 +21339,21 @@ setAllStates(value, id, mapname)\ \- \
value- If all states should be set on or off,true(1) orfalse(0). \
- id- Theidof the token that should have its States set. Defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- Theidof the token that should have its States set. Defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ Examples\
\ -Set all Token States on\ +\ -setBar.description = Sets the value of the specified bar for the Current Token and makes the bar visible. +setBar.description = Sets the value of the specified bar for the Current Token and makes the bar visible. setBar.summary = \Set all Token States on\\\ -[h: setAllStates(1)]
Set all Token States off\ +
Set all Token States off\
\[h: setAllStates(0)]
\ See Also\
\ - \ + \\ Version Changes\
\ @@ -21388,7 +21388,7 @@ setAlwaysVisible.summary = \ \- \
value- The value of the setting to set,true(1) orfalse(0). \
- id- OPTIONAL: The tokenidof the token for which you want to set this setting, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- OPTIONAL: The tokenidof the token for which you want to set this setting, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
\ Example\ @@ -21403,7 +21403,7 @@ setAlwaysVisible.summary = \
\\ -setBarVisible.description = Sets if the specified bar for the Current Token is visible or not. +setBarVisible.description = Sets if the specified bar for the Current Token is visible or not. setBarVisible.summary = \\ @@ -21413,11 +21413,11 @@ setBar.summary = \ \\\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b42\ -Sets the value of the specified bar for the Current Token and makes the bar visible. The value to set is between 0 and 1 for 0% to 100% respectively.\ +Sets the value of the specified bar for the Current Token and makes the bar visible. The value to set is between 0 and 1 for 0% to 100% respectively.\\ Usage\
\ @@ -21432,7 +21432,7 @@ setBar(name, pct/100, id, mapname)\- \
name- The name of the bar. \
value- The value of the bar. Should be between 0 and 1. \
- id- The tokenidof the token which has its bar set, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidof the token which has its bar set, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ @@ -21462,17 +21462,17 @@ setBar(name, pct/100, id, mapname)\ \
- \
- \ - HP and Health Bars\ + HP and Health Bars\ \
- \
- The
bar.namespecial variable\ + Thebar.namespecial variable\ \
\\ @@ -21481,7 +21481,7 @@ setBarVisible.summary = \ setBarVisible() Function\ \\ -setCurrentInitiative.description = Gives the Initiative to the Token at the specified offset in the Initiative Panel . +setCurrentInitiative.description = Gives the Initiative to the Token at the specified offset in the Initiative Panel . setCurrentInitiative.summary = \• Introduced in version 1.3b46\ -Sets if the specified bar for the Current Token is visible or not. If the value is non zero then the bar is visible, if it is 0 it is not visible.\ +Sets if the specified bar for the Current Token is visible or not. If the value is non zero then the bar is visible, if it is 0 it is not visible.\\ Usage\
\ @@ -21496,15 +21496,15 @@ setBarVisible(name, value, id, mapname)\- \
bar- A string that contains the name of the bar that has its visibility set. \
value- The visibility value of the bar, either 0 or 1. \
- id- The tokenidof the token which has its bar visibility set, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidof the token which has its bar visibility set, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ Examples\
\ -Make "health" bar for the Current Token visible.\ +\Make "health" bar for the Current Token visible.\\\ -[h: setBarVisible("Health", 1)]Hide "health" bar for the Current Token.\ +
Hide "health" bar for the Current Token.\
\[h: setBarVisible("Health", 0)]\ @@ -21526,17 +21526,17 @@ setBarVisible(name, value, id, mapname)\ \
- \
- \ - HP and Health Bars\ + HP and Health Bars\ \
- \
- The
bar.namespecial variable\ + Thebar.namespecial variable\ \
\\ @@ -21544,7 +21544,7 @@ setCurrentInitiative.summary = \ \ setCurrentInitiative() Function\ \ -Gives the Initiative to the Token at the specified offset in the Initiative Panel. Offsets start at 0.\ +\Gives the Initiative to the Token at the specified offset in the Initiative Panel. Offsets start at 0.\ To clear, specify a number that is not a valid token offset, like -1.\\ Usage\ @@ -21555,7 +21555,7 @@ To clear, specify a number that is not a valid token offset, like -1.
\ Examples\
\ -Give Initiative to the 4th Token.\ +\Give Initiative to the 4th Token.\\ +Search https://forums.rptools.net/ for\[h: setCurrentInitiative(3)]
Clear current initiative (any number that is not a valid token offset will work).\
\ @@ -21578,7 +21578,7 @@ setCurrentMap.summary = \WARNING: This function changes an internal variable used by MapTool to keep track of which map is current and this change takes place immediately. However, changes to tokens are queued up and only occur when the macro finishes execution (well, sort of). The end result is that if a token is being modified on map "A" and your macro calls setCurrentMap() to switch to map "B", when the macro finishes and the token changes are executed they will be processing a token on map B! If there was no such token on map B a new one will be created, thus mysteriously duplicating tokens!\
Therefore, do NOT modify any token properties, states, names, notes, or any other token-specific values after calling setCurrentMap(). Or make sure that the first thing your macro does is call setCurrentMap() so that all tokens accessed later will be on the map that is current when the macro finishes.\
\ -Search http://forums.rptools.net/ forsetCurrentMapto find some discussion threads on this topic.setCurrentMapto find some discussion threads on this topic.\ Usage\
\ @@ -21617,7 +21617,7 @@ setDrawingEraser.summary = \ \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.5.0\ @@ -21668,12 +21668,12 @@ setDrawingLayer.summary = \ \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.4.1.7\For a specified drawing, set the layer of the map to which the drawing belongs.\ -\ @@ -21721,7 +21721,7 @@ setDrawingOpacity.summary = \ \The Map Layer is one of:\ +
The Map Layer is one of:\
\TOKENGMalso known as HiddenOBJECTBACKGROUND
\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.5.0\ @@ -21770,7 +21770,7 @@ setDrawingProperties.summary = \ \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.5.0\ @@ -21819,7 +21819,7 @@ setFillColor.summary = \ \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.5.0\ @@ -21871,7 +21871,7 @@ setGMName.summary = \ \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b49\ @@ -21889,13 +21889,13 @@ setGMName(name, id, mapname)\ \- \
name- A string that is set as the GM Name on the token. \
- id- The token id of the token that has its GM Name set. Defaults to the Current Token. \
+ id- The token id of the token that has its GM Name set. Defaults to the Current Token. \
mapname- The name of the map to find the token. Defaults to the current map. \
\ Examples\
\ -Sets the GM Name of the Current Token toNew GM Name.\ +Sets the GM Name of the Current Token to\ -setGMNotes.description = Sets the GM notes of the Current Token . +setGMNotes.description = Sets the GM notes of the Current Token . setGMNotes.summary = \New GM Name.\\[h: setGMName("New GM Name")]Sets the GM Name of all selected tokens to
\ @@ -21923,7 +21923,7 @@ setGMName(name, id, mapname)\New GM Name.\\\ -setHalo.description = Sets the Halo color of a Token . +setHalo.description = Sets the Halo color of a Token . setHalo.summary = \\ @@ -21933,11 +21933,11 @@ setGMNotes.summary = \ \\\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b48\ -Sets the GM notes of the Current Token.\ +Sets the GM notes of the Current Token.\\ Usage\
\ @@ -21951,14 +21951,14 @@ setGMNotes(notes, id, mapname)\ \- \
notes- The GM notes to set on the token. \
- id- The tokenidof the token to set the GM notes on.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidof the token to set the GM notes on.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\\ @@ -21967,7 +21967,7 @@ setHalo.summary = \ setHalo() Function\ \• Introduced in version 1.3b49\ - \ + \\ Usage\
\ @@ -21981,25 +21981,25 @@ setHalo.summary = \ Parameters\ \- \
-
color- The color to set the Halo to, valid values are:\ +color- The color to set the Halo to, valid values are:\"Black""Green""Yellow""Orange""Red""Cyan""Magenta""White"- A hexadecimal color value in the format
"#RRGGBB" "None"
\
- id- The tokenidof the token that has its Halo set by this function.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidof the token that has its Halo set by this function.Note: This parameter can only be used in a Trusted Macro.
\
\ Examples\
\ -To remove the Halo from the Current Token.\ +To remove the Halo from the Current Token.\\\ -[h: setHalo("None")]To set the Halo for the Current Token to red.\ +
To set the Halo for the Current Token to red.\
\\ -[h: setHalo("Red")]To set the Halo from the Current Token to a custom color\ +
To set the Halo from the Current Token to a custom color\
\[h: setHalo("#33AAFF")]\ See Also\
\ - \ -setHasSight.description = Enables/disables sight for the Current Token . +setHasSight.description = Enables/disables sight for the Current Token . setHasSight.summary = \\\ @@ -22022,7 +22022,7 @@ setHasSight.summary = \ setHasSight() Function\ \\ -setInitiative.description = Sets the Initiative of the Current Token . +setInitiative.description = Sets the Initiative of the Current Token . setInitiative.summary = \• Introduced in version 1.3b48\ -Enables/disables sight for the Current Token. If the argument is 0 (false) sight will be disabled on the Current Token. If it is non-zero (true) sight is enabled.\ +Enables/disables sight for the Current Token. If the argument is 0 (false) sight will be disabled on the Current Token. If it is non-zero (true) sight is enabled.\\ Usage\
\ @@ -22036,13 +22036,13 @@ setHasSight(state, id, mapname)\ \- \
state- Boolean - true to enable sight, false to disable \
- id- Theidof the token to set the sight of. Defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- Theidof the token to set the sight of. Defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ Example\
\ -Enables sight for Current Token\ +\Enables sight for Current Token\\\ Returns: Empty String.[h: setHasSight(1)]
\ @@ -22060,7 +22060,7 @@ Returns: Empty String.
\\ -setInitiativeHold.description = Sets if the Current Token is on hold in the Initiative Panel . +setInitiativeHold.description = Sets if the Current Token is on hold in the Initiative Panel . setInitiativeHold.summary = \\ @@ -22069,7 +22069,7 @@ setInitiative.summary = \ setInitiative() Function\ \\• Introduced in version 1.3b41\ -Sets the Initiative of the Current Token.\ +Sets the Initiative of the Current Token.\\ Usage\
\ @@ -22080,7 +22080,7 @@ setInitiative(value, id, mapname)\- \
value- The initiative value to set. If included, the initiative will be set even if the token is already on the initiative list. \
- id- The tokenidof the token to have its initiative set. Defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidof the token to have its initiative set. Defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ @@ -22103,7 +22103,7 @@ setInitiative(value, id, mapname)\
\\ @@ -22112,7 +22112,7 @@ setInitiativeHold.summary = \ setInitiativeHold() Function\ \\ -setInitiativeRound.description = Sets the current round number in the Initiative Panel . +setInitiativeRound.description = Sets the current round number in the Initiative Panel . setInitiativeRound.summary = \• Introduced in version 1.3b41\ -Sets if the Current Token is on hold in the Initiative Panel. If the value passed is non zero then the Current Token is placed on hold, if it is 0 it is removed from on hold.\ +Sets if the Current Token is on hold in the Initiative Panel. If the value passed is non zero then the Current Token is placed on hold, if it is 0 it is removed from on hold.\\ Usage\
\ @@ -22126,7 +22126,7 @@ setInitiativeHold(value, id, mapname)\ \- \
value- The initiative hold value to set. \
- id- The tokenidof the token to set the initiative hold. Defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidof the token to set the initiative hold. Defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ @@ -22144,7 +22144,7 @@ setInitiativeHold(value, id, mapname)\
\\ @@ -22154,10 +22154,10 @@ setInitiativeRound.summary = \ \\ -setLabel.description = Sets the Token Label of a specific Token . +setLabel.description = Sets the Token Label of a specific Token . setLabel.summary = \\\ -\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\Sets the current round number in the Initiative Panel.\ +Sets the current round number in the Initiative Panel.\\ Usage\
\ @@ -22168,7 +22168,7 @@ setInitiativeRound.summary = \\\ @@ -22177,7 +22177,7 @@ setLabel.summary = \ setLabel() Function\ \\ -setLayer.description = Sets the Map Layer that a Token is on. +setLayer.description = Sets the Map Layer that a Token is on. setLayer.summary = \• Introduced in version 1.3b48\ -Sets the Token Label of a specific Token.\ +Sets the Token Label of a specific Token.\\ Usage\
\ @@ -22191,8 +22191,8 @@ setLabel.summary = \ Parameters\ \- \
-
label- The string that the Token Label is set to. \
- id- The tokenidof the token that has its label set, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ label- The string that the Token Label is set to. \
+ id- The tokenidof the token that has its label set, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
\
\ @@ -22215,7 +22215,7 @@ setLabel.summary = \\\ @@ -22225,12 +22225,12 @@ setLayer.summary = \ \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b48\ -Sets the Map Layer that a Token is on.\ -\ -setLibProperty.description = Sets the Token Property on a Library Token . if the name of the Library Token is not specified then the Token Property is set on the Library Token that the macro is running from. +setLibProperty.description = Sets the Token Property on a Library Token . if the name of the Library Token is not specified then the Token Property is set on the Library Token that the macro is running from. setLibProperty.summary = \The Map Layer is one of:\ +
Sets the Map Layer that a Token is on.\ +\ @@ -22247,8 +22247,8 @@ setLayer(layer, id, forceshape, mapname)\ Parameters\ \The Map Layer is one of:\
\TOKENGMalso known as HiddenOBJECTBACKGROUND
- \
-
layer- The layer to move the Token to. \
- id- The tokenidof the token which has its layer set, defaults to the Current Token. \
+ layer- The layer to move the Token to. \
+ id- The tokenidof the token which has its layer set, defaults to the Current Token. \
forceshape- Iftrue(1), change the token shape type to TOP_DOWN if the layer isOBJECT, and to a shape reflecting its image if the layer isTOKEN. Defaults totrue(1). \
mapname- The name of the map to find the token. Defaults to the current map. \
\\ @@ -22292,7 +22292,7 @@ setLibProperty.summary = \ setLibProperty() Function\ \• Introduced in version 1.3b48\ -Sets the Token Property on a Library Token. if the name of the Library Token is not specified then the Token Property is set on the Library Token that the macro is running from.\ +Sets the Token Property on a Library Token. if the name of the Library Token is not specified then the Token Property is set on the Library Token that the macro is running from.\\ Usage\
\ @@ -22303,9 +22303,9 @@ setLibProperty(name, value, libName)\\ Examples\
\ -Set a property on the Library Token that the macro is running from.\ +\ -setLight.description = Sets the light sources of the Current Token . +setLight.description = Sets the light sources of the Current Token . setLight.summary = \Set a property on the Library Token that the macro is running from.\\ @@ -22313,7 +22313,7 @@ Known Bug: note that using setLibProperty during onCampaignLoad and not being on\ -[h: setLibProperty("defaultStrength", 10)]Set a property on a specifig Library Token.\ +
Set a property on a specifig Library Token.\
\\ Known Bug: note that using setLibProperty during onCampaignLoad and not being on the map where the lib resides, will result in a duplicate of that lib on the current map![h: setLibProperty("defaultStrength", 10, "Lib:Character")]\\ @@ -22322,7 +22322,7 @@ setLight.summary = \ setLight() Function\ \\ -setMacroCommand.description = Sets the command that will be run when the Macro Button is pressed. +setMacroCommand.description = Sets the command that will be run when the Macro Button is pressed. setMacroCommand.summary = \• Introduced in version 1.3b48\ -Sets the light sources of the Current Token. If the value is\ +false(0) then the light source is turned off; otherwise, it is turned on.Sets the light sources of the Current Token. If the value is\false(0) then the light source is turned off; otherwise, it is turned on.\ Usage\
\ @@ -22336,9 +22336,9 @@ setLight(type, name, value, id, mapname)\ \- \
type- The light source type, (e.g. "Generic", "D20"). \
- name- The name of the light source. \
+ name- The name of the light source. \
value- Iftrue(1) sets the light on, iffalse(0) turns it off. \
- id- The tokenidof the token to change the light sources, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidof the token to change the light sources, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ @@ -22374,7 +22374,7 @@ setLineCap.summary = \ \
\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.5.0\ @@ -22415,7 +22415,7 @@ setLineCap.summary = \\\ @@ -22425,11 +22425,11 @@ setMacroCommand.summary = \ \\ -setMacroProps.description = Sets the properties for the specified Macro Button on the Current Token . +setMacroProps.description = Sets the properties for the specified Macro Button on the Current Token . setMacroProps.summary = \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b48\ -Sets the command that will be run when the Macro Button is pressed. Note because of the way the parser interprets values within [] you may have to use the encode() and decode() functions with the string.\ +Sets the command that will be run when the Macro Button is pressed. Note because of the way the parser interprets values within [] you may have to use the encode() and decode() functions with the string.\\ Usage\
\ @@ -22469,7 +22469,7 @@ setMacroCommand(index, command, id, mapname)\\\ @@ -22478,7 +22478,7 @@ setMacroProps.summary = \ setMacroProps() Function\ \\ -setMaxLoopIterations.description = Sets the max amount of loops (in [count():] , [foreach():] , [for():] , [while():] ) that are allowed. +setMaxLoopIterations.description = Sets the max amount of loops (in [count():] , [foreach():] , [for():] , [while():] ) that are allowed. setMaxLoopIterations.summary = \• Introduced in version 1.3b48\ -Sets the properties for the specified Macro Button on the Current Token . The properties are passed to this function as a String Property List. This function accepts either a Macro Button Index or the label of a Macro Button. If it is a label then all of Macro Buttons on the Current Token with a matching label are changed.\ +Sets the properties for the specified Macro Button on the Current Token . The properties are passed to this function as a String Property List. This function accepts either a Macro Button Index or the label of a Macro Button. If it is a label then all of Macro Buttons on the Current Token with a matching label are changed.\\ Usage\
\ @@ -22500,11 +22500,11 @@ setMacroProps(label, props, delim, id, mapname)\- \
index- The index of the macro button. \
label- The label of the macro button. \
- props- A String Property List or JSON Object containing the properties for the button.\ -applyToSelected- Should the macro be applied to the selected tokens.autoExecute- If the macro will be automatically executed when the button is clicked, acceptstrue(1) orfalse(0).color- The name of the color for the button.command- The command for the macro (only when using JSON version of function).fontColor- The name of the font color for the button.fontSize- The size of the font for the button.includeLabel- If the label will be output when the button is clicked. Acceptstrue(1) orfalse(0).group- The name of the group that the button belongs to.sortBy- The sort by value of the macro button.label- The label for the button.maxWidth- The maximum width of the button.minWidth- The minimum width of the button.playerEditable- Is the button player editable, acceptstrue(1) orfalse(0).tooltip- The tool tip for the macro button.compare- Takes a JSON Array which can contain one or more of the following keywords (only usable with JSON version of the function).\ +props- A String Property List or JSON Object containing the properties for the button.\ +applyToSelected- Should the macro be applied to the selected tokens.autoExecute- If the macro will be automatically executed when the button is clicked, acceptstrue(1) orfalse(0).color- The name of the color for the button.command- The command for the macro (only when using JSON version of function).fontColor- The name of the font color for the button.fontSize- The size of the font for the button.includeLabel- If the label will be output when the button is clicked. Acceptstrue(1) orfalse(0).group- The name of the group that the button belongs to.sortBy- The sort by value of the macro button.label- The label for the button.maxWidth- The maximum width of the button.minWidth- The minimum width of the button.playerEditable- Is the button player editable, acceptstrue(1) orfalse(0).tooltip- The tool tip for the macro button.compare- Takes a JSON Array which can contain one or more of the following keywords (only usable with JSON version of the function).\applyToSelected- Use the macro applyToSelected for common macro comparisons.autoExecute- Use the macro autoExec for common macro comparisons.command- Use the macro command for common macro comparisons.group- Use the macro group for common macro comparisons.includeLabel- Use the macro includeLabel for common macro comparisons.sortPrefix- Use the macro sortPrefix for common macro comparisons.
\
- delim- The delimiter used in the String Property List that is sent to thepropsparameter, defaults to";"and can be omitted if you are sending a JSON Object to thepropsparameter. If you are sending a JSON Object to thepropsparameter, and using theidparameter, you can set this to"json". \
- id- The tokenidof the token that the macro button is located on.Note: This parameter can only be used in a Trusted Macro.
\
+ delim- The delimiter used in the String Property List that is sent to thepropsparameter, defaults to";"and can be omitted if you are sending a JSON Object to thepropsparameter. If you are sending a JSON Object to thepropsparameter, and using theidparameter, you can set this to"json". \
+ id- The tokenidof the token that the macro button is located on.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ @@ -22550,7 +22550,7 @@ setMapDisplayName.summary = \ \
\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.9.0\ @@ -22596,7 +22596,7 @@ setMapName.summary = \ \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.4.0.1\ @@ -22636,7 +22636,7 @@ setMapVisible.summary = \ \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.4.0.1\ @@ -22668,7 +22668,7 @@ setMapVisible(visible, mapName)\
\\ @@ -22677,7 +22677,7 @@ setMaxLoopIterations.summary = \ setMaxLoopIterations() Function\ \\ -setName.description = Sets the name of a Token . +setName.description = Sets the name of a Token . setName.summary = \• Introduced in version 1.4.0.2\ -Sets the max amount of loops (in [count():], [foreach():], [for():], [while():]) that are allowed. The current allowed min is 10,000. Note that this settings lasts only for the current session.\ +Sets the max amount of loops (in [count():], [foreach():], [for():], [while():]) that are allowed. The current allowed min is 10,000. Note that this settings lasts only for the current session.\\ Usage\
\ @@ -22743,7 +22743,7 @@ setMaxRecursionDepth.summary = \\\ @@ -22752,7 +22752,7 @@ setName.summary = \ setName() Function\ \\ -setNotes.description = Sets the notes of the Current Token . +setNotes.description = Sets the notes of the Current Token . setNotes.summary = \• Introduced in version 1.3b40\ -Sets the name of a Token.\ +Sets the name of a Token.\\ Usage\
\ @@ -22766,7 +22766,7 @@ setName(name, id, mapname)\ \- \
name- The name to set on the current token. \
- id- The tokenidof the token which has its name set.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidof the token which has its name set.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ @@ -22785,7 +22785,7 @@ setName(name, id, mapname)\
\\ @@ -22794,7 +22794,7 @@ setNotes.summary = \ setNotes() Function\ \\ -setNPC.description = Sets a Token to a NPC Token . +setNPC.description = Sets a Token to a NPC Token . setNPC.summary = \• Introduced in version 1.3b48\ -Sets the notes of the Current Token.\ +Sets the notes of the Current Token.\\ Usage\
\ @@ -22809,7 +22809,7 @@ setNotes(notes, id, mapname)\ \- \
notes- The notes to set on the token. \
- id- The tokenidof the token to set the notes on.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidof the token to set the notes on.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ @@ -22822,7 +22822,7 @@ See also getNotes\
\\ @@ -22832,11 +22832,11 @@ setNPC.summary = \ \\ -setOwner.description = Changes the owners of a token (default is the Current Token ) when given a String owner name or JSON Array of owner names. +setOwner.description = Changes the owners of a token (default is the Current Token ) when given a String owner name or JSON Array of owner names. setOwner.summary = \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b48\ - \ + \\ Usage\
\ @@ -22849,7 +22849,7 @@ setNPC(id, mapname)\ Parameter\ \- \
-
id- The tokenidof the token which has its NPC status set, defaults to the Current Token. \
+ id- The tokenidof the token which has its NPC status set, defaults to the Current Token. \
mapname- The name of the map to find the token. Defaults to the current map. \
\ @@ -22897,7 +22897,7 @@ setOwnedByAll(owned, id, mapname)\
\- \
owned- The value of the setting to set,true(1) orfalse(0). \
- id- The tokenidof the token which has its Owned by All status set, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidof the token which has its Owned by All status set, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ @@ -22925,7 +22925,7 @@ setOwnedByAll(owned, id, mapname)\
\\ @@ -22934,7 +22934,7 @@ setOwner.summary = \ setOwner() Function\ \• Introduced in version 1.3b48?\ -Changes the owners of a token (default is the Current Token) when given a String owner name or JSON Array of owner names. All other owners are removed.\ +Changes the owners of a token (default is the Current Token) when given a String owner name or JSON Array of owner names. All other owners are removed.\\ Usage\
\ @@ -22950,33 +22950,33 @@ setOwner(ownerNames, id, mapname)\ Parameters\ \- \
-
ownerName- The player name to set the ownership on the token. Ownership is not constrained to the client names currently connected, but only currently connected clients appear in the Token Editor Dialog. This parameter is a String. An empty string here is treated as an empty JSON array (see next parameter). \
- ownerNames- The player names to set the ownership on the token. Ownership is not constrained to the client names currently connected, but only currently connected clients appear in the Token Editor Dialog. This parameter is a JSON Array. \
- id- The tokenidof the token which has its owners changed, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ ownerName- The player name to set the ownership on the token. Ownership is not constrained to the client names currently connected, but only currently connected clients appear in the Token Editor Dialog. This parameter is a String. An empty string here is treated as an empty JSON array (see next parameter). \
+ ownerNames- The player names to set the ownership on the token. Ownership is not constrained to the client names currently connected, but only currently connected clients appear in the Token Editor Dialog. This parameter is a JSON Array. \
+ id- The tokenidof the token which has its owners changed, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ Examples\
\ -To change the owners of the Current Token to a single user use:\ +To change the owners of the Current Token to a single user use:\\ -[h: setOwner("Frank")]To change the owners of the Current Token to a list of three players use:\ +
To change the owners of the Current Token to a list of three players use:\
\\[h: setOwner("['Peter', 'Paul', 'Mary']")]or:\
\\ -[h: list = json.append("[]", "Peter", "Paul", "Mary")]\ [h: setOwner(list)]To make all current players owners of the Current Token use:\ +
To make all current players owners of the Current Token use:\
\\ -[h: setOwner(getAllPlayerNames("json"))]To remove all owners of the Current Token use:\ +
To remove all owners of the Current Token use:\
\\[h: setOwner("")]or:\
\\ -[h: setOwner("[]")]To display the current owners of the Current Token as checkboxes, then accept the user's changes to apply back onto the token, use the following. Note that this example does not provide for adding owners to the list, only removing them. (Adding owners would require the use of getAllPlayerNames() and would make this example even more complex.)\ +
To display the current owners of the Current Token as checkboxes, then accept the user's changes to apply back onto the token, use the following. Note that this example does not provide for adding owners to the list, only removing them. (Adding owners would require the use of getAllPlayerNames() and would make this example even more complex.)\
\\ -setOwnerOnlyVisible.description = Sets the Visible to Owners Only flag on a Token if the value passed in is non-zero([h: names = getOwners("json")]\ [h: input = "tab0 | OwnerList || TAB"]\ @@ -23010,7 +23010,7 @@ setOwner(ownerNames, id, mapname)\true(1)), otherwise resets it tofalse(0). +setOwnerOnlyVisible.description = Sets the Visible to Owners Only flag on a Token if the value passed in is non-zero(true(1)), otherwise resets it tofalse(0). setOwnerOnlyVisible.summary = \\\ @@ -23020,11 +23020,11 @@ setOwnerOnlyVisible.summary = \ \\ -setPC.description = Sets a Token to a PC Token . +setPC.description = Sets a Token to a PC Token . setPC.summary = \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b74\ -Sets the Visible to Owners Only flag on a Token if the value passed in is non-zero(\ +true(1)), otherwise resets it tofalse(0).Sets the Visible to Owners Only flag on a Token if the value passed in is non-zero(\true(1)), otherwise resets it tofalse(0).\ Usage\
\ @@ -23039,7 +23039,7 @@ setOwnerOnlyVisible.summary = \ \- \
visible- The state of owner only visibility,true(1) orfalse(0). \
- id- The tokenidof the token which has its owner only visibility set, defaults to the Current Token. \
+ id- The tokenidof the token which has its owner only visibility set, defaults to the Current Token. \
\
\ @@ -23052,7 +23052,7 @@ setOwnerOnlyVisible.summary = \\\ @@ -23062,11 +23062,11 @@ setPC.summary = \ \\ -setProperty.description = Sets the value of a Token Property on the Current Token (unless trusted, in which case a Token ID can be supplied to indicate which token is to be affected). +setProperty.description = Sets the value of a Token Property on the Current Token (unless trusted, in which case a Token ID can be supplied to indicate which token is to be affected). setProperty.summary = \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b48\ - \ + \\ Usage\
\ @@ -23079,7 +23079,7 @@ setPC(id, mapname)\ Parameter\ \- \
-
id- The tokenidof the token which has its PC status set, defaults to the Current Token. \
+ id- The tokenidof the token which has its PC status set, defaults to the Current Token. \
mapname- The name of the map to find the token. Defaults to the current map. \
\ @@ -23114,7 +23114,7 @@ setPenColor.summary = \ \
\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.5.0\ @@ -23163,7 +23163,7 @@ setPenWidth.summary = \ \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.5.0\ @@ -23203,7 +23203,7 @@ Regardless of the set width, a line will only be visible if it has a visible col\\ @@ -23212,7 +23212,7 @@ setProperty.summary = \ setProperty() Function\ \• Introduced in version 1.3b48\ -Sets the value of a Token Property on the Current Token (unless trusted, in which case a Token ID can be supplied to indicate which token is to be affected).\ +Sets the value of a Token Property on the Current Token (unless trusted, in which case a Token ID can be supplied to indicate which token is to be affected).\ Note that if there is not already an existing property by the name listed in the macro, setProperty will create a new Token Property with that name. Any created Property will not be visible in the Properties tab of the Edit Token window but can still be used like normal. It's value can be retrieved with the getProperty command.\\ Usage\ @@ -23228,13 +23228,13 @@ setProperty(property, value, id, mapname)\
- \
property- A string containing the name of the property that has its value set. \
value- The value that the property is set to. \
- id- The tokenidof the token which has its property set, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidof the token which has its property set, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ Examples\
\ -Sets a property namedHealthto the value of10on the Current Token.\ +Sets a property named\ -setPropertyType.description = Sets the Property Type of a Token . +setPropertyType.description = Sets the Property Type of a Token . setPropertyType.summary = \Healthto the value of10on the Current Token.\\[h: setProperty("Health", 10)]Sets a property named
\ @@ -23264,7 +23264,7 @@ setProperty(property, value, id, mapname)\Fatigueto the value of5on the selected token.\\\ @@ -23273,7 +23273,7 @@ setPropertyType.summary = \ setPropertyType() Function\ \\ -setSightType.description = Sets the type of sight that the Current Token has. +setSightType.description = Sets the type of sight that the Current Token has. setSightType.summary = \• Introduced in version 1.3b48\ -Sets the Property Type of a Token.\ +Sets the Property Type of a Token.\\ Usage\
\ @@ -23287,7 +23287,7 @@ setPropertyType(type, id, mapname)\ \- \
type- The property type to set on the token. \
- id- The tokenidof the token which has its property type set, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidof the token which has its property type set, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ @@ -23312,7 +23312,7 @@ setPropertyType(type, id, mapname)\
\\ @@ -23321,7 +23321,7 @@ setSightType.summary = \ setSightType() Function\ \\ -setSize.description = Sets the size of a Token with one of the defined sizes according to each Grid Type. +setSize.description = Sets the size of a Token with one of the defined sizes according to each Grid Type. setSize.summary = \• Introduced in version 1.3b48\ -Sets the type of sight that the Current Token has.\ +Sets the type of sight that the Current Token has.\\ Usage\
\ @@ -23335,7 +23335,7 @@ setSightType(type, id, mapname)\ \- \
type- The type of sight to set. \
- id- Theidof the token to set the sight. Defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- Theidof the token to set the sight. Defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ @@ -23353,7 +23353,7 @@ setSightType(type, id, mapname)\
\\ @@ -23363,11 +23363,11 @@ setSize.summary = \ \\ -setSpeech.description = Sets the Speech value from the Current Token . +setSpeech.description = Sets the Speech value from the Current Token . setSpeech.summary = \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b48\ -Sets the size of a Token with one of the defined sizes according to each Grid Type. The sizes can be found on the Token Size page.\ +Sets the size of a Token with one of the defined sizes according to each Grid Type. The sizes can be found on the Token Size page.\\ Usage\
\ @@ -23380,8 +23380,8 @@ setSize(size, id, mapname)\ Parameters\ \- \
-
size- The Token Size to set the token to. \
- id- The tokenidof the token which will have its Token Size set. Defaults to the Current Token. \
+ size- The Token Size to set the token to. \
+ id- The tokenidof the token which will have its Token Size set. Defaults to the Current Token. \
mapname- The name of the map to find the token. Defaults to the current map. \
\ @@ -23412,7 +23412,7 @@ setSize(size, id, mapname)\
\\ @@ -23421,7 +23421,7 @@ setSpeech.summary = \ setSpeech() Function\ \\ -setState.description = Sets the value of the State on Token . +setState.description = Sets the value of the State on Token . setState.summary = \• Introduced in version 1.3b48\ -Sets the Speech value from the Current Token.\ +Sets the Speech value from the Current Token.\\ Usage\
\ @@ -23432,7 +23432,7 @@ setSpeech.summary = \\\ @@ -23441,7 +23441,7 @@ setState.summary = \ setState() Function\ \• Introduced in version 1.3b40\ -Sets the value of the State on Token. If The value is\ +false(0) then the State is unset if it is non-zero(true(1)) then it is set.Sets the value of the State on Token. If The value is\false(0) then the State is unset if it is non-zero(true(1)) then it is set.\ Usage\
\ @@ -23456,21 +23456,21 @@ setState(state, value, id, mapname)\- \
state- The name of the state to set on the token. \
value- The value of the state to set,true(1) orfalse(0). \
- id- Theidof the token to have the State set. Defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- Theidof the token to have the State set. Defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ Examples\
\ -To set the "Dead" Token State on the Current Token\ +To set the "Dead" Token State on the Current Token\\\ -[h: setState("Dead", 1)]To reset the "Dead" Token State on the Current Token\ +
To reset the "Dead" Token State on the Current Token\
\[h: setState("Dead", 0)]\ See Also\
\ -State,\ + \\ -setStrProp.description = Returns a String Property List with the key set to the value passed in. +setStrProp.description = Returns a String Property List with the key set to the value passed in. setStrProp.summary = \\ @@ -23486,7 +23486,7 @@ setState(state, value, id, mapname)\
\\ -varsFromStrProp.description = Creates variables from a string property list with the values assigned to variables with the names of the keys in the string property list . +varsFromStrProp.description = Creates variables from a string property list with the values assigned to variables with the names of the keys in the string property list . varsFromStrProp.summary = \\ @@ -23495,7 +23495,7 @@ setStrProp.summary = \ setStrProp() Function\ \\• Introduced in version 1.3b42\ -Returns a String Property List with the key set to the value passed in.\ +Returns a String Property List with the key set to the value passed in.\\ Usage\
\ @@ -23506,19 +23506,19 @@ setStrProp.summary = \ Parameters\ \- \
-
propList- The String Property List affected by this function. \
- key- The key in the specified String Property List that will have its value set. \
+ propList- The String Property List affected by this function. \
+ key- The key in the specified String Property List that will have its value set. \
value- The value that the specified key will be set to. \
\ Examples\
\ -Add a new key to an existing String Property List:\ +\ -setTokenHandout.description = Sets the handout image for the for the Current Token . +setTokenHandout.description = Sets the handout image for the for the Current Token . setTokenHandout.summary = \Add a new key to an existing String Property List:\\ @@ -23636,7 +23636,7 @@ setTableImage.summary = \ \\[h: weapon = "name=longsword; damage=1d8; maxdamage=8"]\ [h: weapon = setStrProp(weapon, "value", 10)]\ [r: weapon]
Returns
"name=longsword ; damage=1d8 ; maxdamage=8 ; value=10 ; "\ -Change the value of a key in an existing String Property List:\ +
Change the value of a key in an existing String Property List:\
\\[h: weapon = "name=longsword; damage=1d8; maxdamage=8"]\ [h: weapon = setStrProp(weapon, "damage", "1d6")]\ @@ -23544,7 +23544,7 @@ setTableAccess.summary = \ \\ See Also\ \ \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.4.0.1\ @@ -23592,7 +23592,7 @@ setTableEntry.summary = \ \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.4.0.1\ @@ -23620,7 +23620,7 @@ setTableEntry(tableName, roll, result, imageId)\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.4.0.1\ @@ -23678,7 +23678,7 @@ setTablePickOnce.summary = \ \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.6.0\ @@ -23720,7 +23720,7 @@ setTableRoll.summary = \ \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.4.0.1\ @@ -23767,7 +23767,7 @@ setTableVisible.summary = \ \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.4.0.1\ @@ -23815,7 +23815,7 @@ setTerrainModifier.summary = \ \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.5.2\ @@ -23902,7 +23902,7 @@ setTokenDrawOrder(z, id, mapname)\ \- \
z- The Z coordinate to set the draw order to. \
- id- The id of the token to move, defaults to the Current Token. \
+ id- The id of the token to move, defaults to the Current Token. \
mapname- The name of the map to find the token. Defaults to the current map. \
\ @@ -23936,7 +23936,7 @@ setTokenFacing.summary = \ \
\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b51\ @@ -23987,7 +23987,7 @@ setTokenGMName.summary = \ \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b40\ @@ -24008,7 +24008,7 @@ setTokenGMName.summary = \\\ @@ -26225,7 +26225,7 @@ This Is a Test\ @@ -24017,7 +24017,7 @@ setTokenHandout.summary = \ setTokenHandout() Function\ \\ -setTokenImage.description = Sets the image for the for the Current Token . +setTokenImage.description = Sets the image for the for the Current Token . setTokenImage.summary = \• Introduced in version 1.3b77\ -Sets the handout image for the for the Current Token. The image can come from several sources. It can be an asset id (like from tblImage() orgetTokenImage().) or a Image Token.\ +Sets the handout image for the for the Current Token. The image can come from several sources. It can be an asset id (like from tblImage() orgetTokenImage().) or a Image Token.\\ Usage\
\ @@ -24035,7 +24035,7 @@ setTokenHandout(tokenImageName, id, mapname)\ Parameters\ \- \
-
id- OPTIONAL: The tokenidof the token for which you want to set the handout, defaults to the Current Token. \
+ id- OPTIONAL: The tokenidof the token for which you want to set the handout, defaults to the Current Token. \
mapname- OPTIONAL: The name of the map to find the token. Defaults to the current map. \
\ @@ -24075,7 +24075,7 @@ setTokenHeight(size, id, mapname)\
\- \
size- grid size of the token \
- id- The tokenidof the token to set its height. Defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidof the token to set its height. Defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ @@ -24103,7 +24103,7 @@ setTokenHeight(size, id, mapname)\
\\ -switchToken.description = Changes the Current Token for the remainder of the Macro. +switchToken.description = Changes the Current Token for the remainder of the Macro. switchToken.summary = \\ @@ -24112,7 +24112,7 @@ setTokenImage.summary = \ setTokenImage() Function\ \\ -setTokenPortrait.description = Sets the portrait image for the for the Current Token . +setTokenPortrait.description = Sets the portrait image for the for the Current Token . setTokenPortrait.summary = \• Introduced in version 1.3b48\ -Sets the image for the for the Current Token. The function accepts an Asset ID or an Image Token name. You can get Asset IDs from macro functions such as tblImage() or getTokenImage(). Image Tokens are special tokens whose name starts with "image:".\ +Sets the image for the for the Current Token. The function accepts an Asset ID or an Image Token name. You can get Asset IDs from macro functions such as tblImage() or getTokenImage(). Image Tokens are special tokens whose name starts with "image:".\\ Usage\
\ @@ -24132,7 +24132,7 @@ setTokenImage(imageToken, id, mapname)\- \
assetId- The Asset ID for an image. \
imageToken- The name of an image token e.g. "image:myimage" \
- id- OPTIONAL: The tokenidof the token for which you want to set the image, defaults to the Current Token. \
+ id- OPTIONAL: The tokenidof the token for which you want to set the image, defaults to the Current Token. \
mapname- OPTIONAL: The name of the map to find the token. Defaults to the current map. \
\ @@ -24215,7 +24215,7 @@ setLayoutProps(scale, xOffset, yOffset, id, mapName)\
scale- The scale of the token layout. If an empty string, the scale is not changed.xOffset- The xOffset of the token layout. If an empty string, the xOffset is not changed. Negative values shift the image left.yOffset- The yOffset of the token layout. If an empty string, the yOffset is not changed. Negative values shift the image up.id- The tokenidof the token to name, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
id- The tokenidof the token to name, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
mapname- The name of the map to find the token. Defaults to the current map.The
\xOffsetandyOffsetvalues must be integers.\ @@ -24261,7 +24261,7 @@ setTokenOpacity(value, id, mapname)\- \
value- The value of the opacity to set, ranging from 0.0 (completely transparent) to 1.0 (completely opaque). This must be a floating point value with leading zero if less than 1.0. \
- id- OPTIONAL: The tokenidof the token for which you want to retrieve the opacity, defaults to the Current Token. \
+ id- OPTIONAL: The tokenidof the token for which you want to retrieve the opacity, defaults to the Current Token. \
mapname- OPTIONAL: The name of the map to find the token. Defaults to the current map. \
Returns\ @@ -24291,7 +24291,7 @@ The opacity value that was set.\
\\ @@ -25208,10 +25208,10 @@ strfind.summary = \ strfind() Function\ \\ @@ -24300,7 +24300,7 @@ setTokenPortrait.summary = \ setTokenPortrait() Function\ \\• Introduced in version 1.3b77\ -Sets the portrait image for the for the Current Token. The image can come from several sources. It can be an asset id (like from tblImage() or getTokenImage()), or a Image Token.\ +Sets the portrait image for the for the Current Token. The image can come from several sources. It can be an asset id (like from tblImage() or getTokenImage()), or a Image Token.\\ Usage\
\ @@ -24318,7 +24318,7 @@ setTokenPortrait(tokenImageName, id, mapname)\ Parameters\ \- \
-
id- OPTIONAL: The tokenidof the token for which you want to set the portrait, defaults to the Current Token. \
+ id- OPTIONAL: The tokenidof the token for which you want to set the portrait, defaults to the Current Token. \
mapname- OPTIONAL: The name of the map to find the token. Defaults to the current map. \
\ @@ -24359,7 +24359,7 @@ setTokenShape(shape, id, mapname)\
\- \
shape- String value:"TOP_DOWN","CIRCLE","SQUARE","FIGURE". \
- id- The token id of the token to set to a new shape, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The token id of the token to set to a new shape, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
Result
\ @@ -24401,7 +24401,7 @@ The function returns the token's shape as a string value:"TOP_DOWN"\ -setTokenSnapToGrid.description = Sets the "snap to" behaviour for the Current Token or a specified token. +setTokenSnapToGrid.description = Sets the "snap to" behaviour for the Current Token or a specified token. setTokenSnapToGrid.summary = \\\ -setVisible.description = Sets the Visible to Players flag on a Token if the value passed in is non-zero(\ @@ -24410,7 +24410,7 @@ setTokenSnapToGrid.summary = \ setTokenSnapToGrid() Function\ \\• Introduced in version 1.4\ -Sets the "snap to" behaviour for the Current Token or a specified token.\ +Sets the "snap to" behaviour for the Current Token or a specified token.\\ Usage\
\ @@ -24464,7 +24464,7 @@ setTokenVBL.summary = \ \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.4.1.6\ @@ -24486,7 +24486,7 @@ setTokenVBL.summary = \ \- \
vbl- A JSON object containing thevblto be added to the token. Use getTokenVBL() to get VBL from another token. \
- id- OPTIONAL: The tokenidof the token for which you want to set this setting, defaults to the Current Token. \
+ id- OPTIONAL: The tokenidof the token for which you want to set this setting, defaults to the Current Token. \
\ Example\ @@ -24498,14 +24498,14 @@ setTokenVBL.summary = \ \
[r: finalVblData = "{'shape':'none'}"]\ [r: setTokenVBL(finalVblData)]
\ -Auto-generate VBL for the Current Token\ +
Auto-generate VBL for the Current Token\
\[h: options = json.set("{}", "shape", "auto", "sensitivity", 10, "inverse", 0, "level", 2, "method", "DOUGLAS_PEUCKER_SIMPLIFIER", "r", 0, "g", 0, "b", 0, "a", 255)]\ [h: setTokenVBL(options)]\ See Also\
\ - \ + \\ Version Changes\
\ @@ -24542,7 +24542,7 @@ setTokenWidth(size, id, mapname)\ \- \
size- grid size of the token \
- id- The tokenidof the token to set its width. Defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
+ id- The tokenidof the token to set its width. Defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
\
mapname- The name of the map to find the token. Defaults to the current map. \
\ @@ -24613,7 +24613,7 @@ setViewArea.summary = \
true(1)), otherwise resets it tofalse(0). +setVisible.description = Sets the Visible to Players flag on a Token if the value passed in is non-zero(true(1)), otherwise resets it tofalse(0). setVisible.summary = \\\ @@ -25022,7 +25022,7 @@ sr4e.summary = \\ @@ -24623,11 +24623,11 @@ setVisible.summary = \ \\ -sortInitiative.description = Sorts the Initiative Panel Tokens and returns the number of Tokens in the Initiative Panel . +sortInitiative.description = Sorts the Initiative Panel Tokens and returns the number of Tokens in the Initiative Panel . sortInitiative.summary = \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b40\ -Sets the Visible to Players flag on a Token if the value passed in is non-zero(\ +true(1)), otherwise resets it tofalse(0). The Visible to Players flag has two meanings, on a normal Token players will only be able to see the Token if it is set (when all other things like Fog of War etc are taken into account). If it is a Library Token then it determines if players can call Category:Macros using the [macro(...): ...] roll option.Sets the Visible to Players flag on a Token if the value passed in is non-zero(\true(1)), otherwise resets it tofalse(0). The Visible to Players flag has two meanings, on a normal Token players will only be able to see the Token if it is set (when all other things like Fog of War etc are taken into account). If it is a Library Token then it determines if players can call Category:Macros using the [macro(...): ...] roll option.\ Usage\
\ @@ -24642,7 +24642,7 @@ setVisible.summary = \ \- \
visible- The state of visibility,true(1) orfalse(0). \
- id- The tokenidof the token which has its player visibility set, defaults to the Current Token. \
+ id- The tokenidof the token which has its player visibility set, defaults to the Current Token. \
\
\ @@ -24723,7 +24723,7 @@ showTextLabels.summary = \ \• Introduced in version 1.6\• Last checked for compatibility with version 1.6\ -Enables the display of Text Labels if they are not showing. This can also be set in the View menu.\ +Enables the display of Text Labels if they are not showing. This can also be set in the View menu.\\ Usage\
\ @@ -24754,7 +24754,7 @@ showTextLabels.summary = \\\\ @@ -24764,11 +24764,11 @@ sortInitiative.summary = \ \\\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b41\ -Sorts the Initiative Panel Tokens and returns the number of Tokens in the Initiative Panel.\ +\ +Sorts the Initiative Panel Tokens and returns the number of Tokens in the Initiative Panel.\\- The Default sort order is descending, with any non-numeric values coming after any numbers, and any blank values coming last.
- Since 1.8: If the
reverseOrderparameter is1, this order is reversed - blank values come first, and any non-numeric strings (in ascending lexical order) come before numbers (in ascending order).
\ Usage\ @@ -24792,7 +24792,7 @@ sortInitiative(reverseOrder)\
Reverse Order\ Command\ sortInitiative()sortInitiative(0)sortInitiative(1)Result\ - \
\ @@ -24986,7 +24986,7 @@ sr4.summary = \
\\ See Also\
\ -For another method of rolling dice, see Dice Expressions.\ +For another method of rolling dice, see Dice Expressions.\\ See Also\
\ -For another method of rolling dice, see Dice Expressions.\ +For another method of rolling dice, see Dice Expressions.\• Introduced in version 1.3b48\ -Finds and extracts substrings from a string.\ -stringToList.description = Converts a string into a string list using a pattern to determine separator between elements. +stringToList.description = Converts a string into a string list using a pattern to determine separator between elements. stringToList.summary = \strfind()is used to match a pattern against an input string and extract all of the capture groups. The function returns an id which can be used with other functions to extract the information. The supplied pattern is a regular expression.\ +Finds and extracts substrings from a string.\ @@ -25447,7 +25447,7 @@ string.summary = \strfind()is used to match a pattern against an input string and extract all of the capture groups. The function returns an id which can be used with other functions to extract the information. The supplied pattern is a regular expression.\Functions related to
\ -strfind():\- getFindCount(id)
- getGroupCount(id)
- getGroup(id, matchNo, groupNo)
- getGroupStart(id, matchNo, groupNo)
- getGroupEnd(id, matchNo, groupNo)
- getFindCount(id)
- getGroupCount(id)
- getGroup(id, matchNo, groupNo)
- getGroupStart(id, matchNo, groupNo)
- getGroupEnd(id, matchNo, groupNo)
Both
\ Groups are the regex capture groups, designated by the parts inmatchNoandgroupNostart at 1, the special group number0returns the whole pattern match.\"("parenthesis")". Group 1 returns the string that matches the first regex statement in(), 2 returns the second, etc.\\ @@ -25697,7 +25697,7 @@ Returns:\ @@ -25456,7 +25456,7 @@ stringToList.summary = \ stringToList() Function\ \\• Introduced in version 1.3b48\ -Converts a string into a string list using a pattern to determine separator between elements. The specified delimiter is used to separate the elements in the Macros:string list if it is specified, otherwise the default value of "," is used. Pattern can be a regular expression.\ +Converts a string into a string list using a pattern to determine separator between elements. The specified delimiter is used to separate the elements in the Macros:string list if it is specified, otherwise the default value of "," is used. Pattern can be a regular expression.\\ Usage\
\ @@ -25656,7 +25656,7 @@ Returns a number than is between0and12, which is th\ See Also\
\ -For another method of rolling dice, see Dice Expressions.\ +For another method of rolling dice, see Dice Expressions.\"14"
\\\ @@ -25707,12 +25707,12 @@ switchToken.summary = \ \\ -tableImage.description = Gets the image asset value from the specified table . +tableImage.description = Gets the image asset value from the specified table . tableImage.summary = \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.3b48\ -Changes the Current Token for the remainder of the Macro.\ -\In practice, "the remainder of the Macro" is the same as the variable scope. Thus, if a macro is running as a user defined function (see defineFunction() ) with a new scope, switchToken will only apply until the end of the current macro. Once control passes back to the calling macro, the Current Token reverts back to what it was before the external macro was called ( as a function ).\ +
Changes the Current Token for the remainder of the Macro.\ +\In practice, "the remainder of the Macro" is the same as the variable scope. Thus, if a macro is running as a user defined function (see defineFunction() ) with a new scope, switchToken will only apply until the end of the current macro. Once control passes back to the calling macro, the Current Token reverts back to what it was before the external macro was called ( as a function ).\ If a defineFunction() does not create a new variable scope for the called macro, then effects of switchToken persist when control passes back to the calling macro.
\ Note: You cannot switch to a token on a different map.\ @@ -25749,8 +25749,8 @@ tbl(name, row)\ Parameters\ \
- \
-
name- A string containing the name of the table. \
- row- The row of the table that should be returned. \
+ name- A string containing the name of the table. \
+ row- The row of the table that should be returned. \
\ Examples\ @@ -25776,12 +25776,12 @@ tbl(name, row)\
\ See Also\
\ -tableImage()\ +
There is a tool available to import tables from excel. You can find more about this heretableImage()\
There is a tool available to import tables from excel. You can find more about this here\\\ @@ -25790,7 +25790,7 @@ tableImage.summary = \ tableImage() Function\ \\ @@ -26189,7 +26189,7 @@ Returns a number than is between• Introduced in version 1.3b40\ -Gets the image asset value from the specified table. If the row is not specified then the default roll for the table is used.\ +Gets the image asset value from the specified table. If the row is not specified then the default roll for the table is used.\\ Usage\
\ @@ -25806,16 +25806,16 @@ tblImage(name, row, size)\ Parameters\ \- \
-
name- A string containing the name of the table. \
- row- The row of the table that should have the image asset returned. \
+ name- A string containing the name of the table. \
+ row- The row of the table that should have the image asset returned. \
size- The size the image asset returned should be. If the image is not square, this will be the size of the height. \
\ Examples\
\ -Example 1: Display a random image from table\ -tblImage.description = Gets the image asset value from the specified table . +tblImage.description = Gets the image asset value from the specified table . tblImage.summary = \"tbl1"using default roll:\ +Example 1: Display a random image from table\"tbl1"using default roll:\\ -<image src='[r: tableImage("tbl1")]'></image>Example 1: Display the first image from table
"tbl1":\ +Example 1: Display the first image from table
\"tbl1":\\<image src='[r: tableImage("tbl1", 1)]'></image>Example 2: Display one of the first four images, resized to
\40pixels tall, from"tbl1", chosed randomly:\ @@ -25856,8 +25856,8 @@ tbl(name, row)\ Parameters\- \
-
name- A string containing the name of the table. \
- row- The row of the table that should be returned. \
+ name- A string containing the name of the table. \
+ row- The row of the table that should be returned. \
\ Examples\ @@ -25883,12 +25883,12 @@ tbl(name, row)\
\ See Also\
\ -tableImage()\ +
There is a tool available to import tables from excel. You can find more about this heretableImage()\
There is a tool available to import tables from excel. You can find more about this here\\\ @@ -25897,7 +25897,7 @@ tblImage.summary = \ tableImage() Function\ \\• Introduced in version 1.3b40\ -Gets the image asset value from the specified table. If the row is not specified then the default roll for the table is used.\ +Gets the image asset value from the specified table. If the row is not specified then the default roll for the table is used.\\ Usage\
\ @@ -25913,16 +25913,16 @@ tblImage(name, row, size)\ Parameters\ \- \
-
name- A string containing the name of the table. \
- row- The row of the table that should have the image asset returned. \
+ name- A string containing the name of the table. \
+ row- The row of the table that should have the image asset returned. \
size- The size the image asset returned should be. If the image is not square, this will be the size of the height. \
\ Examples\
\ -Example 1: Display a random image from table\ @@ -25995,7 +25995,7 @@ transferVBL.summary = \ \"tbl1"using default roll:\ +Example 1: Display a random image from table\"tbl1"using default roll:\\ -<image src='[r: tableImage("tbl1")]'></image>Example 1: Display the first image from table
"tbl1":\ +Example 1: Display the first image from table
\"tbl1":\\<image src='[r: tableImage("tbl1", 1)]'></image>Example 2: Display one of the first four images, resized to
40pixels tall, from"tbl1", chosed randomly:\ @@ -25949,7 +25949,7 @@ toggleFoW.summary = \ \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.4.1.3\ @@ -25980,7 +25980,7 @@ toggleFoW.summary = \\ See Also\
\ - \ + \\\\ - Note: This function can only be used in a Trusted Macro\ + Note: This function can only be used in a Trusted Macro\
\• Introduced in version 1.4.2.0\ @@ -26018,7 +26018,7 @@ transferVBL(value, delete, id)\value- The value of the setting to set:\0transfer normal (blue) VBL to token (yellow) VBL1transfer token (yellow) VBL to normal (blue) VBL
delete- Defines if the transferred VBL is deleted from the source.id- OPTIONAL: The tokenidof the token for which you want to set this setting, defaults to the Current Token.id- OPTIONAL: The tokenidof the token for which you want to set this setting, defaults to the Current Token.\ Examples\ @@ -26053,7 +26053,7 @@ transferVBL(value, delete, id)\
\ See Also\
\ - \ + \\ Version Changes\
\ @@ -26146,7 +26146,7 @@ Returns a number than is between0and5.\ See Also\
\ -For another method of rolling dice, see Dice Expressions.\ +For another method of rolling dice, see Dice Expressions.\0and5.\ See Also\
\ -For another method of rolling dice, see Dice Expressions.\ +For another method of rolling dice, see Dice Expressions.\\\ @@ -26234,7 +26234,7 @@ varsFromStrProp.summary = \ varsFromStrProp() Function\ \• Introduced in version 1.3b42\ -Creates variables from a string property list with the values assigned to variables with the names of the keys in the string property list. The function returns the number of variables that were created.\ +Creates variables from a string property list with the values assigned to variables with the names of the keys in the string property list. The function returns the number of variables that were created.\\ Usage\
\
\
\
\
\
\
\
