setMacroProps

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. If the delimiter is not specified then the default value of ";" is used. As of MapTool 1.3b49 setMacroProps() accepts a json object containing the button properties, no delimiter needs to be specified in this case.

Valid Properties for Macro Buttons

• applyToSelected - Should the macro be applied to the selected tokens.
• autoExec - 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.
  • autoExec - 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.

Usage

setMacroProps(index, props)

setMacroProps(index, props, delim)

setMacroProps(label, props)

setMacroProps(label, props, delim)

Example

[h: setMacroProps(1, "color=red;fontColor=white")]
[h: setMacroProps("Attack", "color=red;fontColor=white")]

Version Changes

• 1.3b49 - Added ability for props to accept a JSON object.
• 1.3b53 - Added ability for command, compare, playerEditable, applyToSelected, autoExec, group, and tooltip parameters.