getMacroGroup: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) mNo edit summary |
No edit summary |
||
Line 10: | Line 10: | ||
<source lang="mtmacro" line> | <source 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) | |||
</source> | </source> | ||
'''Parameters''' | '''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. 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.}} | |||
|changes= | |||
{{change|1.5.11|Added {{code|mapname}} parameter option.}} | |||
}} | }} | ||
[[Category:Metamacro Function]] | [[Category:Metamacro Function]] |
Revision as of 23:45, 14 January 2020
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 tojson
, 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.