getMacroProps: Difference between revisions

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




Returns a [[Macros:string property list]] of the properties for a [[macro button]] for the current [[Token:token|token]]. You can retrieve the index of a [[macro button]] with the [[Macros:Functions:getMacroIndexes|getMacroIndexes()]] function.
Returns a [[Macros:string property list]] of the properties for a [[macro button]] for the [[Token:Current Token|Current Token]]. You can retrieve the index of a [[macro button]] with the [[Macros:Functions:getMacroIndexes|getMacroIndexes()]] function.


===Usage===
===Usage===

Revision as of 13:01, 13 December 2008

Function getMacroProps

Returns a Macros:string 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.

Usage

[h: getMacroProps(label, props, delim)]
[h: getMacroProps(index, props, delim)]

Where

  • label is the label for the macro button. If you specify a label then all macro buttons on the token that have that label will be updated.
  • index is the index of the macro button.
  • props is a string property list containing the properties for the button.
  • delim is the delimiter used to separate the values in the string property list which defaults to ';' if not specified.

Valid Properties for Macro Buttons

  • autoExec - true/false - Will the macro be automatically executed when the button is clicked on.
  • color - The name of the color for the button.
  • fontColor - The name of the font color for the button.
  • includeLabel - true/false - Will the label be output when the button is clicked.
  • group - The name of the group that the button is in.
  • sortBy - The sort by value of the macro button.
  • index - The index of the button.
  • label - the lavle of the button.
  • fontSize - The size of the font for the button.
  • minWidth - the minimum width of the button.