getMacroProps: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
VisualWikitext
m (Fixing wikilinks)
No edit summary
Line 1: Line 1:
{{stub|Examples}}
{{MacroFunction
{{MacroFunction
|name=getMacroProps
|name=getMacroProps
Line 20: Line 21:
{{param|id|The token {{code|id}} of the token that the function is executed on. {{TrustedParameter}} }}
{{param|id|The token {{code|id}} of the token that the function is executed on. {{TrustedParameter}} }}


'''Valid Properties for Macro Buttons'''
'''Macro Buttons Properties Returned'''
* {{code|applyToSelected}} - Should the macro be applied to the selected tokens.
* {{code|applyToSelected}} - Should the macro be applied to the selected tokens.
* {{code|autoExecute}} - If the macro will be automatically executed when the button is clicked, accepts {{true}} or {{false}}.
* {{code|autoExecute}} - If the macro will be automatically executed when the button is clicked, accepts {{true}} or {{false}}.
Line 36: Line 37:
* {{code|playerEditable}} - Is the button player editable, accepts {{true}} or {{false}}.
* {{code|playerEditable}} - Is the button player editable, accepts {{true}} or {{false}}.
* {{code|tooltip}} - The tool tip for the macro button.
* {{code|tooltip}} - The tool tip for the macro button.
* {{code|compare}} - Takes a [[JSON Array]] which can contain one or more of the following keywords (only usable with JSON version of the function).
* {{code|compare}} - A [[JSON Array]] of the selected '''Macro Commonality''' options.
** {{code|applyToSelected}} - Use the macro applyToSelected for common macro comparisons.
** {{code|applyToSelected}} - Use the macro applyToSelected for common macro comparisons.
** {{code|autoExecute}} - Use the macro autoExec for common macro comparisons.
** {{code|autoExecute}} - Use the macro autoExec for common macro comparisons.
Line 43: Line 44:
** {{code|includeLabel}} - Use the macro includeLabel for common macro comparisons.
** {{code|includeLabel}} - Use the macro includeLabel for common macro comparisons.
** {{code|sortPrefix}} - Use the macro sortPrefix for common macro comparisons.
** {{code|sortPrefix}} - Use the macro sortPrefix for common macro comparisons.
 
* {{code|metadata}} - A [[JSON Object]] holding the metadata key/value pairs for the macro.
** {{code|uuid}} -
** {{code|commandChecksum}} -
** {{code|propsChecksum}} -
|changes=
|changes=
{{change|1.3b49|Added {{code|json}} delimiter option.}}
{{change|1.3b49|Added {{code|json}} delimiter option.}}
{{change|1.3b51|Added optional token {{code|id}} parameter.}}
{{change|1.3b51|Added optional token {{code|id}} parameter.}}
{{change|1.3b53|Added ability for {{code|command}}, {{code|compare}}, {{code|playerEditable}}, {{code|applyToSelected}}, {{code|autoExecute}}, {{code|group}}, and {{code|tooltip}} parameters.}}
{{change|1.3b53|Added state of Macro Commonality settings under ''compare'' in JSON output.}}
{{change|1.5.7|Added metadata to JSON output.}}
}}
}}
[[Category:Metamacro Function]]
[[Category:Metamacro Function]]

Revision as of 13:38, 9 November 2019

 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)

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. 

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.
Retrieved from "https://wiki.rptools.info/index.php?title=getMacroProps&oldid=7967"