getMacroGroup: Difference between revisions

Latest revision as of 23:59, 10 May 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, tokenRef)
getMacroGroup(group, delim, tokenRef, mapRef)

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.
tokenRef - Either the token id or Token Name of the 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.

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.

@@ Line 11: / Line 11: @@
 getMacroGroup(group)
 getMacroGroup(group, delim)
-getMacroGroup(group, delim, id)
+getMacroGroup(group, delim, tokenRef)
-getMacroGroup(group, delim, id, mapname)
+getMacroGroup(group, delim, tokenRef, mapRef)
 </syntaxhighlight>
 '''Parameters'''
 {{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. Will also work with [[getTokenName|Token Name]]
+{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the 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.}}
+{{param|mapRef|The Name or ID of the map to find the token.  Defaults to the current map.}}
-{{Note|Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than on token has the same name can produce unexpected results.}}
+{{Note|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.}}