hasMacro: Difference between revisions

Latest revision as of 23:59, 16 May 2024

• Introduced in version 1.3b48

Returns true(1) if a macro button with the specified label exists on the Current Token.

hasMacro(label)
hasMacro(label, tokenRef)
hasMacro(label, tokenRef, mapRef)

Parameters

label - The label of the macro to check for.
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.
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 1: / Line 1: @@
 {{MacroFunction
 |name=hasMacro
+|version=1.3b48
 |description=
-Returns 1 if a [[macro button]] with the specified label exists on the [[Token:Current Token|Current Token]].
+Returns {{true}} if a [[Macro_Button|macro button]] with the specified label exists on the [[Current Token]].
 |usage=
-<source lang="mtmacro" line>
+<syntaxhighlight lang="mtmacro" line>
-[h: macroExists = hasMacro(label)
+hasMacro(label)
-</source>
+hasMacro(label, tokenRef)
+hasMacro(label, tokenRef, mapRef)
+</syntaxhighlight>
+'''Parameters'''
+{{param|label|The label of the macro to check for.}}
+{{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|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 one token has the same name can produce unexpected results.}}
+|changes=
+{{change|1.3b51|Added optional token {{code|id}} parameter.}}
+{{change|1.5.11|Added {{code|mapname}} parameter option.}}
+{{change|1.15|Addition of "gm" and "campaign" options for id}}
 }}
 [[Category:Metamacro Function]]