getMacroProps

 This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
 This article needs: Examples

getMacroProps() Function

• 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() function.The type of the value returned depends on the delimiter parameter.

Usage

getMacroProps(index)
getMacroProps(index, delim)
getMacroProps(index, delim, id)
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 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.

Macro Buttons Properties Returned

• 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.
• index - The index of the button.
• 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 - 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.
  • uuid -
  • commandChecksum -
  • propsChecksum -

Version Changes

• 1.3b49 - Added json delimiter option.
• 1.3b51 - Added optional token id parameter.
• 1.3b53 - Added state of Macro Commonality settings under compare in JSON output.
• 1.5.7 - Added metadata to JSON output.
• 1.5.11 - Added mapname parameter option.