getMacros

Contents 1 getMacros() Function 1.1 Usage 1.2 Examples 1.3 Version Changes

getMacros() Function

Returns a list of the labels of all of the macro buttons on the Current Token. The type of the value returned depends on the delimiter parameter.

Usage

Parameters

• delim - The delimiter used to separate the values in the String List, a JSON array is returned if "json" is specified as the delimiter. Defaults to ","
• id - The token id of the token that the function is executed on.  Note: This parameter can only be used in a Trusted Macro. 

Examples

To display all of the macro button labels on the current token use.

Version Changes

• 1.3b49 - Added json delimiter option.
• 1.3b51 - Added optional token id parameter.

Token: A visual marker representing a character, monster, or NPCTrusted Macro: A macro run from a Library token or run by the GM, that cannot be edited by a player.Macro Button: The visual representation of a Macro, usually referred to explicitly for good reason.Macro: A series of text instructions used to automate processes in MapTool.String List: A string containing a list of items in the format "item1, item2, item3,..."