getMacroIndexes: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
VisualWikitext
No edit summary
 
(13 intermediate revisions by 6 users not shown)
Line 1: Line 1:
==Function getMacroIndexes==
{{stub|Examples of usage.}}
{{MacroFunction
|name=getMacroIndexes
|version=1.3b48
|description=Returns a list of the [[Macro Button|macro buttons]] on the [[Current Token]] that have the specified label. The type of the value returned depends on the delimiter parameter.


Returns a [[Macros:string list|string list]] of the [[macro buttons]] on the current [[Token:token]] that have the specified label.
|usage=
<syntaxhighlight  lang="mtmacro" line>
getMacroIndexes(label)
getMacroIndexes(label, delim)
getMacroIndexes(label, delim, tokenRef)
getMacroIndexes(label, delim, tokenRef, mapname)
</syntaxhighlight>
'''Parameters'''
{{param|label|The label for the macro buttons to return.}}
{{param|delim|The delimiter used to separate the values in the [[String List]] which defaults to {{code|","}} if not specified. This function returns a [[JSON Object]] if {{code|"json"}} is specified.}}
{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token that the function is executed on. From v1.15, accepts "campaign" and "gm" as ids for the relevant panels.{{TrustedParameter}} }}
{{param|mapname|The name 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 one token has the same name can produce unexpected results.}}


===Usage===
|changes=
<source lang="mtmacro" line>
{{change|1.3b49|Added {{code|"json"}} delimiter option.}}
[h: indexes = getMacroIndexes(label)]
{{change|1.3b51|Added {{code|id}} parameter option.}}
[h: indexes = getMacroIndexes(label, delim)]
{{change|1.5.11|Added {{code|mapname}} parameter option.}}
</source>
{{change|1.15|Addition of "gm" and "campaign" options for id}}
delim is the delimiter used to separate values in the [[Macros:string list|string list]] and defaults to "," if not specified.
}}
[[Category:Metamacro Function]]

Latest revision as of 19:23, 11 May 2024

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

getMacroIndexes() Function

• Introduced in version 1.3b48
Returns a list of the macro buttons on the Current Token that have the specified label. The type of the value returned depends on the delimiter parameter.

Usage

getMacroIndexes(label)
getMacroIndexes(label, delim)
getMacroIndexes(label, delim, tokenRef)
getMacroIndexes(label, delim, tokenRef, mapname)

Parameters

  • label - The label for the macro buttons to return.
  • delim - The delimiter used to separate the values in the String List which defaults to "," if not specified. This function returns a JSON Object if "json" is specified.
  • tokenRef - Either the token id or Token Name of the token that the function is executed on. From v1.15, accepts "campaign" and "gm" as ids for the relevant panels.

     Note: This parameter can only be used in a Trusted Macro. 

  • mapname - The name 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.


Version Changes

  • 1.3b49 - Added "json" delimiter option.
  • 1.3b51 - Added id parameter option.
  • 1.5.11 - Added mapname parameter option.
  • 1.15 - Addition of "gm" and "campaign" options for id
Retrieved from "https://wiki.rptools.info/index.php?title=getMacroIndexes&oldid=17789"