getMacroGroup: Difference between revisions

Revision as of 05:08, 17 March 2024

This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.

Note: This function can only be used in a Trusted Macro

• Introduced in version 1.3b51

Gets the indexes of the macro buttons for the specified group.

getMacroGroup(group)
getMacroGroup(group, delim)
getMacroGroup(group, delim, id)
getMacroGroup(group, delim, id, mapname)

Parameters

group - The name of the macro group to get the macro button indexes from.
delim - The delimiter used in the string list returned, defaults to ",". If set to json, then a JSON array is returned.
id - The id of the token that the macro group is located on, defaults to the current token. From v1.15, accepts "campaign" and "gm" as ids for the relevant panels. If the id is not specified, this function does not require a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.

@@ Line 17: / Line 17: @@
 {{param|group|The name of the macro group to get the macro button indexes from.}}
 {{param|delim|The delimiter used in the string list returned, defaults to {{code|","}}. If set to {{code|json}}, then a JSON array is returned.}}
-{{param|id|The id of the token that the macro group is located on, defaults to the current token. If the id is not specified, this function does not require a Trusted Macro.}}
+{{param|id|The id of the token that the macro group is located on, defaults to the current token. From v1.15, accepts "campaign" and "gm" as ids for the relevant panels. If the id is not specified, this function does not require a Trusted Macro.}}
 {{param|mapname|The name of the map to find the token.  Defaults to the current map.}}