hasMacro: Difference between revisions

Revision as of 05:16, 17 March 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, id)
hasMacro(label, id, mapname)

Parameters

label - The label of the macro to check for.
id - The token id 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.

@@ Line 6: / Line 6: @@
 |usage=
-<source lang="mtmacro" line>
+<syntaxhighlight lang="mtmacro" line>
 hasMacro(label)
 hasMacro(label, id)
 hasMacro(label, id, mapname)
-</source>
+</syntaxhighlight>
 '''Parameters'''
 {{param|label|The label of the macro to check for.}}
-{{param|id|The token {{code|id}} of the token that the function is executed on. {{TrustedParameter}} }}
+{{param|id|The token {{code|id}} 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.}}
@@ Line 19: / Line 19: @@
 {{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]]