createMacro

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

createMacro() Function

• Introduced in version 1.3b48

Creates a macro button for the Current Token and returns the index of the newly created button.

Usage

createMacro(label, command)

createMacro(label, command, props)

createMacro(label, command, props, delim)

Parameters

• 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.
  • 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.

Example

[createMacro("Test", "this is a test", "autoExec=true;color=blue", ";") ]
[createMacro("Another Test", "this is a test", "autoExec=true;color=red;fontColor=white", ";") ]

Will create the following buttons on the current token.

Version Changes

• 1.3b49 - Added json delimiter option.
• 1.3b51 - Added ability for command, compare, playerEditable, applyToSelected, autoExec, group, and tooltip parameters.