getMacroProps: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
VisualWikitext
No edit summary
No edit summary
Line 31: Line 31:


'''Valid Properties for Macro Buttons'''
'''Valid Properties for Macro Buttons'''
* autoExec - true/false - Will the macro be automatically executed when the button is clicked on.
* {{code|applyToSelected}} - Should the macro be applied to the selected tokens.
* color - The name of the color for the button.
* {{code|autoExec}} - If the macro will be automatically executed when the button is clicked, accepts {{true}} or {{false}}.
* fontColor - The name of the font color for the button.
* {{code|color}} - The name of the color for the button.
* includeLabel - true/false - Will the label be output when the button is clicked.
* {{code|command}} - The command for the macro (only when using JSON version of function).
* group - The name of the group that the button is in.
* {{code|fontColor}} - The name of the font color for the button.
* sortBy - The sort by value of the macro button.
* {{code|fontSize}} - The size of the font for the button.
* {{code|includeLabel}} - If the label will be output when the button is clicked. Accepts {{true}} or {{false}}.
* {{code|group}} - The name of the group that the button belongs to.
* index - The index of the button.
* index - The index of the button.
* label - the lavle of the button.
* {{code|sortBy}} - The sort by value of the macro button.
* fontSize - The size of the font for the button.
* {{code|label}} - The label for the button.
* minWidth - the minimum width of the button.
* {{code|maxWidth}} - The maximum width of the button.
* {{code|minWidth}} - The minimum width of the button.
* {{code|playerEditable}} - Is the button player editable, accepts {{true}} or {{false}}.
* {{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|applyToSelected}} - Use the macro applyToSelected for common macro comparisons.
** {{code|autoExec}} - Use the macro autoExec for common macro comparisons.
** {{code|command}} - Use the macro command for common macro comparisons.
** {{code|group}} - Use the macro group for common macro comparisons.
** {{code|includeLabel}} - Use the macro includeLabel for common macro comparisons.
** {{code|sortPrefix}} - Use the macro sortPrefix for common macro comparisons.


|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|autoExec}}, {{code|group}}, and {{code|tooltip}} parameters.}}
}}
}}
[[Category:Metamacro Function]]
[[Category:Metamacro Function]]

Revision as of 02:51, 24 March 2009

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

Parameters

  • label - The label for the macro button. If you specify a label then all macro buttons on the token that have that label will be returned.
  • 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. 

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


Version Changes

  • 1.3b49 - Added json delimiter option.
  • 1.3b51 - Added optional token id parameter.
  • 1.3b53 - Added ability for command, compare, playerEditable, applyToSelected, autoExec, group, and tooltip parameters.
Retrieved from "https://wiki.rptools.info/index.php?title=getMacroProps&oldid=2167"