getMacroGroup: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Initial write-up.)
 
mNo edit summary
Line 20: Line 20:
* {{code|group}} - The name of the macro group to get the macro button indexes from.
* {{code|group}} - The name of the macro group to get the macro button indexes from.
* {{code|delim}} - The delimiter used in the string list returned, defaults to {{code|","}}. If set to {{code|json}}, then a JSON array is returned.
* {{code|delim}} - The delimiter used in the string list returned, defaults to {{code|","}}. If set to {{code|json}}, then a JSON array is returned.
* {{code|id}} - The id of the token that the macro group is located on, defaults to the current token.
* {{code|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.


}}
}}
[[Category:Metamacro Function]]
[[Category:Metamacro Function]]

Revision as of 06:16, 10 March 2009

 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)

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.