getMacroGroup: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page GetMacroGroup to getMacroGroup: Converting page titles to lowercase)
No edit summary
Line 8: Line 8:


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getMacroGroup(group)
getMacroGroup(group)
getMacroGroup(group, delim)
getMacroGroup(group, delim)
getMacroGroup(group, delim, id)
getMacroGroup(group, delim, id)
getMacroGroup(group, delim, id, mapname)
getMacroGroup(group, delim, id, mapname)
</source>
</syntaxhighlight>
'''Parameters'''
'''Parameters'''
{{param|group|The name of the macro group to get the macro button indexes from.}}
{{param|group|The name of the macro group to get the macro button indexes from.}}

Revision as of 18:38, 14 March 2023

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

getMacroGroup() Function

 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.

Usage

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. 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.


Version Changes

  • 1.5.11 - Added mapname parameter option.