getMacroProps

 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() or getMacroButtonIndex() function. The type of the value returned depends on the delimiter parameter.

Usage

getMacroProps(index)
getMacroProps(index, delim)
getMacroProps(index, delim, tokenRef)
getMacroProps(index, delim, tokenRef, mapRef)

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.
• tokenRef - Either the token id or Token Name of the token that the function is executed on. From v1.15, accepts "campaign" and "gm" as ids for the relevant panels.

   Note: This parameter can only be used in a Trusted Macro. 

• mapRef - The Name or ID of the map to find the token. Defaults to the current map.

Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.

Macro Buttons Properties Returned

• metadata - A JSON Object holding the metadata key/value pairs for the macro.
  • uuid -
  • commandChecksum -
  • propsChecksum -
• See createMacro() for a list of all other properties.

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.
• 1.5.11 - Added mapname parameter option.
• 1.15 - Addition of "gm" and "campaign" options for id